Administration and Security Guide
Administration and Security Guide
Product Information
This document applies to IBM Cognos 8 Version 8.4 and may also apply to subsequent releases. To check for newer versions of this document, visit the IBM Cognos Resource Center (http://www.ibm.com/software/data/support/cognos_crc.html).
Copyright
Copyright 2008 Cognos ULC (formerly Cognos Incorporated). Cognos ULC is an IBM Company. Portions of Cognos ULC software products are protected by one or more of the following U.S. Patents: 6,609,123 B1; 6,611,838 B1; 6,662,188 B1; 6,728,697 B2; 6,741,982 B2; 6,763,520 B1; 6,768,995 B2; 6,782,378 B2; 6,847,973 B2; 6,907,428 B2; 6,853,375 B2; 6,986,135 B2; 6,995,768 B2; 7,062,479 B2; 7,072,822 B2; 7,111,007 B2; 7,130,822 B1; 7,155,398 B2; 7,171,425 B2; 7,185,016 B1; 7,213,199 B2; 7,243,106 B2; 7,257,612 B2; 7,275,211 B2; 7,281,047 B2; 7,293,008 B2; 7,296,040 B2; 7,318,058 B2; 7,325,003 B2; 7,333,995 B2. Cognos and the Cognos logo are trademarks of Cognos ULC (formerly Cognos Incorporated) in the United States and/or other countries. IBM and the IBM logo are trademarks of International Business Machines Corporation in the United States, or other countries or both. Java and all Java-based trademarks are trademarks of Sun Microsystems, Inc. in the United States, other countries, or both. Other company, product, or service names may be trademarks or service marks of others. While every attempt has been made to ensure that the information in this document is accurate and complete, some typographical errors or technical inaccuracies may exist. Cognos does not accept responsibility for any kind of loss resulting from the use of information contained in this document. This document shows the publication date. The information contained in this document is subject to change without notice. Any improvements or changes to the information contained in this document will be documented in subsequent editions. U.S. Government Restricted Rights. The software and accompanying materials are provided with Restricted Rights. Use, duplication, or disclosure by the Government is subject to the restrictions in subparagraph (C)(1)(ii) of the Rights in Technical Data and Computer clause at DFARS 252.227-7013, or subparagraphs (C)(1) and (2) of the Commercial Computer Software - Restricted Rights at 48CFR52.227 as applicable. The Contractor is Cognos Corporation, 15 Wayside Road, Burlington, MA 01803. This document contains proprietary information of Cognos. All rights are reserved. No part of this document may be copied, photocopied, reproduced, stored in a retrieval system, transmitted in any form or by any means, or translated into another language without the prior written consent of Cognos.
Table of Contents
Introduction
27 31
New Features in Version 8.4 31 Additional Language Support 31 Support for IBM Metadata Workbench as a Lineage Solution 32 Access to IBM WebSphere Business Glossary 32 Managing Comments Using Cognos Viewer 32 Adding Application Context to Dynamic SQL 32 Support for New Data Sources 32 Support for New Portal Versions 32 Hiding Entries 32 Updating Published PowerCubes 33 Object Capabilities 33 Schedule Credentials 33 Save History Details for Job Steps 33 Viewing Lineage Information 33 Enhanced Drill-through Capabilities 33 Metric Studio Content in Portal Pages 34 Changed Features in Version 8.4 34 Composite Information Server is Replaced By IBM Cognos 8 Virtual View Manager 34 IBM Cognos 8 Portal Services 34 Deprecated Features in Version 8.4 34 IBM Cognos 8 PowerCube Connection Utility and cubeswap 34 New Features in Version 8.3 35 Improved User Interface for Administrators 35 Access to More Documentation 35 More Granular Administrative Capabilities 35 Access to System Statistics 35 Snapshot of System Health 35 Managing Queues 36 Reducing Deployment Details 36 Setting Priority on Schedules 36 Better Control of Interactive Features in Reports 36 New Sample Audit Reports 36 Publishing and Managing Packages in Non-root Folders 36 Enabling Report Studio Authoring Modes 37 Server Administration 37 Transformer Integrated into IBM Cognos 8 37 My Activities and Schedules 37 My Watch Items 38 Report Alerts 38 Watch Rules 38 Drilling Through on Multiple Values 38
Table of Contents Go Directly to Target Report When Only One Target Report Exists 39 Support for Microsoft Excel 2007 39 Saving Report Outputs to a File System 39 Resubmitting Failed Jobs and Reports 40 Resubmitting Failed Agent Tasks 40 Default Actions for Agent Items 40 Tabbed Portal Pages 40 Global Filters and Enhanced Portal Interactivity 40 Metric Studio Content in Portal Pages 41 Support for Microsoft SharePoint Portal 2003 and 2007 41 Changed Features in Version 8.3 41 Updated IBM Cognos Connection Look 41 More Information in the Go To Page 41 Cognos Watchlist Portlet 42 Replaced Capability 42 Part 1: IBM Cognos 8 Administration Chapter 2: IBM Cognos 8 Administration
43
IBM Cognos Administration 43 Automating Tasks 44 Setting up a Multilingual Reporting Environment 46 Configuring Your Database For Multilingual Reporting 47 Installing Fonts 47 IBM Cognos 8 Default Font 48 Report Studio Fonts 48 Set Up Printers 48 Configuring Web Browsers 50 Allow User Access to Series 7 Reports from IBM Cognos Connection 52 Restricting Access to IBM Cognos 8 53 Chapter 3: Building IBM Cognos 8 Applications Chapter 4: Samples
55
57
The Great Outdoors Company Samples 57 The Great Outdoors Group of Companies 58 Employees 60 Sales and Marketing 60 Great Outdoors Database, Models, and Packages 61 Setting Up the Samples 63 Restore Backup Files for the Samples Databases 64 Create Data Source Connections to the Samples Databases 67 Set Up Microsoft Analysis Services Cube Samples 68 Set Up the Essbase Cube Sample 69 Create Data Source Connections to OLAP Data Sources 70 Set Up the Metric Studio Sample 73 Import the Samples 74 Sample Database Models 76 Example - Running the Sample ELM Returns Agent Against Changed Data 76 Remove the Samples Databases from IBM Cognos 8 78
79
Log Messages 80 Logging Levels 80 Set Logging Levels 82 Audit Reports 82 Setting Up Audit Reporting 83 Sample Audit Model and Audit Reports 83 View Full Details for Secure Error Messages 88 Disable the Creation of Core Dump Files 89 Part 2: System Administration Chapter 6: System Performance Metrics
91
How Metric Data is Gathered 91 System Metrics 92 Panes on the Status System Page 99 Assess System Performance 100 View Attributes for Metric Scores 101 Set Metric Threshold Values 101 Reset Metrics 103 Reset Metrics for the System 103 Chapter 7: Server Administration
105
Dispatchers and Services 105 Stop and Start Dispatchers and Services 108 Activate a Content Manager Service 110 Remove Dispatchers from the Environment 111 Group Dispatchers in Configuration Folders 112 Specify Advanced Dispatcher Routing 113 Specify Gateway Mappings for Series 7 PowerPlay Data 116 Rename Dispatchers 116 Test Dispatchers 117 Administering Failover for Multiple Dispatchers 118 Securing Dispatchers 120 Content Manager Computers 121 Managing Database Connection Pool Settings for Content Manager 121 Sorting Entries for Non-English Locales 122 Managing Content Manager Synchronization 123 Control Browsing of External Namespaces 123 Set Advanced Content Manager Parameters 123 Override the (Default) Locale Processing in the Prompt Cache 124 Maintain the Content Store 125 Migrating PowerPlay Reports Published to IBM Cognos 8 127 Tune Server Performance 127 Set Server Group Names for Advanced Dispatcher Routing 128 Balance Requests Among Dispatchers 129 Use Cluster Compatible Mode for Dispatchers 129 Set Usage Peak Periods 130 Set the Maximum Number of Processes and Connections 131 Specify Queue Time Limits 133 Administration and Security Guide 5
Table of Contents PDF File Settings 134 Set Maximum Execution Time 137 Specify How Long to Keep Watch List Report Output 138 Limit Hotspots That are Generated in an Analysis Studio or Report Studio Chart 139 Set Compression for Email Attachments 140 Set the Report Size Limit for the Report Data Service 141 Set Parameters for Concurrent Query Execution 141 Set Query Prioritization 143 Disable Session Caching 145 Add Application Context to Dynamic SQL 147 Saved Report Output 148 Set File Location to Save a Copy of Report Output Outside of IBM Cognos 8 149 Set File Location to Save Copy of Report Output in IBM Cognos 8 149 Configure the Lineage Solution 151 Configure the IBM WebSphere Business Glossary URI 152 Enable Job, SMTP, and Task Queue Metrics 153 Part 3: Data Management Chapter 8: Data Sources and Connections
155
DB2 156 IBM Cognos Cubes 157 IBM Cognos Finance 157 IBM Cognos Now! Cube 158 IBM Cognos Planning - Contributor 158 IBM Cognos Planning - Series 7 159 IBM Cognos PowerCubes 159 IBM DB2 OLAP and Hyperion Essbase Data Source 164 Configure Scenario Dimensions 165 Specify Balanced Hierarchies 165 Specify Measure Formats 166 Specify the Attributes of a Dimension 167 IBM Infosphere Warehouse Cubing Services 168 Informix Data Sources 169 Microsoft Analysis Services Data Sources 169 Microsoft SQL Server Data Sources 171 ODBC Data Sources 173 Oracle Data Sources 176 SAP Business Information Warehouse (SAP BW) Data Sources 176 TM1 Data Sources 178 XML Data Sources 179 Create a Data Source 180 Add or Modify a Data Source Connection 183 Manage Data Source Connections 184 Create or Modify a Data Source Signon 186 Specifying Isolation Levels 188 Using Database Commands for Oracle, DB2, and Microsoft SQL Server 190 Example - Open Connection Command Block 191 Example - Close Connection Command Block 191 Add Command Blocks While Creating a Data Source 191 6
Table of Contents Add or Modify Command Blocks for a Connection 191 Command Block Examples 192 Securing Data Sources 195 Chapter 9: Back Up Data
197 199
Run a Data Movement Entry 199 Change Default Data Movement Entry Properties 200 Part 4: Security Administration Chapter 11: Security Model
201
Authentication Providers 201 Deleting or Restoring Unconfigured Namespaces 202 Authorization 203 Cognos Namespace 203 IBM Cognos Application Firewall 204 Data Validation and Protection 204 Logging and Monitoring 205 Chapter 12: Users, Groups, and Roles
207
Users 207 User Locales 208 Groups and Roles 208 Create an Cognos Group or Role 210 Add or Remove Members of an Cognos Group or Role 211 Chapter 13: Access Permissions
213
Set Access Permissions for an Entry 216 Trusted Credentials 218 Create Trusted Credentials 218 Chapter 14: Secured Functions and Features
221
Set Access to a Secured Function or Feature 225 Set Access to the Report Studio User Interface Profiles 227 Chapter 15: Object Capabilities
229
Set Up Object Capabilities for a Package 231 Chapter 16: Initial Security
233
Built-in Entries 233 Predefined Entries 234 Specify Security Settings After Installation 236 Securing the Content Store 237 Part 5: Content Administration in IBM Cognos Connection Chapter 17: IBM Cognos Connection Log On 239 Log Off 239 Create a Shortcut 240 Create a URL 241 Administration and Security Guide 7
239
Table of Contents Bookmark an Entry 242 Models and Packages 243 Entry Properties 243 General Properties 243 Permissions 246 Report, Query, Analysis, and PowerPlay Report Properties 247 Job Properties 248 Agent Properties 249 Page Properties 249 Rule Properties 250 Organizing Entries 251 Copy an Entry 251 Move an Entry 252 Rename an Entry 253 Disable an Entry 253 Hide an Entry 254 Select a Link for an Entry 256 Delete an Entry 257 Specify the Order of Entries 257 Create a Folder 258 Specify an Alternative Icon for an Entry 259 Search for an Entry 259 Personalize the Portal 260 My Watch Items 263 View Watch Items 264 Remove Yourself from an Alert List 264 Edit a Watch Rule 264 Chapter 18: Pages and Dashboards
267
Create a Page 269 Edit a Page 270 Share a Page 270 Modify a Portlet 271 Enable Communication Between Cognos Portlets 271 Portal Tabs 273 Add a Tab 273 Delete a Tab 274 Reorder the Tabs 275 Change Your Home Page 275 Create a Dashboard with Multiple Tabs 275 Adding Interactivity to Pages and Dashboards 278 Defining Global Filters 278 Enable Sharing of Drill-up and Drill-down Actions 283 Enable Sharing of Drill-through Actions 283 Chapter 19: Activities Management
285
Manage Current Activities 285 Manage Past Activities 287 Manage Upcoming Activities for a Specific Day 289 Manage Scheduled Activities 291 8
Table of Contents Manage Entry Run Priority 293 View the Run History for Entries 294 Specify How Long to Keep Run Histories 296 Rerun a Failed Entry Task 297 Chapter 20: Schedule Management
299
Schedule an Entry 300 Example - Schedule an Entry on the Last Day of the Month 301 Use Jobs to Schedule Multiple Entries 301 Trigger-based Entry Scheduling 304 Setting Up Trigger-based Scheduling 304 Schedule an Entry Based on an Occurrence 305 Chapter 21: Deployment
307
Deployment Specifications 307 Deployment Archives 308 Deployment Planning 308 Security and Deployment 308 Deploying the Entire Content Store 309 Deploying Selected Public Folders and Directory Content 311 Deployment Rules When Importing 315 Rules For Deploying the Entire Content Store 316 Rules For Partial Deployment 320 Deploying IBM Cognos 8 Entries 324 Create an Export Deployment Specification 325 Move the Deployment Archive 328 Import to a Target Environment 328 Include Configuration Objects in Import of Entire Content Store 331 Testing Deployed Applications 332 Upgrade Report Specifications 332 Chapter 22: Administering Packages
335
Data Trees 335 Configure or Reconfigure a Package 336 Set Permissions for Package Configuration 336 Remove a Package Configuration 337 Chapter 23: Managing User Profiles
339
Edit the Default User Profile 339 Delete a User Profile 340 Copy a User Profile 340 View or Change a User Profile 341 Chapter 24: Administering Microsoft Office Documents
343
Deploying IBM Cognos 8 Go! Office Client 343 Set Macro Security Level for Microsoft Office XP 344 Install the CA Certificate for the HTTPS Interface to Series 7 PowerPlay 344 Download a Microsoft Office Document 344
Table of Contents Part 6: Report, Agent, and Metric Administration Chapter 25: Reports and Cubes
347
View, Run, or Open a Report 348 Set Default Report Options 348 Set Report Options for the Current Run 350 Set Advanced Report Options for the Current Run 351 Create a Report 353 Creating a Query Studio Report Without Using Actual Data 354 Create a Report View 354 View Lineage Information for a Data Item 355 Access the IBM WebSphere Business Glossary 356 Edit a Report 356 Report Formats 357 HTML Formats 358 XML Format 358 PDF Format 358 Excel Formats 359 CSV Format 360 Report Languages 360 Add Multilingual Properties 361 Specify the Default Language for a Report 362 Specify the Default Prompt Values for a Report 362 Save Report Output 363 View Report Output Versions 364 Specify How Long to Keep Report Output 365 Enable an Alert List for a Report 365 Add Yourself to or Remove Yourself from the Alert List for a Report 366 Watch Rules in Saved Reports 366 Enable Watch Rules for a Report 367 Create a Watch Rule for a Report 367 Modify or Delete a Watch Rule in Cognos Viewer 368 Comments in Saved Reports 369 Enable Comments in Saved Output Versions 369 Add Comments to a Report Version in Cognos Viewer 370 View, Modify or Delete Comments in Cognos Viewer 370 Disable Selection-based Interactivity 371 Exclude Blank Pages in PDF Reports 372 Distributing Reports 372 Saving a Report 373 Sending a Report by Email 373 Sending a Report to your Mobile Device 373 Printing a Report 373 Distributing a Report by Bursting 374 Create Distribution Lists and Contacts 374 Drilling to View Related Data 375 Drill Up or Drill Down 376 Drill Through to Another Target 376 Drill Through to Another Target Passing Multiple Values 377
10
Table of Contents Data Sources With Named Sets May Produce Unpredictable Results 378 Series 7 Reports in IBM Cognos Connection 378 Series 7 PowerPlay Reports and Cubes 379 Single Signon 380 Run or Open a Series 7 PowerPlay Report 380 Change the Defaults for a Series 7 PowerPlay Report 381 Open a Series 7 Cube 382 Multilingual Properties for Series 7 Reports and Cubes 382 Chapter 26: Agents
383
Run an Agent 383 Change Default Agent Properties 384 Create an Agent View 385 Open or Create an Agent from IBM Cognos Connection 385 Enable an Alert List for an Agent 386 Add Yourself to or Remove Yourself from an Alert List for an Agent 386 Remove All Users from the Alert List for an Agent 387 Receive News Item Headlines 387 View the Most Recent Event List 387 Chapter 27: Metric Studio Metrics
391
Create a Metric Package 391 Change the Default Action for Packages 392 Run a Metric Task 392 Delete a Metric Task 393 Modify a Metric Task 393 Metric Import Tasks 394 Create New Metric Import Task 394 Edit Metric Import Task Properties 395 Metric Maintenance Tasks 395 New Metric Maintenance 396 Edit Metric Maintenance Properties 396 Metric Export Tasks 397 Change Metric Export Properties 399 Chapter 28: Drill-through Access
401
Understanding Drill-through Concepts 402 Drill-through Paths 402 Selection Contexts 402 Drilling Through to Different Report Formats 403 Drilling Through Between Packages 403 Bookmark References 404 Members and Values 404 Member Unique Names 405 Conformed Dimensions 406 Business Keys 407 Scope 407 Mapped Parameters 407 Drilling Through on Dates Between PowerCubes and Relational Packages 408 Set Up Drill-through Access in Packages 408
Table of Contents Set Up Parameters for a Drill-Through Report 411 Set Up Parameters for a Drill-through Target in Analysis Studio 412 Example - Drill Through Between OLAP Reports in the Same Package 413 Example - Drill Through from an OLAP Report to a DMR Report 416 Debugging a Drill-through Definition 419 Access the Drill-through Assistant 420 Example - Debugging a Drill-through Definition 421 Set Up Drill-through Access in a Report 422 Example - Drill Through to a Hidden Report from a Report Studio Report 423 Specify the Drill-through Text 425 Setting Up Drill-through Access from IBM Cognos Visualizer 426 Setting Up Drill-through Access from PowerPlay Web 426 Create and Test the Target for a Series 7 Report 426 Part 7: Portal Services Administration Chapter 29: Managing Portlets and Styles
429
Portlets 429 Cognos Portlets 429 Other Portlets 432 Import Portlets 432 Control Access to Portlets 433 Configure the Portlet Cache 434 Modify a Portlet 435 Display the HTML Code From the Source RSS Feed in RSS Viewer and Cognos Navigator 436 Styles 437 Add a New Style 438 Control Access to Styles 439 Modify a Style 440 Chapter 30: Deploying Cognos Portlets to Other Portals
441
Deploying Cognos Portlets to WebSphere Portal 5.0, 5.1, 6.0, and 6.1 441 Install the Portlet Applications File 442 Configure the Portlet Applications 443 Configure the Portlet Cache 444 Customize the Content of Cognos Portlets 444 Deploying Cognos Portlets to SAP Enterprise Portal 6.0, 6.4, and 7.0 445 Install the IBM Cognos Business Package 446 Edit Properties for the iViews 447 Set the Default iView Content and Appearance for All Users 448 Deploying Cognos Portlets to ALUI 6.1 and 6.5 Portal 449 Start the Remote Server 449 Import the Cognos Portlet Package File 452 Connect to the Remote Server 453 Customize the Content of Cognos Portlets 454 Deploying Cognos Portlets to Microsoft SharePoint Portal Server 2003 and 2007 454 Set up Virtual Directories and Change the Gateway URIs 455 Copy the Cognos Web Parts Resources to the IIS HTTP Root Directory 456 Set Up the IBM Cognos Security Trust File 457
12
Table of Contents Modify the .NET Framework web.config File 458 Edit the Cognos Web Parts Catalog Files 461 Restart IIS 461 Add Cognos Web Parts to a SharePoint Page 462 Customize the Content of Cognos Web Parts 463 Migrating Cognos Portlets from IBM Cognos ReportNet 1.1 to IBM Cognos 8 464 Change the Root Name of File Paths in Cognos Portlets 464 Disable the Transfer of the IBM Cognos 8 Passport ID as a URL Parameter 465 Set Portal Services Protocol Scheme 467 Configuring Security for Portal Services 467 Disable Anonymous Access to IBM Cognos 8 Components 468 Enable Single Signon Using Shared Secret 468 Enable Single Signon for SAP EP with the SAP Logon Ticket 474 Enable Single Signon for SAP EP with User Mapping 474 Enable Secure Communication Between SAP EP and IBM Cognos 8 Components 475 Enable Single Signon for WebSphere Portal Using the Application Server 476 Enable Single Signon for BEA ALUI Portal Using Basic Authentication 476 Enable Single Signon for BEA ALUI Portal Using SiteMinder 477 Part 8: Customization Chapter 31: Customizing the Appearance of IBM Cognos 8
479
Making Global Changes to all Components 479 Customizing Styles 479 Rebranding the IBM Cognos 8 Interface 481 Changing IBM Cognos 8 Fonts 482 Changing the Global IBM Cognos 8 Style Sheet 482 Migrating Changes to Future Releases 483 Modifying the Appearance of IBM Cognos Connection 484 Example - Customize the Default Welcome Page 484 Example - Change the Branding Details in the IBM Cognos Connection Main Header 484 Example - Change the Background Color in the IBM Cognos Connection Main Header 485 Example - Change the Portal Graphics 486 Example - Change the Default Fonts for Page Titles and Instructions 486 Modifying the Report Studio Style Sheets 486 Example - Change the Fonts Used in Report Studio 487 Example - Change the Colors Used in Report Studio Menus 487 Example - Change the Report Studio Graphics 488 Modifying the Query Studio Style Sheets 488 Example - Change the Colors Used in Query Studio Menus 489 Example - Change the Query Studio Graphics 489 Customize the Query Studio Toolbar and Menus 490 Modifying the Appearance of Cognos Viewer 492 Modifying the Cognos Viewer Style Sheets 493 Example - Change the Language of the Cognos Viewer User Interface 493 Modifying the Prompt Page Style Sheets 494 Adding Custom Report Templates for Report Studio 495 Create a Report Specification for a Custom Report Template 495 Add a Custom Report Template to the templates.xml File 497 Provide an Icon for the Custom Report Template 497 Administration and Security Guide 13
Table of Contents Add the Custom Template Information to the Resources.xml File 497 Chapter 32: Customizing the Functionality of IBM Cognos 8
501
Upgrade the ReportNet system.xml Files to IBM Cognos 8 501 Customizing IBM Cognos Connection 502 Add or Hide User Interface Elements Based on Groups and Roles 503 Hide and Disable the New URL Button 508 Limit the Number of Entries That Users Can Cut, Copy, and Paste 509 Customizing Object Actions 509 Restrict Content Browsing 513 Implementing a Custom Welcome Page 514 Customize Report Output Formats in IBM Cognos Connection and Cognos Viewer 517 Configure the Document Lookup Table 519 Start Query Studio in Preview Mode 520 Customizing Data Formats for Query Studio 520 Modify the cogformat.xml File 521 Change the Order of Data Formats 521 Change the Text Strings 522 Remove Data Formats 523 Add a Data Format to a Locale 524 Add Data Formats for a New Locale 525 Change the Default Query Studio Template 525 Modify Properties for the CSV Output Format 526 CSV Properties and Values 527 Supported Encoding Values 528 Modify Properties for the Batch Report Service and Report Service 529 Batch Report Service and Report Service Properties and Values 529 Customize Error-Handling on the SMTP Mail Server 530 Disable Report Attachments in Email Messages 534 Show Attachments in IBM Lotus Notes 534 Disable Support for Trigger-based Scheduling 535 Set Up a Trigger Occurrence on a Server 535 Hide History Summary Counts 537 Change the Suppression Functionality in Analysis Studio 538 Part 9: Troubleshooting Chapter 33: Troubleshooting Resources
539
Error Messages 539 Log Files 539 Core Dump Files 542 Metric Dump File 543 Windows Event Viewer 544 Samples 544 Example - Testing Report Studio 545 View the Report Definition in Query Studio 545 Call IBM Cognos Resource Center 545 IBM Cognos Diagnostic Tools 546
14
547
Problems When Printing a PDF Manual 547 Unable to Launch a Web Browser When Accessing Help 547 Text Does Not Appear Properly in Quick Tours 548 Chapter 35: Installation and Configuration Problems
549
Problems Starting IBM Cognos 8 549 CFG-ERR-0106 Error When Starting the IBM Cognos 8 Service in IBM Cognos Configuration 549 Cryptographic Error When Starting IBM Cognos 8 551 Unable to Start the IBM Cognos 8 Service Because the Port is Used by Another Process 551 IBM Cognos 8 Service Does Not Start or Fails After Starting 552 IBM Cognos 8 Server Fails to Start and Gives No Error Message 552 IBM Cognos BI Server Not Available When Starting IBM Cognos 8 553 Cannot Log On to a Namespace When Using IBM Cognos Connection 556 IBM Cognos 8 Services Fail to Restart After a Network Outage 557 No Warning That Installing a Later Version of IBM Cognos 8 Will Automatically Update the Earlier Version of the Content Store 557 Download of Resource Fails 557 DB2 Returns SQL1224N Error When Connecting from AIX 558 Content Manager Error When Starting IBM Cognos 8 558 DPR-ERR-2014 Error Appears in Log File on Content Manager Computer 558 Non-ASCII Characters in Installation Directory Cause Run-time Errors 558 Cannot Open an MS Cube or PowerCube 559 Cannot Open an OLAP Data Source 560 The Page Cannot Be Found When Starting IBM Cognos 8 in Windows 2003 560 The Page Is Not Shown When Opening a Portal After Installing IBM Cognos 8 560 DPR-ERR-2058 Error Appears in Web Browser When Starting IBM Cognos 8 560 EBA-090034 Error When Starting WebLogic 8 562 Report Studio Does Not Start 563 DPR-ERR-2022 Error Appears in Web Browser When Starting IBM Cognos 8 563 Unable to Download the cognos.xts File 563 Application Server Startup Script Fails 564 Issues with IBM WebSphere 6.0 on AIX 5.3 564 IBM Cognos 8 Running under WebLogic Application Server on AIX Fails 564 Deploying IBM Cognos 8 to an Oracle Application Server or IBM WebSphere Application Server Fails 564 Microsoft Excel 2000 Multipage Report Type Does Not Work 565 Unable to Deserialize Context Attribute Error When Deploying the p2pd.war File to WebLogic 565 Error Appears After Upgrading IBM Cognos 8 on a WebLogic Application Server 566 Chinese, Japanese, or Korean Characters Are Different After Upgrade 566 Accented or Double-Byte Characters May Not Display Correctly When Installing IBM Cognos 8 on Linux 567 RSV-SRV-0066 A soap fault has been returned or RQP-DEF-0114 The user cancelled the request Errors Appear in High User Load Environments 567 Problems Configuring IBM Cognos 8 567 Configuration Tool cogconfig.sh Return Values Are Not Compliant with Conventional UNIX Return Values 567
Table of Contents Run Database Cleanup Scripts 568 Error Trying to Encrypt Information When Saving Your Configuration 570 Problems Generating Cryptographic Keys in IBM Cognos Configuration 570 CAM-CRP-1315 Error When Saving Configuration 571 Manually Changing the Installation Directory Name Affects Installations Running Under an Application Server 571 Configuration Data is Locked by Another Instance of IBM Cognos Configuration 572 Unable to Exit a Tab Sequence When Using Keyboard-only Navigation in IBM Cognos Configuration 572 Unable to Save Your Configuration 572 Java Error When Starting IBM Cognos Configuration 573 Cryptographic Error When Starting IBM Cognos Configuration 573 Current Configuration Settings Are Not Applied to Your Computer 574 CM-CFG-029 Error When Trying to Save a Configuration That Specifies a SQL Server Content Store 574 DPR-ERR-2079 When Content Manager Configured For Failover 574 Importing a Large Content Store in Solaris using JRE 1.5 Fails 575 Users are Prompted for Active Directory Credentials 575 Font on UNIX Not Found When Starting IBM Cognos Configuration 575 Unable to Load Essbase/DB2 OLAP Library in Framework Manager 576 Group Membership is Missing From Active Directory Namespace 576 Deploying IBM Cognos 8 to an Oracle Application Server or IBM WebSphere Application Server 577 Errors Displayed Deploying to Oracle 10G Application Server 578 Page Cannot be Found Error Running Reports using IBM Cognos 8 Go! Office 578 Error Initializing Oracle Content Store After Upgrade from ReportNet 578 CGI Timeout Error While Connected to IBM Cognos 8 Components Through a Web Browser 579 Servlet Class Fails to Load in WebLogic 579 Desktop Icons or IBM Cognos Configuration Window Flicker on Windows 580 Chapter 36: Security Problems
581
Problems Setting Up Security 581 Access to Entries is Denied During Deployment 581 Prompt to Change Passwords When Logging On to an Active Directory Security Source 581 Unable to Log On 581 Certificate Authority Error When Logging On to IBM Cognos Connection 582 HTTPS DRP-ERR-2068 Error In Log File When No Error is Reported During a Switch to HTTPS 582 Entries Do Not Appear in IBM Cognos Connection for a Member of a Newly Created Group 582 Problems Logging On to Cognos Portlets 583 Existing Passwords May not Work in an SAP Namespace 584 Users Are Repeatedly Prompted for Credentials When Trying to Log On to an SAP Namespace 585 Problems Using Authentication Providers 585 CAM-AAA-0096 Unable to Authenticate User When Using an IBM Cognos Series 7 Namespace 585 Expired Password Error Appears When Using Active Directory Server 586
16
Table of Contents Single Signon Is Not Working When Using Active Directory Server 586 Unable to Authenticate User for Cognos Portlets 587 Unable to Identify SAP Permissions Required 587 Unable to Access IBM Cognos Administration When an NTLM Namespace Is Used and Single Signon Is Enabled 587 Chapter 37: Report and Server Administration Problems
589
Database Connection Problems 589 Unable to Select ODBC as the Type of Data Source Connection 589 Cannot Connect to an SQL Server Database Using an OLE DB Connection 590 Intermittent Problems Connecting to a SQL Server Database 590 Cannot Access IBM Cognos Series 7 Reports from IBM Cognos Connection 590 Series 7 Namespaces Do Not Initialize When Services are Started 591 Content Manager Connection Problem in Oracle (Error CM-CFG-5036) 591 Cannot Connect to an OLAP Data Source 592 Error When Creating a Data Source Connection to a PowerCube 592 Not Yet Optimized IBM Cognos PowerCubes May Open Slowly in IBM Cognos 8 592 Other Administration Problems 593 Restarting Servers After Solving Content Store Problems 593 An Update or Delete Request Fails 594 BI Bus Server Processes Remain in Memory After a Shutdown 594 Higher Logging Levels Negatively Affect Performance 594 Problems Accessing Cognos Portlets 595 Unable to Edit Object Properties in ALUI 6.1 and 6.5 Portal 596 Only the Administrator Can See Cognos Portlets 597 Locale Mismatch in Cognos Navigator Portlet 597 Properties Pages in Cognos Portlets Are not Displayed Properly 598 Problems Displaying HTML Reports in a Multi-tab Dashboard 598 Unable to Identify SAP BW Version and Corrections 599 SBW-ERR-0020 Error When Running Reports Based on SAP BW Data Sources 599 Links to Referenced Content Objects are Broken Following Deployment 599 Table or View Does not Exist for Sample Database 600 Chapter 38: Problems When Using Framework Manager
601
Measures Not Added After Initial Import in an Upgraded Model 601 Unable to View the Result Set of a Stored Procedure 601 Unable to Compare Two CLOBs in Oracle 601 An Out of Memory Error with ERWin Imported Metadata 602 Calculation Fails Testing 602 Framework Manager Cannot Access the Gateway URI 602 Object Names Appear in the Wrong Language 603 Full Outer Joins in Oracle Return Incorrect Results 603 Error When Testing Query Subjects in a Model Imported from Teradata 603 Error for Type-In SQL Query Subject 603 Function Name Not Recognized 604 QE-DEF-0259 Error 604 QE-DEF-0260 Parsing Error 605 Externalized Key Figures Dimension Retains Old Prompt Value 605 Older IBM Cognos 8 Models Display Level Object Security 605
Table of Contents Exporting a Framework Manager Model to a CWM File Fails With Error MILOG.TXT was not found 605 Difference in SQL for Inner Joins After Upgrading to IBM Cognos 8.3 606 Publishing a Large Package Results in a CCLOutOfMemory Error 606 Full Outer Joins Not Sent to Oracle 9i and 10GR1 606 Review Governors When Upgrading Models 606 File Creation from Framework Manager fails with Error QE-DEF-0178 607 Chapter 39: Problems When Using Transformer
609
Known Issues When Modeling in IBM Cognos Transformer 609 BAPI Error Occurs After the Prompt Specification File Edited Manually 609 Unable to Access an IQD Data Source using a Sybase Database Connection 609 Importing Time Dimensions from IBM Cognos 8 Packages Not Supported 610 Data in Multiple Languages Does Not Display Properly 610 Unable to Use an IQD Created in Framework Manager That Contains an Oracle Stored Procedure 610 Preventing Errors When Model Calculations Use Double Quotation Marks 611 Framework Manager and Transformer may Display Different Locale Session Parameters for Some Languages 611 Regular Columns cannot be Converted to Calculated Columns and Vice Versa 611 Transformer Takes a Long Time to Retrieve Data from an SAP-based Data Source 612 Categories Missing When Creating a Transformer Model Based on an SAP Query Containing a Manually Created SAP Structure 612 Error Occurs When Creating a PowerCube Containing an SAP Unbalanced Hierarchy 612 Rebuilding a PowerCube Soon After Publishing Produces a TR0787 Error 612 Known Issues Using Cubes in the IBM Cognos 8 Studios 613 Not Yet Optimized IBM Cognos PowerCubes May Open Slowly in IBM Cognos 8 613 Analysis Studio Shows the Wrong Currency Symbol 614 Changes to Decimals in Currency Formats 615 Ragged or Unbalanced Hierarchies Result in Unexpected Behavior 615 Error Opening Saved Reports After PowerCube Refresh 616 Unable to Open Sample Model, Great Outdoors Sales.mdl, and Generate Cubes 616 Data Records that Support External Rollup Measure Data are Not Always Created 617 Chapter 40: Problems Authoring Reports
619
Problems Creating Reports 619 Chart Labels Overwrite One Another 619 Chart Shows Only Every Second Label 619 Chart Gradient Backgrounds Appear Gray 619 Division by Zero Operation Appears Differently in Lists and Crosstabs 620 Application Error Appears When Upgrading a Report 620 Nested List Report Containing a Data Item That is Grouped More Than Once Does Not Run After Upgrade 620 Background Color in Template Does not Appear 621 Subtotals in Grouped Lists 621 Metadata Change in Essbase Not Reflected in Reports and in the Studios 621 Relationships Not Maintained in a Report With Overlapping Set Levels 621 Creating Sections on Reports That Access SAP BW Data Sources 622 Error Characters (--) Appear in Reports 622 Descendants Function Unreliable with Sets 623 18
Table of Contents Columns, Rows, or Data Disappear With SSAS 2005 Cubes 623 Unexpected Cell Formatting in Reports 624 Report Differences Between TM1 Executive Viewer and IBM Cognos 8 with TM1 Data Sources 624 Order of Metadata Tree Differs for TM1 Data Sources 624 Problems Calculating Data 625 Count Summaries in Query Calculations Include Nulls with SAP BW Data Sources 625 Unexpected Summary Values in Nested Sets 625 Incorrect Results with IBM Cognos PowerCubes and Time Measures 626 Problems Filtering Data 626 HRESULT= DB_E_CANTCONVERTVALUE Error When Filtering on a _make_timestamp Column 626 Problems Distributing Reports 627 A Report Link in an Email Notification Does Not Work 627 Report Contains No Data 627 Hyperlinks in Email Messages Are Stripped Out When the Agent is Saved 627 CNC-ASV-0001 The Following Agent Service General Error Occurred: java.lang.StackOverflowError 628 Cannot Call the SDK from Event Studio 628 Saving a Report Takes a Long Time 628 Chapter 41: Problems Running, Viewing, or Printing Reports and Analyses
629
Problems Running Reports and Analyses 629 Summaries in Report Do not Correspond to the Visible Members 629 Unexpected Results for Analysis Studio Reports Using Suppression and Nested Rows 630 Unexpected Results May Occur When Using Items from the Same Hierarchy on Multiple Crosstab Edges 631 Defining Languages for OLAP Data Sources 631 Crosstab Shows Percentage But Chart Shows Values 631 Cube Refresh in Data Analysis Studio Uses UTC/GMT Time 631 Cannot Drill when Caption Represents a Blank or a Zero-length String 632 DPR-ERR-2082 The Complete Error Has Been Logged by CAF With SecureErrorID 632 Query Studio Does Not Generate a SELECT DISTINCT statement if a Column is Aliased Without Using the Actual Column Name 632 Cannot Find the Database in the Content Store (Error QE-DEF-0288) 632 Parse Errors When Opening or Running an Upgraded Report 633 Overflow Error Occurs When a Value in a Crosstab Is More Than 19 Characters 633 IBM Cognos 8 Runs Out of TEMP Space 633 A Report Does Not Run as Expected 633 Performance Issues when Showing Multiple Attributes Using Dimensionally Modeled Relational Data Sources 634 Analysis Studio Shows the Wrong Currency Symbol 634 Error Occurs in Japanese Internet Explorer 7 When Running an Excel Report in Analysis Studio 635 The ORA-00907 Error Appears When Running a Report 635 Drilling Through to IBM Cognos 8 from an IBM Cognos Series 7 Product Results in Firewall Error 635 Scheduled Reports Fail 636 The Table or View Was Not Found in the Dictionary 636
Table of Contents Mixed Languages Are Displayed in IBM Cognos Connection When Using Samples 636 Unable to Select Multiple Report Formats When Running a Report 637 A Report Does Not Run as Scheduled 637 A Report or Analysis Does Not Run Because of Missing Items 637 Cannot View Burst Report 638 PCA-ERR-0057 Recursive Evaluation Error 639 Arithmetic Overflow Error When Running a Report in PDF Format 639 Performance Problems When Running Reports 639 CGI Timeout Error While Transferring Data to IBM Cognos 8 Components 639 Slow Server Performance 640 The BAP-ERR-0002 BAPI Error 641 The Out of Memory Error Appears in HP-UX 641 A Query Is Slow When Filtering Non-ASCII Text 641 Query Studio Output Takes a Long Time to Run 641 Problems Viewing Reports 641 A Report Upgraded from ReportNet Does Not Retain its Original Look 641 Drill-through Links Not Active in the Safari Browser 642 A Running Total in Grouped Reports Gives Unexpected Results 642 The Page Cannot Be Found Error Appears When Viewing Report Outputs from Email Links 642 Non-English Characters Appear as Placeholders 642 Cannot Drill Between PowerCubes Because MUNs Do Not Match 643 Unexpected or Empty Results When Drilling Through 643 Cannot Drill From a Relational Source to a Cube 644 Charts Do Not Appear in HTML reports 644 Portal Problems 645 Cannot Connect to a SQL Server Database Using an ODBC Driver 645 The My Folders Tab Does Not Appear After Logging On to IBM Cognos Connection 646 Icon Graphics Are Not Working in Portlets 646 Styles Used in the Previous Installation Still Appear 647 Unable to Click Links 647 Missing Images in a PDF Report 648 Charts in PDF Output Show Unexpected Results 648 Problems Printing Reports 648 Unable to Print PDF Reports 648 A Printed HTML Report is Unsatisfactory 649 Chapter 42: Problems When Using Map Manager Problems Importing Files 651 Error Importing Translated Text File 651 Chapter 43: Problems With Metrics
651
653
Metric Studio Log Files 653 Metric Studio Support Bundle 654 Known Issues When Using Metric Studio 654 Metric Studio Reports Fail Because of an Oracle Internal Error 654 Metric Studio Errors Occur When Loading Data into an Oracle Database 655 Oracle Errors Occur When Using the cmm_uninstall Script 655 Error When Attempting to Run Metric Studio on SQL Server 2005 655 Data from a Relational Database Source or a Flat File Data Source Does Not Appear 656 20
Table of Contents A Metric Maintenance Task Fails to Run 657 You Do Not Have Permission to Access This Metric Package. Contact Your System Administrator. 657 Failed to Check the Metrics Store Install Status Error When Using DB2 8.2.3 657 Errors Occur When Importing Tab-delimited Files into a DB2 Metric Store 657 Required User Permissions for the Metric Store Database (MS SQL Server) 658 Error When Viewing a History Chart or Diagram on a DB2 Server with the 8.2 JDBC Driver 658 Oracle 9.2 Package Initialization Error if NLS_LANG Environment Variable is Not Set Appropriately Before Starting Up IBM Cognos 8 Tomcat Server 658 Known Issues When Using Metric Designer 658 Adding Multiple IQD Files to an Import Source 658 Previewed Scorecard Hierarchy Shows Blanks 659 Chapter 44: Troubleshooting IBM Cognos 8 for Microsoft Office and the Report Data Service
661
Configuration Issues 661 The IBM Cognos 8 for Microsoft Office Interface Fails to Initialize in Microsoft Office 661 IBM Cognos 8 Go! Office Does Not Start in Microsoft Word 661 IBM Cognos 8 for Microsoft Office Fails to Initialize in Microsoft Internet Explorer 662 bo:heap Buffer Overflow Error 662 Microsoft Office Does Not Open a Microsoft Office Document Published from IBM Cognos 8 for Microsoft Office 662 Unable to Open Published Microsoft Office Documents from IBM Cognos Connection 663 Error Messages, the .NET shortcut, or the .NET Console Are Not in the Language of the .NET Framework 2.0 That Was Installed 664 Workbook Closes Unexpectedly if the Name Contains a Square Bracket 664 The server committed a protocol violation. Section=ResponseHeader Detail=CR must be followed by LF 664 Reports Unavailable in IBM Cognos Connection Jobs after Using Save As Command in Report Studio 665 Unable to Correctly Display East Asian Characters 665 The Content of the Cell-based Report Shows #NAME? 665 Processing Issues 666 Cannot Render this Report 666 RDS Data Limit Exceeded When Importing from Large Report Outputs 666 RDS Server Unavailable 666 Imported Reports Are Missing Charts or Images 667 #ERROR Appears in Cells with Multiple Images in a Cell (Excel Only) 667 The Dispatcher Is Unable to Process the Request. The Request Is Directed to an Unknown Service Name: Content 667 Report Content is Not Imported 667 Incorrect Format for the Prompt Value in Prompted Reports 668 DPR-ERR-2079 Firewall Security Rejection 668 This item cannot be expanded. Microsoft Excel has reached the maximum number of rows or columns for this worksheet 669 Prompted to Log on for Each Imported Report 669 Object reference not set to an instance of an object 669 Error 0:RSV-BBP-0027 The Secondary Request Failed 669 Security Issues 669
Table of Contents IBM Cognos 8 for Microsoft Office Unable to Create Trust Relationship 670 Unable to View Reports After Clicking View Report 670 Report Data Service (RDS) Numbered Error Messages 670 RDS-ERR-1000 Report Data Service Could Not Process the Response from the Content Provider 670 RDS-ERR-1001 The PowerPlay Report Name Could Not Be Run. The Expected Response Was Not Returned by PowerPlay 671 RDS-ERR-1004 A Connection Could Not Be Established with IBM Cognos 8 671 RDS-ERR-1005 The Logon Requirements for IBM Cognos 8 Could Not Be Obtained. You May Already Be Logged into this Namespace, or the Target Namespace Does Not Exist 672 RDS-ERR-1012 IBM Cognos Content Service was Unable to Discover the Content Providers 672 RDS-ERR-1013 Report Data Service Was Unable to Query Content Manager 672 RDS-ERR-1014 Report Data Service Was Unable to Create the Document Object Object Name 672 RDS-ERR-1015 Report Data Service Was Unable to Create a New Document Version 672 RDS-ERR-1016 Report Data Service Was Unable to Create a New Document Content Object 672 RDS-ERR-1018 The IBM Cognos 8 Report Name Could Not Be Run. The Expected Response Was Not Returned by IBM Cognos 8 673 RDS-ERR-1019 IBM Cognos Content Service Was Unable to Retrieve the Portal Information from IBM Cognos Connection 673 RDS-ERR-1020 The Currently Provided Credentials are Invalid. Please Provide the Logon Credentials 673 RDS-ERR-1021 The IBM Cognos 8 Report Name Could Not be Run Because it Contains Unanswered Prompts. Please Provide the Prompt Answers, and Run the Report Again 674 RDS-ERR-1022 The Request Received by Report Data Service Is Not Valid 674 RDS-ERR-1023 The Report Name Could Not Be Run Because It Exceeds the Report Data Service Data Size Limit Set by the Administrator 674 RDS-ERR-1027 The Encoding for the PowerPlay Server Name Could Not Be Determined. ISO-8859-1 Will Be Used as the Encoding 674 RDS-ERR-1030 A Security Error Occurred While Trying to Establish a Connection with Name 674 RDS-ERR-1031 Report Data Service was unable to retrieve the metadata for Name 674 RDS-ERR-1033 Report Data Service Was Unable to Create the Report View Name 674 RDS-ERR-1034 The Report Specification for Name Could Not Be Retrieved From IBM Cognos 8 675 RDS-ERR-1039 The Request Could Not Be Cancelled. The Request is No Longer Running 675 RDS-ERR-1040 The Conversation With Conversation ID Has Been Cancelled 675 RDS-ERR-1044 The Output for the Requested Version for Object NameCould Not be Retrieved 675 RDS-ERR-1045 LayoutDataXML Output Was Not Generated for the Requested Version for Object [Name] 676 IBM Cognos 8 Go! Office Numbered Error Messages 676 COC-ERR-1003 Failed to Create Slide 676 COC-ERR-1302 There Is No Data Source Available 676
22
Table of Contents COC-ERR-2005 The Import Failed 676 COC-ERR-2006 Failed to Load the Portal Tree: Name 677 COC-ERR-2012 Failed to Render the List 677 COC-ERR-2013 This Is an Unsupported Office Application 677 COC-ERR-2014 Refresh Failed 677 COC-ERR-2015 Failed to Open the Import Wizard Dialog 677 COC-ERR-2019 Failed to Refresh an Image 678 COC-ERR-2301 Logon Failed 678 COC-ERR-2303 This Report Is Not Valid for Rendering 678 COC-ERR-2304 This Is a Prompted Report. It Is Not Currently Supported 678 COC-ERR-2305 Microsoft Excel Returned an Error. Ensure That Microsoft Excel is Not in Edit Mode, Then Try Again 679 COC-ERR-2308 Report Specification is Empty 679 COC-ERR-2603 You Must Add a Slide to the Presentation Before Importing Any Content 679 COC-ERR-2604 Cannot Render Empty List Object 679 COC-ERR-2607 Microsoft Office Message 679 COC-ERR-2609 The Custom property "Property_Name" does not exist 679 IBM Cognos 8 for Microsoft Office Numbered Error Messages 680 COI-ERR-2002 Block type is not valid 680 COI-ERR-2005 This Version of Microsoft Office Is Not Supported 680 COI-ERR-2006 This Microsoft Office Product Is Not Supported 680 COI-ERR-2008 Unable to Retrieve from Resources. Tried '{0}' 680 COI-ERR-2009 Unable to Perform This Operation Because Microsoft Excel is in Edit Mode 681 COI-ERR-2010 The Name {0} is Not Valid. A Name Must Not Contain Both a Quote (") Character and an Apostrophe (') Character 681 COI-ERR-2011 The server did not return the expected response. Check that the gateway is valid. 681 IBM Cognos 8 BI Analysis for Microsoft Excel Numbered Error Messages 681 COR-ERR-2002 Block Type is Not Valid 681 COR-ERR-2005 Block Specification is Not Valid or Missing "{0}" 681 COR-ERR-2006 Unexpected Type: [Stacked Block] 681 COR-ERR-2007 Error Retrieving from Resources. Tried '{0}' 682 COR-ERR-2009 Name Formula is Not Valid 682 COR-ERR-2010 Formula is Not Valid 682 COR-ERR-2011 Prompted Metadata Is Not Supported 682 COR-ERR-2012 Unable to Load Metadata 682 COR-ERR-2013 Exploration Cannot Be Converted to Formula Based Because at Least One Context Item Contains a Selection 682 COR-ERR-2014 Due to Excel worksheet limitations the results may be truncated 682 COR-ERR-2015 Exploration Cannot Be Converted to Formula Based Because There is a Default Measure and a Measure on Either Rows or Columns 683 COR-ERR-2016 Unable to Retrieve Package Name 683 COR-ERR-2017 The Current Selection Did Not Return Any Data 683 Part 10: Reference Material Appendix A: Round Trip Safety Configuration of Shift-JIS Characters Example: Safe Conversion of Shift-JIS 686 Administration and Security Guide 23
685
Table of Contents The Round Trip Safety Configuration Utility 686 Specify Conversions 687 Specify Substitutions 688 Apply the Conversions and Substitutions 689 Restore the Default Conversion Settings 689 Specify Conversions for Series 7 PowerPlay Web Reports 690 Appendix B: Initial Access Permissions
691
703
One Column Per Language 703 One Row Per Language 704 Transliterations and Multiscript Extensions 705 Appendix D: User Interface Elements Reference List Elements You Can Hide 707 Elements You Can Add 714 Appendix E: User Reference Help for Portal Services Cognos Navigator 717 Cognos Search 719 Cognos Viewer (IBM Cognos Connection) 721 Cognos Viewer 724 Cognos Extended Applications 726 Metric List 726 Metric History Chart 728 Metrics Impact Diagram 730 Metrics Custom Diagram 731 Bookmarks Viewer 732 HTML Viewer 733 Image Viewer 734 RSS Viewer 735 HTML Source 737 Multi-page 738 Appendix F: Schema for Data Source Commands
707
717
741
commandBlock 742 Child Elements of commandBlock Element 742 Parent Elements of commandBlock Element 742 commands 742 Child Elements of commands Element 742 Parent Elements of commands Element 742 sessionStartCommand 742 Child Elements of sessionStartCommand Element 743 Parent Elements of sessionStartCommand Element 743 sessionEndCommand 743 Child Elements of sessionEndCommand Element 743 Parent Elements of sessionEndCommand Element 743 arguments 744 Child Elements of arguments Element 744 24
Table of Contents Parent Elements of arguments Element 744 argument 744 Child Elements of argument Element 744 Parent Elements of argument Element 744 setCommand 745 sqlCommand 745 Child Elements of sqlCommand Element 745 Parent Elements of sqlCommand Element 745 sql 745 Child Elements of sql Element 745 Parent Elements of sql Element 745 name 745 Child Elements of name Element 746 Parent Elements of name Element 746 value 746 Child Elements of value Element 746 Parent Elements of value Element 747 Appendix G: Data Schema for Log Messages
749
Table Definitions 749 Table Interactions 750 COGIPF_ACTION Table 752 COGIPF_USERLOGON Table 753 COGIPF_NATIVEQUERY Table 754 COGIPF_PARAMETER Table 755 COGIPF_RUNJOB Table 756 COGIPF_RUNJOBSTEP Table 757 COGIPF_RUNREPORT Table 759 COGIPF_EDITQUERY Table 761 COGIPF_VIEWREPORT Table 763 COGIPF_AGENTBUILD Table 764 COGIPF_AGENTRUN Table 766 COGIPF_THRESHOLD_VIOLATIONS Table 768 Appendix H: Performing Tasks in IBM Cognos 8 Using URLs
773
CGI Program and Alternative Gateways 773 URL Methods 774 Parameterized URL Method 774 cognosLaunch Method 775 Common Optional Parameters 776 URL Validation 776 Starting IBM Cognos 8 Components 777 Start Parameters 778 Starting Report Studio 778 Starting Query Studio 779 Starting Analysis Studio 781 Starting Metric Studio 782 Starting Event Studio 782 Starting Cognos Viewer 783 Starting IBM Cognos 8 Components in a Specified Browser Window 785 Administration and Security Guide 25
Table of Contents Access an IBM Cognos Connection Page 787 Preparing a Page for Standalone Access 788 Using Search Paths and Page IDs 788 Using a Page ID Instead of the Object Search Path 789 Glossary Index
791
799
26
Introduction
This document is intended for use with IBM Cognos 8. IBM Cognos 8 is a Web product with integrated reporting, analysis, scorecarding, and event management features. This document contains step-by-step procedures and background information to help you administer IBM Cognos 8.
Audience
To use this guide, you should be familiar with reporting and security concepts, and have experience using a Web browser.
Related Documentation
Our documentation includes user guides, getting started 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. Note: For online users of this document, a Web page such as The page cannot be found may appear when clicking individual links in the following table. Documents are made available for your particular installation and translation configuration. If a link is unavailable, you can access the document on the IBM Cognos Resource Center (http://www.ibm.com/software/data/support/cognos_crc.html).
Document
IBM Cognos Connection User Guide
Description
Using IBM Cognos Connection to publish, find, manage, organize, and view IBM Cognos content, such as scorecards, reports, analyses, and agents Creating self-service business intelligence reports Authoring reports that analyze corporate data according to specific needs
Query Studio User Guide Report Studio Professional Authoring User Guide
Report Studio Express Authoring User Guide Authoring financial reports that analyze corporate data according to specific needs Event Studio User Guide Creating and managing agents that monitor data and perform tasks when the data meets predefined thresholds Creating and publishing models using Framework Manager
Introduction
Document
IBM Cognos PowerPlay Enterprise Server Guide
Description
Administering PowerPlay servers and deploying cubes and reports to PowerPlay users in Windows environments or on the Web Viewing, exploring, formatting, and distributing PowerPlay reports using a Web browser Viewing, finding, organizing, and sharing information in Upfront, the customizable interface used to publish IBM Cognos reports to the Web Authoring scorecard applications and monitoring the metrics within them Using IBM Cognos 8 Go! Office to retrieve content from IBM Cognos reporting products within Microsoft Office Exploring, analyzing, and comparing dimensional data Describing features that are new in this release Installing and using the Localization Development Kit to translate and customize the messages and user interface text in IBM Cognos products Installing and using Map Manager to import and manage maps that are used in map reports
IBM Cognos 8 New Features Localization Development Kit Installation and User Guide
IBM Cognos 8 Architecture and Deployment Understanding the IBM Cognos 8 architecture, Guide developing installation strategies, including security considerations, and optimizing performance IBM Cognos 8 Installation and Configuration Installing, upgrading, configuring, and testing IBM Guide Cognos 8, changing application servers, and setting up samples Custom Authentication Provider Developer Guide Creating a custom authentication provider or a trusted signon provider using the Custom Authentication Provider API Creating and publishing models using the Framework Manager API
28
Introduction
Document
IBM Cognos Finance User Guide
Description
Creating and managing financial reports and administering the database Using the samples included with the IBM Cognos 8 SDK to learn how to automate IBM Cognos 8
IBM Cognos 8 Migration Tools User Guide Moving metadata and applications from IBM Cognos Series 7 to IBM Cognos 8 IBM Cognos 8 Planning Installation and Configuration Guide Installing and Configuring IBM Cognos 8 Planning Products
Finding Information
Product documentation is available in online help from the Help menu or button in IBM Cognos products. To find the most current product documentation, including all localized documentation and knowledge base materials, access the IBM Cognos Resource Center (http://www.ibm.com/software/ data/support/cognos_crc.html). You can also read PDF versions of the product readme files and installation guides directly from IBM Cognos product CDs.
Getting Help
For more information about using this product or for technical assistance, visit the IBM Cognos Resource Center (http://www.ibm.com/software/data/support/cognos_crc.html). This site provides information on support, professional services, and education.
Introduction
30
To review an up-to-date list of environments supported by IBM Cognos products, such as operating systems, patches, browsers, Web servers, directory servers, database servers, and application servers, visit the IBM Cognos Resource Center Web site (http://www.ibm.com/software/data/support/cognos_ crc.html).
You can use the new product languages when personalizing your user interface in IBM Cognos 8 (p. 260). English product documentation is installed when you install the IBM Cognos 8 gateway component. The Installation and Configuration Guide, the Quick Start Installation and Configuration Guide, and the Readme are the exceptions, and are available in all supported languages. To access all other translated documentation, you must install the Supplementary Languages Documentation.
Hiding Entries
You can hide entries in IBM Cognos Connection and IBM Cognos Administration, such as reports, packages, pages, folders, jobs, data sources, portlets, and so on. This functionality is most often used with drill-through reports. Hiding an entry does not affect its security policies.
32
Chapter 1: Whats New? For more information, see "Hide an Entry" (p. 254).
Object Capabilities
You can now specify capabilities for individual packages. For more information, see "Object Capabilities" (p. 229).
Schedule Credentials
When you choose to import schedules in the deployment, you can change the imported schedule credentials to your credentials. For more information, see "Including Schedules" (p. 313).
Chapter 1: Whats New? The drill-through assistant contains improved debugging information (p. 419).
34
Chapter 1: Whats New? the automated copy and activate options on the Deployment tab of the PowerCube properties dialog box For more information about the PowerCube copy and activate options, see "Deploy Updated PowerCubes" (p. 163) or the Transformer User Guide.
Managing Queues
IBM Cognos Administration provides specific views and tools to identify the report, job, or application currently in the queue or being processed. These views also reveal who is running the item, regardless of whether it is a background or interactive task. You can better understand what is happening in your environment and take action to resolve issues. For example, you can cancel a job for a user. For more information, see (p. 285)
36
Chapter 1: Whats New? For more information, see "Models and Packages" (p. 243).
Server Administration
Server administration is enhanced with new capabilities. You can now: set PDF file character encoding, font embedding, and compression types and levels set the maximum execution time limit hotspots that are generated in an Analysis Studio or Report Studio chart set watch list output retention time
Settings for the maximum number of processes and connections has been improved. For some services, you can now set the maximum number of processes and the maximum number of high affinity and low affinity connections that the dispatcher can open to handle requests. For other services, you can set the maximum number of connections. For more information, see "Server Administration" (p. 105).
Chapter 1: Whats New? You can view a list of your activities that are current, past, upcoming on a specific day, or scheduled. You can filter the list so that only the entries that you want appear. A bar chart shows you an overview of activities. You can set run priority for entries. You can also view the run history for entries, specify how long to keep run histories, and rerun failed entries. For more information, see "Activities Management" (p. 285)
My Watch Items
Use the My Watch Items area of the portal to view and manage alerts for new report versions and rules that you have set for conditional report delivery (p. 263). The My Watch Items functionality enables end users to monitor and manage business information that is critical to them from a single location. As a report owner, you must allow report users to receive alerts and create watch rules for the reports. For information about how to enable these features for reports, see "Enable Watch Rules for a Report" (p. 367).
Report Alerts
By enabling an alert on a report, you can now be notified when a new version is available. Whenever a report is run and saved due to a scheduled or manual run, all subscribers receive an email that a new version is available. Subscriptions are saved to the Alerts tab of My Watch Items (p. 263) and can be maintained from that location. For information about how to subscribe to a report, see "Add Yourself to or Remove Yourself from the Alert List for a Report" (p. 366).
Watch Rules
A new watch rule action is available in Cognos Viewer. You can use watch rules to control when users are notified about the availability of new report versions. When a report is run and saved, a user-defined threshold condition is checked. If this condition satisfies a user's criteria, the report can be e-mailed. To create a watch rule (p. 367), a saved report must be viewable in HTML format. You can select the data to be monitored and enter the threshold condition that will trigger the delivery of the report. Watch rules are saved to the Rules tab of My Watch Items (p. 263), and can be maintained from that location. This feature lets users maintain their own report distribution preferences and avoid information overload.
38
Chapter 1: Whats New? through path that was created. Drilling through is automatically enabled when you select multiple values. In previous versions, passing multiple values was available only within drill-through paths created in IBM Cognos Connection.
The default action is defined on the Agent tab of the item properties in IBM Cognos Connection.
40
Activities and Schedules areas in IBM Cognos Connection. The portal style named Business. The updated Welcome to IBM Cognos 8 page.
Chapter 1: Whats New? page now automatically shows more information, such as the target report and its location. This information helps you choose which drill-through path to use.
Replaced Capability
The capability known as Directory in previous releases of IBM Cognos 8 was replaced by the following, more granular capabilities: Data Source Connections Set capabilities and manage UI profiles Users, Groups, and Roles
For more information, see "Secured Functions and Features" (p. 221).
42
Aside from the typical administrative tasks, you can also customize the appearance (p. 479) and functionality (p. 501) of different IBM Cognos 8 components. For information about potential problems, see the Troubleshooting section in this guide.
Administrative Area
Activities
Tab
Status
Use
To manage current, past, upcoming, and scheduled IBM Cognos 8 entries. To manage Content Manager computers. To perform content store maintenance tasks. To create and manage data sources connections
Content Manager computers Status Content store Data sources Configuration Configuration
Administrative Area
Deployment
Tab
Configuration
Use
To deploy IBM Cognos 8, to export from a source environment and then import in a target environment. To manage dispatchers and services To create and manage distribution lists and contacts. To manage styles, Cognos portlets, and other portlets in IBM Cognos Connection. To create and manage printers. To control access to specific product functions, such as administration and reporting, and features within the functions, such as bursting and user defined SQL. To monitor system performance using system metrics and administer servers. To tune server performance. To create and manage users, groups, and roles.
Status Configuration
Configuration
Printers Security
Configuration Security
System, dispatcher, server, and service administration Server tuning Users, groups, and roles
Status
Status Security
Automating Tasks
Virtually everything you can do with the product, you can achieve using the appropriate API, URL interface, or command line tool as illustrated in the table below.
Goal
Document
Begin basic reporting with the IBM Cognos 8 SDK Modify a model, or republish it to UNIX or Windows
IBM Cognos 8 Getting Started Guide Framework Manager Developer Guide and Framework Manager User Guide
44
Goal
Document
Modify an unpublished model using IBM Cognos 8 Developer BI Bus API Guide the updateMetadata and queryMetadata methods Retrieve the query items available in IBM Cognos 8 Developer BI Bus API the published package using the get- Guide Metadata method Grant capabilities to users IBM Cognos 8 Developer BI Bus API Guide
Administer and implement security IBM Cognos 8 Developer BI Bus API by authenticating and managing users Guide
Run, view, and edit reports through IBM Cognos 8 Developer URL InterGuide a hyperlink in an HTML page face Using URLs to View, Edit, and Run Reports To manipulate objects in the content IBM Cognos 8 Developer BI Bus API Guide store Managing IBM Cognos 8 Content in the
Administer reports
Administer servers and manage Dis- IBM Cognos 8 Developer BI Bus API Guide patchers
Goal
Document
IBM Cognos 8 Developer BI Bus API Guide and report specification IBM Cognos 8 Adminis- URL Intertration and Security face Guide
Modify the functionality of IBM Cognos 8 by hiding user Interface elements and restricting content browsing
46
Chapter 2: IBM Cognos 8 Administration For more information, see the Map Manager Installation and User Guide. Create a multilingual report. The report author uses Report Studio to create a report that can be viewed in different languages. For example, you can specify that text, such as the title, appears in German when the report is opened by a German user. You can also add translations for text objects, and create other language-dependent objects. For more information, see the Report Studio Professional Authoring User Guide. Specify the language in which a report is viewed. You can use IBM Cognos Connection to do the following: Define multilingual properties, such as a name, screen tip, and description, for each entry in the portal. Specify the default language to be used when a report is run. Tip: You can specify the default language on the run options page, in the report properties, or in your preferences. Specify a language, other than the default, to be used when a report is run.
For more information, see the IBM Cognos Connection User Guide. The data then appears in the language and with the regional settings specified in the user's Web browser options the run options the IBM Cognos Connection preferences
Any text that users or authors add appears in the language in which they typed it.
Installing Fonts
IBM Cognos 8 uses fonts
Chapter 2: IBM Cognos 8 Administration to display HTML reports and pages in browsers to render PDF reports on the IBM Cognos 8 server to render charts used in PDF and HTML reports
To display output correctly, fonts must be available where the report or chart is rendered. In the case of charts and PDF reports, the fonts must be installed on the IBM Cognos 8 server. For example, if a Report Studio user selects the Arial font for a report, Arial must be installed on the IBM Cognos 8 server to properly render charts and PDF files. If a requested font is not available, IBM Cognos 8 substitutes a different font. Because HTML reports are rendered on a browser, the required fonts must be installed on the personal computer of each IBM Cognos 8 user who will read the HTML report. If a requested font is not available, the browser substitutes a different font. When creating reports, you must select fonts that your IBM Cognos 8 server or users have installed. Microsoft delivers a broad selection of fonts with different language packs, so this will likely not be an issue in Windows. However, UNIX servers rarely have fonts installed. You should be prepared to purchase and install the fonts you need on both the server and browser clients. For information about PDF file settings, see (p. 134). For information on using PDF format in reports, see (p. 357). For information about configuring fonts and about mapping substitute fonts, see the IBM Cognos Configuration User Guide.
Set Up Printers
To make printers available to users when they distribute reports, you can create entries for printers and save them in the IBM Cognos 8 content store. When users want to print a report, they can select a printer that you set up without needing to know its network address details. When you create a printer entry, ensure that the printer you define is set up on the computer where IBM Cognos 8 is installed. If the printer is not set up, the users cannot use it.
48
Chapter 2: IBM Cognos 8 Administration To set up printers, You must have the required capabilities to access IBM Cognos Administration functionality. You must have write permissions for the Cognos namespace. See "Secured Functions and Features" (p. 221).
Printing Considerations
To avoid possible errors, ensure that the following conditions are met before you try printing: Ensure that Adobe Reader version 5.0.5 or later is installed on each computer where IBM Cognos 8 servers are installed. Ensure that the IBM Cognos 8 server is started using an account that has access to the network printer. Sometimes, system accounts may not have access to network printers. If IBM Cognos 8 is installed on UNIX, ensure that Adobe Reader is installed in the path of the user that starts IBM Cognos 8. If IBM Cognos 8 is installed on UNIX, ensure that the command lpstat -v, returns a configured printer and that a printer variable is defined. When you define the network address for the printer in IBM Cognos Connection, use the following syntax: For Windows, use \\server_name\printer_name. For UNIX, use printer_name. When you define the network address for the printer, try using the IP address of the printer instead of the computer name. Ensure that IBM Cognos 8 users have the correct access permissions to the printer. The role Directory Administrators must have all access permissions granted, and the group Everyone must have read, execute, and traverse permissions granted.
Steps
1. In IBM Cognos Connection, in the upper-right corner, click Launch, IBM Cognos Administration. 2. On the Configuration tab, click Printers. A list of printers appears. Tip: To remove a printer, select the check box for the printer and click the delete button. 3. On the toolbar, click the new printer button .
4. Type a name and, if you want, a description for the printer. Tip: Use a name that provides details about the printer, such as Color Printer - 4th Floor 5. Type the network address of the printer by using the format \\server_name\printer_name for a network printer on a Windows installation and printer_name for a UNIX installation or for a local printer on Windows. Administration and Security Guide 49
Chapter 2: IBM Cognos 8 Administration 6. Click Finish. Tip: To check or assign access permissions for a printer, in the Actions column, click the set properties button for the printer, and then click the Permissions tab.
Browser
Internet Explorer (settings for studios and portals)
Setting
Allow Cookies Active Scripting Allow META REFRESH
Run ActiveX controls and plug- Report Studio ins Query Studio Script ActiveX controls marked Analysis Studio safe for scripting Binary and script behaviors Allow programmatic clipboard access Report Studio
Note: Report Studio and Query Studio use the native Microsoft Internet Explorer XML support, which is a component of the browser. ActiveX support must be enabled because Microsoft implements XML using ActiveX. IBM Cognos 8 does not provide or download ActiveX controls. Only the ActiveX controls that are installed as part of Internet Explorer are enabled through this configuration. IBM Cognos 8 uses the following cookies to store user information.
50
Cookie
AS_TICKET
Type
Session temporary
Purpose
Created if IBM Cognos 8 is configured to use an IBM Cognos Series 7 namespace Contains security state information Stores a reference to a user session stored on the Content Manager server Holds session information that is specific to IBM Cognos Connection Holds information during edit operations, such as cut, copy, and paste Contains the content and product locale information, and is set for all IBM Cognos users Stores the choice that the user makes for the "view members folder" in Report Studio Stores the current folder path if local file access is used, and is updated after the Open or Save dialog box is used Stores session information that is specific to PowerPlay Studio Stores the settings that the user makes for user interface elements such as menus and toolbars Contains all capabilities and the signature for the current user
caf
Session temporary
Cam_passport
Session temporary
cc_session
Session temporary
cc_state
Session temporary
CRN
Session temporary
CRN_RS
Persistent
PAT_CURRENT_ FOLDER
Persistent
pp_session
Session temporary
qs
Persistent
userCapabilities
Session temporary
Cookie
usersessionid
Type
Session temporary
Purpose
Contains a unique user session identifier, valid for the duration of the browser session.
After upgrading or installing new software, restart the Web browser and advise users to clear their browser cache.
Steps
1. In IBM Cognos Configuration, configure IBM Cognos 8 to use your IBM Cognos Series 7 namespace. For more information, see the Installation and Configuration Guide. 2. In the Properties window, under Cookie Settings, ensure that the Secure Flag Enabled property is set to false. 3. From the File menu, click Save and close IBM Cognos Configuration. 4. Ensure that the ticket server for IBM Cognos Series 7 namespace is running. 5. Ensure that the timeout value of the Series 7 ticket server is set to the same value or to a higher value than the IBM Cognos 8 passport timeout value. 6. On the computer where IBM Cognos 8 is installed, open the c8_location/templates/ps/portal/ system.xml file in an editor. Ensure that your editor supports saving files in UTF-8 format. 7. Find and edit (with an XML editor) the series7 parameter as follows:
<!-- Series 7 Integration parameters --> <param name="series7"> <enabled>true</enabled> <!-- character encoding used by series7 --> <encoding>series7_character_encoding</encoding> <!-- host and port to connect to Upfront server -->
52
To view the character encoding used by Series 7, in Series 7 Configuration Manager, on the Properties tab, click IBM Cognos Shared, click Locale, and then click the Encoding property 8. Save the system.xml file in UTF-8 format. 9. Using IBM Cognos Configuration, stop and then restart IBM Cognos 8. For more information about stopping IBM Cognos 8, see the Installation and Configuration Guide.
For more information about the security concepts implemented in IBM Cognos 8, see (p. 201).
54
Locate and prepare data sources and models IBM Cognos 8 can report from a wide variety of data sources, both relational and dimensional. Database connections are created in the Web administration interface, and are used for modeling, for authoring, and for running the application. To use data for authoring and viewing, the business intelligence studios need a subset of a model of the metadata (called a package). The metadata may need extensive modeling in Framework Manager.
Build and publish the content Reports, scorecards, analysis, dashboards and more are created in the business intelligence studios of IBM Cognos 8. Which studio you use depends on the content, lifespan, and audience of the report, and whether the data is modeled dimensionally or relationally. Report Studio reports and scorecards are usually prepared for a wider audience, published to IBM Cognos Connection or another portal, and scheduled there for bursting, distribution, and so on. You can also use Report Studio to prepare templates for self-service reporting.
Deliver and view the information You deliver content from the IBM Cognos portal or other supported portals, and view information that has been saved to portals, or delivered by other mechanisms. You can also
Chapter 3: Building IBM Cognos 8 Applications run reports, analyses, scorecards, and more from within the business intelligence studio in which they were created. For information about tuning and performance, see the IBM Cognos 8 Administration and Security Guide and the IBM Cognos Resource Center (http://www.ibm.com/software/data/ support/cognos_crc.html).
56
Chapter 4: Samples
This section explains the purpose, content and location of IBM Cognos 8 samples. It also discusses the sample company, Great Outdoors, its structure, databases, model and packages. For information on how to set up the sample databases, see "Setting Up the Samples" (p. 63).
Chapter 4: Samples
Security
You can add security to the samples using an employee list included with the product. The list is in the form of an LDIF file that can be imported into any directory server, such as the Sun Java System Directory Server. Note: You can download a version of the Sun Java System Directory Server from the Sun Web site (http://www.sun.com/download/). For more information, see the Installation and Configuration Guide. For information about conformance, see the IBM Cognos Resource Center (http://www. ibm.com/software/data/support/cognos_crc.html).
The diagram below illustrates the consolidated corporate structure, including the percentage changes in ownership for GO Central Europe, and shows the reporting currency and GL prefix for each subsidiary.
58
Chapter 4: Samples
Each corporation has the same departmental structure and the same GL structure, shown in the table below. Divisions may not report in the same currencies. For example, the Americas subsidiary reports in US dollars, but the Corporate division local currency is Canadian dollars, and the Operations division local currency is pesos.
Division (GL)
Corporate (1700)
Department (GL)
Sales (1720) Marketing (1750) IS&T (1760) Human Resources (1730) Finance (1740) Procurement (1710)
Operations (1800)
Each corporation has a complete chart of accounts. Most of the accounts, such as those under nonpersonnel expenses, are at the department level, and contain only summary amounts. For example, although each marketing department has expenses, the cost is unspecified at the transaction level where marketing promotions occur. Administration and Security Guide 59
Chapter 4: Samples
Employees
The Great Outdoors data contains a full list of employees in all divisions, departments, and locations. Data is available for reports about bonuses (Global Bonus report) and sales commissions (Sales Commissions for Central Europe report), training (Employee Training by Year report), and performance reviews and employee satisfaction surveys (Employee Satisfaction 2006). If you use Metric Studio, sample metrics for human resources are also available. In the GO Data Warehouse (analysis) package, groups of measures and the related dimensions are organized into folders. The employees are organized in hierarchies for region, manager, position or department, and organization, to make different kinds of aggregation easy to report on. Aggregation has been defined for the Employee Position Summary measures, so that Position count and Planned position count aggregate correctly at each level of time: monthly, quarterly, or yearly. For example, see the Planned Headcount report. The employees are also listed in a sample LDIF file (p. 58). This authentication directory is necessary for the Transformer 8 cubes and for IBM Cognos Planning samples. No other samples depend on security profiles. For more information, see the Installation and Configuration Guide.
Customer Surveys
The data also contains information from customer surveys. For example, the product line that includes bug spray, sun screen, and so on has not been successful (Product Satisfaction - Outdoor Protection 2005) and a source of retailer dissatisfaction may be the level of customer service rather than the returns (Customer Returns and Satisfaction). If you use Metric Studio, this information can also be monitored in metrics.
Sales Outlets
Revenue from the corporate outlets is available at the transaction level. Revenue from the franchise outlets is available at the consolidated level only (Sales and Marketing cube). Metrics about retailers show that the number of new retail outlets has dropped over the time period covered by this data. GO Accessories sells worldwide, and sells only accessories. Transaction data for GO Accessories is the primary source for analysis of product by brand, color and size. The other five subsidiaries in the group of companies are regional and sell all product lines for retailers in their region. For
60
Chapter 4: Samples example, the report Top 10 Retailers in 2005 uses sparklines and list data to review revenues at the retailer level.
GO Data Warehouse
The GO Data Warehouse model, great_outdoors_data_warehouse.cpf, is based on the database GOSALESDW. It contains data about human resources, sales and marketing, and finance, grouped into business areas. In the Database view, the three business areas are grouped into separate namespaces. The Database view contains a fourth namespace (GO Data) for the common information. The Database view is very similar to the structure of the underlying database. All tables (database query subjects) are unchanged. This enables IBM Cognos 8 to retrieve metadata directly from the package in most cases, instead of using a metadata call to the database. The following changes and additions have been made in the Database view: Joins have been added as necessary. To allow for aggregation at different levels of granularity, some model query subjects have been created. For example, see the relationships between Time and Sales or Sales fact. To allow single joins to be made between the lookup tables and each level in a dimension, lookup tables have been copied. For example, see the Products look up tables.
The Business view contains only model query subjects, with no joins. The following changes and additions have been made in the Business view: Calculations were added to the model query subjects. For example, the time dimension contains language calculations. Where the database has multiple hierarchies, new dimensions have been created to organize each hierarchy. For example, see the employee hierarchies, where employees are organized by manager, organization, region, and position.
Chapter 4: Samples
The Business view contains only model query subjects, with no joins. The following changes and additions have been made in the Business view: Calculations were added to the model query subjects. Model query subjects that were created in the Database view to enable joins on the time dimension have been linked as reference shortcuts. Where the database has multiple hierarchies, new dimensions have been created to organize each hierarchy. Sales Staff is a subset of the slowly changing Employee dimension.There is no unique Employee key in GO Sales, so a filter retrieves the current record only. This model does not use historical data.
62
Chapter 4: Samples
Chapter 4: Samples Before you can use the sample databases, IBM Cognos 8 must be installed, configured, and running. For IBM Cognos 8 reports and analyses, Framework Manager should also be installed, configured, and running. To use the sample content for Metric Designer, the optional modeling tool for Metric Studio, Metric Designer must also be installed, configured, and running. To set up the samples, do the following: Restore the samples databases. Create the data source connections to the samples databases. If you plan to use OLAP data source samples, set up the sample cubes, if this is required, and create data source connections to the OLAP data sources you want to use. Setup tasks are required only for Microsoft Analysis Services cubes and Essbase cubes. If you plan to use the Metric Studio sample, set up the Metric Studio sample. If you plan to use the Metric Designer sample, set up a data source connection to it, set up the Metric Studio sample, and import the Cognos_Samples and GO_Metrics deployment archives. Import the samples content (packages) into the content store. If you want to test the sample agent ELM Returns Agent using Event Studio, run the sample agent against changed data.
After you complete these tasks, use IBM Cognos 8 to run the sample reports or scorecards. You can later remove the IBM Cognos 8 samples.
File name
GOSALES.zip GOSALES.zip GOSALESDW. zip GOSALES.zip
64
Chapter 4: Samples
File name
GOSALES.zip
File name
GOSALES.dmp.gz GOSALESRT.dmp.gz GOSALESDW. dmp.gz GOSALESMR. dmp.gz GOSALESHR. dmp.gz
File name
GS_DB.tar.gz GS_DB.tar.gz GS_DB.tar.gz GS_DB.tar.gz GS_DB.tar.gz
When restoring the samples databases, ensure that you do the following: Give the restored databases the same names as the backup or export file names. The names are case-sensitive. Create users with select privileges for tables in multiple schemas. Setup for the GO Data Warehouse packages specifies a single connection object and user signon. This requires a single user named GOSALESDW with the select privilege to tables in a single schema named GOSALESDW. Setup for the GO Sales packages specifies a single connection object and user signon. This requires a single user named GOSALES with the select privilege to tables in four schemas: GOSALES, GOSALESHR, GOSALESMR, and GOSALESRT. Use the UTF-8 character set on the database server. Administration and Security Guide 65
Chapter 4: Samples Use the UTF-8 character set on the Windows computer that is the Oracle or DB2 client to see reports in multiple languages. For DB2, you must set the DB2CODEPAGE environment variable to a value of 1208. For Oracle, you must set the NLS_LANG environment variable to a value that is specific to a region. For example, set NLS_LANG for Americas to American_America.UTF8. Have sufficient disk space available in the target location. Reserve 150MB for the GO Sales data (four schemas) and 200MB for the GO Data Warehouse data (one schema).
Oracle Considerations
To create foreign key constraints in tables that reference different schemas, you must run gs_or_modify.sql, found in the same folder as the .dmp files.
DB2 Considerations
Before you restore the Great Outdoors schemas contained in the DB2 move file on UNIX or Windows, extract the DB2 move file. On UNIX, extract the DB2 move file using the gnutar -xcvf
DB2_move_filename or tar -xcvf DB2_move_filename command. If you use WinZip to extract
the DB2 move file on Windows, ensure that the TAR file smart CR/LF conversion option is not selected. After extracting the DB2 move file, restore the schemas to a database named GS_DB. To add views, constraints, user privileges, and stored procedures to GS_DB, prepare and run the gs_db_modify files included with the samples in the following order: Update the user name and password at the top of the gs_db_modify.sql and save it. Execute gs_db_modify.bat
Steps
1. On the computer where IBM Cognos 8 is installed, go to the sql server, oracle, or db2 directory located in c8_location /webcontent/samples/datasources. 2. If required, copy the backup files for the samples databases to your database backup directory. To ensure the security and integrity of IBM Cognos 8, copy the files to a directory that is protected from unauthorized or inappropriate access. 3. Restore the samples databases using your database management tool. Tips: For SQL backup files, restore the database from a device, and ensure that the restore locations are correct for the .ldf and .mdf database files. For more information, see the Microsoft SQL Server documentation or the IBM Cognos Knowledge Base on the IBM Cognos Customer Service Center (http://www.ibm.com/software/data/support/cognos_crc.html).
66
Chapter 4: Samples For DB2, when you create the GS_DB database, create a buffer pool with a page size of 16 KB and an associated tablespace.
4. For each database, create at least one user who has select permissions for all the tables in the restored databases. You can now create the data source connections in the portal.
Steps
1. Open IBM Cognos Connection by connecting to the IBM Cognos 8 portal and clicking IBM Cognos Content on the Welcome page. 2. In the upper-right corner, click Launch, IBM Cognos Administration. 3. Click the Configuration tab. 4. Click the new data source button .
5. In the Name box, type great_outdoors_sales and then click Next. 6. In the connection page, click the type of database that you restored and want to connect to, select an isolation level, and then click Next. The connection string page for the selected database appears. Tip: The user specified in the great_outdoors_sales data source must have select privileges on the tables in each of the GOSALES, GOSALESRT, GOSALESMR, AND GOSALESHR schemas (p. 64). 7. Do one of the following: If you restored the samples databases in SQL Server, in the Server Name box, type the name of the server where the restored databases are located. In the Database name box, type GOSALES. IBM Cognos 8 samples require TCP/IP connectivity with SQL Server. Ensure the SQL Server Security is set to SQL Server and Windows, instead of Windows Only. The samples use SQL Server security for authentication.
Chapter 4: Samples If you restored the samples databases in Oracle, in the SQL*Net connect string box, type the Oracle connection string. If you restored the samples database in DB2, in the DB2 database name box, type GS_DB using uppercase letters. In the DB2 connect string box, type the DB2 connection string. 8. Under Signons, select the both Password and Create a signon that the Everyone group can use check boxes, type the user ID and password for the user that you created when you restored the databases, and then click Finish. Tip: To test whether the parameters are correct, click Test the connection.... 9. Click Finish. 10. Repeat steps 4 to 9 for the GOSALESDW samples database or schema, and type great_outdoors_ warehouse in step 5. 11. If the GOSALES model will be used by modelers in IBM Cognos 8 Transformer, the connection string must be manually added to the cs7g.ini file. For more information, see the Installation and Configuration Guide. The Great Outdoors data source connections appear as entries in Data Source Connections. You can now import the samples unless there is a syntax error in the connection string or an incorrect parameter.
68
Chapter 4: Samples Note: Both Microsoft XML 6.0 Parser and Microsoft SQL 2005 Analysis Services 9.00 OLEDB Provider must be installed on the local client to establish data source connections to MSAS cubes.
Steps
1. On the computer where IBM Cognos 8 is installed, go to the c8_location/webcontent/samples/ datasources/cubes/MSAS/en directory. 2. Copy the GOSALESDW.cab and GOSALESDW.abf files to a directory that you can access from the Analysis Manager console in the Analysis Servers of Microsoft SQL Server. 3. Use the Microsoft Analysis Services Analysis Manager to restore the database from the GOSALESDW.cab and GOSALESDW.abf files. You can now create the data source connections using either the GOSalesFact_XX or GOFinanceFact_XX cubes (p. 70).
Steps
1. Go to the c8_location\webcontent\samples\datasources\cubes\Essbase\Outlines_and_Raw_Data directory. This directory contains zip files for the different languages, such as EN.zip or JA.zip for English and Japanese, respectively. 2. Unzip the file for your language. Each zip file contains the following two files: languageU_Data.txt, such as ENU_Data.txt or JAU_Data.txt. GODWlanguageU.otl, such as GODWENU.otl or GODWJAU.otl.
3. Using block storage in Essbase, create a Unicode application. 4. Within the application, create a new database. You can use GODWlanguageU, such as GODWENU or GODWJAU, as your database name, or use the name of your choice. 5. Copy and paste the GODWlanguageU.otl file in your database directory. 6. If the database name specified in step 4 is different than GODWlanguageU, rename the GODWlanguageU.otl file to match the database name that you created. Confirm that you want to overwrite the .otl file.
Chapter 4: Samples 7. In Essbase Administration Services console, open your database outline and save it. Confirm that you want to save the outline even if it was not changed. 8. Copy the languageU_Data.txt file and paste it in the same directory as the .otl file. 9. In Essbase Administration Services console, right-click the database you created and select Load Data. 10. Browse to the languageU_Data.txt file in your database directory, select the file, and click OK. 11. After the data loads successfully, right-click the database and select Execute Calculation. 12. Select the default calculation, and click OK. The calculation process may take up to 5 hours, depending on the computer where Essbase OLAP Server is installed. You can now create a data source connection to the cube.
You must create data source connections to the cubes to use the samples. You must set up the Microsoft Analysis Services cube samples or set up the Essbase cube sample, if you are using them, before creating data source connections. You can increase the read cache size to improve query performance, although this setting has no effect on the initial time required to open a cube. To create data sources, you must have execute permissions for the Data Source Connections secured feature, and traverse permissions for the Administration secured function.
70
Chapter 4: Samples If you define a UNIX path and you plan to use Framework Manager, you must also define the Windows path and ensure that the cube is also available in the Windows location. Framework Manager can access cubes only from Windows locations. 6. In the connection page, under Type click IBM Cognos PowerCube. The connection string page for the selected database appears. 7. In the Read cache size (MB) box, type the cache size of the cube in megabytes. If you leave this field blank or type 0, IBM Cognos Connection uses the default value in the ppds_cfg.xml file in the configuration folder. 8. In the Windows location box, type the location and name of the Sales_and_Marketing.mdc file for the data source connection. For example, type c8_location/webcontent/samples/datasources/cubes/PowerCubes/En/Sales_and_Marketing. mdc 9. To test whether the parameters are correct, click Test. 10. Click Finish. You can now import the sample package for the PowerCube to use this data source.
Chapter 4: Samples 2. In the upper-right corner, click Launch, IBM Cognos Administration. 3. On the Configuration tab, click New Data Source. 4. In the Name box, type the name of the data source connection, and then click Next. For the GOFinanceFact cube, type GOFinanceFact_XX_MSAS2005. For the GOSalesFact cube, type GOSalesFact_XX_MSAS2005.
5. In the Specify Connection page of the New Datasource Wizard, click Microsoft Analysis Services 2005 or click Microsoft Analysis Services (via ODBO) as appropriate to the cube you are accessing. 6. Click Next. 7. In the Server Name box, type the name of the server where the restored databases are located. Back slashes are not required. 8. Under Signon, select the Password check box and then select the Create a signon that the Everyone group can use check box. Type the user ID and password for the MSAS database. For MSAS2005, this is a network login. 9. Click Test the connection, and then click the Test button. Click Close. 10. Click Finish. You are now prompted to create a package. Alternatively, you can deploy an existing package from a sample deployment archive. The names of the deployment archives match the datasource connection names specified in step 4 and contain sample reports that work with the associated cubes. In Content Administration on the Configuration tab in IBM Cognos Administration, click New Import. The New Import Wizard prompts you to select a deployment archive. When you select a deployment archive, it is important to click Edit and specify a target name for the package to prevent an existing package from being overwritten. 11. To create a package, check Create a Package and then click OK. 12. Specify a package name and then click OK. For the GO Finance Fact cube, type GOFinanceFact_XX_MSAS2005. For the GO Sales Fact cube, type GOSalesFact_XX_MSAS2005.
13. Specify the Analysis Services database you restored either GOFinanceFact_XX or GoSalesFact_XX: For either the GOFinanceFact cube or the GOSalesFact cubes, type GOSALESDW. For the GO Sales Fact cube, type GO Sales Fact.
14. Click the cube applicable to the database. 15. Click Finish.
72
Chapter 4: Samples
Tip: You may need to create the cmm folder. 2. In Public Folders, click GO Metrics. 3. In Metric Studio, in the Tools list, click Import Sources. 4. Click the Set Properties icon in the Actions column next to the Default Import Source. 5. Under Metric Deployment Location, click cmm folder. This is the default deployment location. 6. Click Include sub-directories. 7. In the File format box, click 8.4.2. 8. Under Character Set Encoding, select the appropriate encoding and click OK. For SQL Server or Oracle, select Unicode (UTF-16) For DB2, select Unicode (UTF-8)
Steps to Import Metric Data and Files into the Metric Store
1. Choose whether to import the files into the metric store using IBM Cognos Connection or Metric Studio: Administration and Security Guide 73
Chapter 4: Samples To use IBM Cognos Connection, in Public Folders or My Folders, open the GO Metrics package by clicking the view metric package contents icon in the Actions column. Click Metric Maintenance. To use Metric Studio, in Metric Studio, in the Tools list, click Metric Maintenance.
2. Click the Import and transfer data from files into metric store metric task. Tip: If an error occurs, click Clear staging area rejected data logs, Clear metric history data only, and Clear metric history and calendar data. You can now use the GO Metrics package in Metric Studio.
Steps
1. Copy the zip file from the c8_location/webcontent/samples/content directory to the directory where your deployment archives are saved. The default location is c8_location/deployment. The location is set in the configuration tool. For information about changing the location, see the configuration tool online help. 2. Open IBM Cognos Connection by connecting to the IBM Cognos 8 portal and clicking IBM Cognos Content on the Welcome page. 3. In the upper-right corner, click Launch, IBM Cognos Administration. 4. On the Configuration tab, click Content Administration. Note: To access this area in IBM Cognos Administration, you must have the required permissions for the Administration tasks secured feature. 5. On the toolbar, click the new import button. The New Import wizard appears. 6. In the Deployment Archive box, select Cognos_Samples, Cognos_PowerCube, Cognos_Metrics, or Cognos_Audit. 7. Click Next.
74
Chapter 4: Samples 8. Type a unique name and an optional description and screen tip for the deployment archive, select the folder where you want to save it, and then click Next. 9. In the Public Folders Content box, select the packages and folders that you want to import. The Cognos_Samples deployment archive has the following packages or folders: GO Data Warehouse (analysis), GO Data Warehouse (query), GO Sales (analysis), GO Sales (query), Sales and Marketing (conformed) Dashboard Folder, Dashboard Objects, Sample Template, Practical Examples
The Cognos_PowerCube deployment archive has packages or folders for the following languages: English French German Japanese Simplified Chinese
The GO_Metrics deployment archive has the following packages or folders: GO Metrics
10. Select the options you want, along with your conflict resolution choice for options that you select, and then click Next. 11. In the Specify the general options page, select whether to include access permissions and references to external namespaces, and who should own the entries after they are imported. 12. Click Next. The summary information appears. 13. Review the summary information and click Next. 14. Select the action that you want: To run once now or later, click Save and run once. Click Finish, specify the time and date for the run, then click Run. Review the run time and click OK. To schedule at a recurring time, click Save and schedule. Click Finish, and then select frequency and start and end dates. Click OK. Tip: To temporarily disable the schedule, select the Disable the schedule check box. To save without scheduling or running, click Save only and click Finish.
15. When the import is submitted, click Finish. You can now use the sample packages to create reports and analyses in Report Studio, Query Studio, and Analysis Studio, view extracts in Metric Designer, or create agents in Event Studio. You can also run the sample reports that are available on the Public Folders tab in the portal.
Chapter 4: Samples
You can use sample database models on different platforms. For information about moving models from one platform to another, see the Framework Manager User Guide. Note: Transformer 8 uses some of the reports in the GO Data warehouse (query) package and GO Sales (query) package as source data for various cubes. These reports are meant to be simple list reports with no formatting. The description information for the reports indicates if the report was developed to be source data for Transformer 8.
GO Sales Model
This model contains sales analysis information for the fictional company, The Great Outdoors. It also has the query items required by the Event Studio samples. The model accesses three schemas and has two packages. One package is based on the dimensional view and the other is baed on the query (relational) view.
GO Sales Scriptplayer
These files can be used to run the action logs in sequence. This action generates a model named gosales_scriptplayer, and publishes a package to the content store.
Example - Running the Sample ELM Returns Agent Against Changed Data
You can change data in the GOSALES database if an Event Studio user wants to test the sample agent ELM Returns Agent. The Event Studio user can then run the sample agent twice and detect a new event. For more information, see the Event Studio User Guide. Running the sample agent against changed data involves the following steps: The Event Studio user runs the sample agent against the default data and then asks you to change the data. You simulate the occurrence of some initial events and then ask the Event Studio user to run the sample agent a second time. The Event Studio user runs the sample agent against the changed data. The Event Studio user informs you when the agent has completed running.
76
Chapter 4: Samples You simulate the passage of time and the resolution of some events and then ask the Event Studio user to run the sample agent a third time. The Event Studio user runs the sample agent for the final time. The Event Studio user informs you when the agent has completed running. You modify the data so that the ELM Returns Agent detects no events.
Steps
1. In SQL Query Analyzer, from the File menu, click Open. 2. Go to c8_location/webcontent/samples/datasources/sqlserver and double-click the Event_Studio_ ELM_Agent_Modify_GOSALES.sql file. 3. In the toolbar, from the list of databases, click GOSALES. 4. In the Query window, under Part 1, select all sixteen lines of code. 5. From the Query menu, click Execute. The database is updated with the changes.
Example - Simulate the Passage of Time and the Resolution of Some Events
Run part of the Event_Studio_ELM_Agent_Modify_GOSALES.sql script to simulate data changes. First, change it so that two days elapsed since the ELM Returns Agent sample was last run. Second, for three of the four event instances found the last time that the ELM Returns Agent sample ran, change the follow-up code from -1 to +1. This indicates that only one of the these event instances still requires follow-up and the other instances are resolved.
Steps
1. In SQL Query Analyzer, from the File menu, click Open. 2. Go to c8_location/webcontent/samples/datasources/sqlserver and double-click the Event_Studio_ ELM_Agent_Modify_GOSALES.sql file. 3. On the toolbar, click GOSALES from the list of databases. 4. In the Query window, under Part 2, select all lines of code that appear after the comments. 5. From the Query menu, click Execute. The database is updated with the changes.
Chapter 4: Samples
Example - Modify the Data So That the ELM Returns Agent Detects No Events
When the Event Studio user finishes running the sample ELM Returns Agent against changed data, they should notify you. You can then modify the GOSALES database so that the agent no longer detects any event instances.
Step
Run the following sql commands: UPDATE GOSALES.RETURNED_ITEM SET FOLLOW_UP_CODE = 0 UPDATE GOSALES.RETURNED_ITEM SET ASSIGNED_TO = 0 UPDATE GOSALES.RETURNED_ITEM SET DATE_ADVISED = NULL The data is modified. The sample ELM Returns Agent is ready to be used by another Event Studio User.
Steps
1. Open IBM Cognos Connection by connecting to the IBM Cognos 8 portal and clicking IBM Cognos Content on the Welcome page. 2. Click the Public Folders tab. 3. Select the check box for the sample package you want to delete. 4. Click the delete button on the toolbar, and click OK. To use the samples again, you must set up the samples.
78
During planning, determine the logging configuration that is suitable for your environment. For example, evaluate various log message destinations, such as remote log servers and log files, such as the UNIX or Linux syslog or the Windows NT Event log, in addition to the local log file. You can also send only audit logging information to a database. Consider security, such as methods available for protecting log files from system failures and user tampering. For information about planning, see the Architecture and Deployment Guide. During configuration, define the startup properties for logging, such as connection settings for databases. You must also create a logging database if you plan to collect audit logs. If communication between a local log server and a remote log server must be secured, make the appropriate configuration changes on both IBM Cognos 8 computers. For information about configuring logging, see the Installation and Configuration Guide. When setting up logging, specify the level of detail to log to focus messages on the information that is relevant in your organization. Audit reports may also be set up to track user and report activity. For information about setting up logging, see the Administration and Security Guide.
For information about using log messages to solve problems and resolving logging-related issues, see the Troubleshooting section of the Administration and Security Guide. You can perform the following tasks to set up logging: set logging levels (p. 82) set up audit reporting (p. 82) view full details for secure error messages (p. 88) Administration and Security Guide 79
Chapter 5: Setting up Logging disable the creation of core dump files (p. 89)
Log Messages
You specify the location of the log messages and the size and number of log files, and configure the properties of the log server in the configuration tool. By default, log messages are saved to the cogserver.log file located in c8_location/logs. They can also be saved in a database. For more information, see the Installation and Configuration Guide. For more information about the log service, see "Dispatchers and Services" (p. 105).
Logging Levels
You set logging levels to specify the events and messages to record in the log file or in the log database. An event is an occurrence in your IBM Cognos 8 environment that is significant enough to be tracked, such as starting or stopping a service. You can set a different logging level for each dispatcher service. You can do this for each dispatcher or for all dispatchers in the same folder. By setting different logging levels for different services you can reduce the amount of irrelevant logging information. For example, if you must troubleshoot the batch report service, you can select a detailed logging level for just that service, keeping log messages to a minimum. The logging level for a service applies to all its components. Note: The log service does not have logging levels associated with it. The following table indicates the details that each logging level logs.
Details
System and service startup and shutdown, runtime errors User account management and runtime usage of IBM Cognos 8 Use requests Service requests and responses All requests to all components with their parameter values
Minimal
Basic
Request
Trace
Full
80
Details
other queries to IBM Cognos 8 components (native query)
Minimal
Basic
Request
Trace
Full
You can maintain system performance by managing the amount of logging performed by the server. Since extensive logging affects server performance, increasing the logging level may negatively affect the performance of IBM Cognos 8. The default logging level is Minimal. Use Full logging level only for detailed troubleshooting purposes because it may significantly degrade server performance.
Logging level
Minimal, Basic Request Trace Full
The higher you set the logging level, the more it degrades system performance. Normally, you set the level to Minimal or Basic to collect errors, or to Request to collect errors and warnings. For information about reports and report validation, see the Report Studio Professional Authoring User Guide.
Chapter 5: Setting up Logging Native query logging is part of Request level logging. However, if you are using audit reports, you can enable native query logging independently from Request level logging, as described in the following steps. For information on setting logging levels for audit reports, see "Audit Reports" (p. 82).
Steps
1. Start IBM Cognos Connection. 2. In the upper-right corner, click Launch, IBM Cognos Administration. 3. On the Status tab, click System. 4. In the upper left corner of the Scorecard pane, click the arrow to view the Change view menu, and then click All servers, All server groups, All dispatchers, or Services, depending on where you want to set logging levels. 5. Click the arrow next to the item to view the Actions menu, and then click Set properties. For example, to set logging levels for the system, click the arrow next to the Actions menu. 6. Click the Settings tab. 7. From the Category menu, click Logging. 8. From the Value menu, select the logging level you want for the service. 9. If native query logging (p. 81) is available for the service and you want to use it, select the audit the native query check box. 10. Click OK.
Audit Reports
You use audit reports to view the information in a logging database about user and report activity.
82
Chapter 5: Setting up Logging The information in this section is intended to help you model the audit logging database in FrameWork Manager and create reports based on your logging data. First, you must set up audit reporting (p. 83). You may want to refer to the sample model and sample audit reports (p. 83) to help you create audit reports. For information on the database schema for audit reports, see "Data Schema for Log Messages" (p. 749).
Description
Lists agent execution history by user and date and time range and includes a bar chart. It also includes the total number of times each agent was executed and the total number of agents that were executed. You can select a date and time range.
Description
Daily average and poor exceptions - Shows how to monitor daily average and poor exceptions all services of thresholds set in IBM Cognos Administration for all services using an agent. An email with attached report output is sent to the administrator when average and poor exceptions occur. To run this report properly, you must first set thresholds in IBM Cognos Administration (see "System Performance Metrics" (p. 91)). To receive an email, you must specify a mail server account. For more information, see the IBM Cognos 8 Installation and Configuration Guide For more information on setting thresholds in IBM Cognos Administration, see "System Performance Metrics" (p. 91). Daily metric exceptions Execute reports by package and report Lists daily metric exceptions for all services. Lists the reports that were run, by package. It also includes the user, timestamp, and execution time in milliseconds for each report. You can select a date and time range, one or more users, one or more packages, and one or more reports. Execute reports by user Lists the reports that were run, by user and by package. It also includes the timestamp and execution time in milliseconds for each report. You can select a date and time range, one or more users, one or more packages, and one or more reports. Execution history by user Lists the reports that were run alphabetically, along with the package and timestamp, by user, since the logging database was created. It includes the total number of reports each user ran and the total number of times each user ran each report. It also includes the total number of reports run by all users. You can select one or more users for the report. After you run the audit report, you can choose to view the statistics for a particular report or for all reports. Failed report executions - by package Lists report failure executions by package and includes a pie chart, which also shows the failed percentage of each package.
84
Description
Failed service requests detect agent - Detects preset thresholds for service request failures that all services are exceeded. An email is sent to the administrator with service failure metrics information. The report Service requests metrics day report is run. To run this report properly, you must first set thresholds in IBM Cognos Administration (see"System Performance Metrics" (p. 91)). To receive an email, you must specify a mail server account. For more information, see the IBM Cognos 8 Installation and Configuration Guide. Logon operations by time stamp Shows logon and logoff timestamps and operations, by user. It also includes the total number of logons and the total number of logons for each user. You can select the time period and one or more users for the report. Logon operations by user name Shows logon and logoff timestamp by user, along with the type of logoff operation that occurred. It includes the total number of logons and the total number of logons for each user. You can select one or more users for the report. Migration exceptions Operations by selected object and users A list report shows exceptions for migration tasks. Shows the operations that are performed on target objects, by user. It includes the target object path, timestamp, and the status of the operation. You can select one or more objects, operations, or users for the report. Report execution history (detailed report) Lists reports alphabetically along with the associated package and the timestamp for each time the report was executed. It also shows the total number of times each report was executed and the total number of reports that were executed. It also includes a color-coded pie chart that gives an overview of how often the reports are used.
Description
Lists reports alphabetically along with the timestamp for each time the report was run since the logging database was created. Lists reports by frequency of use. For each report, it lists the user and the number of times it was run by the user since the logging database was created. This report can help you determine if there are any reports that are not being used. If so, you may want to remove them.
Report usage
Service requests metrics - day report Shows percentage of successful and failed requests for IBM Cognos services for the current day. Includes a bar chart. User session - abnormal termination Shows logon date and time of abnormally terminated user sessions. It also includes a total of session termination for all dates. You can select a date and time range. User session - details Shows user session details, including the logon time, logoff time, logoff operation, and session duration. It also includes the total amount of session time for each user and the total amount of session time for all users. You can select a date and time range and one or more users. User session - logon errors for past 30 days chart User session - summary This audit report shows a bar graph of logon failures for the past 30 days. This audit report shows the average session duration by user. It also shows the total average session duration by user. You can select a date and time range and one or more users. View reports by package and report This audit report lists users and timestamps for reports for the package that you select. You can select a date and time range, one or more users, and one or more reports.
86
Steps
1. In a text editor, open the web.xml file located at c8_location/webapps/p2pd/web-inf, and add the following XML fragment:
<servlet> <servlet-name>DSServlet</servlet-name> <servlet-class>com.cognos.demo.DSServlet</servlet-class> </servlet> <servlet-mapping> <servlet-name>DSServlet</servlet-name> <url-pattern>/cognos/DSServlet.jsp</url-pattern> </servlet-mapping>
Note that the url-pattern value can be anything you choose. 2. If you do not have the following directory on your system, create it: c8_location/webapps/p2pd/ web-inf/classes/com/cognos/demo. 3. Copy the file build.bat for Windows or build.sh for UNIX located in c8_location/webapps/Audit to c8_location/webapps/p2pd/web-inf/classes/com/cognos/demo. Administration and Security Guide 87
Chapter 5: Setting up Logging Edit the build file to ensure the JAVA_HOME definition points to your JDK and ensure the CRN_HOME definition points to your IBM Cognos 8 location. 4. If it is not already there, copy the DSServlet.java file from the c8_location/webapps/Audit directory to c8_location/webapps/p2pd/web-inf/classes/com/cognos/demo. 5. Do one of the following in the DSServlet.java file: If you are allowing anonymous logon, comment out the following line:
binding.logon(...)
If you are not allowing anonymous logon, make sure that the username, password, and namespace are correct and uncomment the following line: binding.logon(...)
6. At a command prompt, run build.bat or build.sh from c8_location/webapps/p2pd/web-inf/ classes/com/cognos/demo. 7. Restart IBM Cognos 8 and open IBM Cognos Connection. 8. Create a data source connection to the XML data source by doing the following: In the upper-right corner, click Launch, IBM Cognos Administration. On the Configuration tab, click New Data Source. Under Name, type url_xml. Click Next. Under Type, select XML. Click Next. In the Connection string field, enter the connection string. If you used the defaults, the connection string is http://localhost:9300/p2pd/cognos/DSServlet.jsp. Click OK.
88
Chapter 5: Setting up Logging An error has occurred. Please contact your administrator. The complete error has been logged by CAF with SecureErrorID:2004-05-25-15:44:11.296-#9 2. Open the cogserver.log file using a text editor. The file is located in c8_location/logs. 3. Search for the error code ID to locate the applicable error message.
Steps to Turn Off Core File Creation for IBM Cognos 8.1 MR1
1. On the server where IBM Cognos 8 is installed, open the rsvpproperties.xml file from the c8_location\configuration directory. 2. Change the Win32StructuredExceptionHandling property to 0 (zero) so that it reads
<property>Win32StructuredExceptionHandling</property> <value type="long">0</value>
Steps to Turn Off Core File Creation for IBM Cognos 8.1 MR2 and Later Versions
1. On the server where IBM Cognos 8 is installed, open the cclWin32SEHConfig.xml file from the c8_location\configuration directory. 2. In the configuration element, change the value of the environment variable setting to 0 (zero) so that it reads
<env_var name="CCL_HWE_ABORT" value="0"/>
90
Change Type
Counter
Description
The value is a sum that increases with each change. For example, number of requests is a counter change type. The value may increase or decrease over time, depending on events. For example, the number of processes running at any time is a gauge change type.
Gauge
Time Scope
Point in time
Description
The value is gathered at a specific point in time, such as when you reset a metric group or restart a service The value is gathered over the interval since the last reset of the metric
Since reset
Gathering Time
On change
Description
The value is collected when a change occurs, such as when the number of requests changes The value is gathered when you select a new item in the Scorecard pane (p. 99), or reset a metric group (p. 103) The gathering time is unknown
On demand
Unknown
System Metrics
There are a wide variety of metrics available to help you monitor the performance of your IBM Cognos 8 installation. They are listed in the following table with the type of entry they apply to, a description, and the associated change type, time scope, and gathering time (p. 91). Some metrics are reset when the service restarts. You can also reset some metrics manually (p. 103). At the system and server levels, the metrics include all associated dispatchers. At the dispatcher level, metrics include all associated services. For server groups, metrics are for all the dispatchers in the group.
Session Metrics
You can use session metrics to monitor user sessions. This is useful for monitoring system trends such as usage patterns by time of day and day of week. Session metrics are also useful for understanding the context of other metrics. For example, if the number of sessions is extraordinarily high, it could account for the queue length metrics (p. 93) being higher than normal.
Metric
Entry
Description
Change Type
92
Metric
Entry
Description
Change Type
The maximum number of act- Gauge ive user sessions since the last reset The minimum number of active Gauge user sessions since the last reset
Since reset
On change
Queue Metrics
You can use queue metrics to determine if the system is keeping up with demand. For example, if requests spend too long in a queue, you may not have enough resources to meet demand. There are queue metrics for services that use queues: report service and report data service. There are also queue metrics at the system level for the following things: Job queue, which contains metrics related to the internal queue used by all event management services. Task queue, which contains metrics related to the internal queue used by all monitor services. This queue contains tasks until they are successfully completed. SMTP queue, which contains metrics related to the internal queue used by all delivery services. This queue contains emails until they are sent.
Some of the metrics available for these queue metric groups must be enabled to be displayed. For more information, see (p. 153).
Metric
Entry
Description
Latency
The average amount of time that Gauge requests have spent in the queue (in seconds).
On change
Metric
Entry
Description
Queue length
Queue length high System watermark Server/Server group Service Queue length low watermark System Server/Server group Service Time in queue System Server/Server group Service Time in queue high System watermark Server/Server group Service Time in queue low System watermark Server/Server group Service
The maximum number of items Gauge in the queue since the last reset
Since reset
On change
The minimum number of items Gauge in the queue since the last reset
Since reset
On change
The cumulative amount of time Counter Since reset that requests have spent in the queue (in days, hours, minutes, and seconds)
On change
The maximum length of time Gauge that a request waited in the queue (in days, hours, minutes, and seconds)
Since reset
On change
The minimum length of time Gauge that a request waited in the queue (in days, hours, minutes, and seconds)
Since reset
On change
JVM Metrics
You can use JVM metrics to monitor the Java Virtual Machine and associated heap size (the amount of memory that is currently in use). For example, if a dispatcher has been running for a long time and heap usage is high, you may want to restart it. The maximum heap size metric tells you if you have allocated a suitable amount of memory to the JVM based on the amount o hardware memory available. The current heap size, in relation to the maximum heap size, lets you know if available memory is being used. If current heap size is close to the maximum heap size, you may want to
94
Chapter 6: System Performance Metrics adjust tuning settings (p. 127) to reduce the load on a particular JVM. Keep in mind that current heap size may vary widely depending on the current load on the system.
Metric
Entry
Description
Change Type
Time Scope
Gathering Time
Dispatcher
The current size of the JVM heap Gauge (in bytes) The initial amount of memory that the JVM requests from the operating system during startup (in bytes) Gauge
Dispatcher
Dispatcher
The maximum amount of Gauge memory that can be used by the JVM (in bytes) The length of time that the JVM Counter has been running (in days, hours, minutes, and seconds) At the system, server, and server group levels, this is the highest value from all associated dispatchers.
Up time
Request Metrics
You can use request metrics to monitor volume of requests, operational status of services, response times, and processing times. General request metrics include data for all services and are a consolidation of metrics for all dispatchers. Request metrics specific to a service include only data for that service. At the system, server, and server group levels, the metrics include data from all associated dispatchers. At the dispatcher level, metrics include all associated services.
Metric
Entry
Description
Change Type
Counter
Time Scope
Point in time
Gathering Time
On demand
Current time
Service
The current date and time used by the service to interpret time values. Used only if the service has no clock synchronization mechanism
Metric
Entry
Description
Change Type
Time Scope
Point in time
Gathering Time
On change
Last response time System Server/Server group Dispatcher Service Number of failed requests System Server/Server group Dispatcher Service Number of processed requests System Server/Server group Dispatcher Service Number of success- System ful requests Server/Server group Dispatcher Service Percentage of failed System requests Server/Server group Dispatcher Service Percentage of successful requests System Server/Server group Dispatcher Service
Processing time for the most Gauge recent successful or failed request (in days, hours, minutes, and seconds)
The number of service requests Counter that failed (a fault was returned)
The number of service requests that succeeded (no fault was returned)
Counter
Gauge
Gauge
96
Metric
Entry
Description
Change Type
Gauge
Time Scope
Gathering Time
Response time high System watermark Server/Server group Dispatcher Service Response time low System watermark Server/Server group Dispatcher Service Seconds per success- System ful request Server/Server group Dispatcher Service Service time System Server/Server group Dispatcher Service Service time failed requests System Server/Server group Dispatcher Service Service time success- System ful requests Server/Server group Dispatcher Service
The maximum length of time taken to process a successful or failed request (in days, hours, minutes, and seconds)
The minimum length of time taken to process a successful or failed request (in days, hours, minutes, and seconds)
Gauge
The average length of time taken Gauge to process a successful request (in seconds)
The time taken to process all Counter requests (in days, hours, minutes, and seconds)
The time taken to process all failed service requests (in days, hours, minutes, and seconds)
Counter
The time taken to process all suc- Counter cessful service requests (in days, hours, minutes, and seconds)
Metric
Entry
Description
Change Type
Time Scope
Gathering Time
Metric
Entry
Description
Change Type
Gauge
Time Scope
Point in time
Gathering Time
On demand
Number of processes
System
For system, server, and server group, the total of all Number Server/Server of processes high watermark group metrics for all associated Report service and resources Batch report serFor services, the maximum vice number of report service processes that ran at any one time since the last reset System
Gauge
For system, server, and server Gauge group, the total of all Number Server/Server of processes low watermark group metrics for all associated Report service and resources Batch report serFor services, the minimum numvice ber of report service processes that ran at any one time since the last reset
98
Scorecard Pane
The Scorecard pane lists entries: system, servers, server groups, dispatchers, and services. For each, it shows a metric score and operational status so that you can assess system performance (p. 100). Each metric score is represented by a symbol: a green circle for good a yellow diamond for average a red square for poor
You must set metric thresholds before metric scores appear (p. 101). If a service is disabled in IBM Cognos Configuration, it is not listed. The metric score for each entry is based on the performance of individual child entries. The status that is displayed for each entry is the lowest status of the child entries. For example, if all the metrics for a dispatcher are good but one service on that dispatcher has a poor metric, the metric score shown for the dispatcher is poor. Status is one of the following: Available if all components are available Partially available if at least one component is available and at least one component is unavailable or partially unavailable. Unavailable if all components are unavailable
The Toolbar actions menu lets you perform functions such as starting and stopping dispatchers or services (p. 108), unregistering dispatchers (p. 111), and testing dispatchers (p. 117). Each entry also has an Actions menu associated with it, which you access by clicking the arrow next to the entry. You use the Scorecard pane to navigate to the entry that you want to view. You can select the view that you want from the Change view menu in the upper-left corner. You can click on entries to select them and display the next level of entries. For example, click a server to see associated dispatchers or click a dispatcher to see associated services.
Metrics Pane
The Metrics pane shows the metrics for the selected entry. You can expand metric groups to see the individual metric scores and values. You can reset each metric group independently (p. 103) You can select the metrics that you want to display by clicking a check box at the top of the pane. By default, all are displayed. Metrics with no metric score include ones that you can not set thresholds for and ones that you have not yet set metric thresholds for. For the latter, you must display them by clicking the No metric score check box before you can set them.
Settings Pane
The Settings pane shows settings associated with the selected entry in view only mode. To change settings, click the set properties button .
For more information on the settings in the Settings pane, see "Server Administration" (p. 105).
Steps
1. Start IBM Cognos Connection. 2. In the upper-right corner, click Launch, IBM Cognos Administration. 3. On the Status tab, click System. The metric score icon next to System shows overall system status. The metric score icon next to each server shows the status of that server. In the Metrics pane, individual metrics are listed. 4. In the upper left corner of the Scorecard pane, click the arrow to view the Change view menu, and then click the view that you want. 100
Chapter 6: System Performance Metrics If you choose All server groups, display dispatchers that are not grouped by server by clicking Default server group. 5. To view the metrics for a displayed item, click the icon to the left of the entry. 6. To view the children of a displayed entry, click the entry itself. Tip: You can refresh individual panes by clicking the refresh button in the pane. 7. To view or change the properties of an entry, click the actions menu button next to the entry, and then click Set properties. 8. To see the consolidated view, click the maximize button on the Scorecard pane. Tip: To return to the previous view, click the restore button.
Steps
1. Start IBM Cognos Connection. 2. In the upper-right corner, click Launch, IBM Cognos Administration. 3. On the Status tab, click System. 4. In the upper left corner of the Scorecard pane, click the arrow to view the Change view menu, and then click the view that you want. 5. In the Metrics pane, expand the metric group that you want to view.
6. In the Value column of the Metrics pane, pause your pointer over the value for the metric that you want to view. The name of the metric is displayed. 7. To view more information about some metrics, click More.
Chapter 6: System Performance Metrics Or for percentage of successful requests, you select High values are good. You set the upper value to 98 and the lower value to 95. If the percentage of successful requests goes below 95 percent, the metric score is red (poor). If the percentage of successful requests is between 95 and 98 percent, the metric score is yellow (average). If the percentage of successful requests remains above 98, the metric score is green (good). Changes to thresholds are effective immediately. There are no threshold defaults. You must set thresholds for metric scores to display. If you want to be notified when thresholds are exceeded, you can create an agent (p. 383). Sample agents that monitor the audit database for threshold violations and perform common actions when violations are detected are included in the audit samples package. Log entries (p. 79) occur in the following circumstances: when metric thresholds are violated when enumerated metrics, such as operational status, change
Logs are not generated when metric values change but remain in the same range.
Steps
1. Start IBM Cognos Connection. 2. In the upper-right corner, click Launch, IBM Cognos Administration. 3. On the Status tab, click System. 4. In the upper left corner of the Scorecard pane, click the arrow to view the Change view menu, and then click the view that you want. 5. To change the threshold for a metric, in the Metrics pane, click the Edit thresholds button next to the metric. 6. Click the performance pattern that you want: High values are good, Middle values are good, or Low values are good. 7. To specify a threshold value, click in the threshold box and enter the threshold number you want. 8. Click the arrow beside the threshold value to specify which range the value itself falls into. For example, if your maximum value is 50 and you want values of 50 to fall into the average category rather than the poor category, click the arrow to move the threshold value into the average category. 9. Click OK.
102
Reset Metrics
You can reset a group of metrics at any time. For example, for a server, you can reset the Queue Report service group of metrics. When you reset a group of metrics, all the metrics in the group are reset. Some metrics cannot be reset. For example, JVM metrics cannot be reset because they were re-calculated after the last reset.
Steps
1. Start IBM Cognos Connection. 2. In the upper-right corner, click Launch, IBM Cognos Administration. 3. On the Status tab, click System. 4. In the upper left corner of the Scorecard pane, click the arrow to view the Change view menu, and then click the view that you want. 5. In the Metrics pane, click the reset button for the group of metrics that you want to reset.
Steps
1. Start IBM Cognos Connection. 2. In the upper-right corner, click Launch, IBM Cognos Administration. 3. On the Status tab, click System. 4. In the Scorecard pane, click Actions, Reset all metrics of the system.
104
You should be familiar with the IBM Cognos 8 components and with how they are installed and configured. If you installed IBM Cognos 8 servers or components on more than one computer, all functionality can be controlled through system administration. For information about the IBM Cognos 8 environment, see the Installation and Configuration Guide and the Architecture and Deployment Guide. For some server administration tasks, you use IBM Cognos Administration and must have the required permissions to the access administration functionality "Secured Functions and Features" (p. 221).
Chapter 7: Server Administration You can have more than one dispatcher in your IBM Cognos 8 environment. In such distributed installations one dispatcher is configured for every instance of the Content Manager or Application Tier Components that are installed and configured in your environment. After you install and configure IBM Cognos 8, one dispatcher is available on each computer by default. Each dispatcher has a set of associated services, listed in the following table.
Service
Agent service
Purpose
Runs agents. If the conditions for an agent are met when the agent runs, the agent service asks the monitor service to run the tasks. Manages background requests to run reports and provides output on behalf of the monitor service. Performs object manipulation functions in the content store, such as add, query, update, delete, move, and copy Performs content store management functions, such as import and export
Manages the execution of data movement tasks in IBM Cognos 8. Data movement tasks, such as Builds and JobStreams, are created in Data Manager Designer and published to IBM Cognos 8. Sends emails to an external SMTP server on behalf of other services, such as the report service, job service, agent service, or data integration service Creates, schedules, and manages event objects that represent reports, jobs, agents, content store maintenance, deployment imports and exports, and metrics Runs jobs by signaling the monitor service to run job steps in the background. Steps include reports, other jobs, import, exports, and so on.
Delivery service
Job service
106
Service
Log service
Purpose
Records log messages generated by the dispatcher and other services. The log service can be configured to record log information in a file, a database, a remote log server, Windows Event Viewer, or a UNIX system log. The log information can then be analyzed by customers or by Cognos Software Services, including: security events system and application error information selected diagnostic information
Provides the Metric Studio user interface for monitoring and entering performance information Manages the migration from IBM Cognos Series 7 to IBM Cognos 8. Manages the monitoring and execution of tasks that are scheduled, submitted for execution at a later time, or run as a background task Assigns a target service to handle a scheduled task. For example, the monitor service may ask the batch report service to run a report, the job service to run a job, or the agent service to run an agent. Creates history objects within the content manager and manages failover and recovery for executing entries
Migration service
Monitor service
Manages communications with the Planning Job Server subsystem. Manages communications with Contributor Web and Contributor Add-in for Excel users.
Planning administration console service Manages communication with the Contributor Administration Console. Planning data service Manages communications for real-time reporting from Contributor plan data in IBM Cognos 8.
Service
Presentation service
Purpose
Transforms generic XML responses from another service into output format, such as HTML or PDF Provides display, navigation, and administration capabilities in IBM Cognos Connection
Manages the transfer of report data between IBM Cognos 8 and applications that consume the data, such as IBM Cognos 8 Go! Office and IBM Cognos 8 Go! Mobile. Manages interactive requests to run reports and provides output for a user in IBM Cognos Connection or a studio Defines the Business Intelligence Bus API-compliant service used to obtain application-wide IBM Cognos 8 configuration parameters. It also provides methods that normalize and validate locale strings and map locale strings to locales supported by your application.
Report service
System service
You can perform the following maintenance on dispatchers and their associated services: start and stop dispatchers and services activate a Content Manager service remove dispatchers from the environment group dispatchers in configuration folders specify advanced dispatcher routing specify gateway mappings rename dispatchers test dispatchers administer failover for multiple dispatchers
108
Chapter 7: Server Administration stopped immediately and delete all the requests that are running or queued, without completing those requests stopped after running and queued requests are processed
You can stop or start all dispatchers and services in the IBM Cognos 8 environment at once. When you start IBM Cognos 8 using the configuration tool, all dispatchers and services start unless they are disabled in the configuration tool. For more information, see the Installation and Configuration Guide. By default, all services start when you restart the computer on which they are installed. Stopping a service also stops all its processes. When you stop a dispatcher, all its services are stopped. If the suspended dispatcher has an active Content Manager, all users except administrators are locked out. After a service is stopped, it has a suspended status "System Performance Metrics" (p. 91). You must have the required permissions to access IBM Cognos Administration functionality. See "Secured Functions and Features" (p. 221).
Steps
1. Start IBM Cognos Connection. 2. In the upper-right corner, click Launch, IBM Cognos Administration. 3. On the Status tab, click System. 4. In the upper-left corner of the Scorecard pane, click the arrow to view the Change view menu and find the dispatchers or services that you want. Click All servers, All server groups, or All dispatchers. To select a service, pause your pointer over Services and click the required service. 5. Click the arrow next to the dispatcher or service, and choose the action that you want to perform. Depending on the dispatcher or service, you can do the following:
Goal
Action
Start all dispatchers in system With all servers displayed, in the upper right corner of the Scorecard pane, click the arrow to view the Toolbar actions menu, and then click Start dispatchers. Tip: To apply a toolbar action to only some entries, select check boxes for one or more entries and then click the toolbar action that you want. Start all dispatchers for a server With all server groups displayed, click the arrow to view group the Actions menu next to the server group, and then click Start dispatchers.
Goal
Action
Start all dispatchers for a server With all servers displayed, click the arrow to view the actions menu next to the server, and then click Start dispatchers. Start a specific dispatcher With all dispatchers displayed, click the arrow to view the Actions menu next to the dispatcher, and then click Start. Start a specific service With all services displayed, click the arrow to view the Actions menu next to the service, and then click Start. Stop all dispatchers in system With all servers displayed, in the upper right corner of the Scorecard pane, click the arrow to view the Toolbar actions menu, and then click Stop dispatchers immediately or Stop dispatchers after running and queue processed. Stop all dispatchers for a server With all server groups displayed, click the arrow to view group the Actions menu next to the server group, and then click Stop dispatchers immediately or Stop dispatchers after running and queue processed. Stop all dispatchers for a server With all servers displayed, click the arrow to view the Actions menu next to the server, and then click Stop dispatchers immediately or Stop dispatchers after running and queue processed. Stop a specific dispatcher With all dispatchers displayed, click the arrow to view the Actions menu next to the dispatcher, and then click Stop immediately or Stop after running and queue processed. Stop a specific service With all services displayed, click the arrow to view the Actions menu next to the service, and then click Stop immediately or Stop after running and queue processed. A dialog box appears and confirms the action. 6. Click Close.
110
Chapter 7: Server Administration You can manually activate a Content Manager service that is in standby mode. When you activate a service, any currently active service switches to standby mode. You can also specify a Content Manager service which is currently standby as the default active service at startup. You must have the required permissions to access IBM Cognos Administration. See "Secured Functions and Features" (p. 221).
Steps
1. Start IBM Cognos Connection. 2. In the upper-right corner, click Launch, IBM Cognos Administration.
Chapter 7: Server Administration 3. Click the Status tab, and then click System. 4. Determine the dispatchers that you want to unregister. 5. In the upper-left corner of the Scorecard pane, click the arrow to view the Change view menu. Click All servers, All server groups, or All dispatchers.
Goal
Unregister all dispatchers in system
Action
With all dispatchers displayed, in the upper-right corner of the Scorecard pane, click the arrow to view the Toolbar actions menu, and then click Unregister dispatchers. Tip: To apply a toolbar action to only some entries, select check boxes for one or more entries and then click the toolbar action that you want.
Unregister all dispatchers for a With all servers displayed, click the arrow next to a server server to view the Actions menu, and then click Unregister dispatchers. Unregister all dispatchers for a With all server groups displayed, click the arrow next to server group a dispatcher to view the Actions menu, and then click Unregister dispatchers. Unregister a specific dispatcher With all dispatchers displayed, click the arrow next to a dispatcher to view the Actions menu, and then click Unregister. A dialog box appears to confirms the action. 6. Click OK. The dispatcher information is removed from the content store. You can now uninstall it. If you do not uninstall the dispatcher, it reregisters itself and restarts the next time that IBM Cognos 8 is restarted. For information about uninstalling, see the Installation and Configuration Guide.
Chapter 7: Server Administration You can create a new configuration folder at the root of the Configuration area or in an existing configuration folder.
Tips
To view and edit the configuration properties of the parent of an entry shown in the path on the toolbar, click the set properties button . You can change and apply configuration settings for all the dispatchers and services in the Configuration area when you are in the root of the Configuration area. Use the path on the toolbar to explore the different levels of your configuration. The path starts with Configuration and, when the path becomes too long, it wraps.
You must have the required permissions to access IBM Cognos Administration functionality. See "Secured Functions and Features" (p. 221).
Steps
1. Start IBM Cognos Connection. 2. In the upper-right corner, click Launch, IBM Cognos Administration. 3. On the Configuration tab, click Dispatchers and Services. 4. Click the new folder button. 5. Type a name and, if you want, a description, and specify where to save the configuration folder. 6. Click Finish. You can now add dispatchers to the configuration folder by cutting them from their original location and then pasting them inside the folder. You can also change settings at the configuration folder level. Tip: To move a dispatcher to another folder, click More next to the dispatcher and then click Move.
Server Groups
When you define the routing rules, you must select a server group. Server group names are a property of a dispatcher or the configuration folders into which the dispatchers are organized. See (p. 128) to set server group names.
Chapter 7: Server Administration To determine which server groups process certain reports, you must associate keywords with packages and user roles or groups, and then specify how the keywords are distributed among the dispatchers in your environment. The distribution is controlled by routing rules that you create for the routing keywords. The report request will be processed by a specific server depending on the keywords associated with the package from which the report was created and/or the user or group running the report. When you create the routing rules, you create conditions that determine the server groups by which the reports are to be processed. For example, you can set up routing rules so that reports from a Finance package made by a user in the Finance group are processed by Finance servers. Alternatively, you can set up routing rules so that reports by any Sales users, regardless of which package was used to create the report, are processed by Sales servers. In the first example, you would specify keywords for both user role or group and package, but in the second you would only specify a keyword for user role or group and leave the package keyword blank. You do not have to specify a keyword for both package and user role or group in your routing rules. You set up the routing keywords and the routing rules using IBM Cognos Connection. You must have the required permissions to access IBM Cognos Administration functionality. See "Secured Functions and Features" (p. 221).
114
Chapter 7: Server Administration 6. Under Advanced routing, click Set. The Assign routing sets page appears. 7. Select a routing keyword for the users role or group in Select routing sets, or type it in Type Routing Sets, and click Add. If you are typing, separate each keyword with a semi-colon, for example, Red;Blue;Green;. 8. Repeat step 7 to add other routing keywords that you want to apply to the users role or group. The order in which the routing keywords are added does not matter. 9. Click OK. The routing keywords are displayed under Advanced routing. 10. On the Set properties page, click OK.
The Specify the routing rules page appears. 5. Click Add a rule. 6. Select the Package routing set, Group routing set, Role routing set, and Server group that you want. 7. In the Actions column, click the View the members button to see an overview of the members. 8. To change the order of routing rules, click Modify the sequence, and then the item you want to move and click Up, Down, To top, or To bottom. Note: Unlike routing keywords, the order in which the routing rules are listed affects how they are applied. A rule is matched when properties associated with the package and/or the user or group involved in the request satisfy the criteria of the rule. The rules are evaluated in order until the first one is matched, and the request is routed to the server group named by the first rule that was matched. You can change the order of the rules by clicking Modify the sequence. 9. Click OK.
Steps
1. Start IBM Cognos Connection. 2. In the upper-right corner, click Launch, IBM Cognos Administration. 3. On the Status tab, click System. 4. In the upper-left corner of the Scorecard pane, click the arrow to view the Change view menu. Click Services, and then click Report data. 5. Click the arrow next to reportDataService to view the Actions menu, and then click Set properties. 6. Click the Settings tab. 7. In the Value column, click Edit for Gateway mappings. 8. Click the check box Override the settings acquired from the parent entry. 9. Click Add a mapping. 10. For Application gateway (external), type the address of the Web server. 11. For Application gateway (internal), type the address of the Series 7 PowerPlay server. 12. Click OK.
Rename Dispatchers
As a security measure, you can rename dispatchers if you do not want to reveal the host computer name, port number, servlet, or path of the dispatcher (p. 120). Typically, server administrators can view and change the name of dispatchers. We recommend that when renaming a dispatcher, you do not use any information that reveals the host computer name or port, or other system or path information. However, it is important to remember where the dispatcher is installed, for monitoring purposes. Tip: If you rename a dispatcher and need to access the host, port, and path information, you can use the SDK methods to find this information in the dispatcherPath property of the Dispatcher Object. 116
Chapter 7: Server Administration You must have the required permissions to access IBM Cognos Administration functionality. See "Secured Functions and Features" (p. 221).
Steps
1. Start IBM Cognos Connection. 2. In the upper-right corner, click Launch, IBM Cognos Administration. 3. On the Status tab, click System. 4. In the upper-left corner of the Scorecard pane, click the arrow to view the Change view menu. Click All dispatchers. 5. Click the arrow next to the dispatcher to view the Actions menu, and then click Set properties. 6. In the Name box, type the new name for the dispatcher. Use a meaningful name to help you distinguish dispatchers. Do not reveal system information in the name. 7. If you want, add a screen tip and description information. 8. Click OK.
Test Dispatchers
To evaluate how IBM Cognos 8 is performing, you can test the status of dispatchers. You can also ensure that the dispatchers are responding and view the uptime, which is the time in seconds during which the dispatchers are working without failure. You can also view the status of dispatchers and service and review log messages. When you test a dispatcher, you also test the services that belong to that dispatcher. You must have the required permissions to access IBM Cognos Administration(p. 221).
Steps
1. Start IBM Cognos Connection. 2. In the upper-right corner, click Launch, IBM Cognos Administration. 3. On the Status tab, click System. 4. Determine the dispatchers that you want to test then follow the instructions in this table. In the upper-left corner of the Scorecard pane, click the arrow to view the Change view menu and then click the items you want to display.
Goal
Test all dispatchers in system
Action
With all servers displayed, in the upper right corner of the Scorecard pane, click the arrow to view the Toolbar actions menu, and then click Test. Tip: To apply a toolbar action to only some entries, select check boxes for one or more entries and then click the toolbar action that you want.
Test all dispatchers for a server With all server groups displayed, in the upper right corner group of the Scorecard pane, click the arrow to view the Toolbar actions menu, and then click Test dispatchers. Test all dispatchers for a server With all servers displayed, click the arrow next to the server to view the Actions menu, and then click Test. Test a specific dispatcher With all dispatchers displayed, click the arrow next to the dispatcher to view the Actions menu, and then click Test. A dialog box appears and confirms the action. 5. Click OK. If dispatchers are not performing as they should, you can tune server performance by changing their configuration settings (p. 127).
118
Parameter
ConnectionCheckingSleep Time
Purpose
The interval in seconds between scans for the state of dispatchers.
Valid Setting
1 to 2147483647 Settings less than 5 may consume too many resources (CPU time and network bandwidth). 1 to 2147483647
Default
30
ConnectionCheckingQuick SleepTime
The interval in seconds between scans when no operational dispatchers are found.
Settings less than 5 may consume too many resources (CPU time and This parameter must be less network bandwidth). than ConnectionCheckingSleepTime.
Steps
1. Copy the c8_location/cgi-bin/cognoscgi.conf.sample file to c8_location/bin and rename it cognoscgi.conf. 2. Open the cognoscgi.conf file in an editor that can save files in UTF-8 format. 3. Add the following lines to the file:
ConnectionCheckingSleepTime=time in seconds ConnectionCheckingQuickSleepTime=time in seconds
Parameter
pingPeriod
Purpose
Valid Setting
Default
The interval in seconds 1 to 2147483647 180 between scans for the state of Settings less than 5 may condispatchers. sume too many resources (CPU time and network bandwidth).
Parameter
fileCheckPeriod
Purpose
Valid Setting
Default
30
The interval in seconds 1 to 2147483647 between startup configuration file checks for new dispatchers.
Steps
1. Open the Servlet Gateway web.xml file, located either in c8_location/war/gateway/ or in the deployment directory of the servlet, depending on which server you are using, in an editor that supports saving files in UTF-8 format. 2. Change the values for the parameters as required.
<!-- The number of seconds between pings to dispatcher --> <param-name>pingPeriod</param-name> <!-- A non-zero positive integer --> <param-value>180</param-value> </init-param> <init-param> <!-- The number of seconds between checking the startup file for changed dispatchers --> <param-name>fileCheckPeriod</param-name> <!-- A non-zero positive integer --> <param-value>30</param-value> </init-param>
Securing Dispatchers
Users of IBM Cognos 8 can enter XPath search paths in the address field of a Web browser, or in hyperlinks. The users can input any search path syntax against search path parameters in the user interface. IBM Cognos 8 relies on the Content Manager Access Control List to check the objects that are returned to the user. In some cases, malicious users could see the dispatcher name in IBM Cognos Connection by providing a crafted search path. This can pose a security risk, even though the users cannot click the object or perform any actions on the object. To avoid this type of security risk, administrators can: set the advanced parameter CM.SECURITYQUERYREQUIRESREAD to TRUE. For more information, see "Set Advanced Content Manager Parameters" (p. 123). change the default dispatcher name The default dispatcher name is computer_name:9300 and it can be changed to, for example, server1 to mask the port number and host name. For more information, see "Rename Dispatchers" (p. 116). For more information about other security technics used in IBM Cognos Connection, see the Architecture and Deployment Guide. 120
For more information about Content Manager, see the Installation and Configuration Guide. You must have the required permissions to access IBM Cognos Administration functionality (p. 221).
Parameter
CM.DbConnectPoolMax
Purpose
The maximum number of concurrent database connections that are allowed to the content store.
Valid Setting
-1, or 5 to 2147483647, or the database setting, whichever is less This setting applies only to Content Manager connection pool settings. If you have other services that access the same content store, there may be more concurrent database connections than specified in this parameter. -1 to 2147483627
Default
-1 (unlimited)
CM.DbConnectPoolTimeout
Maximum time in milliseconds that a thread waits for a connection to be available from the pool.
-1
A setting of 0 specifies that (unlimited) threads never wait for a connection if one is not available immediately. -1 to 2147483647 300000
CM.DbConnectPoolIdleTime
Minimum time in milliseconds that a connection stays idle in the pool. Only valid if the value of DbConnectPoolCleanUpPeriod setting is positive.
A setting of 0 or -1 specifies 5 min that idle connections are closed when Content Manager restarts.
CM.DbConnectPoolCleanUp Period
Time in milliseconds between -1 to 2147483647 300000 invocations of a cleanup A setting of 0 or -1 specifies 5 min thread that closes idle connec- no clean up thread. tions in the pool that exceed the setting of DbConnectPoolIdleTime.
122
Parameter
Purpose
Valid Setting
Default
CM.CMSync_Negotiation- Time in milliseconds that it takes 1 to 2000 Time to determine the active Content 9223372036854775807 Manager when a failover occurs. CM.CMSync_Negotiation- Time in milliseconds that it takes 1 to 60000 TimeForStartUp to determine the active Content 9223372036854775807 Manager at startup. CM.CMSync_CheckActive Time in milliseconds for an active Time Content Manager to become standby when another Content Manager becomes active. 10000
CM.CMSync_PingTimeout Time in milliseconds that a busy 1 to 120000 Content Manager sends a 9223372036854775807 response if it is running. CM.CMSync_ShortNetwork Time in milliseconds that a short 1 to 3000 InterruptionTime network interruption can occur 9223372036854775807 without causing a failover.
Steps
1. Start IBM Cognos Connection.
Chapter 7: Server Administration 2. In the upper-right corner, click Launch, IBM Cognos Administration. 3. On the Status tab, click System. 4. In the upper-left corner of the Scorecard pane, click the arrow to view the Change view menu. Click Services, and then click Content Manager. 5. Click the arrow next to ContentManagerService to display the Actions menu, and then click Set properties. 6. Click the Settings tab. 7. Click Edit next to Advanced Settings. 8. Select Override the settings acquired from the parent entry. 9. In the Parameter column, enter the parameter name. For example, enter CM.DbConnectPoolCleanUpPeriod. 10. In the Value column, enter the associated value for the setting. 11. Continue entering setting names and values as required. 12. Click OK. 13. On the Set properties page, click OK.
Steps
1. Start IBM Cognos Connection. 2. In the upper-right corner, click Launch, IBM Cognos Administration. 3. On the Status tab, click System. 4. In the upper-left corner of the Scorecard pane, click the arrow to view the Change view menu, and then click Services and click Report. 5. Click the arrow next to ReportService to display the Actions menu and click Set properties. 6. Click the Settings tab. 7. Click Edit next to Advanced Settings. 8. Select Override the settings acquired from the parent entry.
124
Chapter 7: Server Administration 9. In the Parameter column, type RSVP.PROMPTCACHE.LOCALE. 10. In the Value column, enter the associated value for the setting. 11. Click OK. 12. On the Set properties page, click OK.
Chapter 7: Server Administration task, ensure that your credentials contain logon information for each namespace by renewing the credentials after you log on to every namespace that you select to run the content maintenance task against. Tip: Click My Area, My Preferences, click the Personal tab, and then click Renew the credentials. You must have logon permission for each selected external namespace and read permission for all user accounts on each external namespace. If you do not have read permission for a user account on the external namespace, it is assumed that the user was deleted from the namespace. When you run a content maintenance job, the user information on the content store is either listed as inconsistent (for find) or automatically deleted (for find and fix). You must have the required permissions to access IBM Cognos Administration functionality. See "Secured Functions and Features" (p. 221).
7. Click Next. 8. Choose the action that you want: To run the task now or later, click Save and run once and click Finish. Specify a time and date for the run. Click Find only or Find and fix, and then click Run. Review the run time and click OK. To schedule the task at a recurring time, click Save and schedule and click Finish. Then, select frequency and start and end dates. Click Find only or Find and fix and click OK. Tip: To temporarily disable the schedule, select the Disable the schedule check box. To view the schedule status, see "Manage Scheduled Activities" (p. 291).
126
Chapter 7: Server Administration To save the task without scheduling or running, click Save only and click Finish.
Models
Ensure that your models are optimized for reporting. For more information, see the Framework Manager User Guide.
Operating Systems
How IBM Cognos 8 performs is tightly related to the performance of the operating system of the computer where IBM Cognos 8 is installed. Therefore, it is important to ensure that your operating system is tuned.
Tuning Process
Tuning IBM Cognos 8 includes setting server group names for advanced dispatcher routing balancing requests amongst dispatchers (processing capacity) using cluster compatible mode for dispatchers (load balancing) setting usage during peak periods setting the maximum number of processes and connections and affinity settings setting queue time limits setting PDF file character encoding, font embedding, and compression types and levels setting the maximum execution time limiting hotspots that are generated in and Analysis Studio or Report Studio chart setting retention time for watch list output setting compression for email attachments setting the report size limit for the report data service (governor limit)
Steps
1. Start IBM Cognos Connection. 2. In the upper-right corner, click Launch, IBM Cognos Administration. 3. On the Status tab, click System. 4. In the upper-left corner of the Scorecard pane, click the arrow to view the Change view menu. Click All dispatchers. Tip: You can also set the server group property at the system level. 5. Click the arrow for the Actions menu next to the dispatcher and click Set properties. 128
Chapter 7: Server Administration 6. Click the Settings tab. 7. Select Tuning from the Category list. 8. Type a name in the Value column for the Server Group property. 9. Click OK. You can use this server group name when you define routing rules.
Steps
1. Start IBM Cognos Connection. 2. In the upper-right corner, click Launch, IBM Cognos Administration. 3. On the Status tab, click System. 4. Click the arrow for the Actions menu next to System and click Set properties. Tip: You can also change the processing capacity setting at the dispatcher level. 5. Click the Settings tab. 6. Select Tuning from the Category list. 7. In the Value column, type a new value for the Processing capacity, and then click OK. The new value takes effect immediately.
Chapter 7: Server Administration You can set the dispatcher property named loadBalancingMode either to weightedRoundRobin or clusterCompatible. In weightedRoundRobin mode, the dispatcher sprays requests in a weighted round fashion, according to the configuration settings for the dispatcher (p. 129). This is the default mode. In clusterCompatible mode, non-affinity requests are processed locally if possible. If there is no service on the local dispatcher, the request fails. This ensures that IBM Cognos 8 respects any load balancing performed by your own load-balancing infrastructure. You can set the loadBalancingMode property for single dispatchers or for a group of dispatchers in a configuration folder (p. 112). Because it is an inherited property, you can move dispatchers to a configuration folder and set the loadBalancingMode property for the folder to quickly set the property for a group of dispatchers. You must have the required permissions to access IBM Cognos Administration functionality. See "Secured Functions and Features" (p. 221).
Steps
1. Start IBM Cognos Connection. 2. In the upper-right corner, click Launch, IBM Cognos Administration. 3. On the Status tab, click System. 4. Click the arrow for the Actions menu next to System and click Set properties. Tip: You can also change the load balancing setting at the dispatcher level. 5. Click the Settings tab. 6. Select Tuning from the Category list. 7. In the Value column, select the value for the Load Balancing Mode, either Weighted Round Robin or Cluster Compatible, and then click OK. The new value takes effect immediately.
130
Chapter 7: Server Administration You must have the required permissions to access IBM Cognos Administration functionality. See "Secured Functions and Features" (p. 221).
Steps
1. Start IBM Cognos Connection. 2. In the upper-right corner, click Launch, IBM Cognos Administration. 3. On the Status tab, click System. 4. In the upper-left corner of the Scorecard pane, click the arrow to view the Change view menu. Click All dispatchers. 5. Click the arrow for the Actions menu next to the dispatcher and click Set properties. 6. Click the Settings tab. 7. Select Tuning from the Category list. 8. In the Value column, type new values for the following settings: Peak period start hour Non Peak period start hour
Tip: If you want to reset a configuration setting to its default value, select its check box and click Reset to default value. 9. Click OK.
Affinity Connections
In addition, report servers accept low and high affinity connections to process requests from the batch report and report services. Servers also accept low and high affinity connections to process requests from the data movement service. Low affinity requests can be handled by any report server. Typically, low affinity requests are used when a report or data movement run is initially requested. High affinity requests are ideally handled by a specific report server. Typically, high affinity requests are for reports that were already requested and may include actions, such as going to the next page in a report. If the specific report server is not available or busy, then the report is rerun (low affinity request) on any report server and the next page (high affinity request) is directed to that server. Affinity settings take precedence over balance request settings (p. 129) and advanced routing settings (p. 113). If affinity settings are changed for a service while entries are running, the number of server processes could double. The number of processes may temporarily exceed the maximum setting while the change takes effect. This may cause problems if your system does not have enough memory for the interim period. For more information about affinity connections, see the Architecture and Deployment Guide. You can specify the number of low and high affinity connections for the report service, the batch report service, and the data movement service using the following settings: Number of high affinity connections for the<service_name> during peak period Number of high affinity connections for the <service_name> during non-peak period
For batch report service, the default number of low affinity connections is two. For the data movement service and report service, the default number of low affinity connections is four. The default number of high affinity connections for all services is one.
Prerequisites
You must have the required permissions to access IBM Cognos Administration functionality. See "Secured Functions and Features" (p. 221).
Steps
1. Start IBM Cognos Connection. 2. In the upper-right corner, click Launch, IBM Cognos Administration. 132
Chapter 7: Server Administration 3. On the Status tab, click System. 4. In the upper-left corner of the Scorecard pane, click the arrow to view the Change view menu. Click Services and then click the service you want. 5. Click the arrow for the Actions menu next to the service and click Set properties. Tip: For report service and batch report service, you can also set some settings at the system or dispatcher level. 6. Click the Settings tab. 7. Select Tuning from the Category list. 8. In the Value column, type new values for the processes and connections that you want to change. Tip: If you want to reset a configuration setting to its default value, select its check box and click Reset to parent value. 9. Click OK.
Steps
1. Start IBM Cognos Connection. 2. In the upper-right corner, click Launch, IBM Cognos Administration. 3. On the Status tab, click System. 4. Click the arrow for the Actions menu next to System and click Set properties. Tip: You can also change the queue time limit settings at the dispatcher or service level. 5. Click the Settings tab.
Chapter 7: Server Administration 6. Select Tuning from the Category list. 7. In the Value column, type a new value for the Queue time limit of report service (seconds) or Queue time limit of data movement service (seconds) setting. Tip: If you want to reset a configuration setting to its default value, select its check box and click Reset to default value. 8. Click OK.
Value
Windows1252
Purpose
If you know your files contain only Windows1252 characters, use this setting for faster PDF file creation. Any unicode (UTF-16) character without a Windows1252 equivalent is converted to an indeterminate Windows1252 character.
Font
If you know your files contain non-Windows1252 characters (for example, Chinese characters), use this setting for faster PDF generation than with the Auto setting. PDF built-in fonts are all Windows1252 character encoded. Almost all other fonts use the UTF-16 character set. This setting typically creates larger PDF files than the Windows1252 setting. It is possible for UTF-16 encoded files to gain better compression (see "Content Compression Type" (p. 136)).
134
Value
Auto
Purpose
Use this setting to automatically determine if Windows1252 or UTF-16 should be used to encode the text in the document. If large bodies of text must be analyzed, this is the slowest of the three settings. If speed is a concern you may choose to try the other values with various reports to determine the best setting for your environment. This is the default.
Font Embedding
To ensure that the fonts that areused in a report are available to all readers, fonts can be embedded in PDF files. In IBM Cognos Configuration, there are two font embedding lists, one for the report service and one for the batch report service. Fonts can be specified as always embedded or never embedded. For example, fonts that you do not have a legal right to redistribute may be specified as never embedded. Fonts that are not available at your remote sales offices but are required to read PDF reports may be specified as always embedded. For more information about the font embedding lists, see the Installation and Configuration Guide. In IBM Cognos Administration, you can allow or disallow font embedding in report service and batch report service PDF files. You can also choose automatic font embedding. Keep in mind that files with embedded fonts are larger and take more time to generate. Embedding fonts can cause a strain on network resources. Fewer embedded fonts can reduce network resource consumption. The license for some fonts prohibits embedding. Ensure that you have permission from the vendor to embed licensed fonts. The settings names are: Option to allow the report service to embed fonts in generated PDF documents Option to allow the batch report service to embed fonts in generated PDF documents.
There are specialized fonts, such as bar-code fonts, that are always embedded when used. These settings do not control embedding of specialized fonts. PDF built-in fonts are never embedded.
Value
Allow
Purpose
If you know that your audience does not have all the fonts they need to view PDF reports, use this setting. Files are larger and PDF output is generated more slowly. Fonts that are in the never embed list in IBM Cognos Configuration are prevented from being embedded. This is the default.
Value
Disallow
Purpose
If you know that your audience has all the fonts they need to view PDF reports, use this setting. Files are smaller and are generated faster. Fonts are not embedded unless theyre in the always embed list in IBM Cognos Configuraiton.
Auto
Automatically determines which fonts to embed. This setting takes the longest time to generate PDF reports. If the data contains only Windows1252 characters, both the always embed and the never embed list in IBM Cognos Configuration are used. If there is a conflict, the never embed list is used. Except for specialized fonts, unlisted fonts are usually embedded only if UTF-16 characters from that font are used in the file.
The choices for this setting, from lowest to highest compression type, are: Classic, Basic, Improved, Advanced, and Full. Classic is the default. Compression type refers to the amount of data that is compressed within a PDF report. Typically, less compression means faster compression and a larger document. Versions of the Adobe PDF Acrobat Reader earlier than version 6.0 do not support compression types higher than Classic. There are rare cases where compression causes small files to become slightly larger.
136
Chapter 7: Server Administration Valid choices for compression algorithm level are 0 (no compression) to 9 (maximum compression). The default is 9.
Steps
1. Start IBM Cognos Connection. 2. In the upper-right corner, click Launch, IBM Cognos Administration. 3. On the Status tab, click System. 4. In the upper-left corner of the Scorecard pane, click the arrow to view the Change view menu. Click Service, and the service you want. 5. Click the arrow for the Actions menu next to the service and click Set properties. 6. Click the Settings tab. 7. Select Tuning from the Category list. 8. In the Value column, type the value that you want for each of the PDF file settings. Tip: If you want to reset a configuration setting to its default value, select its check box and click Reset to default value. 9. Click OK.
Steps
1. Start IBM Cognos Connection. 2. In the upper-right corner, click Launch, IBM Cognos Administration. 3. On the Status tab, click System. 4. In the upper-left corner of the Scorecard pane, click the arrow to view the Change view menu. Click Services and the service you want. Tip: You can also change the queue time limit settings at the dispatcher or service level.
Chapter 7: Server Administration 5. Click the arrow for the Actions menu next to the service and click Set properties. Tip: You can also set these service settings at the System level. 6. Click the Settings tab. 7. Select Tuning from the Category list. 8. In the Value column, type a new value for the Maximum execution time for the <service_name> (seconds) setting. 9. Click OK.
Steps
1. Start IBM Cognos Connection. 2. In the upper-right corner, click Launch, IBM Cognos Administration. 3. On the Status tab, click System. 4. Click the arrow for the Actions menu next to System and click Set properties. 5. Click the Settings tab. 6. Select Tuning from the Category list.
138
Chapter 7: Server Administration 7. In the Value column, type a new value for the Periodical document version retention age setting and select Day(s) or Month(s) from the drop-down menu. 8. In the Value column, type a new value for the Periodical document version retention count setting. 9. Click OK.
Limit Hotspots That are Generated in an Analysis Studio or Report Studio Chart
A hotspot in a chart appears when you pause a pointer over it. For example, a hotspot on a drilldown symbol or a tooltip gives details about the column, line, or pie slice. The browser response time increases with the number of hotspots. When charts with many members are generated, the hotspots can become an additional burden for the system resources, which can freeze the browser. To improve performance, limit the number of hotspots that are generated for Analysis Studio and Report Studio charts. When you limit the number of hotspots, priority is given to items such as axis labels and legend labels before individual graphical elements such as bars, pie slices, and so on. Depending on the number of items in a chart and the setting for maximum number of hotspots, some axis items may have hotspots while other axis items and all graphical elements do not, or all axis items and some graphical elements may have hotspots while other graphical elements do not. The maximum hotspot setting in Report Studio overrides this setting. For more information, see the Report Studio Professional AuthoringUser Guide. The default is an unlimited number of hotspots.
Steps
1. Start IBM Cognos Connection. 2. In the upper-right corner, click Launch, IBM Cognos Administration. 3. On the Status tab, click System. 4. Click the arrow for the Actions menu next to System and click Set properties. Tip: You can also change the hotspot setting at the dispatcher or service level. 5. Click the Settings tab. 6. Select Tuning from the Category list. 7. Locate the Number of hotspots generated in a chart by the Batch report service or the Number of hotspots generated in a chart by the Report service setting. In the Value column, click the arrow next to Unlimited and then click <Number>. Type a new value for the maximum number of hotspots 8. Click OK.
Steps
1. Start IBM Cognos Connection. 2. In the upper-right corner, click Launch, IBM Cognos Administration. 3. On the Configuration tab, click Dispatcher and Services. 4. Click the dispatcher you want. 5. For DeliveryService, click the set properties button. 6. Click the Settings tab. 7. To filter the settings, in the Category box, click Tuning. 8. Specify a value for the Maximum size of an uncompressed email attachment in MB setting. The following settings that are available.
Goal
Disable compression Compress email attachments if the attachment is greater than n. N is the size of the attachment in MB.
Action
Type 0 (zero). This is the default setting. Type n, where n is the size of the attachment in MB.
9. Click OK. 10. Click the Configuration link in the path at the top of the page. You return to the list of dispatchers. 11. If you have more than one dispatcher configured, perform steps 4 to 10 for each remaining dispatcher. 12. Using IBM Cognos Configuration, stop and then restart IBM Cognos 8. For information about stopping IBM Cognos 8, see the Installation and Configuration Guide.
140
Set the Report Size Limit for the Report Data Service
To limit the resources, such as memory, that are used by Report data service, IBM Cognos 8 restricts the size of the report data that can be sent out. If you receive errors in IBM Cognos 8 Go! Office that a report result is too large, you can increase the size limit for report data by changing the Governor limit setting. The maximum execution time setting (p. 137) has priority over this setting.
Steps
1. Start IBM Cognos Connection. 2. In the upper-right corner, click Launch, IBM Cognos Administration. 3. On the Status tab, click System. 4. In the upper-left corner of the Scorecard pane, click the arrow to view the Change view menu. Click Services, and then click Report Data. 5. Click the arrow next to ReportDataService to view the Actions menu, and then click Set properties. 6. Click the Settings tab. 7. In the Value column, change the number for Governor limit (MB). 8. Click OK.
Chapter 7: Server Administration If the maximum number of query execution helpers is set to 2, the maximum number of data source connections created by the report service is 24 (two low affinity connections plus two high affinity connections plus two query execution helpers times four processes).
The default value for this parameter is 1. This setting has no effect unless RSVP.CONCURRENTQUERY.NUMHELPERSPER PROCESS is set to greater than 0.
RSVP .PROMPT.EFFECTIVEPROMPTINFO.IGNORE
Use this parameter to disable the issuing of effectivePromptInfo attribute in metadata requests and effectively disable moving the prompt information from under the caption attribute of a level to the level itself. The default value for this parameter is false, meaning disabled. You must have the required permissions to access IBM Cognos Administration functionality. See "Secured Functions and Features" (p. 221).
Steps
1. Start IBM Cognos Connection. 2. In the upper-right corner, click Launch, IBM Cognos Administration. 3. On the Status tab, click System.
142
Chapter 7: Server Administration 4. In the upper-left corner of the Scorecard pane, click the arrow to view the Change view menu. Click Services, and then click (All). 5. Click the arrow for the Actions menu next to a Report or Batch report and click Set properties. 6. Click the Settings tab. 7. Click the set properties button 8. Click the Settings tab. 9. Click Edit next to Advanced Settings. 10. Select Override the settings acquired from the parent entry. 11. In the Parameter column, enter a parameter name. 12. In the Value column, enter the setting that you want to use. 13. Click OK. 14. On the Set properties page, click OK. for the report or the batch report service.
Query group
Priority
Queries with the Use for Parameter Info property set to Yes in Report Studio 1 Queries with defined filters that are not used to populate prompt controls First reference to such queries Subsequent references to such queries 2
Query group
Queries with defined filters that are used to populate prompt controls First reference to such queries Subsequent references to such queries
Priority
3
Queries with no defined filters that are not used to populate prompt controls 4 First reference to such queries Subsequent references to such queries 5
Queries with no defined filters that are used to populate prompt controls First reference to such queries Subsequent references to such queries
To specify a system-wide configuration that defines how queries and query groups are processed, you can assign either a setting value or name to the report server advanced setting, RSVP.PROMPT. RECONCILIATION. This allows you to specify the degree of reconciliation between prompt control capabilities and data type to that of the associated parameter. The setting you choose determines whether reconciliation accuracy or speed is more important. For example, if the report author ensures that parameters are defined with the same datatype and capabilities (i.e., optionality, cardinality, and discreteness), across all queries, specifying CHUNKED or 3 would likely achieve the best performance in the widest variety of situations. RSVP.PROMPT.RECONCILIATION.CHUNKSIZE lets you specify chunk size. This setting is applicable when you use CHUNKED GROUPED and CHUNKED. The default chunk size is 5. The report server advanced properties and Report Studio query hints work cooperatively to provide the best performance. You can use the settings shown in the following table to configure RSVP.PROMPT.RECONCILIATION.
Setting
0
Name
COMPLETE
Purpose
All queries are sent at once. This is the slowest, most accurate form of reconciliation. This is the default setting.
GROUPED
Queries are sent by priority group. This setting works best for reports that have many unfiltered queries and few filtered queries. It provides medium speed and high reconciliation accuracy.
144
Setting
2
Name
CHUNKED GROUPED
Purpose
Queries are sent by priority group with a maximum number per request. The queries do not span groups. This setting works best on reports that have many queries with similar filter expressions. It provides maximum speed and low reconciliation accuracy. Queries are sent by priority group with a maximum number per request. The queries can span groups.
CHUNKED
You must have the required permissions to access IBM Cognos Administration functionality. See "Secured Functions and Features" (p. 221).
Steps
1. Start IBM Cognos Connection. 2. In the upper-right corner, click Launch, IBM Cognos Administration. 3. On the Status tab, click System. 4. In the upper-left corner of the Scorecard pane, click the arrow to view the Change view menu. Click Services, and then click (All). 5. Click the arrow for the Actions menu next to a Report or Batch report and click Set properties. 6. Click the Settings tab. 7. Click Edit next to Advanced Settings. 8. Select Override the settings acquired from the parent entry. 9. In the Parameter column, enter a parameter name. 10. In the Value column, enter the setting that you want to use. 11. Click OK. 12. On the Set properties page, click OK.
Chapter 7: Server Administration Because performance may be affected, you may want to leave session caching disabled at the server level in the following situations: users expect up-to-date results directly from the database for every query, for example new records that were added to the database in the interim you want to limit the number of times the cache is accessed during a session
You may also want to leave session caching disabled for individual reports because of high resource consumption, for example, reports that use bursting. You can also enable and disable session caching for specific queries in reports in Report Studio (see the Report Studio Professional Authoring User Guide) and for models in Framework Manager (see the Framework Manager User Guide). Session caching for new models and reports is enabled by default. Existing packages and reports retain existing session caching settings.
146
At run time, the macro used in the above example would add the following comment to the automatically-generated SQL, or native SQL:
/* CC user=Anonymous report=REPORT1 start=2008-08-28T01:59:35.403Z modelPath=/ content/package[@name='New Package']/model[@name='model']reportPath=/content/ package[@name='New Package']/report[@name='REPORT1'] queryName=Query1 REMOTE_ADDR=127.0.0.1 HTTP_HOST=localhost SERVER_NAME=localhost requestID=wq2lshM9jGhqdMj9h92MqlqvdMlhyMlGq9lyG9sq sessionID=010:0d159165-745a11dd-ac9f-b741aeca4631:2789499633 */ select distinct ALL_TIME.CALENDAR_WEEKDAY as CALENDAR_WEEKDAY from EAPPS..EAPPS.ALL_TIME ALL_TIME
Chapter 7: Server Administration Not all information in the generated comment is meaningful in all situations. The request and session ID information provides a link to the auditing facility, perfQFS performance information, and other traces in IBM Cognos 8.4. However, the name of a query in a report and the report itself may be meaningless, for example, when a user is performing an ad-hoc query or analysis as opposed to running a saved query, analysis or report. By default, an anonymous user cannot see all session variables in the generated comments.
4. If you want, you can modify NativeCommentMacro and CognosCommentMacro by specifying the required parameter values and deleting the parameters that you do not need. If you leave a parameter value empty, the parameter will not appear in the generated comment. 5. Save the CQEConfig.xml file. 6. Restart the IBM Cognos 8 service.
A descriptor file with an _descr extension is also saved. Saved files are not managed by IBM Cognos 8.
148
Set File Location to Save a Copy of Report Output Outside of IBM Cognos 8
You can specify that an additional copy of report output be saved in a file system outside of IBM Cognos 8. For example, users may want to share a report with an external application, such as a web site, and have it saved there every time it is updated so that current content is always available. Users may also want to save reports on a Local Area Network for people who do not have access to IBM Cognos 8. In IBM Cognos Connection, if users select Save to the file system as the report delivery method (p. 363) when they run or schedule a report, the files are saved in the specified location each time the report runs. There are two associated properties in IBM Cognos Configuration that must be set first: one enables saving file output to a file system, the other specifies the root directory for saving files. For more information, see the IBM Cognos 8 Installation and Configuration Guide. You must have the required permissions to access IBM Cognos Administration functionality. See "Secured Functions and Features" (p. 221).
Steps
1. Start IBM Cognos Connection. 2. In the upper-right corner, click Launch, IBM Cognos Administration. 3. On the Configuration tab, click Dispatchers and Services. 4. On the toolbar, click the Define File System Locations button 5. Click New. 6. Enter a name, description, and screen tip. 7. In File systems location box, type the location where you want to save report output files. The location that you type is appended to the File system root location. 8. Click Finish. .
Post-processing Scripts
You can also specify a script so that you can run post-processing commands each time a report output is copied to the file system. For example, if your report output files are ultimately stored in an archiving system, you can use a script to perform this action.
Parameters
You can use the parameters that are listed in the following table.
Parameter
CM.OutputLocation
Purpose
The location where you want to store copies of report output files. Old report versions are not deleted when a new one is saved. You must manage the content of the output directory to keep the report versions you want.
CM.OutputScript
The location and name of a shell script, such as a .bat or .sh file, that runs after a report output is saved to the target directory. The full file names of the output file and descriptor are passed to the script. When report output is distributed by bursting, it is assigned a burst key. Specify whether to store output in a subdirectory with the same name as the burst key. Default: false (output not stored by burst key)
CM.OutputByBurstKey
Steps
1. Start IBM Cognos Connection. 2. In the upper-right corner, click Launch, IBM Cognos Administration. 3. On the Status tab, click System. 4. In the upper-left corner of the Scorecard pane, click the arrow to view the Change view menu. Click Services, and then click Content Manager.
150
Chapter 7: Server Administration 5. Click the arrow next to ContentManagerService to display the Actions menu, and then click Set properties. 6. Click the Settings tab. 7. Click Edit next to Advanced Settings. 8. Select Override the settings acquired from the parent entry. 9. In the Parameter column, enter the parameter name. For example, enter CM.OutPutLocation. 10. In the Value column, enter the associated value for the setting. 11. Continue entering setting names and values as required. 12. Click OK. 13. On the Set properties page, click OK.
To enable lineage, you must set up the Lineage capability. For more information, see "Secured Functions and Features" (p. 221), and "Object Capabilities" (p. 229).
Steps
1. In IBM Cognos Connection, click Launch, IBM Cognos Administration. 2. On the Status tab, click System. 3. Click the arrow next to System to display the Actions menu, and then click Set Properties. 4. Click the Settings tab.
Chapter 7: Server Administration 5. For the Environment category, Metadata Information Service URI, type one of the following values. If you want to configure the default IBM Cognos 8 lineage solution, type /lineageUIService. If this value is already specified, click Cancel at the bottom of the page. You do not need to change anything. If you want to configure IBM Metadata Workbench as your lineage solution, type /lineageUIService?iis=http://workbench_server_name:9080/workbench/autoLoad.do where http://workbench_server_name:9080/workbench/autoLoad.do is the URL where IBM Metadata Workbench can be accessed on the network. workbench_server_name represents the server name where IBM Metadata Workbench is installed. If you want to configure a custom lineage solution, replace the existing value with the URI that represents your lineage Web interface. For example, type http://mycompany.com/ourLineageService.cgi 6. Click OK.
Steps
1. In IBM Cognos Connection, click Launch, IBM Cognos Administration. 2. On the Status tab, click System. 3. Click the arrow next to System to display the Actions menu, and then click Set Properties. 4. Click the Settings tab. 5. For the Environment category, IBM Business Glossary URI, type the following URI: http://server_name:port_number/bg/popup/popupSearch.do For example, type http://myserver:9080/bg/popup/popupSearch.do All terms that contain the keyword specified in the search are returned.
152
For more information about these metrics, see "System Performance Metrics" (p. 91). Note that enabling these settings may affect performance. You must have the required permissions to access IBM Cognos Administration functionality. See "Secured Functions and Features" (p. 221).
Steps
1. Start IBM Cognos Connection. 2. In the upper-right corner, click Launch, IBM Cognos Administration. 3. On the Status tab, click System. 4. Click the arrow next to System to display the Actions menu, and then click Set Properties. 5. Click the Settings tab. 6. For the Environment category, next to Advanced settings, click the Edit link. 7. If it appears, select the Override the settings acquired from the parent entry check box. Otherwise, proceed to the next step. 8. In the Parameter column, type the following settings: enable.tide.metrics.smtpqueue, enable. tide.metrics.jobqueue, and enable.tide.metrics.taskqueue. 9. Beside each parameter, in the Value column, type True to enable the metric. 10. Click OK. 11. Open the c8_location/webapps/p2pd/WEB-INF/classes/iManage-metadata.xml file in a n editor. Ensure that your editor supports saving files in UTF-8 format. 12. Uncomment the sections that begin with <!-- These metrics have been explicitly
disabled. Please consult documentation on how to enable them. -->
Chapter 7: Server Administration 13. Save the file. 14. Using IBM Cognos Configuration, stop and then restart IBM Cognos 8. For information about stopping IBM Cognos 8, see the Installation and Configuration Guide.
154
A data source defines the physical connection to a database. The data source connection (p. 180) specifies the parameters needed to connect to the database, such as the location of the database and the timeout duration. A connection can include credential information and signons (p. 186). You can also add new connections to data source and modify existing connections (p. 183). You can make more than one data source connection available by combining them, along with other elements, in packages created and published using Framework Manager. When more than one data source is available in a package, users are prompted to select a data source connection and a signon when they run a report. For information about creating and publishing packages, see the Framework Manager User Guide. You can secure data sources using IBM Cognos 8 security. IBM Cognos 8 also respects any security that is defined within the data source (p. 195). You move data sources from one environment to another environment by deploying the entire content store (p. 307).
DB2
IBM Cognos 8 supports DB2 data sources. DB2 connection types can be used to connect to DB2 Linux/UNIX/Windows, Db2 zOS, and DB2 i5OS.
Parameter
Description
DB2 database name Enter the name (alias) of the DB2 database that was used when the DB2 client was configured. DB2 connect string Optional. Enter name/name value pairs that DB2 or ODBC vendors can accept. Enter the collation sequence to be included in the database connection string. Collation sequences are required only in rare cases where there may be sorting discrepancies between IBM Cognos 8 and a database. We recommend that you contact customer support before using a collation sequence. Open asynchronously Trusted context Select this check box to allow IBM Cognos 8 to attempt a trusted connection to an appropriately configured DB2 server. For more information, refer to the DBA/DB2 documentation. If you select this check box with a client or server that does not support the feature, you may get a connection error or a report execution error. Timeouts Specify the time in seconds within which you want the database to connect or wait for your reply before timing out. Valid entries are zero to 32,767. To have the database wait indefinitely, enter zero, which is the default. Not used.
Collation sequence
156
Parameter
Signon
Description
For more information on signon, see "Securing Data Sources" (p. 195). If no authentication is required, click No authentication. If authentication is required, click Signons. If a user ID and password is required in the connection string, select the User ID check box. If a password is required, select the Password check box and enter the password in the Password and Confirm password boxes. To create a user ID and password that automatically connects to the data source, click Create a signon that the Everyone group can use. Enter the User ID and then enter the password in the Password and Confirm password boxes.
If you have problems creating data source connections to Cognos cubes, see the Troubleshooting section in this document. For information about integrating IBM Cognos Finance multidimensional cubes in your IBM Cognos 8 environment, see the IBM Cognos Finance User Guide. For information about connecting to the IBM Cognos Planning - Contributor unpublished (real-time) data, see the IBM Cognos Planning Installation Guide.
Parameter
Server name Port number
Description
Enter the name of the IBM Cognos Finance server. Enter the port number of the IBM Cognos Finance server. Use the port number that is specified on the IBM Cognos Finance Server Configuration page. The default is 8800. Select the namespace to use for authentication.
Signon
Parameter
Server name Port number IBM Cognos Now! connection string:
Description
Enter the name of the server. Enter 80 as the port number. Enter /cognos/now/RelXMLAProvider.jsp
158
Chapter 8: Data Sources and Connections Using Framework Manager, you can determine how many cubes to expose in a package. By default, you get one cube in each package. However, this may result in a large number of packages in Cognos Connection, which could be difficult to manage. For more information, refer to the Framework Manager User Guide.
Parameter
Description
Parameter
Server name
Description
Enter the name of the server.
Planning Administra- If the cube was created using IBM Cognos Planning - Contributor version tion Domain (PAD 7.3, indicate the Planning Administration Domain (PAD ID). ID) Port number Enter the port number. The default is 8800.
Chapter 8: Data Sources and Connections You cannot build cubes on Linux or HPUX Itanium if you are using Impromptu Query Definition (.iqd) files as data sources because the Series 7 IQD Bridge is not supported on those platforms. After a connection to a PowerCube is created, you can: create a package for a PowerCube (p. 162) deploy updated PowerCubes (p. 163)
For more information about PowerCubes, see the Transformer User Guide.
Securing PowerCubes
PowerCubes supported by IBM Cognos 8 can be secured using IBM Cognos 8 security namespaces. Security can be applied to an entire cube or to its custom views. Before accessing a cube secured against an IBM Cognos 8 namespace, you must log on to the applicable namespace. In production environments, IBM Cognos 8 supports only PowerCubes secured against a single namespace. Therefore, when you deploy PowerCubes for use in a production environment, you must select the signon option Restrict PowerCube authentication to a single namespace. Note: Instead of using IBM Cognos 8 security, you can add password protection to a PowerCube or decide not to use security.
160
Parameter
Read cache size
Description
The default value for this parameter is 80 MB. You can set this parameter to a value between 1 MB and 1 GB, as required for optimal query performance. The optimal read cache size may be higher or lower than the default value of 80 MB. This is to be expected, as PowerCubes in production vary widely in type and query characteristics. Note that the read cache size has no effect on the initial time required to open a cube. The typical profile for query performance, or processing time, follows a pattern whereby performance increases with the read cache size and then levels off beyond the optimal setting. To determine the optimal setting, we recommend that you lower the default by 10 MB (or 5 MB, or 1 MB, depending on the level of fine tuning desired) and use the resulting query performance results as a guide for establishing whether further reductions, or increases, are required. The optimal read cache size will change as the cube grows and changes in the production environment. As a result, you should review the optimal read cache size when changes to the users query performance pattern, or changes in the PowerCube characteristics, occur.
Location
If all your report servers are installed on Windows computers, specify the Windows location. If all report servers are installed on UNIX computers, specify the Unix or Linux location. Type the full path and file name for the cube. For example, for a local cube type C:\cubes\Great Outdoors Company.mdc. For a network cube type \\servername\cubes\Great Outdoors Company.mdc For cubes that reside on UNIX computers, specify the correct UNIX location and type any characters in the Windows location because the Windows location cannot be empty. If the report servers are installed on Windows and UNIX computers, and you want the report server running a request to access the PowerCube in both environments, specify the Windows and UNIX locations. To ensure that the same data is returned regardless of the environment in which the report server accesses the cube, the same cube file must be saved in both locations.
Parameter
Signon
Description
If you are using IBM Cognos 8 security, click Restrict PowerCube authentication to a single namespace, and select a namespace from the list. If you are connecting to a password-protected PowerCube, click Cube password, and type the password in the Password and Confirm password boxes. Select All applicable namespaces (including unsecured PowerCubes) only if you are migrating Series 7 PowerCubes to IBM Cognos 8 in your development or test environment. This setting can also be used for unsecured PowerCubes in a production environment. For more information, see "Securing PowerCubes" (p. 160). If a cube password is required, click Cube password, then enter the password in the Password and Confirm password boxes. To create a user ID and password that automatically connects to the data source, click Create a a signon that the Everyone group can use. For more information, see "Securing Data Sources" (p. 195).
Steps
1. In IBM Cognos Connection, in the upper-right corner, click Launch, IBM Cognos Administration. 2. On the Configuration tab, click Data Source Connections. 3. Click More beside the data source with which you want to create a package. 4. Click Create a Package. The New Package Wizard appears. 5. Enter a name for the package, and click Next. 6. Select the null-suppression options you want to make available to the IBM Cognos 8 studio user. 162 Allow Null Suppression enables suppression.
Chapter 8: Data Sources and Connections Allow Multi-Edge Suppression allows the studio user to suppress values on more than one edge. Allow Access to Suppression Options allows the studio user to choose which types of values will be suppressed, such as zeros or missing values. By default, all null values are suppressed when suppression is enabled.
7. Click Finish.
For example, copy the PowerCube to "D:\Cubes\production\production.mdc". 2. At the command line prompt, type the pcativate command using the following syntax:
pcactivate cube_name.mdc destination_location destination_location
You can type more than one destination location. For example, type pcactivate TheCube.mdc d:\deploy\cubes pcactivate production.mdc D:\Cubes
Chapter 8: Data Sources and Connections pcactivate sales.mdc \\server_1\cubes \\server_2\cubes pcactivate "Production Cube.mdc" "d:\Program Files\cognos\c8\webcontent\cubes"
Note: If you include a path in the cube_name parameter, the path is removed and ignored.
Authentication
When a Hyperion Essbase System 9 Data Source is configured with an LDAP namespace, single signon is supported. The user ID and password used to log on to the LDAP namespace automatically connects to the data source. For more information about configuring an LDAP namespace for IBM DB2 OLAP and Hyperion Essbase Data Sources, see the IBM Cognos 8 Installation and Configuration Guide.
Connection Parameters
You specify connection parameters when you create a data source (p. 180) or modify a data source connection (p. 183).
Parameter
Server name
Description
Enter the name of the server where the database is located. For UNIX, this can be the TCP/IP address of the server.
164
Parameter
Signon
Description
For more information on signon, see "Securing Data Sources" (p. 195). If no authentication is required, click No authentication. For Essbase Server System 9 and IBM Cognos 8.4, single signon is supported if your Essbase server is configured for an LDAP namespace. Select An external namespace and select LDAP from the list. The user ID and password used to log on to the LDAP namespace automatically connects to the data source.
If a user ID and password is required in the connection string, click Signons. If a password is required, select the Password check box and enter the password in the Password and Confirm password boxes. To create a user ID and password that automatically connects to the data source, click Create a a signon that the Everyone group can use. Enter the User ID and then enter the password in the Password and Confirm password boxes.
Step
In the Hyperion Solutions Essbase Administration Services tool, assign a User Defined Attribute (UDA) named COGNOS_SCENARIO_DIMENSION to the scenario dimension.
Steps
1. In the Hyperion Solutions Essbase Administration Services tool, create a special User Defined Attribute (UDA) named COGNOS_HIERARCHY_BALANCED in the outline of the Essbase/DB2 OLAP database. The UDA is created for the root member of the corresponding dimension containing a balanced hierarchy.
The format_string value can be any one of the predefined number formats listed in the table below. You can use a preset numeric format to show values as millions (M) or thousands (K). For example, 1,801,791 can be shown as 1.8M or 1,801.8K. The predefined format strings are as follows:
Format Option
General 0 #,##0 $0 $#,##0 0% %0 0E+000 0K #,##0K K0 K#,##0 $0K $#,##0K 0M #,##0M
Sample Value
1000000 1000000 1000000 1000000 1000000 1000000 1000000 1000000 1000000 1000000 1000000 1000000 1000000 1000000 1000000000 1000000000
Example
1000000 1000000 1,000,000 $1000000 $1,000,000 100000000% %100000000 1E+006 1000K 1,000K K1000 K1,000 $1000K $1,000K 1000M 1,000M
166
Format Option
M0 M#,##0 $0M $#,##0M
Sample Value
1000000000 1000000000 1000000000 1000000000
Example
M1000 M1,000 $1000M $1,000M
With the exception of the General format string, you can also preset the number of decimal places to show, using the format_string ~n, where n is the number of decimal places. For example, 1,801,791 can be shown as $1,801,791.00 using the format string $#,##0~2. If you do not want any decimal places, end the format string with ~0. If your client application uses a different locale, you must replace the Currency ($), Thousands (,) and Decimal (.) symbols in the format_string value for the COGNOS_FORMAT UDA with the corresponding locale symbols in effect for the client application. If you do not specify the number of decimal places to show, or if the format string does not match one of the predefined values (including locale symbols), the General format string is used by default. You can apply a different format for each measure. The following illustrates some examples of how you can apply different formatting to different measures:
Measure
Measures (Account dimension) Units Costs Profits
Applied Format
COGNOS_FORMAT=#,##0 COGNOS_FORMAT=#,##K COGNOS_FORMAT=$#,### COGNOS_FORMAT=0%
Steps
1. In IBM Cognos Connection, in the upper-right corner, click Launch, IBM Cognos Administration. 2. On the Configuration tab, click Data Source Connections.
Chapter 8: Data Sources and Connections 3. Click More beside the data source with which you want to create a package. 4. Click Create a Package. The New Package Wizard appears. 5. Enter a name for the package and click Next. 6. Select a catalogue and click Next. 7. Select a cube and click Next. 8. Assign a language specific alias table and click Next. 9. Choose a language for the alias table and click Next. 10. Choose how to present model attributes. Select Separate the Dimensions or Properties of the dimension they are associated with. The default selection is Properties of the dimension they are associated with. 11. Click Finish.
Parameter
Server URL
Description
Enter the URL of the server in the format http://<hostname>:<cube server xmla port>/IBMXmlAnalysis/ or https://<hostname>:<cube server xmla port>/IBMXmlAnalysis/. An example of the <hostname>:<cube server xmla port> is wottcub1:80.
To use secure sockets, select this check box. To use unsecure sockets, do not select it. The setting must be the same as the setting on the server.
Signon
If a user ID and password is required in the connection string, select the User ID check box. If a password is required, select the Password check box and enter the password in the Password and Confirm password boxes.
168
Parameter
Informix database name Host name Server name Collation sequence
Description
Enter the database name.
Enter the host name. Enter the server name. Enter the collation sequence to be included in the database connection string. Collation sequences are required only in rare cases where there may be sorting discrepancies between IBM Cognos 8 and a database. We recommend that you contact customer support before using a collation sequence.
Service
Select or enter the service name that the remote database server uses for incoming requests. For more information on signon, see "Securing Data Sources" (p. 195). If a user ID or password are required in the connection string, select the User ID check box. If a password is required, select the Password check box and enter the password in the Password and Confirm password boxes. To create a user ID and password that automatically connects to the data source, select Create a a signon that the Everyone group can use. Enter the User ID and then enter the password in the Password and Confirm password boxes.
Signon
Chapter 8: Data Sources and Connections The domain account should be added in local security settings in your Windows operating system administration tools. Note: You must restart your server after changing this property. The domain account should be a member of the OLAP Administrators group on the Microsoft Analysis Services computer. The OLE database for OLAP (ODBO) client must be installed. This is included in the Microsoft Analysis Services installation files.
For more information about installation options for the gateway and Content Manager, as well as configuring the namespace and delegating trust, see the IBM Cognos 8 Installation and Configuration Guide.
Microsoft Analysis Services (via ODBO) and Microsoft Analysis Services 2005 Connection Parameters
You specify connection parameters when you create a data source (p. 180) or modify a data source connection (p. 183).
Parameter
Server Name
Description
Enter the server name where the databases are located.
170
Parameter
Named instance
Description
Enter the named instance if one was specified during installation. This parameter is used only by Microsoft Analysis Services 2005.
Language
Select the language. This locale is used as a design locale by the report author and is used only for retrieving metadat from the cube to display in reports. Once the reports are created, they can be run in any locale.
Signon
For more information on signon, see "Securing Data Sources" (p. 195). Select IBM Cognos 8 service credentials to authenticate using a domain account. To use service credentials, ensure that IBM Cognos 8 is started as a service and that the service uses a valid domain account. The service account should be added to the local OLAP administrator group on the machine that runs Microsoft Analysis Services (MSAS). To use an external namespace, select An external namespace and select the Active Directory namespace. To create a user ID and password that automatically connects to the data source, select Create a a signon that the Everyone group can use. Enter the User ID and then enter the password in the Password and Confirm password boxes.
For more information about installation options for the gateway and Content Manager, as well as configuring the namespace and delegating trust, see the IBM Cognos 8 Installation and Configuration Guide.
Microsoft SQL Server and Microsoft SQL Server (SQL 2005 Native Client) Connection Parameters
The following parameters are used by Microsoft SQL Server (OLE DB).
Parameter
Server name Database Name Application Name Collation Sequence
Description
Enter the server name. Enter the database name. Enter the application name. Enter the collation sequence to be included in the database connection string. Collation sequences are required only in rare cases where there may be sorting discrepancies between IBM Cognos 8 and a database. We recommend that you contact customer support before using a collation sequence.
172
Parameter
MARS Connection
Description
Select the Multiple Active Results Set (MARS) connection. This parameter is used only by Microsoft SQL Server (SQL 2005 Native Client). Click Yes to allow applications to have more than one pending request per connection and more than one active default result set per connection.
Signon
For more information on signon, see "Securing Data Sources" (p. 195). If no authentication is required, select No authentication. For more information on IBM Cognos 8, see "Authentication Using IBM Cognos 8 Service Credentials" (p. 171). If you use a Microsoft Active Directory namespace and you want to support single signon, select An external namespace, and select the Active Directory namespace. For more information, see "Authentication Using an External Namespace" (p. 172). If authentication is required, select Signons. If a user ID and password is required in the connection string, select the User ID check box. If a password is required, select the Password check box and enter the password in the Password and Confirm password boxes.
You can include database commands in the connection information for this type of data source. For more information, see "Using Database Commands for Oracle, DB2, and Microsoft SQL Server" (p. 190). For information about Microsoft SQL Server (ODBC) connection parameters, see "ODBC Data Sources" (p. 173).
IBM Cognos 8 supports the ODBC data sources listed in the following table. The database code appears in the connection string, but can not be edited.
Database code
CS Administration and Security Guide 173
Database code
VM SS PG RB TD
Any ODBC data source not listed should be created using the generic ODBC data source, database code OD.
Parameter
ODBC data source
Description
Enter the data source name (DSN) as defined in the ODBC.ini file. For more information about the ODBC.ini file, see the IBM Cognos 8 Installation and Configuration Guide.
Enter any text that must be appended to the connection string. This parameter is typically left blank.
Collation sequence
Enter the collation sequence to be included in the database connection string. Collation sequences are required only in rare cases where there may be sorting discrepancies between IBM Cognos 8 and a database. We recommend that you contact customer support before using a collation sequence.
174
Parameter
Open asynchronously
Description
Select if you want the connection to process requests independent of each other. Do not select if you want the connection to complete the current request before starting another one. Select if you want IBM Cognos 8 to the Unicode data standard to interpret data. Leave it unselected if you want IBM Cognos 8 to use ANSI to interpret data. This selection applies only to Composite, Virtual View Manager, Progress OpenEdge, Teradata, and generic ODBC data source connections.
Unicode ODBC
Timeouts
Specify the time in seconds within which you want the database to connect or wait for your reply before timing out. Valid entries are zero to 32,767. To have the database have wait indefinitely, enter zero, which is the default.
Signon
For more information on signon, see "Securing Data Sources" (p. 195). For Teradata, Composite, Virtual View Manager, and Microsoft SQL: If no authentication is required, select No authentication. If the credentials to the database match the credentials used to logon to the IBM Cognos 8 environment, for single signon, select An external namespace and select the appropriate namespace. If authentication is required, select Signons. If a password is required, select the Password check box and enter the password in the Password and Confirm password boxes. To create a user ID and password that automatically connects to the data source, select Create a a signon that the Everyone group can use. Enter the User ID and then enter the password in the Password and Confirm password boxes. For generic ODBC, RedBrick, and Progress OpenEdge: If a user ID and password are required in the connection string, select the User ID check box, then select the Password check box and enter the password in the Password and Confirm password boxes. To create a user ID and password that automatically connects to the data source, select Create a a signon that the Everyone group can use. Enter the User ID and then enter the password in the Password and Confirm password boxes.
Parameter
SQL*Net connect string Collation sequence
Description
Enter the SQL*Net connect string.
Enter the collation sequence to be included in the database connection string. Collation sequences are required only in rare cases where there may be sorting discrepancies between IBM Cognos 8 and a database. We recommend that you contact customer support before using a collation sequence.
Signon
For more information on signon, see "Securing Data Sources" (p. 195). If a user ID or password are required in the connection string, select the User ID check box. If a password is required, select the Password check box and enter the password in the Password and Confirm password boxes. To create a user ID and password that automatically connects to the data source, select Create a a signon that the Everyone group can use. Enter the User ID and then enter the password in the Password and Confirm password boxes.
Parameter
SAP logon type
Description
Select the logon type. The parameters change depending on the logon type you select.
176
Parameter
Application server
Description
For SAP logon type Application server, enter the SAP application server name. For more information, contact your SAP system administrator.
System number
For SAP logon type Application server, enter the system number. For more information, contact your SAP system administrator.
Client number
For SAP logon type Application server, enter the client number. For more information, contact your SAP system administrator.
SAP server code page For SAP logon type Application server, select the SAP server code page. IBM Cognos 8 follows the SAP internationalization rules, providing a compatible application that supports multiple scripts and languages without modifying SAP BW in IBM Cognos 8. For more information, contact your SAP system administrator. SAP router string For SAP logon type Application server, enter the SAP router string. The router string describes the stations of a connection required between two hosts. For more information, contact your SAP system administrator. Destination For SAP logon type Destination, enter the location of the SAPRFC.ini file that is used to connect to the SAP BW server. For more information, contact your SAP system administrator. Client number For SAP logon types Destination and Message server, enter the client number. For more information, contact your SAP system administrator. SAP server code page For SAP logon types Destination and Message server, select the SAP server code page. IBM Cognos 8 follows the SAP internationalization rules, providing a compatible application that supports multiple scripts and languages without modifying SAP BW in IBM Cognos 8. To obtain the correct SAP server code page, contact your SAP system administrator. Message server For SAP logon type Message server, enter the SAP message server. For more information, contact your SAP system administrator.
Parameter
System ID
Description
For SAP logon type Message server, enter the system ID of the SAP system that you want to connect to. For more information, contact your SAP system administrator.
Logon Group
For SAP logon type Message server, enter the SAP group. For more information, contact your SAP system administrator.
Client number
For SAP logon type Message server, enter the client number. For more information, contact your SAP system administrator.
Signon
For more information on signon, see "Securing Data Sources" (p. 195). If a trusted signon namespace is configured using IBM Cognos Configuration, you can select An external namespace and select the namespace you want to use. To create a user ID and password that automatically connects to the data source, select Create a a signon that the Everyone group can use. Enter the User ID and then enter the password in the Password and Confirm password boxes.
Authentication
Your choice must meet the TM1 server authentication requirement. For example, if you do not create a user ID and password, but the TM1 server requires a log on, the user is prompted to log on. You can use an external namespace (third-party directory service provider) as an authentication method. The TM1 server must be configured to authenticate with IBM Cognos 8. For more information, see your TM1 documentation on Cognos Access Manager Authentication.
TM1Connection Parameters
You specify connection parameters when you create a data source (p. 180) or modify a data source connection (p. 183).
178
Parameter
Administration Host
Description
Enter the name of a machine that can be identified by the network. For example, sottolapsrv1.ent.ad.cognos.com Enter the server name as configured in the TM1S.cfg file. For more information, see your TM1 documentation. For more information on signon, see "Securing Data Sources" (p. 195). If no authentication is required, select No authentication. If an external namespace is used, select An external namespace and then select the namespace. If authentication is required, select Signons. If a user ID is required in the connection string, select the User ID check box. If a password is required, select the Password check box and enter the password in the Password and Confirm password boxes. To create a user ID and password that automatically connects to the data source, select Create a a signon that the Everyone group can use. Enter the User ID and then enter the password in the Password and Confirm password boxes.
Server Name
Signon
Chapter 8: Data Sources and Connections The text of this code is not case sensitive.
Parameter
Connection string
Description
Enter the connection string.
180
Chapter 8: Data Sources and Connections If you are an administrator, you can set up all required data sources before models are created in Framework Manager so that all connections are available in the Framework Manager Metadata wizard. Data sources are stored in the Cognos namespace and must have unique names. For example, you cannot use the same name for a data source and a group. You can include authentication information for the database in the data source connection by creating a signon (p. 186). Users need not enter database authentication information each time the connection is used because the authentication information is encrypted and stored on the server. The signon produced when you create a data source is available to the Everyone group. Later, you can modify who can use the signon or create more signons. For more information about data source security, see "Securing Data Sources" (p. 195). Before creating data sources, you must have write permissions to the folder where you want to save the data source and to the Cognos namespace. You must also have execute permissions for the Data Source Connections secured feature.
Steps
1. In IBM Cognos Connection, in the upper-right corner, select Launch, IBM Cognos Administration. 2. On the Configuration tab, select Data Source Connections. Tip: To remove a data source, select the check box for the data source and select the delete button. Administration and Security Guide 181
4. In the name and description page, type a unique name for the data source and, optionally, a description and screen tip, and then select Next. 5. In the connection page, from the Type drop-down list, select the type of data source that you want to create. If your data source is not listed, click Other type. 6. Specify the Isolation level. If the isolation level is unavailable, select Next. If the isolation level is available, select the default object gateway or specify a value, and then select Next. 7. Specify the connection parameters for the data source. For information about connection parameters for the type of data source that you are using, click the associated item in the following list: IBM Cognos Finance IBM Cognos Now! Cube IBM Cognos Planning - Contributor IBM Cognos Planning - Series 7 IBM Cognos PowerCube Composite (ODBC) IBM Cognos Virtual View Manager (ODBC) DB2 Hyperion Essbase/IBM DB2 OLAP Server IBM InfoSphere Warehouse Cubing Services Informix Microsoft SQL Server (ODBC) Microsoft SQL Server (OLE DB) Microsoft SQL Server (SQL 2005 Native Client) Microsoft Analysis Services (via ODBO) Microsoft Analysis Services 2005 ODBC Oracle
182
Chapter 8: Data Sources and Connections Progress OpenEdge Red Brick (ODBC) SAP BW Teradata (ODBC) TM1 XML
8. Select Test the connection, and then Test to test whether parameters are correct. In the Status column, you can see if the connection was successful. If it was unsuccessful, select Close, return to the previous steps, and verify your connection parameters. If it was successful, go to the next step. 9. Click Finish. If you selected a data source other than IBM Cognos PowerCube, the new data source appears in Data Source Connections on the Configuration tab, and can be selected when using the Metadata Wizard in Framework Manager. If you selected IBM Cognos PowerCube, go to the next step. 10. Click OK to return to Data Source Connections, or click Create a Package and OK, and follow the instructions in the new package wizard. Note: You can create a package with your new data source now or later. For more information, see Create a Package for a PowerCube Data Source. If you created a signon, you can now modify or add more signons (p. 186). You can also add more connections (p. 183).
Chapter 8: Data Sources and Connections If you are creating an Oracle, DB2, or Microsoft SQL Server data source, you can include database commands in the connection information. For more information, see "Using Database Commands for Oracle, DB2, and Microsoft SQL Server" (p. 190). If you select Microsoft Analysis Services 2005 as the connection type, you can have more than one instance on the same server. For information about setting the maximum number of data source connections available to the report server, see "Manage Data Source Connections" (p. 184).
5. In the name and description page, type a unique name for the connection and, optionally, a description and screen tip, and then click Next. 6. Proceed with steps 5 to 10 for creating a data source. If you created a signon, you can now modify or add more signons (p. 186).
184
Chapter 8: Data Sources and Connections until they are idle for a timeout period and then are closed. Once a pool is full, no further connection are added. This results in a request failure.
PoolSize
Set the maximum number of data source connections available to the report server by modifying the PoolSize variable.
Timeout
Set the duration for retaining connections by modifying the Timeout variable. Connections are examined once per minute and any connection that has been inactive longer than the timeout value is removed. The default timeout value is 900 seconds.
Steps
1. On each computer where IBM Cognos 8 is installed, open the c8_location/configuration/ CQEConfig.xml.sample file in a text editor. Ensure that your editor supports saving files in UTF-8 format. 2. Find the Timeout and PoolSize parameter and edit them as follows:
<?xml version="1.0" encoding="UTF-8"?> <configuration company="Cognos" version="#.#" rendition="###"> <component name="CQE"> <section name="DBConnectionPool"> <!-- Description: Database connection timeout. Default is 900 seconds (15minutes) --> <entry name="Timeout" value="number_of_seconds"/> <!-- --> <!-- Description: Database connection pool size. --> <!-- Maximum number of connections managed by the report server. Default=50 --> <entry name="PoolSize" value="number_of_connections"/> </section> </component> </configuration>
3. Save the file as CQEConfig.xml to the c8_location/configuration directory. 4. Using IBM Cognos Configuration, stop and then restart the services.
Chapter 8: Data Sources and Connections For information about stopping services, see the IBM Cognos 8 Installation and Configuration Guide.
5. In the name and description page, type a unique name for the data source signon and, if you want, a description and screen tip, and then click Next. 6. Type the User ID and Password to connect to the database, and click Next. The Select the users page appears. 7. To add users and groups that can use the signon, and click Add. To choose from listed entries, click the appropriate namespace, and then select the check boxes next to the users, groups, or roles. To search for entries, click Search and in the Search string box, type the phrase you want to search for. For search options, click Edit. Find and click the entry you want. To type the name of entries you want to add, click Type and type the names of groups, roles, or users using the following format, where a semicolon (;) separates each entry: namespace/group_name;namespace/role_name;namespace/user_name; Here is an example: Cognos/Authors;LDAP/scarter; 8. Click the right-arrow button and when the entries you want appear in the Selected entries box, click OK.
186
Chapter 8: Data Sources and Connections Tips: To remove entries from the Selected entries list, select them and click Remove. To select all entries in a list, click the check box in the upper-left corner of the list. To make the user entries visible, click Show users in the list. 9. Click Finish. The new data source signon appears under the connection.
Database type
Oracle DB2 MS SQL Server Sybase Adaptive Server Enterprise Informix
Read Committed A transaction can access only rows committed by other transactions.
Database type
Oracle DB2 MS SQL Server Sybase Adaptive Server Enterprise Informix
Cursor Stability Other transactions cannot update the row in which a transaction is positioned.
188
Database type
Oracle DB2 MS SQL Server Sybase Adaptive Server Enterprise Informix
Reproducible Read Rows selected or updated by a transaction cannot be changed by another transaction until the transaction is complete.
Database type
Oracle
Phantom Protection A transaction cannot access rows inserted or deleted since the start of the transaction.
Database type
Oracle DB2 MS SQL Server Sybase Adaptive Server Enterprise Informix
Chapter 8: Data Sources and Connections Serializable A set of transactions executed concurrently produces the same result as if they were performed sequentially.
Database Type
Oracle DB2 MS SQL Server Sybase Adaptive Server Enterprise Informix
Using Database Commands for Oracle, DB2, and Microsoft SQL Server
Use the connection wizard to specify database commands that run when an Oracle connection or session is opened or closed, or when a DB2 or Microsoft SQL Server session is opened. For example, you can use a database command to set the language when you open a connection to an Oracle database, or to set up proxy connections (p. 193) or virtual private databases (p. 194). For Oracle (OR), DB2 (D2), Microsoft SQL Server (SS), and Teradata (TD), you can use commands to run native SQL commands when you open a session, such as running a stored procedure. Database commands are included in command blocks which are formatted using XML.
Notes:
You cannot test the command blocks using the Test the connection link on the connection string page. If you have SDK installed, you can ensure that your XML code validates against the schema file named c8_location/webapps/p2pd/WEB-INF/classes/DataSource.xsd The command structure is the same for Oracle, DB2, and Microsoft SQL Server. However, the specific database commands can vary depending on which database you are using. For example, the above examples are Oracle commands. The commands in the blocks are vendor-specific and must be included in an <sqlCommand> tag, as used in the examples above.
190
Chapter 8: Data Sources and Connections issued. The associated Open Connection block is only executed once when the trusted connection is attempted, while Open Session blocks may execute many times for different users.
Steps
1. Create a data source, choosing Oracle, DB2, or Microsoft SQL Server as the data source type. 2. Click Next. 3. In the specify commands page, click Set next to the command string that you want to specify. 4. In the set command page, add an XML command block, and click OK. Note: If you are using DB2 or Microsoft SQL Server, you can only add commands block for opening a session. 5. Continue adding command blocks, as required. 6. Click Finish.
Chapter 8: Data Sources and Connections You can change a command block for a specific connection, and you can remove the command block if you do not want it used for the connection.
Steps
1. Create a connection or modify a connection (p. 184), choosing Oracle, DB2, or Microsoft SQL Server as the data source type. 2. Click Next. 3. Click Set or Edit next to the command block that you want to modify. The Acquired column shows Yes or No to indicate whether the connection acquires properties from its parent data source. 4. In the set command page, add or modify the XML code command block, and click OK. Tip: You can reset command blocks by selecting the check box next to the connections clicking Reset to parent value or Clear. Note: If you are using DB2 or Microsoft SQL Server, you can only add commands block for opening a session. 5. Continue adding or modifying command blocks, as required. 6. Click Finish.
192
Run query 1
Chapter 8: Data Sources and Connections Another example is a macro that can be substituted if authentication userNames are equivalent to the proxy userid or trusted context user.
<commandBlock> <commands> <sessionStartCommand> <arguments> <argument> <name>OCI_ATTR_USERNAME</name> <value>#$account.personalInfo.userName# </value> </argument> </arguments> </sessionStartCommand> </commands> </commandBlock>
The following is a simple example of a close session command block for a proxy session. The current proxy connection is terminated. Note that sessionEndCommand ends an OCI_session in Oracle and switches the user back to the trusted context owner for DB2.
<commandBlock> <commands> <sessionEndCommand> <arguments/> </sessionEndCommand> </commands> </commandBlock>
Example - Using Command Blocks for Virtual Private Databases for Oracle
Typically, Oracle uses signons to determine the database information that users can access. A virtual private database determines which users can access which information, without further signon information required. You create a command block for the connection using macros that are substituted at run time for the logged on user. The macros identify the user so that the user need not re-enter signon information. If all users who access the database are defined as database users and user accounts are used for connections, you can set up the context automatically when the connection is established. For example, the macro can be substituted for the userName. The XML command block stores a series of commands that are run in the stated sequence. This may include the commands that are described in "Schema for Data Source Commands" (p. 741). The following example shows an XML command block for a virtual private database. This command block sets up a context (virtual private database) within the connection based on the passed parameter. The passed parameter is retrieved from the environment, which is related to the user's logon at the portal level. These variables can be modified in the configuration tool. Their values are user specific and obtained using the security control mechanism (CAM).
<commandBlock> <commands> <sqlCommand> <sql>BEGIN PKG_COUNTRY_CONTEXT.SP_SET_COUNTRY1 (#$account.parameters.var1#); END;</sql> </sqlCommand> </commands> </commandBlock>
194
Chapter 8: Data Sources and Connections This example shows account parameter substitution. You must specify account information as custom properties. For information about session properties, see the Framework Manager User Guide. Note: Command blocks for Oracle proxy connections and virtual private databases at the data source level apply to all connections to that data source.
196
198
You can schedule data movement entries to run at a specified time or based on a trigger, such as a database refresh or an email (p. 299). If you want to use an agent (p. 383) for a data movement entry, include the entry as part of a job (p. 301), and then include the job in an agent. You can view the run histories for data movement entries (p. 294)You can rerun failed data movement entries. See "Rerun a Failed Entry Task" (p. 297).
Steps
1. In IBM Cognos Connection, click the run with options button to the data movement entry you want to run. on the actions toolbar next
2. Under Time, select Now to run the data movement entry now, or Later to specify a later date and time. 3. Click Run. The confirmation page appears. 4. Click OK.
Steps
1. In IBM Cognos Connection, click the set properties button the data movement entry that you want to run. 2. Click the General tab. 3. If you want to make yourself the owner of the entry, click Make me the owner. 4. If you want to set a contact or an email address for the entry, click Set the contact and then click either Select the contact or Enter an email address. 5. If you want to change the icon associated with the entry, click Edit, specify the new icon for the entry, and click OK. 6. If you want to select a different language, select from the Language menu. 7. If you want, enter or change the Name, Description, and Screen tip for the data movement entry. 8. If you want to set Run history options, click Number of occurrences, and set the number of run repetitions, or click Duration, and set the number of days to run the entry. 9. Click OK. The next time the data movement entry runs, it uses these properties instead of the original defaults. on the actions toolbar next to
200
In addition to the namespaces that represent the authentication providers, IBM Cognos 8 has a built-in namespace called IBM Cognos. The Cognos namespace enhances your organization security policies and deployment ability of applications. Security in IBM Cognos 8 is optional. If security is not enabled it means that no authentication providers are configured, and therefore all user access is anonymous. Typically, anonymous users have limited, read-only access.
Authentication Providers
User authentication in IBM Cognos 8 is managed by authentication providers. Authentication providers define users, groups, and roles used for authentication. User names, IDs, passwords, regional settings, personal preferences are some examples of information stored in the providers. If you set up authentication for IBM Cognos 8, users must provide valid credentials, such as user ID and password, at logon time. In IBM Cognos 8 environment, authentication providers are also referred to as namespaces, and they are represented by namespace entries in the user interface.
IBM Cognos 8 does not replicate the users, groups, and roles defined in your authentication provider. However, you can reference them in IBM Cognos 8 when you set access permissions to reports and other content. They can also become members of Cognos groups and roles. The following authentication providers are supported in this release: Active Directory Server IBM Cognos Series 7 eTrust SiteMinder LDAP NTLM SAP
You configure authentication providers using IBM Cognos Configuration. For more information, see the Installation and Configuration Guide.
Multiple Namespaces
If multiple namespaces are configured for your system, at the start of a session you must select one namespace that you want to use. However, this does not prevent you from logging on to other namespaces later in the session. For example, if you set access permissions, you may want to reference entries from different namespaces. To log on to a different namespace, you do not have to log out of the namespace you are currently using. You can be logged on to multiple namespaces simultaneously. Your primary logon is the namespace and the credentials that you use to log on at the beginning of the session. The namespaces that you log on to later in the session and the credentials that you use become your secondary logons. When you delete one of the namespaces, you can log on using another namespace. If you delete all namespaces except for the Cognos namespace, you are not prompted to log on. If anonymous access is enabled, you are automatically logged on as an anonymous user. If anonymous access is not enabled, you cannot access the IBM Cognos Connection logon page. In this situation, use IBM Cognos Configuration to enable anonymous access.
Hiding Namespaces
You can hide namespaces from users during logon. This lets you have trusted signon namespaces without showing them on the namespace selection list that is presented when users log on. For example, you may want to integrate single signon across systems, but maintain the ability for customers to authenticate directly to IBM Cognos 8 without being prompted to choose a namespace. You can hide Custom Java Provider and eTrust SiteMinder namespaces that you configured. For more information, see the Installation and Configuration Guide.
202
Steps
1. In IBM Cognos Connection, in the upper-right corner, click Launch, IBM Cognos Administration. 2. On the Security tab, click Users, Groups, and Roles. If the namespace you want to delete does not have a check mark in the Active column, it is inactive and can be deleted. 3. In the Actions column, click the delete button. If the namespace is active, the delete button is not available. The namespace is permanently deleted. To use the namespace again in IBM Cognos 8, you must add it using IBM Cognos Configuration.
Authorization
Authorization is the process of granting or denying access to data, and specifying the actions that can be performed on that data, based on a user identity. IBM Cognos 8 authorization assigns permissions to users, groups, and roles that allow them to perform actions, such as read or write, on content store objects, such as folders and reports. The content store can be viewed as a hierarchy of data objects. These objects include not only folders and reports, but packages for report creation, directories, and servers. When IBM Cognos 8 administrators distribute reports to users, they can set up folders in which reports and other objects can be stored. They can then secure those folders so that only authorized personnel can view, change, or perform other tasks using the folder contents. For information about setting access permissions to the IBM Cognos 8 entries, see "Access Permissions" (p. 213). For information about the Content Manager hierarchy of objects and the initial access permissions, see "Initial Access Permissions " (p. 691).
Cognos Namespace
The Cognos namespace is the IBM Cognos 8 built-in namespace. It contains the IBM Cognos objects, such as groups, roles, data sources, distribution lists, and contacts. During the content store initialization, built-in and predefined security entries are created in this namespace (p. 233). You must modify the initial security settings for those entries and for the Cognos namespace immediately after installing and configuring IBM Cognos 8 (p. 236).
Chapter 11: Security Model You can rename the Cognos namespace using IBM Cognos Configuration, but you cannot delete it. The namespace is always active. When you set security in IBM Cognos 8, you may want to use the Cognos namespace to create groups and roles that are specific to IBM Cognos 8. In this namespace, you can also create security policies that indirectly reference the security entries in authentication providers so that IBM Cognos 8 can be more easily deployed from one installation to another (p. 308). The Cognos namespace always exists in IBM Cognos 8, but the use of Cognos groups and roles it contains is optional. The groups and roles created in the Cognos namespace repackage the users, groups, and roles existing in the authentication providers to optimize their use in the IBM Cognos 8 environment. For example, in the Cognos namespace, you can create a group called HR Managers and add to it specific users and groups from your corporate IT and HR organizations defined in your authentication provider. Later, you can set access permissions for the HR Managers group to entries in IBM Cognos 8.
204
Parameter Signing
Parameter signing protects parameter values against tampering when they are sent to a Web browser. CAF can sign parameters or specific parts of data. Signing is used only in specific situations. It is enabled when CAF is enabled.
206
Users
A user entry is created and maintained in an authentication provider to uniquely identify a human or a computer account. You cannot create user entries in IBM Cognos 8.
Information about users, such as first and last names, passwords, IDs, locales, and email addresses, is stored in the providers. However, this may not be all the information required by IBM Cognos 8. For example, it does not specify the location of the users personal folders, or format preferences for viewing reports. This additional information about users is stored in IBM Cognos 8, but when addressed in IBM Cognos 8, the information appears as part of the external namespace.
Series 7 Users
If you configured the IBM Cognos Series 7 authentication provider (p. 201), a user from that namespace must belong to at least one Access Manager user class for the user to be usable in IBM Cognos 8. For example, if you create a new user in Series 7 Access Manager and assign the user to a user class, but then remove the user from that user class, you cannot log on as that user in IBM Cognos 8.
User Locales
A locale specifies linguistic information and cultural conventions for character type, collation, format of date and time, currency unit, and messages. You can specify locales for individual products, content, servers, authors, and users in IBM Cognos 8. User locale refers to the product and content locales for each IBM Cognos 8 user. Requests from users arrive with an associated locale. IBM Cognos 8 must determine the language and locale preferences of users and enforce an appropriate response locale when you distribute reports in different languages. A user locale specifies the default settings that a user wants to use for formatting dates, times, currency, and numbers. IBM Cognos 8 uses this information to present data to the user. IBM Cognos 8 obtains a value for user locale by checking these sources, in the order listed: user preference settings If the user sets the user preference settings in IBM Cognos Connection, IBM Cognos 8 uses these settings for the users product and content locale and for default formatting options. The user preference settings override the values obtained from the authentication provider. authentication provider If the authentication provider has locale settings that are configured, IBM Cognos 8 uses these values for the users product and content locale. browser setting Anonymous and guest users cannot set user preference settings. For these users, IBM Cognos 8 obtains a user locale from the browser stored on the users computer.
Group
Role
User
Group
User
Group
Role
208
Chapter 12: Users, Groups, and Roles Users can become members of groups and roles defined in IBM Cognos 8, and groups and roles defined in authentication providers. A user can belong to one or more groups or roles. If users are members of more than one group, their access permissions are merged. You create Cognos groups and roles when you cannot create groups or roles in your authentication provider groups or roles are required that span multiple namespaces portable groups and roles are required that can be deployed Create the required groups and roles in your authentication provider, and add them to the appropriate Cognos groups and roles. you want to address specific needs of IBM Cognos 8 administration you want to avoid cluttering your organization security systems with information used only in IBM Cognos 8
Series 7 Roles
If you have configured the IBM Cognos Series 7 authentication provider (p. 201), user collections known as user classes in Series 7 appear as roles in IBM Cognos 8. You can access Series 7 and IBM Cognos 8 using a single logon. If you start your session by logging on to Series 7, and then access IBM Cognos 8, you automatically assume the roles that were in effect for you in Series 7 when you first logged on. You cannot assume different Series 7 roles. Users can assume different roles in Series 7 after they access IBM Cognos 8.
Steps
1. In IBM Cognos Connection, in the upper-right corner, click Launch, IBM Cognos Administration. 2. On the Security tab, click Users, Groups, and Roles. 3. Click the Cognos namespace. Tip: If you want to delete an Cognos group or role, select the check box next to it and click the delete button. 4. On the toolbar, click the new group or new role button.
5. In the Specify a name and description page, type a name and, if you want, a description for the new group or role, and then select a destination folder and click Next. 6. If you want to create a group without members, click Finish. 7. If you want to add members to the new group or role, click Add and choose how to select the users, groups, or roles: To choose from listed entries, click the appropriate namespace, and then select the check boxes next to the users, groups, or roles. To search for entries, click Search and in the Search string box, type the phrase you want to search for. For search options, click Edit. Find and click the entry you want.
210
Chapter 12: Users, Groups, and Roles To type the name of entries you want to add, click Type and type the names of groups, roles, or users using the following format, where a semicolon (;) separates each entry: namespace/group_name;namespace/role_name;namespace/user_name; Here is an example: Cognos/Authors;LDAP/scarter; 8. Click the right-arrow button and when the entries you want appear in the Selected entries box, click OK. Tips: To remove entries from the Selected entries list, select them and click Remove. To select all entries in a list, click the check box in the upper-left corner of the list. To make the user entries visible, click Show users in the list. 9. Click Finish.
Steps
1. In IBM Cognos Connection, in the upper-right corner, click Launch, IBM Cognos Administration. 2. On the Security tab, click Users, Groups, and Roles. 3. Click the Cognos namespace. 4. In the Actions column, click the properties button for the group or role whose membership you want to modify. 5. Click the Members tab. 6. If you want to add members, click Add and choose how to select members: To choose from listed entries, click the appropriate namespace, and then select the check boxes next to the users, groups, or roles. To search for entries, click Search and in the Search string box, type the phrase you want to search for. For search options, click Edit. Find and click the entry you want. To type the name of entries you want to add, click Type and type the names of groups, roles, or users using the following format, where a semicolon (;) separates each entry: Administration and Security Guide 211
Chapter 12: Users, Groups, and Roles namespace/group_name;namespace/role_name;namespace/user_name; Here is an example: Cognos/Authors;LDAP/scarter; 7. Click the right-arrow button and when the entries you want appear in the Selected entries box, click OK. Tips: To remove entries from the Selected entries list, select them and click Remove. To select all entries in a list, click the check box in the upper-left corner of the list. To make the user entries visible, click Show users in the list. 8. To remove members from an Cognos group or role, in the Set Properties page, specify which users, groups, or roles to remove, and click Remove. 9. Click OK.
212
Permissions
Read
Icons
Permitted Actions
View all the properties of an entry, including the report specification, report output, and so on, which are properties of a report. Create a shortcut to an entry.
Write
Modify properties of an entry. Delete an entry. Create entries in a container, such as a package or a folder. Modify the report specification for reports created in Report Studio and Query Studio. Create new outputs for a report.
Permissions
Execute
Icons
Permitted Actions
Process an entry. For entries such as reports, agents, and metrics, the user can run the entry. For data sources, connections, and signons, the entries can be used to retrieve data from a data provider. The user cannot read the database information directly. The report server can access the database information on behalf of the user to process a request. IBM Cognos 8 verifies whether users have execute permissions for an entry before they can use the entry. For credentials, users can permit someone else to use their credentials.
Note: Users must have execute permissions for the account they use with the run as the owner report option. Set policy Read and modify the security settings for an entry.
Traverse
View the contents of a container entry, such as a package or a folder, and view general properties of the container itself without full access to the content. Note: Users can view the general properties of the entries for which they have any type of access. The general properties include name, description, creation date, and so on, which are common to all entries.
Action
Add an entry Query the entry properties View the children of the entry Update an entry Delete an entry
Permissions required
Write permissions for a parent entry Read permissions for an entry Traverse permissions for an entry Write permissions for an entry Write permissions for an entry, and write permissions for a parent entry Read permissions for an entry and any child entries, traverse permissions for all of the children, and write and traverse permissions for the target parent entry Read and write permissions for an entry, write permissions for both the source parent entry and the target parent entry, and traverse permissions for the target parent entry
Copy an entry
Move an entry
Ownership of Entries
If the user is an owner of an entry, the user has full access rights for the entry. This ensures that users can always access and modify the entries they own. By default, the owner of the entry is the user who creates the entry. However, any other user who has set policy permissions for the entry can take ownership of the entry.
When a group has execute permissions denied for a report, this icon name.
Denied access has precedence over granted access. When you deny specific users or groups access to an entry, you replace other security policies that grant access to the entry. If the grant and deny permissions are in conflict, access to the entry is always denied. For example, a user belongs to two groups. One group has access granted to a report and the other group has access denied to the same report. Access to this report is denied for the user.
Chapter 13: Access Permissions Deny access only when it is really required. Typically, it is a better administrative practice to grant permissions than to deny them.
Parent/Child Permissions
Access permissions are acquired from parent entries. If access permissions are not defined, the entry acquires permissions from its parent entry. You can replace parent permissions by defining permissions for the child entry. Objects that exist only as children of other objects always acquire permissions from their parents. Examples of such objects are report specifications and report outputs. They are visible through the SDK. You cannot set permissions specifically for those objects.
Capabilities Permissions
If you are an administrator, you set access to the secured functions and features by granting execute permissions for specified namespaces, users, groups, or roles. For more information, see "Secured Functions and Features" (p. 221).
Accessing Entries Associated with Data Sources Secured Against Multiple Namespaces
Data sources in IBM Cognos 8 can be secured against multiple namespaces. In some environments, the namespace used to secure the data source is not the primary namespace used for access to IBM Cognos Connection. When you try to access an entry, such as a report, a query, or an analysis, that is associated with a data source secured against multiple namespaces, and you are not logged on to all of the required namespaces, a prompt for authentication appears. You must log on to the namespace before you can access the entry. When single signon (SSO) is enabled, the prompt for authentication does not appear. You are automatically logged on to the namespace. This functionality applies to Cognos Viewer only. If a similar situation occurs in an IBM Cognos 8 studio, you must quit your task and log on to all the namespaces that you want to use in the current session.
Chapter 13: Access Permissions such entries are reports, queries, analyses, packages, agents, metrics, namespaces, groups, users, or dispatchers. You can reference entries from different namespaces. If you plan to set permissions that reference multiple namespaces, you must log on to each of those namespaces before you start your task. Otherwise, you do not have full administrative rights for the entries you want to modify. To administer security, you must have set policy permissions.
Steps
1. In IBM Cognos Connection, locate the entry for which you want to set access permissions. 2. In the Actions column, click the set properties button 3. In the Set properties page, click the Permissions tab. 4. Choose whether to use the permissions of the parent entry or specify permissions specifically for the entry: To use the permissions of the parent entry, clear the Override the access permissions acquired from the parent entry check box, then click OK if you are prompted to use the parent permissions. Click OK. To set access permissions for the entry, select the Override the access permissions acquired from the parent entry check box, then proceed to step 5. 5. If you want to remove an entry from the list, select its check box and click Remove. Tip: If you want to select all entries, select the check box at the top of the list in the upper-left corner. Clear the check box to deselect all entries. 6. To specify the entries for which you want to grant or deny access, click Add, then choose how to select entries: To choose from listed entries, click the appropriate namespace, and then select the check boxes next to the users, groups, or roles. To search for entries, click Search and in the Search string box, type the phrase you want to search for. For search options, click Edit. Find and click the entry you want. To type the name of entries you want to add, click Type and type the names of groups, roles, or users using the following format, where a semicolon (;) separates each entry: namespace/group_name;namespace/role_name;namespace/user_name; Here is an example: Cognos/Authors;LDAP/scarter; 7. Click the right-arrow button and when the entries you want appear in the Selected entries box, click OK. Tips: To remove entries from the Selected entries list, select them and click Remove. To select all entries in a list, click the check box in the upper-left corner of the list. To make the user entries visible, click Show users in the list. Administration and Security Guide 217 for the entry.
Chapter 13: Access Permissions 8. For each entry in the list, in the box next to the list, select or clear check boxes to specify what type of access you want to grant or deny. 9. Click Apply. In the Permissions column, an icon appears next to the user, group, or role. This icon represents the type of access granted or denied to the entry. 10. If you want to replace the existing permissions of the child entries with the permissions you set for this entry, in the Option section, select the Delete the access permissions of all child entries check box. This option appears only with the entries that are containers. You can use it to restrict access to a hierarchy of entries. 11. Click OK.
Trusted Credentials
Trusted credentials are used for users who must perform a task or process, but do not have sufficient access permissions for entries that contain sensitive data, such as database signons and group memberships. Users with more extensive access permissions, who own the entries, can authorize a trusted user to use their credentials to access the entries. Trusted credentials are also used to run scheduled requests when users are not logged on to IBM Cognos 8, for example, overnight. When the request runs, a user session is created. The trusted credential is used to log on to IBM Cognos 8 as the user the trusted credential represents and the user's access permissions are used to run the report or the job. The credentials are stored as part of the account object in the namespace.
Steps
1. In IBM Cognos Connection, in the upper-right corner, click the my area button erences. 2. On the Personal tab, under Credentials, if you have not created credentials before, click Create the Credentials. 3. Select the users, groups, or roles you want to authorize to use your credentials. If you are prompted for your credentials, provide your user ID and password. 4. If you want to add entries, click Add then choose how to select entries: To choose from listed entries, click the appropriate namespace, and then select the check boxes next to the users, groups, or roles. , My Pref-
218
Chapter 13: Access Permissions To search for entries, click Search and in the Search string box, type the phrase you want to search for. For search options, click Edit. Find and click the entry you want. To type the name of entries you want to add, click Type and type the names of groups, roles, or users using the following format, where a semicolon (;) separates each entry: namespace/group_name;namespace/role_name;namespace/user_name; Here is an example: Cognos/Authors;LDAP/scarter; 5. Click the right-arrow button and when the entries you want appear in the Selected entries box, click OK. Tips: To remove entries from the Selected entries list, select them and click Remove. To select all entries in a list, click the check box in the upper-left corner of the list. To make the user entries visible, click Show users in the list. 6. If you want to remove an entry from the list, select the check box next to it and click Remove. 7. Ensure that the list contains only the users, groups, or roles that you want, and click OK.
220
the user interface in IBM Cognos 8 (p. 221). Examples of the secured functions are Administration and Report Studio. Examples of the secured features are User Defined SQL and Bursting (p. 221). Content Manager reads the users permissions at logon time. Depending on the permissions for the secured functions and features, users can access specific components and perform specific tasks in IBM Cognos 8. When a content store is initialized, the initial permissions for the secured functions and features are created (p. 693). The permissions define which of the predefined and built-in Cognos groups and roles have access to which secured functions and features, and the type of access. The initial permissions grant unrestricted access to IBM Cognos 8 because the built-in role System Administrators includes the group Everyone in its membership. You must remove the group Everyone from the membership of System Administrators before you start setting access to capabilities. For more information, see "Initial Security" (p. 233). When running a report using the Run as the owner option, the capabilities of the owner are used for bursting and report layout properties in the HTML format. All other capabilities are based on the user who runs the report. Administrators can set up access to the secured functions and features using the Capabilities page on the Security tab in IBM Cognos Administration (p. 225). Users can see a list of the secured functions and features available to them in My Area the Capabilities section. The secured functions and features include the following. of the portal, in My Preferences, Personal,
Adaptive Analytics
This secured function controls access to the reports packaged using Adaptive Analytics.
Administration
This secured function contains the secured features that control access to the administration pages that you use to administer IBM Cognos 8. System administrators can use this capability to delegate administration tasks to different administrators. The secured features associated with this function are Adaptive Analytics Administration Users can access Adaptive Analytics to perform administrative tasks. Administration tasks Users can access Content Administration on the Configuration tab in IBM Cognos Administration to administer exports, imports, index updates, consistency checks, and report updates. Administration and Security Guide 221
Chapter 14: Secured Functions and Features Configure and manage the system Users can access System on the Status tab and Dispatchers and Services on the Configuration tab in IBM Cognos Administration to configure dispatchers and services, and to manage the system. Controller Administration Users can use the administrative functions of IBM Cognos 8 Controller. Data Source Connections Users can access Data Source Connections on the Configuration tab in IBM Cognos Administration to define data sources, connections, and signons. Distribution Lists and Contacts Users can access Distribution Lists and Contacts on the Configuration tab in IBM Cognos Administration to manage distribution lists and contacts. Metric Studio Administration Users can create new metric packages using the new metric package wizard in IBM Cognos Connection, and access the Tools menu in Metric Studio. Planning Administration Users can access IBM Cognos 8 Planning - Contributor Administration Console and IBM Cognos 8 Planning - Analyst to perform administration tasks. Printers Users can access Printers on the Configuration tab in IBM Cognos Administration to manage printers. Run activities and schedules Users can access Current Activities, Past Activities, Upcoming Activities and Schedules on the Status tab in IBM Cognos Administration to monitor the server activities and manage schedules. To grant access to the scheduling functionality independently from the monitoring functionality, use the Scheduling capability. Set capabilities and manage UI profiles Users can access Capabilities and User Interface Profiles on the Security tab in IBM Cognos Administration to manage the secured functions and features and the Report Studio user interface profiles. Styles and portlets Users can access Styles and Portlets on the Configuration tab in IBM Cognos Administration to manage styles and portlets. Users, Groups and Roles Users can access Users, Groups and Roles on the Security tab in IBM Cognos Administration to manage namespaces, users, groups, and roles.
222
Analysis Studio
This secured function controls access to Analysis Studio.
Cognos Viewer
This secured function controls access to Cognos Viewer, which you use to view reports. The secured features associated with this function are Context Menu Users can use the context menu in Cognos Viewer. Note: To see the context menu, users must have access to both the Selection and Context Menu secured features. Run With Options Users can change the default run options. Selection Users can select text in lists and crosstabs. Toolbar Users can see the Cognos Viewer toolbar.
Controller Studio
This secured function controls access to IBM Cognos 8 Controller.
Data Manager
This secured function controls access to IBM Cognos 8 Data Manager.
Detailed Errors
This secured function controls access to viewing detailed error messages in the Web browser.
Event Studio
This secured function controls access to Event Studio.
Glossary
This secured function controls access to the IBM WebSphere Business Glossary.
Hide Entries
This secured function specifies that a user can hide entries and view hidden entries in IBM Cognos 8.
Chapter 14: Secured Functions and Features The Hide this entry check box appears on the General tab of the entries properties pages. The Show hidden entries check box appears on the Preferences tab in user profiles, and on the General tab in My area , My Preferences.
Lineage
This secured function controls access to the Lineage action. Use this to view information about data or metadata items from Cognos Viewer, or from the source tree in Report Studio, Query Studio, and Analysis Studio.
Metric Studio
This secured function controls access to Metric Studio. The secured feature associated with this function is Edit View Use the edit features of Metric Studio to edit metric content.
Planning Contributor
This secured function controls access to IBM Cognos 8 Planning - Contributor and IBM Cognos 8 Planning - Analyst.
Query Studio
This secured function controls access to the Query Studio, which you use to create simple, ad hoc reports. The secured features associated with this function are Create Create new reports and use the Save as option for new reports and custom views. Advanced Use advanced authoring features, such as creating complex filters, formatting style, and multilingual support.
Report Studio
This secured function controls access to Report Studio, which you use to author professional reports. The secured features associated with this function are Bursting Users can author and run burst reports. Create/Delete Users can create new reports, use the Save as option for new reports and report views, and change models. HTML Items in Report
224
Chapter 14: Secured Functions and Features Users can use the button, HTMLItem, and hyperlink elements of the report specification when authoring reports. User Defined SQL Users can edit the SQL statements directly in the query specification and run the query specifications that contain the edited SQL statements. Note: Restrictions on who can use this feature are not enforced in Framework Manager. For example, a Framework Manager user who does not have User Defined SQL rights in IBM Cognos Administration can still create a query subject and use manually created SQL queries to search a database.
Scheduling
This secured function controls access to the scheduling functionality for items that can be run, such as reports. The secured feature associated with this function is Scheduling Priority Users can set up and change the processing priority of scheduled entries.
Specification Execution
This secured function specifies that a user or SDK application can use an inline specification. IBM Cognos 8 studios and some services use inline specifications internally to perform tasks. The service running the specification tests a number of capabilities to ensure that the user is entitled to use the inline specification. For more information, see the runSpecification method in the Developer Guide. This capability is required to author Data Manager tasks.
Watch Rules
This secured function controls access to the Rules tab in My Watch Items in IBM Cognos Connection. Use this secured function to create and run watch rules.
Chapter 14: Secured Functions and Features must grant execute permissions for the feature and traverse permissions for its parent secured function. For example, to grant access to Report Studio and all its functionality, you grant execute permissions for the Report Studio secured function. If you want to grant access only to the Create/Delete secured feature within Report Studio, grant traverse permissions for the Report Studio secured function and execute permissions for the Create/Delete secured feature. You must have set policy permissions to administer secured functions and features. Typically, this is done by directory administrators. Before you start setting permissions on capabilities, ensure that the initial security settings are already changed.
Steps
1. In IBM Cognos Connection, in the upper-right corner, click Launch, IBM Cognos Administration. 2. On the Security tab, click Capabilities. A list of available secured functions appears. 3. Choose whether to set access for a function or for a feature: To set access for a function, click the actions button click Set properties. To set access for a feature, click the actions button next to the feature name, and click Set properties. Tip: Functions that have secured features have links. 4. Click the Permissions tab. 5. Choose whether to use the permissions of the parent entry or specify different permissions: To use the permissions of the parent entry, clear the Override the access permissions acquired from the parent entry check box, and click OK. To set access permissions explicitly for the entry, select the Override the access permissions acquired from the parent entry check box, and then perform the remaining steps. 6. If you want to remove an entry from the list, select its check box and click Remove. Tip: To select or deselect all entries in a page, click Select all or Deselect all at the bottom of the list. 7. If you want to add new entries to the list, click Add and choose how to select entries: To choose from listed entries, click the appropriate namespace, and then select the check boxes next to the users, groups, or roles. To search for entries, click Search and in the Search string box, type the phrase you want to search for. For search options, click Edit. Find and click the entry you want. next to the function name, and
226
Chapter 14: Secured Functions and Features To type the name of entries you want to add, click Type and type the names of groups, roles, or users using the following format, where a semicolon (;) separates each entry: namespace/group_name;namespace/role_name;namespace/user_name; Here is an example: Cognos/Authors;LDAP/scarter; 8. Click the right-arrow button and when the entries you want appear in the Selected entries box, click OK. Tips: To remove entries from the Selected entries list, select them and click Remove. To select all entries in a list, click the check box in the upper-left corner of the list. To make the user entries visible, click Show users in the list. 9. Select the check box next to the entry for which you want to set access to the function or feature. 10. In the box next to the list, select the proper check boxes to grant execute permissions the entry. 11. Click Apply. In the Permissions column, an icon that denotes the execute permissions granted appears next to the namespace, user, group, or role. 12. Repeat steps 8 to 10 for each entry. 13. Click OK. for
Chapter 14: Secured Functions and Features In addition, a page section and context area (similar to Analysis Studio) allow you to easily create multi-page, filtered, and prompted crosstabs. To support the different authoring modes in Report Studio, IBM Cognos Administration provides two User Interface Profiles named Professional and Express. Use the Professional profile to set access to the Professional mode, and the Express profile to set access to the Express mode. If users have access to both the Professional and Express authoring modes, they can later switch between the two in Report Studio. For more information, see the Report Studio Professional Authoring User Guide.
Steps
1. In IBM Cognos Connection, in the upper-right corner, click Launch, IBM Cognos Administration. 2. On the Security tab, click User Interface Profiles. 3. Specify access permissions for the user interface profile you want To grant access to the Professional authoring mode, click the actions button Professional, and click Set properties. To grant access to the Express authoring mode, click the actions button next to Express, and click Set properties. The Permissions page appears. 4. Select the Override the access permissions acquired from the parent entry check box. 5. In the box on the left, select the check box next to the user, group, or role for which you want to grant access to this user interface profile. 6. In the box on the right, grant execute groups, or roles. No other permissions are required. 7. Click OK. For more detailed information about setting access permissions, see "Set Access Permissions for an Entry" (p. 216). and traverse permissions for the selected users, next to
228
Adaptive Analytics
This secured function controls access to the reports packaged using Adaptive Analytics.
Analysis Studio
This secured function controls access to Analysis Studio.
Administration
This secured function controls access to the administrative pages in IBM Cognos 8. You can specify object capabilities for the following secured features within Administration. Adaptive Analytics Administration Users can access Adaptive Analytics to perform administrative tasks. Planning Administration Users can access IBM Cognos 8 Planning - Contributor Administration Console and IBM Cognos 8 Planning - Analyst to perform administration tasks. Metric Studio Administration Users can create new metric packages using the new metric package wizard in IBM Cognos Connection, and access the Tools menu in Metric Studio.
Event Studio
This secured function controls access to Event Studio.
Glossary
This secured function controls access to the IBM WebSphere Business Glossary.
Metric Studio
This secured function controls access to Metric Studio. The secured feature associated with this function is Edit View Use the edit features of Metric Studio to edit metric content.
Planning Contributor
This secured function controls access to IBM Cognos 8 Planning - Contributor and IBM Cognos 8 Planning - Analyst.
Query Studio
This secured function controls access to the Query Studio, which you use to create simple, ad hoc reports. The secured features associated with this function are Create Create new reports and use the Save as option for new reports and custom views. Advanced Use advanced authoring features, such as creating complex filters, formatting style, and multilingual support.
Report Studio
This secured function controls access to Report Studio, which you use to author professional reports. The secured features associated with this function are Bursting Users can author and run burst reports. Create/Delete Users can create new reports, use the Save as option for new reports and report views, and change models. HTML Items in Report Users can use the button, HTMLItem, and hyperlink elements of the report specification when authoring reports. User Defined SQL Users can edit the SQL statements directly in the query specification and run the query specifications that contain the edited SQL statements.
230
Chapter 15: Object Capabilities Note: Restrictions on who can use this feature are not enforced in Framework Manager. For example, a Framework Manager user who does not have User Defined SQL rights in IBM Cognos Administration can still create a query subject and use manually created SQL queries to search a database.
Lineage
This secured function controls access to the Lineage action. Use this to view information about data or metadata items from Cognos Viewer, or from the source tree in Report Studio, Query Studio, and Analysis Studio.
Specification Execution
This secured function specifies that a user or SDK application can use an inline specification. IBM Cognos 8 studios and some services use inline specifications internally to perform tasks. The service running the specification tests a number of capabilities to ensure that the user is entitled to use the inline specification. For more information, see the runSpecification method in the Developer Guide. This capability is required to author Data Manager tasks.
Watch Rules
This secured function controls access to the Rules tab in My Watch Items in IBM Cognos Connection. Use this secured function to create and run watch rules.
Chapter 15: Object Capabilities When setting up object capabilities for the first time after installing IBM Cognos 8, we recommend that you start with Public Folders, and that the capabilities for Public Folders mirror the global capabilities. This provides an accurate baseline on which object capabilities can be further refined.
Steps
1. In IBM Cognos Connection, click the properties button the folder that contains the package. for the package that you want, or
Tip: When setting up object capabilities for Public Folders, click the properties button the product toolbar. 2. Click the Capabilities tab. 3. Select the Override the capabilities acquired from the parent entry check box.
in
4. In the box on the left, select the check box next to the user, group, or role for which you want to specify object capabilities. If the user, group, or role is not in the list, click Add. If you want to remove the user, group, or role from the list, select its check box, and click Remove. For more information about adding or removing entries from this list, see the steps in "Set Access Permissions for an Entry" (p. 216). 5. In the box on the right, select or clear the applicable check boxes to grant or deny the required object capabilities for users, groups, or roles. An icon that represents a granted or denied capability appears next to the name of the user, group, or role. When you deny access to a secured function, you automatically deny access to all its secured features. 6. If applicable, select the Delete the capabilities of all child entries check box. Use this option to specify object capabilities for a hierarchy of entries, for example, for all packages in a folder. 7. Click OK.
232
Built-in Entries
The built-in entries include the Anonymous user account, the groups All Authenticated Users and Everyone, and the role System Administrators. You cannot delete the built-in entries. They appear in both secured and non-secured environments.
Anonymous
This entry represents a user account shared by members of the general public who can access IBM Cognos 8 without being prompted for authentication. For example, this type of access is useful when distributing an online catalog. Anonymous users can see only those entries for which access permissions are not set, or are set specifically for this account or for the Everyone group. You can disable the Anonymous user account by changing the configuration parameters in the configuration tool.
Everyone
This group represents all authenticated users and the Anonymous user account. The membership of this group is maintained by the product and cannot be viewed or altered. You can use the Everyone group to set default security quickly. For example, to secure a report, you grant read, write, or execute permissions to the report for the Everyone group. After this security is in place, you can grant access to the report to other users, groups, or roles, and remove the group Everyone from the security policy for this report. Then, only users, groups, and roles that you specified have access granted to the report. You can use the Everyone group to apply security during deployment (p. 308), but you cannot deploy the group itself (p. 313).
System Administrators
This is a special role in IBM Cognos 8. Members of this role are considered root users or super users. They may access and modify any object in the content store, regardless of any security policies set for the object. Only members of the System Administrators role can modify the membership of this role. The System Administrators role cannot be empty. If you do not want to use System Administrators, you can create an empty group in the Cognos namespace or in your authentication provider, and add this group to the membership of the System Administrators role. When this role is created during the content store initialization, the group Everyone is included in its membership. This means that all users have unrestricted access to the content store. Immediately after installing and configuring IBM Cognos 8, you must modify the initial security settings for this role and remove the group Everyone from its membership (p. 236). You can deploy this role (p. 313).
Predefined Entries
The predefined entries include several Cognos roles (p. 208). Each of the roles has a specific set of access permissions, and can be used to secure different components and functions in IBM Cognos 8. You can use the predefined roles, or delete them. When the predefined roles are created during the content store initialization, the group Everyone is a member of some of them. Some of such roles are Consumers, Query Users, Analysis Users, and Authors. If you want to use the predefined roles, we recommend that you modify their initial membership immediately after installing and configuring IBM Cognos 8 (p. 236). The predefined roles include the following.
Role
Adaptive Analytics Administrators
Description
Members can administer reports packaged using Adaptive Analytics. Members can use reports packaged using Adaptive Analytics. Members have the same access permissions as Consumers. They can also use the IBM Cognos Analysis Studio. Members have the same access permissions as Query Users and Analysis Users. They can use Report Studio, Query Studio, and Analysis Studio, and save public content, such as reports and report outputs. Members can read and execute public content, such as reports.
Analysis Users
Authors
Consumers
234
Role
Controller Administrators
Description
Members have full access to IBM Cognos Controller menus and can create individual IBM Cognos Controller users and define their limitations. Members have general access to IBM Cognos Controller menus. Members can use Data Manager to create data warehouses and data repositories for reporting, analysis, and performance management. Members can administer the contents of namespaces. In the Cognos namespace, they administer groups, accounts, contacts, distribution lists, data sources, and printers. Members can use the Report Studio Express user interface profile. Members can administer metric packages and tasks in IBM Cognos Connection. Members can create and edit scorecard applications in Metric Studio. Members can monitor performance in Metric Studio. Members can administer the Cognos portlets and other portlets in IBM Cognos Connection. This includes customizing portlets, defining portlet styles, and setting access permissions for portlets. Members can access the Contributor Web client, Contributor Add-in for Excel, or Analyst. Members can access Contributor Administration Console, Analyst, and all associated objects in the application. Members have the same access permissions as Consumers. They can also use the IBM Cognos Query Studio.
Controller Users
Directory Administrators
Express Authors
Metrics Administrators
Metrics Authors
Query Users
Role
Readers
Description
Members have read-only access to IBM Cognos 8. They can navigate some portions of the content store, view saved report outputs in the portal, select cells in saved report outputs in Cognos Viewer, and use the Cognos Viewer context menu to perform actions, such as drillthrough. Members can administer the public content, for which they have full access. They can also use IBM Cognos Report Studio and IBM Cognos Query Studio. Members can administer servers, dispatchers, and jobs.
Report Administrators
Server Administrators
236
Chapter 16: Initial Security Ensure that one or more users defined in your authentication provider are members. Remove the group Everyone.
6. Click OK. 7. On the Permissions tab, set access permissions for this role to prevent unauthorized users from creating, updating, or deleting the content, and then click OK. For each role, repeat steps 3 to 6.
Chapter 16: Initial Security Users must have permissions to connect to the database. Also, they must be able to create, alter, and drop tables, triggers, views, procedures, and sequences, as well as insert, update, and delete data in the database tables. The permissions must be granted to the user account directly, and not through a group or role membership. DB2 Users must have the create, drop table, CREATETAB, CONNECT and IMPLICITSCHEMA permissions for the database. Also, they must have USE permissions for the USER TEMPORARY tablespace and other appropriate tablespaces associated with the database. Sybase Adaptive Server Enterprise Users must have create, drop table, create default, create procedure, create rule, create table, and create view permissions for the database. Limit the number of users who have read or write access for the Content Manager tables. Follow other recommendations on securing the database. For information, see the database documentation.
238
Log On
IBM Cognos 8 supports authenticated and anonymous user access. To use IBM Cognos 8 as an authenticated user, you must successfully log on. During the logon process, you must provide your credentials, such as user ID and password, as required by your organization. Anonymous users do not log on. Tip: If you want to see a summary of your logon information for the current session, in the portal, click My Area, My Preferences and then click the Personal tab. This is not available to anonymous users.
Steps
1. In the portal, click Log On. 2. If the namespace Logon page appears, in the Namespace box, click the namespace you want to use. 3. Click OK and type your user ID and password. 4. Click OK. Your session starts.
Log Off
You log off to end your session. Even if you used multiple namespaces in the session, you log off only once.
Chapter 17: IBM Cognos Connection If you close your Web browser without logging off, your session ends.
Steps
1. In the portal, click Log Off. You are now logged out of all the namespaces you were using. 2. Choose whether to log on again: If you do not want to log on again, close your Web browser. If you want to log on as an authenticated user, click Log on again. If you want to log on as an anonymous user, click Open a session as an anonymous user. This is available only if your administrator set it up.
Create a Shortcut
A shortcut is a pointer to another entry such as a report, report view, folder, job, agent, page, or URL. You can use shortcuts to organize information that you use regularly. For example, if you frequently use a report in Public Folders, you can create a shortcut in My Folders. If you want to make a new entry, it might be easier to make a copy of an existing entry (p. 251) and modify it. If you want to run an existing agent or report with some minor changes, create an agent view (p. 385) or a report view (p. 354). For example, to change the format, language, or delivery method of a report, create a report view. You cannot update the source entry by clicking the shortcut. Updating the source automatically updates all shortcuts to the entry. Tip: If the source entry was deleted or moved to another location, the shortcut icon to indicate a broken link. changes
You can change access permissions for a shortcut entry, but it does not change the access permissions for the source entry.
Steps
1. In IBM Cognos Connection, locate the entry you want to create a shortcut to. 2. Under Actions, click More and then click Create a shortcut to this entry 3. In the Name box, type the name of the shortcut. 4. If you want, in the Description and in the Screen tip box, you can type a description of the entry. The description appears in the portal when you set your preferences to use the details view (p. 260). The screen tip, which is limited to 100 characters, appears when you pause your pointer over the icon for the entry in the portal. .
240
Chapter 17: IBM Cognos Connection 5. If you do not want to use the target folder shown under Location, choose another location: Click Select another folder, select the target folder, and click OK. If the folder box is empty, go back one folder level using the path at the top of the dialog box. Click Select My Folders as the location.
6. Click Finish. In the portal, shortcut entries are identified by the shortcut icon .
Create a URL
A URL is a standard way of identifying the location for any external file or Web site. Create URLs to keep the files and Web sites you use most frequently at your fingertips. Clicking a URL opens the file or Web site in the browser. After opening a URL, click the back button in your browser to return to the portal. The URL must contain a valid server name that is included in the valid domains list, as specified by your administrator. Otherwise, you cannot create the URL. Administrators maintain the list of valid domains in IBM Cognos Configuration, in the IBM Cognos Application Firewall category, the Valid domains or host property. For more information, see the Installation and Configuration Guide.
Steps
1. In IBM Cognos Connection, go to the folder where you want to create the new URL. 2. Click the new URL button on the toolbar.
3. In the Name box, type the name of the new URL. 4. If you want, in the Description and in the Screen tip box, you can type a description of the entry. The description appears in the portal when you set your preferences to use the details view (p. 260). The screen tip, which is limited to 100 characters, appears when you pause your pointer over the icon for the entry in the portal. 5. In the URL box, type the URL location. If the URL points to a Web site address, the protocol must be included. For example, to create a URL for the IBM Cognos Web site, type http://www.cognos.com. 6. If you do not want to use the target folder shown under Location, choose another location: Click Select another folder, select the target folder, and click OK. If the folder box is empty, go back one folder level using the path at the top of the dialog box. Click Select My Folders as the location.
7. Click Finish.
Bookmark an Entry
You can bookmark an IBM Cognos 8 entry in your Web browser so that later you can quickly perform the default action associated with the entry. For example, using a report bookmark, you can view the most recent report output, run the report, or open it in an authoring tool. For more information, see "Set Default Report Options" (p. 348). The bookmark saves the URL of the entry and its default action at the time when the bookmark was created. Some default actions are available only to users who have the required access permissions for the entries. have the required product components installed. have access to specific, secured functions and features. For example, the capabilities to use a specific IBM Cognos 8 studio. use specific Web browsers.
For example, to open an agent, users must have read and traverse permissions for the agent, have Event Studio installed and the permissions to use it, and use Internet Explorer as their Web browser.
3. On the General tab, click View the search path, ID and URL. 4. Right-click the link that appears under Default action URL. The link shows the entry name and the action that will be performed. If the entry has no default actions, the link is replaced by None. The text below the link shows the URL used by the link. A menu box specific to your Web browser appears. 5. From the menu, click the option for creating bookmarks.
242
Chapter 17: IBM Cognos Connection For example, if you are using Internet Explorer, click Add to Favorites. If you are using Firefox, click Bookmark This Link. 6. Create the bookmark as you normally do in your Web browser.
Entry Properties
You can control the way an entry appears and behaves by modifying its properties. The properties for entries vary depending upon the type of entry selected and your privileges. For example, reports have properties to control run options while folders do not. If a property is not applicable to the type of entry you are customizing, it will not appear in the Set properties page.
General Properties
General properties appear on the General tab of the Set properties page.
Property
Type Owner
Description
The type of entry. The owner of the entry. By default, the owner is the person who created the entry. When the owner no longer exists in the namespace, or is from a different namespace than the current user, the owner shows as Unknown. If you have Set policy permissions, click Make me the owner to become the owner of the entry.
Property
Contact
Description
The person responsible for the entry. Click Set the contact and then click Select the contact to set the contact for the entry or click Enter an email address to enter the contacts email address.
Location
The location of the entry in the portal and its ID. Click View the search path, ID and URL to view the fully qualified location and the ID of the entry in the content store. Entries are assigned a unique identification (ID) number. For more information, see "Organizing Entries" (p. 251).
The date the entry was created. The most recent date that the entry was modified. The icon for the entry. Click Edit to specify an alternative icon. For more information, see "Specify an Alternative Icon for an Entry" (p. 259) When selected, users that do not have write permissions for this entry cannot access it. The entry is no longer visible in the portal. If an entry is disabled and you have write access to it, the disabled icon appears next to the entry.
Select this property to hide reports, packages, pages, folders, jobs, and other entries. Hide an entry to prevent it from unnecessary use, or to organize your view. The hidden entry is still accessible to other entries. For example, a hidden report is accessible as a drill-through target. A hidden entry remains visible, but its icon is faded. If you clear the Show hidden entries check box in my area Preferences, the entry disappears from your view. You must have access to the Hide Entries capability granted by your administrator to see this property. , My
Language
A list of languages that are available for the entry name, screen tip, and description according to the configuration set up by your administrator. Click Remove values for this language to remove the entry name, screen tip, and description for a specified language.
244
Property
Name Screen tip
Description
The name of the entry for the selected language. An optional description of the entry. The screen tip appears when you pause your pointer over the icon for the entry in the portal. Up to 100 characters can be used for a screen tip. An optional description of the entry. It appears in the portal when you set your preferences to use the details view. Details view appears only in Public Folders and My Folders.
Description
Run history
The number of occurrences or period of time to retain run histories for the entry. The number of occurrences or period of time to keep report outputs. Setting this value to zero (0) saves an unlimited number of versions.
Package
The package that is associated with the entry. If the source package was moved or deleted, the text reads "Unavailable." Click Link to a package to link the entry to a different package. For more information, see "Select a Link for an Entry" (p. 256).
URL
A URL to either a file or Web site address. For more information, see "Create a URL" (p. 241). This field is visible only if you have read permissions for the entry. If you have write permissions without read permissions, this property is not visible.
Source report
A path to the source entry for a report view. If the source entry was moved or deleted, the text reads "Unavailable." Click Report Properties to view the properties of the source report. Click Link to a report to link the entry to a different package. For more information, see "Select a Link for an Entry" (p. 256).
Property
Source agent
Description
A path to the source entry for an agent view. If the source entry was moved or deleted, the text reads "Unavailable." Click Agent Properties to view the properties of the source report. Click Link to an agent to link the entry to a different package. For more information, see "Select a Link for an Entry" (p. 256).
Shortcut to
A path to the entry that the shortcut points to. If the referred entry no longer exists, the text reads "Source entry not found." Click Source Properties to view the properties of the source entry.
Advanced routing
A list of keywords used to direct requests by package, user group, or user role to dispatchers in identified server groups. Click Set to add routing keywords for packages, user roles, or user groups. The rules used to direct the requests are part of IBM Cognos Administration.
Gateway
The location of the web server where the originating IBM Cognos product resides. Applies only to Series 7 PowerPlay reports.
Permissions
Permissions appear on the Permissions tab of the Set properties page.
Property
Override the access permissions
Description
Whether to replace the permissions that are inherited from the parent entry. The permissions that are set for the entry. You can grant or deny read, write, execute, set policy, and traverse permissions. For more information, see "Access Permissions" (p. 213). Click Add to add more names to the list. Click Delete to delete names from the list.
Delete the access permissions of all Whether to remove the existing access permissions for all child entries child entries so that they will use the access permissions for this entry.
246
You can select the available paper sizes. In IBM Cognos Connection, click IBM Cognos Administration and then click Configuration. Click Dispatchers and Services and then click the define paper sizes button . To add new paper sizes, click New. To delete paper sizes, click Delete.
Property
Default action Report options: Override the default values Format
Description
The default action when the report is run. Whether to override default run options for the report. When selected, the values that you can override appear. The default format, orientation, and paper size to use when the report runs. Appears only if Override the default values is selected.
Language
The default language to use for the report data when the report runs. Appears only if Override the default values is selected.
Prompt values
The values that are used to filter data when a report is run(p. 362). Whether to use the owner credentials (p. 218) when the report is run. Whether to open an HTML-format Series 7 PowerPlay report in design mode. The number of rows you want to appear per Web page in HTML reports
HTML options: Open in design mode Number of rows per Web page in HTML reports
Property
Description
Enable selection-based interactivity Whether to enable the following in HTML reports that are in HTML reports viewed in Cognos Viewer: drill up and drill down, drill through, Cognos Search, watch rules, and agent notification. For more information, see (p. 371) Note that to have watch rules evaluated in saved report output, you must select the Enable enhanced user features in saved output versions check box. Enable alerts about new versions Whether to allow report consumers to receive alerts about new versions of a saved report. If this check box is cleared, you are prompted whether to remove all users from the alert list. Whether to create additional output formats so that watch rules can be evaluated and saved output versions can be imported into IBM Cognos 8 Go! Office. Note that to enable watch rules, you must select the Enable selection-based interactivity in HTML reports check box. Enable comments in saved output versions Whether to allow users to add comments to saved reports. For more information, see "Comments in Saved Reports" (p. 369). Create new cache data if none is available, when the report runs interactively. The number of days or months before the report cache data expires. To enable the cache duration, select the Refresh the report cache check box.
Cache duration
Job Properties
Job properties appear on the Job tab of the Set properties page.
Property
Steps Submission of steps Defaults for all steps
Description
A list of steps in the job. Whether to run job tasks all at once or in sequence. Set default values at the job level. Click Set, then specify the defaults for all steps of the job. If no defaults are set, the defaults for the individual steps are used.
248
Property
Run history details level
Description
Click All to save the complete history details for the job steps when the run activity completes successfully. The complete history details for the job steps includes Name, Request time, Start time, Completion time, Status. Click Limited to save limited run history details for the job. The limited run history details include the job start time, completion time, status and messages. If the job run fails, the complete history details are saved. The default is All. The Run history details level setting for the job overrides the settings of the job steps.
Agent Properties
Agent properties appear on the Agent tab of the Set properties page.
Property
Tasks Default action Prompt values
Description
A list of tasks in the agent. The default action when the agent is run. The values that are used to filter data when an agent is run (p. 383). Whether to use the owner credentials (p. 218) when the agent is run. Whether to allow users to add themselves to the alert list for an agent.
Alert list
Page Properties
Page properties appear on the Layout and Content and Page Style tabs of the Set properties page.
Property
Number of columns
Description
The number of columns used to organize the content of a page. Up to three columns can be used.
Property
Content
Description
Type of content added to a page. Use to add and remove portlets, distribute the portlets between the columns, change the order of columns and specify their width.
Language
The language in which the page title and instructions can be typed. It should match the product language. The page title. You can format the title by changing the font and character style, and the text alignment. To return to the default browser settings, click Return to default. To modify the default settings, click Custom. You can hide the title.
Title
Instructions
Additional information about the page. You can format the text of instructions by changing the font and character style, and the text alignment. To return to the default browser settings, click Return to default. To modify the default settings, click Custom. You can hide the instructions.
Portlet style
The way a portlet appears on a page. To avoid cluttering the page, you can hide the portlet borders, title bars, and the edit button on the title bar.
Rule Properties
Use the rule properties to define or modify a watch rule. You can access the rule properties from the My Watch Items, Rules tab by clicking the set properties icon for a watch rule entry. The properties are located on the Rule tab of the Set Properties page. The rule properties specify conditions in saved HTML report output so that when the report is saved and the conditions are satisfied, you are alerted. For information about creating watch rules, see (p. 367). The following table describes the rule properties that are available.
Property
Disable the rule
Description
Whether to disable the watch rule. When disabled, the watch rule is not applied when report output is generated.
250
Property
Send an alert when the report reportname contains:
Description
The name of the report and the rule defined for the watch rule. To edit the definition, click the existing filter condition, such as > (greater than) and in the list that appears, click a different condition. Specify a different value in the box.
The objects in the report to which the rule applies. The type of alert you receive when the rule is satisfied. You can be alerted by email or news item.
Organizing Entries
Organize entries such as reports, analyses, agents, and packages in a meaningful way so that you can easily find them. It is important to plan how you can best organize entries in the portal. Review the entries and attempt to group them in a logical way. Consider grouping the entries by type or frequency of use. You may decide to create a folder hierarchy by using nested folders. The folder structure should be logical and should support the chosen method of grouping. Use meaningful names and detailed descriptions to identify entries in the portal. You can copy, move, rename, or delete entries. You can create copies of entries and store them in multiple folders for easy access. You can disable entries and specify the order of entries. You can select a link for an entry. For example, if a report is deleted, you may want to link an associated report view to a different report. You can also hide an entry to prevent it from unnecessary use. Remember that an entry often refers to other entries such as packages, reports, analyses, or queries. In addition, there may be references to entries in job steps, agents tasks, drill-through targets, or metrics. Reference IDs are hard-coded in the specification for each entry. Note that references to deployment objects are based on search paths, not IDs. IDs are installationspecific while search paths are not.
Copy an Entry
When you create a copy of an entry, you create a replica of that entry in another location in the portal. For example, create a copy if you want to use a generic report as the underlying structure for additional reports. The copy of the entry has a new ID. If there is another entry of the same name in the target location, you are prompted to replace the existing entry with the copied entry. If you choose to replace the existing entry, the ID of the existing entry is used. If you copy a folder, references for entries in the folder that reference each other are updated to reference entries in the copied folder.
Chapter 17: IBM Cognos Connection If you want to run an existing agent or report with some minor changes, create an agent view (p. 385) or a report view (p. 354). For example, to change the format, language, or delivery method of a report, create a report view. You can copy multiple entries at the same time to the same location. If you want a report to appear in more than one location, create a shortcut (p. 240). You must have read permissions for an entry you are attempting to copy. You must also have traverse permissions for the current folder, and write and traverse permissions for the target folder (p. 213).
Steps
1. In IBM Cognos Connection, select the check boxes next to the entry or entries you want to copy. 2. Click the copy button on the toolbar. on the
3. Go to the desired location for the new entry or entries and click the paste button toolbar.
4. If an entry name is the same as an entry name in the destination folder, choose whether you want to replace the existing entry with the one that you are copying: To replace the existing entry, click Yes. To cancel the copy, click No.
Move an Entry
When you move an entry, you remove it from the current folder and place it in another folder. You may decide to move an entry if your folder becomes so full that it is difficult to locate particular entries. You can create a series of subfolders and move the entries to support your new folder hierarchy. For example, a folder containing weekly sales reports can be divided into sales reports by month or by author. When you move an entry, the ID stays the same. References to the entry from other entries are not broken. However, shortcuts to the entry no longer work. For example, a report has several report views associated with it. When you move the report to another location in IBM Cognos Connection, the references in the associated report views are not broken. However, shortcuts to the entry no longer work. When you move an entry, if there is another entry of the same name in the target location, you are prompted to replace the existing entry with the moved entry. If you choose to replace the existing entry, the ID of the existing entry is kept. References to the moved entry are broken. Shortcuts to the entry no longer work. If you want to use a generic entry as the underlying structure for additional entries, make a copy of the entry (p. 251). If you want an entry to appear in more than one location, create a shortcut (p. 240). If you want to run an existing agent or report with some minor changes, create an agent view (p. 385) or a report view (p. 354). For example, to change the format, language, or delivery method of a report, create a report view.
252
Chapter 17: IBM Cognos Connection You must have read permissions for the entry you are attempting to move. You must also have write and traverse permissions for the current folder and for the target folder.
Steps
1. In IBM Cognos Connection, select the check boxes next to the entry or entries you want to move. 2. Click the cut button on the toolbar. on the toolbar.
3. Go to the desired location for the entry or entries and click the paste button
4. If an entry name is the same as an entry name in the destination folder, choose whether you want to replace the existing entry with the one that you are copying: To replace the existing entry, click Yes. To cancel the copy, click No.
Rename an Entry
You may decide to rename an entry. Perhaps the current name for an analysis is confusing or the purpose of a report changed. When you rename an entry, the ID stays the same. However, the search path changes. References to the entry from other entries are not broken. Shortcuts to the entry no longer work. For example, a package has reports, agents, and drill-through definitions associated with it. When you rename the package, the references in the associated reports, agents, and drill-through definitions are not broken. You cannot rename an entry to the same name as another entry that already exists in the same location. You must have read permissions for the entry you are attempting to rename. You must also have write and traverse permissions for the current folder and for the target folder.
Steps
1. In IBM Cognos Connection, locate the entry you want to rename, and in the Actions column, click the set properties button 2. Click the Properties tab. 3. In the Name box, type a new name for the entry. 4. Click OK. .
Disable an Entry
You can disable entries to prevent users from accessing them.
Chapter 17: IBM Cognos Connection Disabling entries is useful when you want to perform maintenance operations. For example, you may want to disable a folder while you reorganize its content. When you disable a folder, the folder content is also disabled. If an entry is disabled, the disabled icon appears beside the entry to indicate that it is disabled. ,
If the source entry is disabled, all shortcuts to the entry appear with the source disabled icon indicating that it no longer works.
You must have read and write permissions for an entry (p. 213) to enable or disable it. You must also have traverse permissions on the folder that contains the entry.
Steps
1. In IBM Cognos Connection, locate the entry you want to disable and, in the Actions column, click the set properties button 2. Click the General tab. 3. Select the Disable this entry check box. Tip: To enable a disabled entry, clear the Disable this entry check box. 4. Click OK. If you have only read, execute, or traverse permissions for a disabled entry, you cannot see the entry in the portal. If you have write or set policy permissions for a disabled entry, it appears in the portal with the disabled icon . .
Hide an Entry
You can hide entries in IBM Cognos Connection and IBM Cognos Administration such as reports, packages, pages, folders, jobs, data sources, portlets, and so on, to ensure that the entries are not accessed or run unnecessarily. This specifically applies to drill-through reports that, when they run, could have negative impact on system performance. For example, running drill-through reports that have optional prompts, or no prompts, could result in database queries that use considerable resources. When these reports are hidden in the portal, users cannot run them and the system is not overloaded with unnecessary requests. Hiding an entry does not affect its properties, including security permissions. You can access hidden entries using different methods, such as using a URL. Depending on the user preferences specified in my area , My Preferences, a hidden entry either entirely disappears from the user interface or remains visible, but its icon fades. For more information, see "View a Hidden Entry" (p. 255). You cannot hide users, groups, or roles in external namespaces.
254
Chapter 17: IBM Cognos Connection An administrator controls which users, groups, or roles can hide entries by granting the users access to the Hide Entries capability in IBM Cognos Administration. Only users who have access to this capability can perform the following steps.
Steps
1. In IBM Cognos 8, locate the entry that you want to hide, and click its set properties button . 2. On the General tab, select the Hide this entry check box. 3. Click OK. The entry is now hidden; however, it may still appear in the user interface with a faded icon. To remove the entry from your view, see "Steps to Change the Preference for Viewing Hidden Entries" (p. 256).
The following, are examples of situations when hidden entries are always visible, regardless of the user preferences for viewing hidden entries. Hidden entries on the Permissions and Personal tabs The entries icons are faded. Portal tabs associated with hidden pages Portlets in a page Job steps that refer to hidden entries already in a job
Chapter 17: IBM Cognos Connection The entries icons are faded. Agent tasks that refer to hidden entries already in an agent The entries icons are faded. Details in a report run history The icons that represent hidden entries do not change. Setting the default option for viewing hidden entries in IBM Cognos 8 is part of managing user profiles. Only users who have access to the Hide Entries capability in IBM Cognos Administration can perform the following steps.
2. On the General tab, select or clear the Show hidden entries check box. If you select this check box, the hidden entries appear in the user interface with faded icons. If you clear this check box, the hidden entries disappear from the user interface. 3. Click OK.
Steps
1. In IBM Cognos Connection, locate the entry you want and click the set properties button 2. Click the General tab and find the current link for the entry. For example, for a report, look in Package. For a report view, look in Source report. 3. Click the link. For example, for a report, click Link to a package. For a report view, click Link to report. .
256
Chapter 17: IBM Cognos Connection 4. Select the new entry that you want to link the entry to and click OK.
Delete an Entry
When you delete an entry, you permanently remove it from the portal and its ID is deleted. You may decide to delete an entry because it is outdated or may no longer satisfy your requirements. Deleting the source entry for a shortcut removes only the source entry. The shortcut entries remain but have an invalid reference icon and are not accessible.
Deleting a shortcut or a report or agent view removes only the selected entry and not the source entry. References from other entries no longer work. You must have write permissions or set policy permissions for the entry you are attempting to delete. You must also have write and traverse permissions for the current folder.
Steps
1. In IBM Cognos Connection, select the check boxes next to the entries you want to delete. 2. Click the delete button on the toolbar.
Steps
1. In IBM Cognos Connection, click the tab you want. 2. Click the order button on the toolbar.
3. Select the entries in the Shown in default order list box and click the right-arrow button to move them to the Shown first list box. Note: You specify the order of folders and entries independently. 4. Click the Up, Down, To top, and To bottom links to move the folders and entries within the list. 5. Click OK.
Create a Folder
You can organize entries into folders. Having folders that are logically labeled and organized helps you easily locate reports. For example, you might want to create folders in My Folders or Public Folders to help you organize your entries. You can create folders in the following locations: Public Folders Entries that are placed in Public Folders are of interest to and can be viewed by many users. When the focus is on the Public Folder tab, the content is grouped by packages or folders. Each package contains a single model and all related entries, such as folders, reports, jobs, report views, agents, metrics, URLs, and shortcuts. My Folders You create personal folders and use them to organize entries according to your preferences. My Folders are accessible by you only when you are logged on. You must have write access to a folder to create entries in it.
Tips
Click More to view a full list of actions that can be performed on an entry. Click Set Properties to change the general properties, defaults, permissions, and job properties for an entry. Not all properties are available for each type of entry.
Steps
1. In IBM Cognos Connection, go to the location for the new folder. 2. Click the new folder button on the portal toolbar.
3. In the Name box, type the name of the new folder. 4. If you want, in the Description and in the Screen tip box, you can type a description of the entry. The description appears in the portal when you set your preferences to use the details view (p. 260). The screen tip, which is limited to 100 characters, appears when you pause your pointer over the icon for the entry in the portal. 5. If you do not want to use the target folder shown under Location, choose another location: Click Select another folder, select the target folder, and click OK. If the folder box is empty, go back one folder level using the path at the top of the dialog box. Click Select My Folders as the location.
6. Click Finish. The new folder has the same permissions as the parent folder. For information about changing access permissions, see "Access Permissions" (p. 213).
258
Steps
1. In IBM Cognos Connection, locate the entry you want and click the set properties button. 2. Click the General tab and next to Icon, click Edit. 3. Click Specify an icon, and in the edit box, specify a name for the image, for example, myicon.gif. The image must exist in the folder c8_location/webcontent/ps/portal/images. 4. Click OK. Wherever the entry appears in the portal, the alternative icon appears instead of the standard icon.
Method
Contains the exact string
Search criteria
Report 1
Results
"Report 1", "Report 100", "Copy of Report 1" "report 1", "Report 100" "Report", "report"
report Report
Entries for which you have access permissions are included in the search results.
Steps
1. Go to the highest level folder you want to include in your search. Tip: You can increase or limit the folders to include in your search by changing the Scope when you enter the search criteria. 2. Click the search button on the toolbar. Administration and Security Guide 259
Chapter 17: IBM Cognos Connection 3. In the search box, type the phrase you want to search for. 4. Click Advanced. 5. Choose the type of match between the search string and the results: To return entries that include the search string somewhere in the name or description, click Contains the exact string. To return entries whose name or description begins with the search string, click Starts with the exact string. To return entries whose name or description matches the search string word for word, click Matches the exact string. 6. In the Type box, click the type of entry to search for. Tip: To search for all shortcuts in the selected location, click Shortcuts. 7. In the Modified box, click the date that the entry was last modified. For example, if you want the search to return entries that were updated in the last week, click In last week. Note: This option is only available in the Cognos namespace. 8. In the Scope box, click the folders you want to include in the search. 9. Click the Search button.
The entries matching the search criteria and for which you have permissions to view appear at the bottom of the screen under Results. Tip: To open an entry, click its link.
General
Number of entries in list view
Description
The maximum number of rows that appear in a list before scrollbars are required. This applies to rows where scrolling is allowed.
260
General
Separators in list view
Description
The method of separating entries in lists in Public Folders and My Folders. Choose from no separator, grid lines, or alternating backgrounds. This setting applies to all lists with the exception of the output versions list. This setting is available only if you use Internet Explorer or Firefox.
Style
The uniform look and feel applied to all components of IBM Cognos 8. You can choose from the styles available to you.
Use this setting to show or remove hidden entries from your view in IBM Cognos Connection. When you select this check box, the hidden entries remain visible, but their icons are faded. When you clear this check box, the hidden entries disappear from your view. For example, hidden packages are not visible in IBM Cognos Connection and in the associated studios. You must have access to the Hide Entries capability granted by your administrator to see this setting.
Default view
The decision to use list view or details view by default. List view shows the name, modified date, and actions. Details view shows the name, description, modified date, and possible actions. Details view works only in Public Folders and My Folders in IBM Cognos Connection. In other components, list view is used.
Number of columns in details view The maximum number of columns per row for the details view. Report format The preferred format to view the report. Choose between HTML, PDF, Delimited Text (CSV), Excel, and XML.
Show a summary of the run options The option to show a summary of the run options when a report is not run interactively. Show the Welcome page at startup The option to show or hide the Welcome page at the beginning of a session.
General
Product language
Description
The language used by the IBM Cognos 8 user interface. It applies to all IBM Cognos 8 components, such as IBM Cognos Connection, Cognos Viewer, and Report Studio. The language used to view and produce content in IBM Cognos 8, such as names and descriptions of entries, or data in reports. The time zone used. Select the default server time zone set by your administrator. For more information, see the Installation and Configuration Guide. Or you can select another time zone.
Content language
Time zone
Personal settings appear if you have read permissions for your account.
Personal
Primary logon
Description
The namespace and credentials that you used to log on to IBM Cognos 8. Also shows the given name, surname, and email address if they have been defined. A list of secondary logons. The secondary logons exists if you logged on to multiple namespaces.
Secondary logon
Alerts
Use to specify an email address for alerts. When the delivery service processes the alert list, it uses the email address specified in the Email box to send alerts to the user. If there is no email address specified, the email address specified in the Primary logon section is used.
Credentials
Authorization to other users, groups, and roles to run entries using the credentials. Click Renew the credentials after you change your password, or to ensure that all credentials are available if you are logged on to multiple namespaces.
A list of groups and roles associated both with your primary and secondary logons.
262
Personal
Capabilities
Description
A list of secured functions and features that you can use based on both your primary and secondary logons. To create trusted credentials, see "Trusted Credentials" (p. 218).
Portal tabs settings appear if you have read permissions for your account.
Portal Tabs
List of entries
Description
Represents the tabs, including Public Folders and My Folders, in your IBM Cognos Connection environment. Use to add a tab for a specified page in IBM Cognos Connection. Each tab represents Public Folders, My Folders, or a page.
Add
Use to remove a tab from IBM Cognos Connection. Use to change the order of tabs in IBM Cognos Connection.
Steps
1. In IBM Cognos Connection, click My Area, My Preferences, and click the required tab. 2. Choose the appropriate settings. 3. Click OK.
My Watch Items
Use the My Watch Items area of the portal to view (p. 264) and manage watch items from a single location. Watch items include alert lists and watch rules that help you monitor business events that are important to you. The Alerts tab shows the alert lists to which you belong. Use this tab to remove yourself from the alert list for a report or agent. The Rules tab shows the watch rules you created in saved HTML report output. Use this tab to edit a watch rule (p. 264) enable or disable a watch rule. For information, see "Disable an Entry" (p. 253). organize watch rules in folders. For information, see "Create a Folder" (p. 258). delete a watch rule. For information, see "Delete an Entry" (p. 257). edit the My Watch Items page properties. For information, see "Edit a Page" (p. 270).
Chapter 17: IBM Cognos Connection You can also add yourself to the alert list for a report (p. 366), add yourself to the alert list for an agent (p. 386), and create a watch rule for a report (p. 367). The report owner must allow report users to receive alerts and create watch rules for the report.
Steps
1. In IBM Cognos Connection, in the upper-right corner, click My Area 2. To view your alerts lists, click Alerts. 3. To view your watch rules, click Rules. , My Watch Items.
Steps
1. In IBM Cognos Connection, in the upper-right corner, click My Area , My Watch Items.
2. Click the Alerts tab, and in the Source column, click the alert list to remove. You can select multiple alert lists. 3. Click the remove me from the alert list button. 4. Click the refresh button. Note that the alert list is removed from the Source column.
264
Chapter 17: IBM Cognos Connection To edit a watch rule in IBM Cognos Connection, you must have read and write permission to the My Watch Items page.
Steps
1. In IBM Cognos Connection, in the upper-right corner, click the my area button My Watch Items. 2. Click the Rules tab, and in the Actions column, click the set properties button for the watch rule you want to edit. 3. Use the Set properties page, General tab, to change the properties, such as name, language, or description for the watch rule. 4. Use the Set properties page, Rule tab, to change the properties, such as rule, context, and alert type for the watch rule. To change a rule, in the Rule section, click the condition that appears, for example, > (greater than), click a new condition in the list, and specify a value for the condition in the box. To change the context, under For the selected context, select the check box next to the report items you want to include. To edit the alert type, under Alert type, select the alert type, if it is not already selected. Next to the alert type, click Edit the options. , and click
266
Page Content
Portlet
Portlet Group
Cognos Content
Browse IBM Cognos folders, reports, and other Cognos Navigator entries Search for IBM Cognos reports and other entries Cognos Search View and interact with IBM Cognos reports and Cognos Viewer other entries View and interact with different types of perform- Metric List ance metrics, such as the metrics you want to monitor closely, or the metrics for which you are directly responsible. Add a metric history chart that illustrates the historical performance of the metric Display an impact diagram associated with a metric Display a custom diagram associated with a scorecard. Metric History Chart
Cognos Metrics
Page Content
Portlet
Portlet Group
Cognos Extended Applications Portlet
View and interact with custom applications cre- Cognos Extended ated using IBM Cognos 8 Software Development Applications Kit Register and show active links to other Web pages Bookmarks Viewer Add and view custom images, such as logos Insert any other Web page Image Viewer HTML Viewer
Cognos Utility
Add and show the content of a Real Simple Syn- RSS Viewer dication (RSS) news feed specified by a URL address Add and view custom text and images HTML Source Dashboard
Create and view a dashboard with multiple tabs Multi-page Add non-Cognos items to a page
Note: The portlets can also be referred to as HTML fragments. The list of pages is cached in an IBM Cognos Connection session. When the state of a page changes during the current session, users who have access to the page are affected. For example, when a page is disabled or deleted, it can no longer be used and its tabs are deleted or not functional. To update the portal with the most current settings, use the IBM Cognos Connection refresh button . When you log on to IBM Cognos Connection for the first time, you access the pages an administrator made available to you. Later, you can create your own pages. You can perform the following page-related tasks in IBM Cognos Connection: create pages (p. 269) and dashboards (p. 275) edit pages (p. 270) share pages with other users (p. 270) modify portlets (p. 271) enable communication between portlets (p. 271) add, remove, or reorder the portal tabs (p. 273) change your home page (p. 275) add interactivity to pages and dashboards (p. 278)
268
Chapter 18: Pages and Dashboards For more information about portlets, see "Deploying Cognos Portlets to Other Portals" (p. 441).
Create a Page
You can create your own pages in IBM Cognos Connection to group different types of information into a single view. The pages are saved in Public Folders or My Folders. If you plan to share a page with other users, save it in Public Folders. After you create the page, you can edit it to modify its contents, layout and style, and to set access permissions (p. 270). You can delete pages in IBM Cognos Connection (p. 257) if you have the required access permissions for the pages. Deleting a page may affect your portal tabs (p. 273).
Steps
1. In IBM Cognos Connection, click the new page button .
2. Specify a name and location for the page, and, if you want, a description and a screen tip. 3. Click Next. The Set columns and layout page appears. 4. Define the layout for your page by setting the number and width of columns. Tip: If you are using multiple columns and one of the columns includes a report that is shown in Cognos Viewer, set the width to at least 50% to minimize scrolling. 5. In the column to which you want to add portlets, click Add. 6. Click the portlet group that contains the portlets you want to add. 7. Select the portlets, and click the add button to move them to the Selected entries box. If
you want to remove a portlet from the Selected entries box, click Remove. Tip: You can preview the content of the portlets by clicking the view this portlet button 8. Click OK. 9. Repeat steps 5 to 8 for each portlet group you want. 10. Click OK, and then click Next. The Set page style page appears. 11. Customize the appearance of your page. If you want, add a title and instructions for the page in the language of the product. For more information, see "Edit a Page" (p. 270). To hide the title or instructions, select the associated check box. .
Chapter 18: Pages and Dashboards Tip: To change the formatting of the text, click Custom. To go back to the default formatting, click Return to default. If you want, hide the portlet borders, title bars, or the edit button in the title bar. This helps to avoid clutter and gives the page a uniform look and feel.
12. Click Next. 13. If you want to add the page to the portal tab bar, select the Add this page to the portal tabs check box. To view the page, select the View the page check box. 14. Click Finish.
Edit a Page
You can change the page content, layout and style, and access permissions. For example, you may want to see a different report, or change the list of users who can access the page.
Steps
1. Go to the page you want to edit. 2. Click the edit page button .
Tip: Alternatively, locate the page in IBM Cognos Connection, and click its set properties button. 3. Change the page properties as required. For more information about changing the page content, layout, and style, see "Create a Page" (p. 269). For more information about setting the page access permissions, see "Share a Page" (p. 270).
Share a Page
You can share your page with other users by giving them access permissions for the page. You can set up the permissions so that other users can only view the page or also modify it. To view a page, traverse and execute permissions for the page, and execute permissions for its portlets are required. To modify the page, write permissions are also required.
Steps
1. If you did not create the page in Public Folders, copy it there from your personal folders (p. 251).
270
Chapter 18: Pages and Dashboards 2. Specify which users, groups, or roles can have read, traverse, execute, or write permissions for the page. For more information, see "Access Permissions" (p. 213)
Modify a Portlet
Portlets provide different types of information for pages. You can modify the content of an instance of a portlet in a page if you have the required permissions for the page (p. 270). You will retain the custom settings even if the administrator resets the portlet. Other users who also have access to the page that contains this portlet instance will also see the changes. However, if the administrator locks the portlet, you cannot configure it. The configurable properties for the Cognos portlets vary. For more information, click the help button in the portlet title bar.
Steps
1. Go to the page that contains the portlet. 2. In the portlet title bar, click the edit button 3. Edit the properties as required. Tip: If you want to go back to the default settings, click the reset button. 4. Click OK. .
Source portlet
Cognos Navigator Cognos Search Cognos Viewer
Target portlet
Cognos Viewer Cognos Viewer Cognos Viewer
Source portlet
Metric List
Target portlet
Cognos Viewer Metric History Chart Metrics Impact Diagram
To enable this functionality, you specify a channel name in the target portlet and refer to this name in the associated source portlets. For more information about Cognos portlets, see "Deploying Cognos Portlets to Other Portals" (p. 441).
Steps
1. Go to the page or the dashboard that contains the portlets for which you want to enable portletto-portlet communication. 2. Click the edit button in the portlet title bar.
3. For the channel property, type the name you want. The name can contain letters, numbers, and underscore (_) characters, but must not contain any spaces. For example, Cognos, Cognos_Portlets, CognosPortlets are valid names. Note: The boxes where you type the channel name have different labels in different portlets. For example, Channel, Portlets using channel, or In a destination portlet. 4. Click OK. 5. Repeat the steps for each portlet that you want to broadcast on the same channel. Ensure that you type the same channel name.
272
Portal Tabs
The tabs in IBM Cognos Connection are used to quickly access the pages that are important to you. The tabs represent: Public Folders My Folders Pages or dashboards
An administrator specifies the default tab setup for users. To personalize IBM Cognos Connection, you can add (p. 273) and remove (p. 274) tabs, or reorder them (p. 275). Other users are not affected by your changes. When you delete a page, the tab associated with this page is automatically removed. Your tabs may also be affected by changes to the associated pages made by other users who have access to the pages. For example, when a page is deleted during the current session, its tab is no longer functional, and an error message may appear when you click the tab. To see the most current tab settings, click the IBM Cognos Connection refresh button .
Add a Tab
You can add a tab in IBM Cognos Connection for a new page or for an existing page so that you can access the page quickly. If the Public Folders or My Folders tabs are not available in your tab bar, you can add them, too. Only one tab can exist for each folder or page. There are various methods to add a tab. Choose the method that is applicable to your current view.
A list of your current tabs appears. 2. Click Add. 3. In the list of available pages, select the page you want. You can select multiple pages. 4. Click the right arrow button 5. Click OK. The tab for the page appears in the portal. to move the page to the Selected entries box.
2. In the list of available pages, select the page you want. You can select multiple pages. 3. Click the right arrow button to move the page to the Selected entries box. 4. Click OK. The tab for the page appears in the portal.
Delete a Tab
You can delete a tab when it is not needed. When you delete a page that has a tab, the tab is automatically removed. When you remove a tab for a page, the page is not deleted. You can delete the Public Folders and My Folders tabs, and add them back later, if needed (p. 273). Deleting the tabs does not delete Public Folders and My Folders from Content Manager.
A list of your current tabs appears. 2. Select the check box next to the tab you want to remove, and click Remove this tab. You can select multiple tabs. 3. Click OK. The tab is deleted from the tab bar.
3. In the message box, ensure you are deleting the proper tab, and click OK. The tab is deleted from the tab bar.
274
A list of your current tabs appears. 2. Click Modify the sequence. 3. In the Tabs box, move the tabs up or down as required. 4. Click OK. The tabs appear in the new order. 5. Click OK to close My Preferences.
A list of your current tabs appears. 2. Move the tabs up or down using the appropriate buttons. 3. Click OK. The tabs appear in the new order.
Steps
1. Go to the page you want to set up as your new home page. 2. Next to the home icon , click the arrow, and click Set as Home Page.
Chapter 18: Pages and Dashboards folders and shortcuts to folders Use folders to include a second level of tabs. packages and shortcuts to packages Use packages to include a second level of tabs. reports and shortcuts to reports Use to view or run a Report Studio report. report views and shortcuts to report views Use to view or run a Report Studio report. queries and shortcuts to queries Use to view or run a Query Studio report. analysis and shortcuts to analysis Use to view or run an Analysis Studio report. pages and shortcuts to pages Use to add a page or another dashboard URLs and shortcuts to URLs Use to embed a different Web page. PowerPlay reports Use to view or run a PowerPlay report MS Documents Use to include a link to a Microsoft document, such as an Excel, PowerPoint, or Word document. The general dashboard properties are the same as page properties. You can edit the dashboard layout and style (p. 270), modify the properties of the Multi-page portlet (p. 271), set up access permissions for the dashboard (p. 270), and add it to the portal tabs (p. 273).
276
Root folder Dashboards Sales (1) Marketing (2) Sales Resources Marketing Resources Shortcut (3) Shortcut Page Folder
1. The Sales and Marketing pages are the multi-tabbed dashboards. These are the dashboard master pages that are built using the Multi-page portlet. The Sales Resources folder is the source folder for the Sales dashboard, and the Marketing Resources folder is the source folder for the Marketing dashboard. The source folders can contain entries such as reports, pages, folders, shortcuts, and so on. These entries appear as tabs in the dashboard.
2.
3.
Steps
1. In IBM Cognos Connection, click the new page button 2. Type the name, and select a location for your page. 3. Click Next. 4. In the Set columns and layout page, set the number of columns to 1, and the column width to 100%. 5. Click Add. A list of portlet groups appears. 6. In the Available Entries box, click Dashboard. 7. Select the Multi-page portlet, and click the right arrow button Selected Entries box. 8. Click OK, and then Next. 9. In the Set page style page, specify a meaningful title for the page, select any of the remaining properties, and click Next. 10. In the Select an action page, you can select Add this page to the portal tabs. 11. Click Finish. The page that you created is the dashboard master page. 12. Open the page you created. Administration and Security Guide 277 to move the portlet to the .
Chapter 18: Pages and Dashboards An empty frame of the Multi-page portlet appears. 13. In the portlet toolbar, click the edit button The portlet properties page appears. 14. In the Folder section, click Select an entry. 15. Browse to the folder or package that contains the resources for the dashboard, such as shortcuts, pages, or bookmarks. Select an entry, and click OK. Tip: To add My Folders as a tab in the dashboard, create a shortcut to My Folders. 16. Specify other portlet properties as required. For example, in the Display Style section, specify how to display the dashboard tabs, horizontally at the top of the page, or vertically on the left side of the page. For more information about the portlet properties, see "Multi-page" (p. 738). 17. Click OK. You can now open and view the dashboard page. Tip: Other users can access the dashboard through its URL. To see the URL, go to IBM Cognos Connection, locate the dashboard master page, and open its properties page. On the General tab, click View the search path, ID and URL. .
278
Chapter 18: Pages and Dashboards Create the Global Filters (p. 279) Assemble the Reports on a Page (p. 280)
We do not recommend using the default parameter name, such as Parameter1. The Report Studio reports must follow the naming convention used in one of the other studios. For example, in Query Studio the convention is [attribute name] or [level name], such as Order_Method1. In Analysis Studio the convention is [hierarchy name], such as Order
Method.
Note: If the page contains only Report Studio reports, we recommend using the p[attribute
name]Prompt convention, for example, pCountryPrompt.
Chapter 18: Pages and Dashboards When a user clicks a metric name in Metric List, Metrics Impact Diagram, or Metrics Custom Diagram, Cognos Viewer dynamically updates the report if the report prompt parameters are based on metric values. When a user clicks a strategy element in Metrics Custom Diagram, Cognos Viewer dynamically updates the report if the report prompt parameters are based on strategy element values. For this functionality to work, the following parameters that are broadcast on a channel after a click action in a Cognos Metrics portlet must match the names of the report prompt parameters:
scorecard_extid scorecard_sid strategy_sid metric_sid metric_extid time_period_sid
280
Target report 2
If your page includes reports from different packages, ensure that the prompt reports use the same parameter names as the target reports. Use the following steps when defining global filters in a single page. If you want to implement this functionality in a dashboard, you must complete additional steps. For more information, see "Create a Dashboard with Multiple Tabs" (p. 275).
Steps
1. In IBM Cognos Connection, click the new page button 2. Type the name, and select a location for your page. 3. Click Next. 4. In the Set columns and layout page, set the number and width of columns. For example, the reports that display the prompts and prompt controls can be placed in one column, and the target reports in a separate column to the right. 5. Click Add at the bottom of the first column. 6. In the Available Entries box, click IBM Cognos Content. 7. Select the Cognos Viewer portlet, click the right arrow button Selected Entries box, and click OK. 8. Repeat steps 5 to 7 for each column. You must add the Cognos Viewer portlet for each report that you want to include in the column. For example, if the column on the left will contain a prompt and prompt controls, add two Cognos Viewer portlets. 9. Click Next. 10. Complete the remaining steps in the wizard, if needed, and click Finish. For more information, see the steps in the section "Create a Page" (p. 269). 11. Go to the folder where you saved the new page, and open it. In the page columns, you can see the empty frames of the Cognos Viewer portlets. to move the portlet to the .
12. For any portlet in the page, click the edit button
13. In the portlet properties page, click Select an entry to select the report you want to display in the portlet. 14. Click Edit Properties. The Advanced Properties Editor appears. 15. For the Fragment Action property, specify the default portlet action when the portlet is invoked in a page. You can choose to show the run icon, run the report, or view the most recent saved output. Tip: For more information about the portlet properties, click the Help button in the portlet. 16. For the Prompt the user property, specify how to execute the prompts. 17. For the Prompt values property, select the Communicate with other portlets check box. This property enables communication between this portlet and other portlets in the page that have this property set up. When you select Every time, if the report contains optional or required prompts, the user is prompted to enter the prompt values before the report is run. When you select Only when required parameter values are missing, the user is prompted if the report contains required prompts and the values are missing. Otherwise the report runs successfully. When you select Never and show the report only when required values are provided, Cognos Viewer attempts to run the report, but the page remains hidden until the required prompt values are provided. When you select Based on the prompt settings of the report, Cognos Viewer uses the prompts specified in the report.
18. If you want to set up communication between only specific portlets in the page, type the channel name in the box provided. Only the portlets that share the same channel name can interact. By specifying the channel name, you have more control over the page. For example, you can link only the reports that have matching parameters. For more information about this property, click the Help button in the portlet. 19. If you want to see the portlet toolbar in the page, for the Show Toolbar property, select the Normal mode and Maximized mode check boxes. 20. Click OK to close Advanced Properties Editor, and click OK again to close the general properties page. 21. Repeat steps 12 to 20 for each portlet in the page.
282
Steps
1. In IBM Cognos Connection, create a page that contains the Cognos Viewer portlet for each report that you want to add to the page. For more detailed information, see the steps in "Create a Page" (p. 269). 2. Configure the Cognos Viewer portlets to display the reports that you want to add to the page. In the portlet properties page, click Select an entry to select the report you want to display in the portlet. 3. In the Advanced Properties Editor of the Cognos Viewer portlets, for the Drill down and drill up property, select the Communicate with other portlets on the page check box. This property enables communication between all portlets in the page using the default channel. For more information, click the Help button in the portlet. 4. If you want to set up communication between only specific portlets in the page, type the channel name in the box provided. Only the portlets that share the same channel name can interact. By specifying the channel name, you have more control over the page.
Chapter 18: Pages and Dashboards This functionality is not supported for dashboards with multiple tabs. However, a single page with drill-through actions enabled can be embedded into a dashboard as one of the tabs.
Steps
1. In IBM Cognos Connection, create a page that contains the Cognos Viewer portlets for the drill-through source report, and the target report. For more detailed information, see the steps in the section "Create a Page" (p. 269). 2. Configure one of the Cognos Viewer portlets to display the Report Studio source report that contains the drill-through path. In the portlet properties page, click Select an entry to select the report you want to display in the portlet. 3. Configure the other Cognos Viewer portlet to display the drill-through target report. As the target report, we recommend using a report that contains prompts. In the portlet properties page, click Select an entry to select the report you want to display in the portlet. 4. For both portlets configured in step 2 and 3, in the Advanced Properties Editor page, for the Report-based drill-through property, select the Communicate with other portlets on the page check box, and type the channel name in the box provided. The channel name is mandatory. For more information about this property, click the Help button in the portlet.
284
Chapter 19: Activities Management You can filter the entries to display only those you want. In My Activities and Schedules, you can choose to display only those entries with a specific status or priority, or entries of a specific type or scope. In IBM Cognos Administration, for interactive current entries, you can filter by status and the dispatcher where the activity is running. For background current entries, you can filter by status, priority, type, scope, user who ran the entry, user who owns the entry, and dispatcher. If you cancel an entry that contains other entries, such as a job or an agent, steps or tasks that have not yet been completed are cancelled. However, steps or tasks that have already completed remain completed. You can change the priority of entries (p. 293) and view the run history (p. 294).
Goal
Show entry details Hide entry details Cancel the run Suspend the run Release suspended entries
Button
286
Goal
Set entry priority
Button
Goal
Show entry details Hide entry details Cancel the run Suspend the run Run suspended entries Set entry priority
Button
Chapter 19: Activities Management Each entry is listed by name and shows the request time and the status. You can sort the Request time and Status columns. The bar chart shows the total number of entries, broken down by status. If an entry has failed, a button appears showing the severity of the error. In IBM Cognos Administration, the user who ran the entry is also listed. You can filter the entries to display only those you want. In My Activities and Schedules, you can choose to view a list of activities that occurred over a specified length of time, such as the last four hours or the last day, or you can specify a date or time range. You can filter by status, type, and scope. In IBM Cognos Administration, you can also filter by the user who ran the entry, the user who owns the entry, and the dispatcher where the activity ran. You can view the run history (p. 294).
Goal
Show entry details Hide entry details
Button
288
Chapter 19: Activities Management 4. From the Filter menu, click the filtering items that you want to use. Tips: If you want to use advanced filtering options, click Advanced options. To reset all selections to the default settings, click Reset to default. 5. Click Apply. The list shows the entries that you selected. 6. If an error occurred when the entry ran, pause over the error button to see the severity of the error. 7. To perform an action on an individual entry, click the arrow to the right of the entry to display the Actions menu and then select the action. To perform an action on several entries, click one of the following buttons on the toolbar.
Goal
Show entry details Hide entry details
Button
Chapter 19: Activities Management The list shows the entries that you selected. 5. To perform an action on an individual entry, click the arrow to the right of the entry and select the action. To perform an action on several entries, select the check box for the entries you want and then click one of the following buttons on the toolbar. Tip: To select all entries, click the check box in the upper left-hand corner, next to Name.
Goal
Show entry details Hide entry details Cancel the run Re-schedule a run that was cancelled Set entry priority
Button
Goal
Show entry details Hide entry details Cancel the run
Button
290
Goal
Re-schedule a run that was cancelled Set entry priority
Button
Goal
Show entry details
Button
Goal
Hide entry details Enable the schedule Disable the schedule Set entry priority
Button
Goal
Show entry details Hide entry details Enable the schedule Disable the schedule Set entry priority
Button
292
and then click Current Activities, Upcoming Activities, or Schedules. 3. To change the priority for one entry, click the arrow to the right of the entry and select Set Priority. To change the priority of more than one entry, select the check box for the entries you want and then click the set priority button on the toolbar.
Tip: To select all entries, click the check box in the upper left-hand corner, next to Name. 4. From the menu, click the priority that you want, and then click OK. If you selected one entry, the current priority of the entry appears in the Set the priority box. If you selected multiple entries, the Set the priority box contains (Multiple).
Chapter 19: Activities Management 2. In the upper-right corner, click Launch, IBM Cognos Administration. 3. Click the Status tab, and then click Upcoming Activities or Schedules. 4. To change the priority for one entry, click the arrow to the right of the entry and select Set Priority. To change the priority of more than one entry, select the check box for the entries you want and then click the set priority button on the toolbar.
Tip: To select all entries, click the check box in the upper left-hand corner, next to Name. 5. From the menu, click the priority that you want, and then click OK. If you selected one entry, the current priority of the entry appears in the Set the priority box. If you selected multiple entries, the Set the priority box contains (Multiple). The new priority appears in the Priority column next to the entries that you selected.
294
Chapter 19: Activities Management You can rerun failed entries (p. 297) from the detailed run history page. You can view a list of related runs that are part of the rerun series and see a detailed run history for each one. You can specify how many run history occurrences to keep or for how long to keep them (p. 296).
Chapter 19: Activities Management the version in Cognos Viewer, click the version you want to view. To delete a version, click Manage versions, click the check box for the version, and then click Delete. 8. If there is a log file associated with the entry and you want to view it, click the view the log file button. 9. If you want to view messages, click an item with a link in the Messages column. Tip: Messages are nested. There may be child messages within child messages. If a message is displayed as a link, you can continue to drill down through the child messages.
2. On the General tab, under Run history, choose the retention method and type the value: To keep run histories for a specific number of occurrences, click Number of occurrences and type the number. To save an unlimited number of run histories, set this value to 0. To keep run histories for a specific length of time, click Duration and click either Days or Months. Type the appropriate value in the box. 3. Click OK.
The View run history details page shows run details, such as start time and completion time, run status, and error messages for a failed run. Other information that appears in the page depends on whether the entry is for a single task, a job with multiple steps, or an agent with tasks. For example, if it is a single task, the report options and the report outputs appear. If it is a job with multiple steps, a Job section appears with the run details of the job steps. 4. Under Status, next to Failed, click Rerun. If the rerun task is a single task, you receive a message asking you to confirm the rerun. If the rerun task is a job with multiple job steps or an agent with tasks, the Rerun page appears. Select the check box next to the entries you want to rerun.
Chapter 19: Activities Management Tips: You can also rerun failed entries by clicking Rerun in the Outstanding to complete section. To rerun a single job step, in the Job section, in the Actions column, click the view run history details button for the failed step.
The View run history details page shows run details, such as start time and completion time, run status, and error messages for a failed run. Other information that appears in the page depends on whether the entry is for a single task, a job with multiple steps, or an agent with tasks. For example, if it is a single task, the report options and the report outputs appear. If it is a job with multiple steps, a Job section appears with the run details of the job steps. 5. Under Status, next to Failed, click Rerun. If the rerun task is a single task, you receive a message asking you to confirm the rerun. If the rerun task is a job with multiple job steps or an agent with tasks, the Rerun page appears. Select the check box next to the entries you want to rerun.
Tips: You can also rerun failed entries by clicking Rerun in the Outstanding to complete section. To rerun a single job step, in the Job section, in the Actions column, click the view run history details button for the failed step.
298
You can schedule entries to run at specified intervals. You can schedule entries individually (p. 300) or use jobs to schedule multiple entries at once (p. 301). Jobs have their own schedules independent from report schedules. You can schedule entries to run on the last day of each month (p. 301). You can also schedule entries to be triggered by occurrences, such as database refreshes or emails (p. 304). Only one schedule can be associated with each entry. If you require multiple schedules for a report or agent entry, you can create report views (p. 354) or agent views (p. 385) and then create a schedule for each view. After you create a schedule, the entry or job runs at the time and date specified. You can then view the scheduled entries and manage them. For more information, see "Activities Management" (p. 285).
Chapter 20: Schedule Management For more information, see "Manage Entry Run Priority" (p. 293).
Schedule an Entry
You schedule an entry to run it at a later time or at a recurring date and time. For example, you can schedule a report or an agent. If you no longer need a schedule, you can delete it. You can also disable it without losing any of the scheduling details. You can then enable the schedule at a later time. For more information, see "Activities Management" (p. 285). You can schedule an entry to run on the last day of each month (p. 301) or as part of a job (p. 301). You can schedule reports based on trigger occurrences (p. 304). To schedule an entry, you need the permissions that are required to run the entry. For example, to schedule a report or report view, you must have read, write, execute, and traverse permissions for it. To schedule a child report view, you must have execute permissions on the parent report. You also require the following access permissions for any data sources used by the report: dataSource - Execute and Traverse dataSourceConnection - Execute and Traverse With only Execute access, you are prompted to log on to the database. dataSourceSignon - Execute
To set priority for an entry, you must have the required permissions for the Scheduling priority secured feature. See "Secured Functions and Features" (p. 221).
Steps
1. Click the schedule button for the entry you want to schedule 2. Set the priority for the scheduled entry. Select a lower number for higher priority. The default is 3. 3. Under Frequency, select how often you want the schedule to run. The Frequency section is dynamic and changes with your selection. Wait until the page is updated before selecting the frequency. 4. Under Start, select the date and time when you want the schedule to start. 5. Under End, select when you want the schedule to end. Tip: If you want to create the schedule but not apply it right away, select the Disable the schedule check box. To later enable the schedule, clear the check box. .
300
Chapter 20: Schedule Management 6. If additional options are available on the Schedule page, specify what you want. For example, for reports, you can select formats, languages, delivery method (including how to save report output files), and prompt values. For more information, see "Reports and Cubes" (p. 347). 7. Click OK. A schedule is created and the report runs at the next scheduled time.
Steps
1. Click the schedule button for the entry you want to schedule 2. Under Frequency, select By Month, and then select Day. 3. Enter Day 31 of every 1 month(s). Entering 31 as the day ensures that the entry runs on the last day of the month, regardless of how many days are in the month. 4. Under Start, select the last day of the current month as the day you want the monthly schedule to start. 5. Under End, select the last day of the same month next year as the day you want the monthly schedule to end. 6. Click OK. .
Chapter 20: Schedule Management You can schedule a job to run at a specific time, on a recurring basis, or based on a trigger, such as a database refresh or an email (p. 304). The individual reports, jobs, and report views in steps can also have individual schedules. Run options for individual step entries override run options set for the job. You can set run options for the job that serve as the default for step entries that do not have their own run options. You can run reports to produce outputs based on the options that you define, such as format and language. You can also include content store maintenance and deployment imports and exports in a job. For more information, see "Maintain the Content Store" (p. 125) and "Deployment" (p. 307).
Permissions
Permissions required to include an entry as part of a job vary depending on the type of entry. The permissions are the same as for scheduling an entry (p. 300).
Steps
1. Click the new job button .
2. Type a name and, if you want, a description and screen tip for the job, select the location in which to save the job, and then click Next. The Select the steps page appears. 3. Click Add. 4. Select the check boxes for the entries you want to add and click the right arrow button the entries you want appear in the Selected entries box, click OK. .When
302
Chapter 20: Schedule Management You can also click Search, and in the Search string box, type the phrase you want to search for. For search options, click Edit. When you find the entry you want, click the right arrow button to list the entry in the Selected entries box and click OK. To remove entries from the Selected entries list, select them and click Remove. To select all entries in a list, click the check box in the upper-left corner of the list. To make the user entries visible, click Show users in the list. 5. If you want to change run options for an individual entry when it runs as part of the job, click the set icon , click Produce report outputs, select the Override the default values box, make
the changes, and click OK. To send the report to mobile recipients, select Send the report to mobile recipients and click Select the recipients. Tip: To return to defaults for individual entries, click the delete button. 6. If you want to refresh the cache for a report when the job runs, click the edit icon next to the report, and then from the Run the report to menu, click Refresh the report cache. Click Override the default values. To accept the displayed language, click OK. To change the language, click Select the languages, select the languages you want, and then click OK. Click OK to accept the displayed languages. Tip: To clear the cache, click the delete button. 7. If you want to create or refresh the cache, click the set icon, click Refresh the report cache, select the Override the default values box, add languages, if you want, and click OK. Tip: To clear the cache, click More next to the report whose cache you want to clear, click Clear the cache, and click OK twice. 8. Under Submission of steps, select whether to submit the steps All at once or In sequence. If you select In sequence, the steps are executed in the order they appear in the Steps list. If you want the job to continue to run even if one of the steps fails, select the Continue on error check box. Tip: To change the order, click Modify the sequence, make the changes, and click OK. 9. If you want to specify default run options at the job level, under Defaults for all steps, click Set. 10. If you want to override defaults, select the category and select the Override the default values check box and select the default options you want for the job and click OK. 11. To save the complete history details for the job steps when the run activity completes successfully, click All from the Run history details level list. Click Limited to save limited run history details for the job. If the job run fails, the complete history details are saved. The default is All. 12. Select the action you want:
Chapter 20: Schedule Management To run now or later, click Run now or at a later time and click Finish. Specify the time and date for the run. Click Find only or Find and fix, then click Run. Review the run time and click OK. To schedule at a recurring time, click Schedule to run at a recurring time and click Finish. Then, select frequency and start and end dates. Click Find only or Find and fix, then click OK. Tip: To temporarily disable the schedule, select the Disable the schedule check box. To view the schedule status, see "Activities Management" (p. 285). To save without scheduling or running, click Save only and click Finish.
Data source
dataSource dataSourceConnection
Permissions
Execute and Traverse Execute and Traverse With only Execute access, you are prompted to log on to the database.
dataSourceSignon
Execute
Before setting up trigger-based scheduling, ensure that your credentials exist and are up to date.
304
Follow this process to set up trigger-based scheduling: Schedule an entry based on the occurrence (p. 305). Have your administrator set up the trigger occurrence on a server.
Trigger occurrences can also be set up by an SDK developer using the IBM Cognos 8 Software Development Kit (SDK). For more information, see the SDK Developer Guide. See information about setting up the trigger occurrence on a server (p. 535). You can also disable trigger-based scheduling (p. 535).
Steps
1. Click the schedule button next to the entry you want to schedule.
2. Under Frequency, click the By Trigger tab. 3. In Trigger name, type the name of the trigger occurrence. Note: The trigger name that you enter may be provided to you by your administrator or developer. If not, you must inform your administrator or developer of the trigger name that you use. 4. The default start date is "now", and the default end date is "forever", which means the trigger schedule runs when the trigger is fired (either from trigger.bat or from an SDK application). If you enter a valid start and end date, the trigger schedule can only be fired between those dates. 5. Click OK.
306
Deployment Specifications
A deployment specification is an entry in the content store that defines the entries to be deployed deployment preferences name of the deployment archive
There are two types of deployment specifications. Export specifications are created in the source environment and control the creation of deployment archives. Import specifications are created in the target environment and control the import of entries from the deployment archive. You can view the deployment history for each deployment specification to see the date, time, and details of the import or export.
Deployment Archives
A deployment archive is a compressed file that contains the actual entries that are deployed. A deployment archive is created when you export from the source environment. If you export to an existing deployment archive, the contents of the archive are overwritten. You move the deployment archive from the source environment to the target environment. Then you import from the deployment archive into the target environment. To move a deployment archive, you need access to the installation directories on the computer where IBM Cognos 8 is installed. This location is set in the configuration tool. The default location is c8_location/deployment. For information about changing the location, see the IBM Cognos 8 Installation and Configuration Guide.
Deployment Planning
When you deploy, you must consider how to handle security and which deployment method to select: the entire content store (p. 309) selected packages, folders and directory contents (p. 311)
To avoid breaking references in the target environment, you must deploy all entries that refer to entries in another package or folder. Entries to consider include: jobs, shortcuts, and report views memberships and entry permissions
Access Permissions
The entries that you deploy may have security applied to them, such as access permissions (p. 213) that specify which users and groups can access them. If you deploy the entire content store (p. 309), all access permissions are deployed. If you deploy selected packages, public folders and directory content, you can choose whether to deploy access permissions (p. 311). Consider the following: Referenced users and groups If you deploy access permissions to a target environment, the referenced users and groups must exist in the target environment. Access permissions rules For access permissions to work after entries are deployed, the source environment and the target environment must use the same authentication provider with the same configuration. Otherwise, the permissions may not work after deployment.
308
Chapter 21: Deployment Use the Cognos namespace to ensure that the permissions from the source environment work in the target environment. For example, in the source environment, create Cognos groups with the group Everyone as a member, and then set access permissions for the groups. After deployment, in the target environment, map the Cognos groups to the appropriate users and groups from the authentication provider, and then remove Everyone from the groups membership. For information about deploying Cognos groups and roles, see "Including Cognos Groups and Roles" (p. 313).
Chapter 21: Deployment installed, you can move the entire content store from the old environment to the new environment and keep all the reports and other entries created by administrators and users. Other reasons to deploy the entire content store include: moving a whole application into a new, empty environment, such as a new computer, from a development environment refreshing a whole application into an existing environment, such as an existing computer, from a development environment moving an application from an existing environment that uses a different underlying technology, such as a different database type for the content store, or a different operating system upgrading the contents of the content store
When you move a content store from one environment to another, you must use the same namespaces for policies, users, roles, and groups to work correctly. When you deploy the entire content store, if there are no conflicts, the contents of the target content store are removed and replaced by the contents of the source content store, except for configuration data. The imported entries keep the owners from the source content store. For information about conflict resolution, see "Conflict Resolution Rules" (p. 315). After the deployment is complete, some links for packages associated with reports may not work. You may need to relink packages to reports. For information about linking packages to reports, see the documentation for the studios. Tip: Instead of deploying the entire content store, you can deploy only specific public folders and directory content (p. 311).
Content Store
The content store includes all entries in the portal, such as: public folders packages reports data sources distribution lists and contacts printers the Cognos namespace deployment specifications
It does not include the deployment history (p. 311). Configuration objects (p. 311) such as dispatchers, are included in exports by default, but excluded in imports. If you want to deploy users personal folders and personal pages, you must choose to include the user account information when you export and import.
310
Deployment History
When you export an entire content store, the export and import deployment specifications that exist in the source content store are exported. Their deployment histories are not exported. Later, when you import the entire content store, you also import the export and import deployment specifications. You do not see entries in the View the deployment history page for the imported specifications. If any of the imported deployment specifications are used for an encrypted deployment archive, you can delete them. To import an entire content store the first time, you must create a new import deployment specification. By default, the information saved in deployment records includes the progress and summary reports only. If you want to include more detailed information, change the recording level using the advanced setting CM.DEPLOYMENTDETAILENTIRECONTENT. Use the steps in "Set Advanced Content Manager Parameters" (p. 123). More recording levels are available in partial deployment (p. 314).
Configuration Information
When you import an entire content store, configuration data is included in the export, but excluded from the import by default. We recommend that you do not change this setting. However, if you must import configuration settings, you can change the default in the Advanced Settings (p. 331). If you import the configuration data, especially in a distributed environment with multiple content managers, the current information about the content manager status may be overwritten by the imported data. Tip: If you import the configuration, restart the service in the target environment to update status information properly. For information about including configuration data in the import, see "Include Configuration Objects in Import of Entire Content Store " (p. 331). For information about how specific objects in the content store are imported, see "Rules For Deploying the Entire Content Store" (p. 316).
Chapter 21: Deployment After the deployment is complete, some links for packages associated with reports may not work, even if you included packages and their reports in the deployment. You may need to relink packages to reports. For information about linking packages to reports, see the documentation for the studios. Tip: If you want to deploy specific entries, you can create a folder at the root level of Public Folders, copy the specific entries to that folder, and select this folder when you deploy.
Deploying Packages
A package is an entry that contains published reports and metadata. Packages are created in Framework Manager, the modeling tool, and then published to IBM Cognos Connection. Packages are stored in the content store and appear as entries in IBM Cognos Connection. During a partial deployment (p. 311), you can deploy one or more packages at a time. A package can reference objects that are outside the package, such as security objects, data sources, and distribution lists. However, referenced objects are not deployed with the package. While you are importing, you can deselect packages in the deployment archive that you do not want to import.
Chapter 21: Deployment versions in the target environment with those from the deployment archive or keep target environment versions.
Including Schedules
You can choose whether to include schedules (p. 299) in your deployment. If you do not deploy schedules, they are removed from the jobs and reports in the target environment. If you select this option, you can choose what to do if there is a conflict. You can replace the existing schedules in the target environment with those from the deployment archive or keep target environment schedules. When you choose to import schedules in the deployment, you can change the imported schedule credentials to your credentials. The credential of a schedule is the credential used to run the report in the schedule. This credential determines the permissions on the report as well as the capabilities that apply to the report execution. If the report does not have the Run as the owner property set to true, then the credential is also used to access the data source, data connection and signon objects. Changing the credential may affect the operation in the following ways: no impact report produces different data as a result of selecting a different connection or signon in the data source report fails to run because the user does not have the proper capabilities or permissions
To change the imported schedule credentials to the credentials of the person doing the import, do the following: Add the advanced setting CM.DeplomentUpdateScheduleCredential and set the value to True. See procedure, "Set Advanced Content Manager Parameters" (p. 123). When you import to the target environment using the New Import Wizard (p. 328), make sure to click Include schedules and select Replace Existing Entries under Conflict Resolution. Next, under Entry ownership, select The user performing the import.
When you deploy groups, members of the System Administrators group are merged with the members of this group already in the target environment. This ensures that the target environment is accessible in case the deployed members are not valid. However, you may need to modify the membership list when the deployment is complete. If you select this option, you can choose what to do if there is a conflict.You can replace groups and roles in the target environment with those from the deployment archive or to keep target environment groups and roles.
314
Chapter 21: Deployment Saves the deployment progress and summary information. This is the default option. Minimal Saves only the deployment summary information. This option requires the least memory. Trace Saves all deployment details. This option requires the most memory. For information about recording deployment details when an entire content store is deployed, see "Deployment History" (p. 311).
Ownership Considerations
You can change the ownership of imported entries to the user performing the import. You can select this option at the time of export or import. If you use the owners from the source, the owners are imported along with the entries. You can apply the ownership options to new entries or to new and existing entries.
Rule
Replace
Description
Replaces the entry and its children. The entry and all its children are removed from the source content store. The new entry and all its children are added to the source content store.
Rule
Keep
Description
Keeps the entry. The properties of the entry and all its children are not updated. Existing children of the entry are kept. New children may be added.
Update
Updates the entry. The properties of the entry and its children are updated. Existing children of the entry are kept. New children may be added.
Merge
If an entry has no children, replace and update have the same end result.
Configuration
When you import the entire content store, objects in the configuration area of the content store are excluded by default. If you used the advanced settings to include configuration information (p. 331), the configuration is updated rather than replaced. Therefore, existing dispatchers and their configuration in the target environment do not change. However, new dispatchers may be added to the configuration. You may need to unregister dispatchers that are imported if they are not applicable to the target environment (p. 111). The following table lists the objects in the configuration area of the content store, whether they are included during import, and the conflict resolution rule used. The alignment of the object names represents the hierarchy of the objects. When a parent object is included, its children are also included Because the root and parent object is replaced, children from the deployment archive replace the existing set of children in the target environment. Therefore, conflicts are unlikely to occur when the children are imported. If a conflict occurs, the conflict resolution rule is to replace the children. 316
Chapter 21: Deployment The following table lists the objects in the configuration area of the content store, whether they are included in the import, and the conflict resolution rule used. In this table, the parent object is configuration and all objects below it are its children.
Object name
configuration configuration folder dispatcher account pageDefinition
Included
No No No No No
*Note: This rule applies only when you manually include the configuration objects using the advanced settings.
Capability
All the objects in the capability area of the content store are included and replaced when you import the entire content store. The following table lists the objects in the capability area of the content store, whether they are included in the import, and the conflict resolution rule used. In this table, the parent object is capability and all objects below it are its children.
Object name
capability securedFunction securedFeature
Included
Yes Yes Yes
Content
All the objects in the content area of the content store are included and replaced when you import the entire content store.
Deployment
All the objects in the deployment area of the content store are included and replaced when you import the entire content store except for the importDeployment object, which is handled differently. To import, you use an importDeployment object in the target environment. The importDeployment object and its children are not replaced so that the import can complete and a deployment history record can be created. All the other importDeployment objects are replaced.
Chapter 21: Deployment The following table lists the objects in the deployment area of the content store, whether they are included in the import, and the conflict resolution rule used. In this table, the parent object is adminFolder and all objects below it are its children.
Object name
adminFolder exportDeployment deploymentHistory adminFolder importDeployment deploymentHistory
Included
Yes Yes Yes Yes Yes Yes
Directory
Before importing a namespace other than the Cognos namespace, IBM Cognos 8 verifies that the namespace exists in the startup configuration of the target environment. If the namespace does not exist, an error occurs and the import moves on the next object. Before importing an account, group, or role, IBM Cognos 8 verifies that the account, group, or role exists in the namespace in the target environment. For more information, see "Including References to Other Namespaces" (p. 309). The members of the System Administrators group are always merged when this group is imported. If you select the option to include user information when you import, the namespace account object and some of its children are included. The following table lists the objects in the directory area, whether they are included in the import, and the conflict resolution rule used. In this table, the parent object is directory and all objects below it are its children.
Object name
directory namespace (except for Cognos) namespaceFolder account credential
Included
Yes Yes Yes Set in options Set in options
318
Object name
session graphic output runTimeState folder namespace (Cognos) namespaceFolder account (anonymous account) credential session graphic output runTimeState folder contact distributionList role group dataSource dataSourceConnection dataSourceNameBinding dataSourceSignon printer
Included
No No No No Set in options Yes Yes No No No No No No No Yes Yes Yes
Portal
All objects in the portal area of the content store are updated when you import the entire content store.
The default conflict resolution rule for partial deployment is update, unless specified differently in the deployment rules for the content and directory areas. When you deploy public folders and directory content, you cannot include objects from the configuration, capability, exportDeploymentFolder, and importDeploymentFolder areas of the content store (p. 312). For information, see "Including References to Other Namespaces" (p. 309).
Content
When a parent object is updated, new children from the deployment archive are added and join the existing set of children in the target environment. If a conflict occurs, the conflict resolution rule is to replace the children. Because all job steps are replaced, no conflict is possible when importing jobStepDefinition objects. If you include report output versions and run histories and you keep existing entries, the associated objects from the archive are merged with the objects in the target environment. Even though the objects are merged, the retention rules still apply. A full merge may not occur because some objects may be discarded. The following table lists the objects in the content area, whether they are included in the import, and the conflict resolution rule used. In this table, the parent object is content and all objects below it are its children.
Object name
content
Included
No
320
Object name
package root level folder model modelView folder jobDefinition jobStepDefinition jobHistory
Included
Yes when selected
schedule
Yes
Yes
Update
Not applicable Not applicable Yes Set in Option 5 Update Merge or replace Set in Option 5
SQL runHistory
Replace Merge or replace Set in Option 6 Administration and Security Guide 321
Object name
schedule
Included
Set in Option 7
Set in Option 5
output runHistory
schedule
Set in Option 7
Directory
If you include data sources, connections, and signons, and you keep existing entries, the associated objects from the archive are merged with the objects in the target environment. Even though the objects are merged, the retention rules still apply. A full merge may not occur because some objects may be discarded. Note that when you want to include Cognos groups and roles, and distribution lists and contacts, these items must be stored in a folder within the namespace in order to be deployed. The members of distribution lists, groups, and roles in the archive are not merged with the contents in the target environment. Instead, the set of distribution lists, groups, and roles are merged with the set already existing in the target environment. However, the members of the System Administrators group are always merged when this group is imported. For more information, see "Including Cognos Groups and Roles" (p. 313). The following table lists the objects in the directory area, whether they are included in the import, and the conflict resolution rule used. In this table, the parent object is directory and all objects below it are its children.
Object name
directory
Included
No
322
Object name
namespace (except forCognos) namespaceFolder account credential session graphic output runTimeState folder namespace (IBM Cognos) namespaceFolder
Included
No No No No No No No No No No
Yes if Option 1 or Update Option 2 is true, and they are stored in a folder within the namespace No No No No No No No Set in Option 2 Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable Merge or replace Set in Option 2
Object name
distributionList
Included
Set in Option 2
Set in Option 1
Set in Option 3
dataSourceConnection
Set in Option 3
dataSourceNameBinding
Set in Option 3
dataSourceSignon
Set in Option 4
printer
No
Not applicable
In IBM Cognos Connection, you can organize your deployment specification in folders in the same way that you organize all your entries. See "Organizing Entries" (p. 251).
Chapter 21: Deployment created by the deployment and the list of entries that were exported or imported. For more information, see (p. 285).
Permissions
To deploy IBM Cognos 8 entries, you must have execute permissions for the Administration tasks secured feature (p. 693) and traverse permissions for the Administration secured function. We also recommend that you belong to the System Administrators group and have read and write access to the Cognos namespace so that you can deploy the System Administrators group. For more information, see "Set Access Permissions for an Entry" (p. 216). When you do a partial export of public folders and directory content (p. 311) rather than exporting the entire content store (p. 309), you must have read and traverse permissions for the entries that you export. You also need write permissions because you create a deployment specification and deployment history when you export. When you import, you must have write and set policy permissions for the entries that you import.
Prerequisites
IBM Cognos 8 and other products, must be installed and configured in the source and target environments. For more information, see the IBM Cognos 8 Installation and Configuration Guide. We recommend that you stop the Content Manager service before you export and import. This prevents users from receiving unpredictable results if they are performing operations during the deployment. For example, if users view reports in a package while the package is being imported, users may encounter errors when the report outputs are replaced. For more information, see "Stop and Start Dispatchers and Services" (p. 108). Before you start, you must plan the deployment to determine what deployment options to use and what entries to deploy (p. 308). You may want to back up before deployment (p. 197).
Chapter 21: Deployment 5. Type a unique name and an optional description and screen tip for the deployment specification. Select the folder where you want to save it and click Next. 6. Choose whether to export the entire content store or to do a partial export of specific folders and directory content: To export specific folders and directory content, click Select public folders and directory content, and then click Next. Proceed to step 7. To export the entire content store, click Select the entire content store and select whether to include user account information. Click Next and proceed to step 18. 7. In the Select the Public folders content page, click Add. 8. In the Select entries page, in the Available Entries box, select the packages or folders that you want to export. You can browse the Public Folders hierarchy and choose the packages and folders you want. Click the right arrow button click OK. 9. For each package and folder that you export, do one of the following: If you want the package or folder to have a different name in the target environment, or if you want to change the target location or add multilingual names, click the edit icon make your changes, and click OK. If you do not want users to access the package or folder and its entries, select the check box in the Disable after import column. This is useful when you want to test the reports before you make them available in the target environment. 10. Under Options, select whether you want to include the report output versions, run history, and schedules and what to do with entries in case of a conflict. 11. Click Next. 12. In the Select the directory content page, select whether you want to export Cognos groups and roles, distribution lists and contacts, and data sources and connections and what to do with the entries in case of a conflict. 13. Click Next. 14. In the Specify the general options page, select whether to include access permissions and references to namespaces other than IBM Cognos, and who should own the entries after they are imported in the target environment. 15. Specify the Recording Level for the deployment history (p. 314). 16. Click Next. 17. In the Specify a deployment archive page, under Deployment archive, select an existing deployment archive from the list, or type a new name to create one. to move the selected items to the Selected entries box, and
326
Chapter 21: Deployment If you are typing a new name for the deployment archive, we recommend that you do not use spaces in the name. If the name of the new deployment specification matches the name of an existing deployment archive, the characters _# are added to the end of the name, where # is a number such as 1. 18. If you want to secure the archive, under Encryption, click Set the encryption password, type a password, and then click OK. 19. Click Next. The summary information appears. 20. Review the summary information and click Next. Tip: If you want to change information, click Back and follow the instructions. 21. Review the summary information and click Next. 22. Select the action you want: To run now or later, click Save and run once and click Finish. Specify the time and date for the run. Then click Run. Review the run time and click OK. To schedule at a recurring time, click Save and schedule and click Finish. Then, select frequency and start and end dates. Then click OK. Tip: To temporarily disable the schedule, select the Disable the schedule check box. To view the schedule status, see "Manage Scheduled Activities" (p. 291). To save without scheduling or running, click Save only, and then click Finish.
After you run the export, you can move the deployment archive. You can also see the export run history (p. 294).
export name in the Target name column, the Public Folders content section, and choose the package or folder you want. 6. Click OK.
Chapter 21: Deployment This saves the options and you can run the export now or at a later time (p. 328).
2. Click Now to run the export immediately, or click Later, and enter the time, that you want the export to run. You can also schedule a task to run on a recurring basis, and view a list of scheduled tasks using the Schedule Management tool. For more information, see "Schedule Management" (p. 299). Tip: To avoid warning messages when logged into multiple namespaces, before you run the export next time, renew your credentials. In IBM Cognos Connection, in the upper-right corner, click the my area button , and then click My Preferences. On the Personal tab, in the Cre-
dentials section, click Renew the credentials. You can now move the deployment archive.
Steps
1. Copy the deployment archive from the source environment to a location on the LAN or to a CD. 2. Copy the deployment archive from the LAN or CD to the target environment in the location set in the configuration tool. You can now include configuration objects if youre importing an entire content store or import to the target environment.
328
Chapter 21: Deployment You can import using an existing deployment specification if you previously saved it without importing, or if you want to redeploy your IBM Cognos 8 entries. You can update the entries in the target environment with entries from the deployment archive. When you import, you select from entries that were exported. You can either accept the default options set during the export, or change them. You cannot select options that were not included in the deployment archive during the export. For information about how specific objects in the content store are imported, see "Deployment Rules When Importing" (p. 315). You can also use the New Import wizard to upgrade entries from previous releases of the product. You can upgrade report specifications during the import, or choose to upgrade them at a later time using the New Report Upgrade wizard. For more information, see "Upgrade Report Specifications" (p. 332). To use an existing import deployment specification, see "Steps to Modify an Existing Import Deployment Specification" (p. 330)
Partial Deployment
If you do a partial deployment of specific public folders and directory content, the import wizard shows whether packages and folders already exist in the target environment and the date and time they were last modified. You can use this information to help you decide how to resolve conflicts. When you redeploy, the wizard also shows whether the packages and folders were in the original deployment.
5. In the Deployment archive box, click the deployment archive that you want to import. 6. If the deployment archive is encrypted, type the password, and then click OK. 7. Click Next. 8. Type a unique name and an optional description and screen tip for the deployment specification, select the folder where you want to save it, and then click Next. 9. Select the content that you want to include in the import. Tip: To ensure that the required target package or folder exists in the target content store, click the edit button next to the package, and check the location. If you want, you can change the target location now. 10. Select the options you want, along with your conflict resolution choice for options that you select.
Chapter 21: Deployment 11. In the Specify the general options page, select whether to include access permissions and references to namespaces other than IBM Cognos, and who should own the entries after they are imported in the target environment. 12. Specify the Recording Level for the deployment history (p. 314). 13. Click Next. The summary information appears. 14. Review the summary information and click Next. 15. Select the action you want: To run now or later, click Save and run once and click Finish. Specify the time and date for the run. Then click Run. Review the run time and click OK. To schedule at a recurring time, click Save and schedule and click Finish. Then, select frequency and start and end dates. Then click OK. Tip: To temporarily disable the schedule, select the Disable the schedule check box. To view the schedule status, see "Manage Scheduled Activities" (p. 291). To save without scheduling or running, click Save only then click Finish. When you run the import, you have the option of selecting to upgrade the report specification. If you choose not to upgrade the deployment specification at this time, you can upgrade it later. For more information, see "Upgrade Report Specifications" (p. 332). After you run the import, you can test the deployment. You can also see the import run history (p. 294).
import name in the Target name column, the Public Folders content section, and choose the package or folder you want. 6. Click OK.
330
Chapter 21: Deployment This saves the options and you can run the import now or at a later time (p. 331).
2. Click Now to run the import immediately, or click Later, and enter the time, that you want the import to run. 3. If you want to upgrade the report specifications, click Upgrade all report specifications to the latest version. You can also schedule a task to run on a recurring basis, and view a list of scheduled tasks using the Schedule Management tool. For more information, see "Schedule Management" (p. 299). You can now test the deployment.
Steps
1. In IBM Cognos Connection, in the upper-right corner, click Launch, IBM Cognos Administration. 2. On the Configuration tab, click Dispatchers and Services. 3. Click the dispatcher you want. 4. Next to ContentManagerService, click the set properties button. 5. Click the Settings tab. 6. In the Value column, click Edit. 7. Select the Override the settings acquired from the parent entry check box. 8. In the Parameter column that appears, type the following in uppercase:
Chapter 21: Deployment CM.DEPLOYMENTINCLUDECONFIGURATION 9. In the Value column, type true 10. Click OK to finish.
Steps
1. Log on to IBM Cognos Connection as an administrator with execute permissions for the Content Administration feature (p. 225). 2. In the upper-right corner, click Launch, IBM Cognos Administration. 3. On the Configuration tab, click Content Administration. 4. Click the arrow on the new content maintenance button New Report Upgrade 5. Type a name for the upgrade task and, if you want, a description and screen tip. Click Next. 6. Select the packages and locations for the report specification you want to upgrade. Click Next. on the toolbar, and then click
332
Chapter 21: Deployment If you upgrade report specifications by package, all reports in the content store that are based on the model in the package will be upgraded. If you upgrade report specifications by folder, all reports in the folder will be upgraded. 7. Choose one of the following: Save and run once opens the run with options page. Save and schedule opens the scheduling tool. Save only allows you to save the upgrade so that you can run it at a later time.
334
Data Trees
Data trees may contain many hierarchical levels and items (members). If all levels and members appear, the data trees may be difficult to use. After packages are deployed to IBM Cognos 8 (p. 307), you can specify how data trees appear in the studios. The settings do not affect the model. They affect only the package configuration. The settings for a package are obtained by the studios when a report is opened. The settings are also obtained when a Analysis Studio analysis is opened in Cognos Viewer.
Setting
Default member limit in a data tree level
Purpose
In Analysis Studio, specifies the number of members that appear at a time in one level of the data tree. For example, if this is set to 10, and the maximum member limit is set to 20, Analysis Studio users see only the first ten memebers and must click More to see the next ten. At this point, they see the maximum number and they must then search for a specific member. If your data tree has only 50 members, you may want to set this to 55 so that users do not have to click a link to see all members. Default: 20
Setting
Purpose
Maximum member limit in a data tree For all studios, specifies the maximum number of members that appear in one level of the data tree. Thereafter, level users must search for a specific member. If your data tree is large, you may want to set this to a low number because users can find the member they are looking for faster by searching. Default: 50
Steps
1. In IBM Cognos Connection, locate the package you want. 2. In the Actions column, click More. 3. Click New package configuration or Modify the package configuration. 4. Click Select an analysis. 5. Select the default analysis to be used for this package when new analysis is created. 6. Click OK. 7. Change the package settings as required and click Finish.
Steps
1. In IBM Cognos Connection, locate the package you want. 2. In the Actions column, click More. 3. Click Modify the package configuration. 4. Click the Permissions tab. 5. Click OK.
336
Steps
1. In IBM Cognos Connection, locate the package you want. 2. In the Actions column, click More. 3. Click Remove the package configuration. 4. Click OK.
338
Users can change their own preferences. For more information, see "Personalize the Portal" (p. 260). User entries are created in authentication providers. For more information, see "Users, Groups, and Roles" (p. 207). To copy, edit, or delete user profiles, an administrator must have write permissions for the namespace that contains the applicable users. The IBM Cognos predefined role, Directory Administrators, does not have write permissions for namespaces other than the Cognos namespace. The System Administrators must grant write permissions to Directory Administrators so that they can administer user profiles for the namespace (p. 234).
Steps
1. Start IBM Cognos Connection. 2. In the upper-right corner, click Launch, IBM Cognos Administration. 3. On the Security tab, click Users, Groups, and Roles. 4. Click the Cognos namespace. 5. On the toolbar, click the edit default user profile button 6. Set the default user profile and click OK. .
Steps
1. Start IBM Cognos Connection. 2. In the upper-right corner, click Launch, IBM Cognos Administration. 3. On the Security tab, click Users, Groups, and Roles. 4. Click the namespace that contains the user. 5. Find the user whose user profile you want to delete. You can use the Search feature to find a user (p. 259). 6. In the Actions column, click More. 7. Click Delete this users profile. 8. Click OK.
340
Chapter 23: Managing User Profiles You are creating many new similar user accounts.
If you plan to delete the source user in your authentication provider, copy the user account information before you delete it. After you delete the user, the user no longer appears in IBM Cognos 8 and you cannot copy the users account information. When you copy a user profile, trusted credentials are not copied. You can only work with profiles of users who have logged in at least once. When users have logged on, there is a date displayed in the Modified column. You must have the required permissions to access IBM Cognos Administration functionality. See "Secured Functions and Features" (p. 221). To copy user profiles, you must have write access to the namespaces for both the source and target users.
Steps
1. Start IBM Cognos Connection. 2. In the upper-right corner, click Launch, IBM Cognos Administration. 3. On the Security tab, click Users, Groups, and Roles. 4. Click the namespace that contains the source user (the user you want to copy from). 5. Find the source user. You can use the Search feature to find a user (p. 259). 6. Click Select the target user. The Select the user page appears. 7. Click the namespace that contains the target user (the user you want to copy to). Tip: You can select only the namespaces that you have write access to. 8. Select the target user and click OK. 9. Select one or more of the following profile settings that you want to copy: Preferences, Portal tabs, or Personal folders content. 10. If required, select the Delete the source users profile after the copy completes check box. 11. Click Copy.
Chapter 23: Managing User Profiles If a user was deleted in your authentication provider, the user no longer appears in IBM Cognos 8 and you cannot change the user profile. You can only see user profiles of users who have logged in at least once. When users have logged on, there is a date displayed in the Modified column. You must have the required permissions to access IBM Cognos Administration functionality. See "Secured Functions and Features" (p. 221). To view a user profile, delete content, or change content, you must have traverse permissions for the user account and any other folder that must use Public Folders. You must also have write permissions for the object and the parent of the object that you want to delete.
342
Steps
1. Open your Microsoft Office XP application. 2. From the Tools menu, click Macros, and then click Security. 3. Choose whether to change the security level or the trusted publishers. On the Security Level tab, click Medium or Low, and then click OK On the Trusted Publishers tab, select Trust all installed add-ins or templates, and then click OK.
Steps
1. Retrieve the CA certificate from your administrator. The file has a .cer extension. 2. Double-click the .cer file, click Install Certificate, and then click Next. 3. Click Place all certificates in the following store. 4. Click Browse, click Trusted Root Certification Authorities, and then click Next. 5. Click Finish.
344
Chapter 24: Administering Microsoft Office Documents For more information, see "Secured Functions and Features" (p. 221).
Steps
1. In IBM Cognos Connection, locate the document that you want to open. 2. Click more on the actions toolbar to the right of the document that you want to download. The IBM Cognos Connection actions page opens. 3. Download the Microsoft Office document: For a Microsoft Office workbook, click the View most recent document in Excel object . For a Microsoft Office presentation, click the View most recent document in PowerPoint object .
For a Microsoft Office word document, click the View most recent document in Word object .
For a Microsoft Office document of unknown type, click the View most recent document object .
The File Download dialog box appears. 4. Click Open or Save and follow the prompts that appear. When you open the document, it opens in the application that was used to create it. You can now perform the same actions that you would perform for any Microsoft Office document of the selected type.
346
Mixed Currencies
Mixed currency values occur when you calculate values with different currencies. When using an OLAP data source, mixed currency values use the asterisk character (*) as the unit of measure.
Step
In IBM Cognos Connection, click the report that you want. For more information about using PowerPlay Web Explorer, see PowerPlay Web Users Guide. For information about using Analysis Studio, see the Analysis Studio User's Guide.
You can set default report options such as format and language. You can also set the default to prompt for values (p. 362) and run as the owner. For information about properties, see "Entry Properties" (p. 243).
348
Chapter 25: Reports and Cubes You must have execute permissions for the report. You must have read and traverse permissions for the folder that contains the report.
Steps
1. In IBM Cognos Connection, click the set properties button right of the report. on the actions toolbar to the
2. Click the Report tab for a Report Studio report, the Query tab for a Query Studio report, or the Analysis tab for a Analysis Studio report. 3. Under Default action, select the default action for when the report is run. 4. If you want to override report options, under Report options, click the Override the default values check box. You can change some or all of the options, such as format and language. For information about setting advanced PDF options, see "Set Advanced PDF Options for a Report" (p. 358). 5. If you want to prompt for values to filter the data in the report, click select the Prompt for values check box under Prompt Values. Note: You are prompted for values only if the report specification or model includes prompts or if you have access to multiple data source connections or signons. 6. If you want to run the report using the owner credentials, click the check box next to the owner listed under Run as the owner. 7. To set additional report options, click Advanced options. Under Number of rows per Web page in HTML reports, click the number of rows you want to allow. To allow such features as drill up and drill down, drill through, Cognos Search, watch rules, and agent notification when the report is viewed in Cognos Viewer, select Enable selection-based interactivity in HTML reports. If you want to allow the creation of additional output formats so that watch rules can be evaluated and saved output versions can be imported into IBM Cognos 8 Go! Office, select Enable enhanced user features in saved output versions. If you want users to receive alerts when new report output is generated, select Enable alerts about new versions. To create an expiry date for the report cache data, select Day or Month and type a corresponding number under Cache duration. Report cache data is created only if there is no cache data or if the cache data is expired.
8. Click OK.
These options override the defaults for a report for a one-time run. Tip: You can also force database access by clicking More next to the report, and then clicking Clear the cache. You can change default run options for reports (p. 348) If you change the delivery method while a report is running, the run operation is cancelled. The report is run again using the new delivery method that you select. This can be time-consuming for large reports. To save time, specify the delivery method before you run the report. To specify a time for the report to run, to choose additional formats or more than one language, or for additional delivery methods, use advanced run options (p. 351). You must have execute permissions for the report you are attempting to run. You must have read and traverse permissions for the folder that contains the report.
Steps
1. In IBM Cognos Connection, click the run with options button the right of the report you want to run. on the actions toolbar to
2. Under Format, click the format that you want for the report output. 3. Under Language, click the language that you want for the report output. 4. Under Delivery, choose to view the report now, save the report, print the report, or send the report your mobile device. 5. If you choose to print, click Select a printer, click the button next to the printer you want to use, and click OK. If the printer is not listed, you can type the printer information. Tip: If you have administrator privileges and want to set up the printer for future use, click New printer. You must type the network address of the printer by using the format \\server_name\printer_name for a network printer on a Windows installation and printer_name for a UNIX installation or for a local printer. 6. If you want to prompt for values to filter the data in the report, under Prompt Values, click the Prompt for values check box. You are prompted for values only if the report specification or model includes prompts or if you have access to multiple data source connections or signons. 7. Click Run.
350
The report runs in the background if you run the report later, select multiple report formats or languages, select to save, print or email the report, send the report to your mobile device, or burst the report. If you set your preferences to show a summary of the run options (p. 260), the summary appears whenever the report is not run interactively. The report runs in the background. When done, the output versions button appears next to the report on the Actions toolbar. Tip: Click the output versions button to view the selected formats. For more information, see "View Report Output Versions" (p. 364). Default options are set by the report author. You can change default run options for reports "Set Default Report Options" (p. 348). If you choose to save, print, or send the report by email, you can choose multiple formats. If you choose to run the report later, the delivery option is automatically changed to save. For more information on saving report output, see "Save Report Output" (p. 363). You must have execute permissions for the report you are attempting to run. You must have read and traverse permissions for the folder that contains the report. You need the appropriate permissions to set advanced run options.
Steps
1. In IBM Cognos Connection, click the run with options button the right of the report you want to run. 2. Click Advanced options. 3. Under Time and mode, click Run in the background, and then click Now or Later. If you specify Later, set a date and time for the report to run. 4. Under Format, click the formats you want for the report output. The Enable selection-based interactivity check box is selected by default. For information about deselecting this option, see "Disable Selection-based Interactivity" (p. 371). on the actions toolbar to
Chapter 25: Reports and Cubes 5. If you want to select a different or additional languages for the report, under Languages, click Select the languages and use the arrow keys to move the available languages to the Selected languages box and click OK. Tip: To select multiple languages, use the Ctrl key or use the Shift key. 6. Under Delivery, choose the delivery method that you want: If you schedule a report for a future time, select multiple formats or languages, or burst the report. You cannot view the report now. Select one of the other delivery methods. If you choose to print, click Select a printer. Click the button next to the printer you want to use and click OK. Or, if the printer is not listed, you can type the printer information. If you choose to save using report view, you can change the name or destination folder of the report view. Click Edit the save as options, make the changes and click OK. If you choose to email the report, proceed to step 7. Tip: If you have administrator privileges and want to set up the printer for future use, click New printer. You must type the network address of the printer by using the format \\server_name\printer_name for a network printer on a Windows installation and printer_name for a UNIX installation or for a local printer. If you choose to send the report to your mobile device, enter your Mobile device ID.
7. If you select Send the report by email, click Edit the email options and set the following options: To display the blind copy field, click Show Bcc. To choose IBM Cognos 8 recipients, click Select the recipients. Select the check box next to the names you want to include, and click To, Cc (copy), or Bcc (blind copy). The entries that you select are listed under Selected entries. Tip: To select all entries in a list, click the check box in the upper-left corner of the list. To remove names from Selected entries, select the check box next to the name and click Remove. To search, click Search. In the Search string box, type the phrase you want to search for. For advanced search features, click Edit. For more information, see "Search for an Entry" (p. 259). When you are done, click OK. To send the email to other recipients, in the To:, Cc, or Bcc boxes, type the email addresses separated by semicolons (;). Tip: If you logged on, your name automatically appears in the To list box. Under Subject, type the subject of the email. Under Body, type a message to be included in the email. Tip: By default, the body of the email is in HTML format, which provides advanced editing features such as font type and size, text color, text formatting and justification, numbers and bullets, indentation, and tables. To use plain text, click Change to plain text.
352
Chapter 25: Reports and Cubes To include a hyperlink to the report, select the Include a link to the report check box. To include the report as an attachment, select the Attach the report check box. Click OK. You can prevent users from including attachments. For more information, see "Disable Report Attachments in Email Messages" (p. 534). 8. If you want to be prompted for values to filter the data in the report, under Prompt Values, select the Prompt for values check box. If you run the report later, the prompt values you provide are saved and used when the report runs. Note: You are prompted for values only if the report specification or model includes prompts or if you have access to multiple data source connections or signons, even if the Prompt for values check box is selected. 9. Under Bursting, specify whether the report should be bursted. This option is available only if the report author defined burst keys in the report. 10. Click Run.
Create a Report
You can create reports to analyze data and answer specific questions related to your business. Use Query Studio to intuitively explore data by creating ad hoc reports. Report Studio is a comprehensive report authoring environment. Use it to create both highly interactive and sophisticated production reports for mass consumption by specifying queries and layouts for each report. Use Analysis Studio for analyses. Access to the report authoring tools is controlled by the capabilities defined for your logon. If you require access to the report authoring tools but the links are not available on the top navigation bar, contact your system administrator. An existing report may contain most of the information you require, but you may need new prompt values or changes to the layout or style. Instead of creating a new report, you can create a report view to satisfy your requirements (p. 354). For instructions about using the studios, see the following guides: Query Studio User Guide Report Studio Professional Authoring User Guide IBM Cognos Analysis Studio User Guide
Before creating a report, confirm that the package containing the data for your report is available in the portal. If you do not have access to the package, contact your administrator. Tip: A package is identified by the package icon .
Chapter 25: Reports and Cubes You must have write and traverse permissions for the folder in which you want to save the new report.
Steps
1. In IBM Cognos Connection, choose whether you want to create a simple or complex report: To create a simple report, in the upper right corner, click the Query Studio link To create a complex report, in the upper right corner, click the Report Studio link . .
To create an Analysis Studio report, in the upper right corner, click the Analysis Studio link .
2. If the Select Package dialog box appears, do one of the following to select the package containing the data you want to use in your report: In the Recently used packages list, click the package. In the List of all packages list, navigate to the package and click it.
If you want to use a generic report as the underlying structure for additional reports, make a copy of the report (p. 251). If you want a report to appear in more than one location, create a shortcut (p. 240).
354
Chapter 25: Reports and Cubes To create a report view, you must have execute or read permissions for the original report.
Steps
1. In IBM Cognos Connection, locate the report you want to use to create the report view. 2. Under Actions, click the report view button 3. In the Name box, type the name of the entry. 4. If you want, in the Description and in the Screen tip box, type a description of the entry. The description appears in the portal when you set your preferences to use the details view (p. 260). The screen tip, which is limited to 100 characters, appears when you pause your pointer over the icon for the entry in the portal. 5. If you do not want to use the target folder shown under Location, click Select another location and select the target folder and click OK. 6. Click Finish. In the portal, report view entries are identified by the report view icon . next to the report.
The report view has the same run options and properties as the original entry. To change the default properties of a report view, see "Set Default Report Options" (p. 348). For information about properties, see "Entry Properties" (p. 243).
Chapter 25: Reports and Cubes For more information, see "Configure the Lineage Solution" (p. 151), "Secured Functions and Features" (p. 221), and "Object Capabilities" (p. 229).
Steps
1. Open an HTML report or report view in Cognos Viewer. 2. Right-click the data item you want, and click Lineage. The lineage views appear.
Edit a Report
You can use the IBM Cognos 8 authoring tools to edit an existing report. You may want to change the report layout, style, or font. The report may need to be updated because of changes to the data or to add language support. If the report was created in Report Studio, you can edit the report in Report Studio. If the report was created in Query Studio, you can edit the report in either Query Studio or Report Studio. If you edit a Query Studio report in Report Studio, you cannot go back and edit the report in Query Studio. For more information about modifying reports, see the Report Studio Professional Authoring User Guide, and the Query Studio User Guide. If the report was created in Analysis Studio, you can edit the report in either Analysis Studio or Report Studio. If you edit an Analysis Studio report in Report Studio, you cannot go back and edit the report in Analysis Studio. For more information about modifying Analysis Studio reports, see the Report Studio Professional Authoring User Guide, and the Analysis Studio User Guide. The edit button differs depending on whether the report is a Query Studio report Studio report , or an Analysis Studio report . , a Report
Editing a report modifies the report specification so that everyone who views the report sees the changes you made.
356
Chapter 25: Reports and Cubes Report properties, such as the preferred output format, language, prompt values, or report retention, can be specified by changing the run options in the portal (p. 348). For information about properties, see "Entry Properties" (p. 243). If you want to use a generic report as the underlying structure for additional reports, make a copy of the report (p. 251). If you want a report to appear in more than one location, create a shortcut (p. 240). If you want to keep the underlying report specifications but want the choice of another report format, language, delivery method, or run option, create a report view (p. 354). You must have read and write permissions for the report you are attempting to edit. You must have traverse permissions for the folder containing the report.
The report opens in the authoring tool used to create the report.
Report Formats
You can choose the output format for a report. You may want to view reports in a browser, or you may want the report in a format that is easily imported into another application. You can choose from the following formats: HTML HTML fragment XHTML XML PDF Excel 2000 Excel 2000 single sheet Excel 2002 Excel 2007 delimited text (CSV) format.
You can specify the default format to be used when a report is run (p. 348). All shortcuts to a report acquire the default format from the source entry. You can specify the report format in the run options page (p. 350), in the report properties (p. 243), or in your preferences (p. 260). When you run a report without specifying run options, the format
Chapter 25: Reports and Cubes specified in the report properties is used. When it is not specified in the report properties, the format specified in your preferences is used. XHTML and some PDF formats are only available when you set advanced run options (p. 351). You can also select multiple formats when you set advanced run options. To specify the report format, you must have read and write permissions for the report and traverse permissions for the folder that contains the report.
HTML Formats
You can select from the following HTML formats: HTML for standard HTML formatting HTML fragment if you must imbed the HTML in an existing Web page XHTML for HTML that is passed through a parser
To select HTML fragment and XMTML or the number of rows per web page, see "Set Advanced Report Options for the Current Run" (p. 351).
XML Format
XML report outputs save the report data in a format that conforms to an internal schema, xmldata.xsd. You can find this schema file in c8_location/bin. This format consists of a dataset element, which contains a metadata element and a data element. The metadata element contains the data item information in item elements. The data element contains all the row and value elements. You can create models from reports and other data that conform to the xmldata.xsd schema. This is useful if you want to use a report as a data source for another report, or if you use a database that cannot be read by Framework Manager. In this case, export the data from the data source to an XML file, in conformance with the xmldata schema, and then open the XML file in Framework Manager. For more information, see the Framework Manager User Guide.
PDF Format
Use the PDF format to view and distribute reports in an online book format. You must have administrator privileges to specify the advanced PDF options. For more information about setting advanced PDF options, see "Set Advanced PDF Options for a Report" (p. 358)
358
Chapter 25: Reports and Cubes You must have administrator privileges to the report to use the advanced options.
Steps
1. In IBM Cognos Connection, click the set properties button on the actions toolbar to the right of the report you want to run. 2. Click the Report tab for a Report Studio report, the Query tab for a Query Studio report, or the Analysis tab for a Analysis Studio report. 3. Click the Override the default values check box. 4. Under PDF options, click Set. 5. In the Set the PDF options page, select the PDF properties you want for the report, and click OK. Here is a list of the properties that are available.
Property
Orientation
Goal
Whether to have portrait or landscape for the report orientation. Set the paper size, such as legal or letter size. Set the password to open the report.
Paper size Requires a password to open the report Requires a password to access options
Set the password to access report options, and then specify the options you want to make available to users, such as whether to allow printing, modifying the report contents, and copying text.
When you run the report, the PDF settings are applied. For example, if you specified a password to open the report, then users must enter the password before viewing the contents of the report.
Excel Formats
The Excel 2000 format can be viewed with versions of Excel 2000 and later. It supports up to 65,536 rows and multiple sheets. The Excel 2000 format is only available in IBM Cognos 8 when IBM Cognos Application Firewall validation is disabled. Excel 2000 single sheet format offers improved security. Excel 2000 may have cookies in the URLs to spreadsheets, which could be used to illegally impersonate a user. Excel 2000 single sheet format does not use outgoing URLs. However, there is a limit of 65,536 rows, and page breaks for multipleauthor pages are ignored. Excel 2002 format and Excel 2000 single sheet format also offer the following benefits: Both work with SSL protocol. Both work with a single signon.
Chapter 25: Reports and Cubes Secure reports can be accessed without subsequent signons because the system automatically identifies users and provides security information. Both work with Netscape 7.01. Spreadsheets are contained in a single file for reliable spreadsheet navigation.
The IBM Cognos 8 full date format does not always appear correctly in Microsoft Excel 2000 if it is on a system with a regional setting other than English. This does not occur with Microsoft Excel 2002 or 2003 versions. To fix this, reapply the proper format in Excel. Excel 2007 format renders report output in native Excel XML format, also known as XLSX, that provides a fast way to deliver native Excel spreadsheets to Microsoft Excel 2002, Microsoft Excel 2003, and Microsoft Excel 2007. Users of Microsoft Excel 2002 and Microsoft Excel 2003 must install the Microsoft Office Compatibility Pack, which provides file open and save capabilities for the new format. The output is similar to other Excel formats, with the following exceptions: Charts are rendered as static images. Row height can change in the rendered report to achieve greater fidelity.
CSV Format
Reports saved in delimited text (CSV) format open in the application associated with the.csv file type, usually Microsoft Excel, Microsoft Windows Wordpad, or Star Office. Reports saved in CSV format are designed to support Unicode data across many client operating systems are UTF-16 Little Endian data-encoded include a BOM (Byte Order Mark) at the beginning of the file are tab-delimited do not enclose strings in quotation marks use a new line character to delimit rows show only the results of a report query. Page layout items, such as titles, images, and paramDisplay values do not appear in the CSV output.
You can modify the CSV output format to suit your environment. For more information about customizing the functionality of IBM Cognos 8, see "Modify Properties for the CSV Output Format" (p. 526).
Report Languages
You can choose the languages for a report. You can specify the report language on the run options page (p. 350), in the report properties (p. 243), or in your preferences (p. 260). When you run a report, the language specified in the report properties is used. When it is not specified in the report properties, the language in your preferences is used.
360
Chapter 25: Reports and Cubes You can run a report using the default language (p. 348), select a different language for a single run of the report (p. 350), or select more than one language for a report (p. 351). You can add multilingual properties for each of the entries in the portal (p. 361). You can specify the default language to be used when a report is run (p. 348). Selecting a language for your report does not change the language used in the portal. You can change the language used in the portal interface by personalizing the portal (p. 260). All shortcuts to a report acquire the default language from the source entry. To specify the report language, you must have read and write permissions for the report and traverse permissions for the folder that contains the report (p. 213). The package used to create the report must contain multilingual data before the report outputs are shown in the selected languages (p. 243).
Steps
1. In IBM Cognos Connection, click the set properties button change. 2. Click the General tab. 3. Under Language, select a language from the list. Languages that already have multilingual properties defined appear at the top of the list above a separator line. 4. If you want, type a description in the Name, Description, and Screen tip box. The name appears in the list of portal entries. The description appears when you set your preferences to use the details view (p. 260). The screen tip, which is limited to 100 characters, appears when you pause your pointer over the icon for the entry in the portal. next to the entry you want to
Chapter 25: Reports and Cubes Tip: To remove multilingual properties for a language, select the language in the list and click Remove values for this language. 5. Click OK.
Steps
1. In IBM Cognos Connection, click the set properties button to change. next to the report you want
2. On the Report options tab, under Language, select the default language from the list box and click OK.
Steps
1. In IBM Cognos Connection, click the set properties button to change. next to the report you want
2. On the Report tab for Report Studio reports, the Query tab for Query Studio reports, or the Analysis tab for Analysis Studio reports, under Prompt values, click either Set or Edit. If the report does not have saved prompt values, the run options show No values saved and clicking Set results in a message indicating that the report does not contain prompts. 362
Chapter 25: Reports and Cubes 3. Select the default value for the prompts and click OK. 4. If you want to be prompted each time the report is run, select the Prompt for values check box. If the check box is selected, you will be prompted for values if the report contains prompts or if you have access to multiple data source connections or signons. If the check box is not selected and the report is run interactively, you will be prompted only if there are missing values or if you have access to more than one connection or signon. The report will have missing values if saved prompts or default prompts were specified for the report. If the check box is not selected and the report is run in the background, the report fails if prompt values are missing. 5. Click OK.
You select how to save report copies as a delivery option. You can also choose how to save a report when you schedule it (p. 299). Before you can save report output to file locations, your administrator must set up the locations. For more information about setting up file locations, see "Saved Report Output" (p. 148).
Steps
1. In IBM Cognos Connection, click the run with options button the right of the report you want to run. 2. Click Advanced options. 3. Under Time and mode, click Run in the background, and then click Now or Later. 4. Under Delivery, choose where you want to save your report: To save a copy in IBM Cognos 8, click Save. Then, click Save the report or Save the report as report view. If you choose to save as report view, you can a change the name or destination folder of the report view. Click Edit the options, make the changes and click OK. To save a copy outside IBM Cognos 8, click Save to the file system. To change the report name, click Edit the options. You can also change how file conflict is resolved. Click Keep existing files to not overwrite existing files, Replace existing files to simply overwrite existing files. Click Make the file names unique and append a timestamp or Make the file on the actions toolbar to
Chapter 25: Reports and Cubes names unique and append a sequence number to avoid overwriting existing files by making new files with unique timestamps or sequence numbers and click OK. 5. If more than one file location is defined, select the location where you want to save from the Location list. 6. Click Run.
Report output versions are listed by report format (p. 357). By default, the list contains report output versions for the language that is defined in your content locale. If no reports versions are found for that language, report formats for all languages are shown. If burst keys are used, they appear next to the report format sorted by burst key and then by language. You can specify how long you want to keep report output (p. 365).
Steps
1. In IBM Cognos Connection, click the view report output versions button that has multiple output versions. 2. Choose the output version that you want to view: To show report formats in a specific language or all languages, click Languages and select from the list. To show a different output version, select the version from the Versions list. To show the current version, click the report format. next to a report
Tip: To delete a version that you have write access to, click Manage versions, select the versions that you want to delete, click Delete and then click the close button to return to the review report output versions page. 3. If you want to download a report output version, click the download icon in the Actions column. 364
Chapter 25: Reports and Cubes You control the report output formats that are available for download. For more information, see "Customize Report Output Formats in IBM Cognos Connection and Cognos Viewer" (p. 517).
Steps
1. Click the set properties button next to the entry you want.
2. On the General tab, under Run history, choose the retention method and type the value: To keep report output for a specific number of occurrences, click Number of occurrences and type the number. To save an unlimited number of report outputs, set this value to 0. To keep report output for a specific length of time, click Duration and click either Days or Months. Type the appropriate value in the box. 3. Click OK.
Steps
1. In IBM Cognos Connection, click the set properties button next to the report for which you want to enable an alert list. 2. On the Report tab for Report Studio reports, the Query tab for Query Studio reports, or the Analysis tab for Analysis Studio reports, click Advanced options, and then click the Enable alerts about new versions check box. 3. Click OK. Users can now add their names to the alert list for notifications of the report outputs.
Add Yourself to or Remove Yourself from the Alert List for a Report
By adding yourself to the alert list for a report, you receive an email notification when new versions of the report output are saved. In this way, you can monitor changes in the output of reports that are of interest to you. In the email, you are included as a Bcc recipient. The email contains a link to the latest report output. Being on the alert list is independent of any distribution lists associated with the report (p. 374). You can view and manage the alert list for a report as a watch item. You can add yourself only once to the alert list for a report. Before you can add yourself to an alert list for a report, the report owner must enable the alert list. To receive alerts, you must have an email address defined in the My Preferences, Personal tab or in your LDAP security profile (used only in special circumstances).
366
Chapter 25: Reports and Cubes Watch rules are based on event conditions that are evaluated when the report is saved, not when the report runs interactively. When the event condition is satisfied, the report user is alerted by email or news item. The event conditions are created using a numeric measure and can be specified only in saved HTML reports. You can define an unlimited number of conditions for a report. The locale for the conditional report output is the same as the locale for the report that contains the event condition. Before a user can create watch rules and receive alerts, the report owner must enable watch rules for the report (p. 367). To create watch rules, the report user must have read and traverse permissions to the report output.
Steps
1. In IBM Cognos Connection, click the set properties button next to the report. 2. On the Report tab for Report Studio reports, the Query tab for Query Studio reports, or the Analysis tab for Analysis Studio reports, under Advanced options, select the Enable selectionbased interactivity in HTML reports and Enable enhanced user features in saved output versions check boxes. Selecting these options specifies that additional context information is saved with the report output. 3. Click OK. After selecting the advanced options, you must run the report and save the report output in HTML format before users can create watch rules.
Chapter 25: Reports and Cubes You must have read and traverse permissions to the report output.
Steps
1. In the IBM Cognos Connection portal, go to the saved HTML report and open it in Cognos Viewer. 2. In the report, click a numeric data item, right-click, and then click Alert Using New Watch Rule. 3. In the Specify the rule - Alert Using New Watch Rule page, in the conditional expression that appears, click the down arrow, click the expression you want for the watch rule, for example, >= (greater than or equal), and specify a value in the box. 4. Under For the selected context, click the report items to which the rule applies. 5. Click Next. 6. In the Specify the alert type page, specify how you want to be alerted when the rule is satisfied: To be alerted by email, select the Send the report by email check box. If you want to change the email options, click Edit the options. To be alerted by news item, select the Publish a news item check box. If you want to change the news item options, click Edit the options. 7. Click Next. 8. In the Specify a name and description - Alert Using New Watch Rule page, specify a name, description, and location for the watch rule. You can organize watch rules in folders on the Rules tab of the My Watch Items area of the portal. 9. Click Finish.
Steps
1. Open the saved report output in Cognos Viewer. 2. On the toolbar, click Watch New Versions and, while hovering over the watch rule, from the submenu, click Modify to edit the watch rule. The Set properties dialog box appears. Proceed to step 3.
368
Chapter 25: Reports and Cubes click Delete to delete the watch rule.
3. Click the General tab to change properties, such as the language, name, and description of the watch rule. 4. Click the Rules tab to edit the rules properties, such as the conditional expression for the rule, the items to which the rule applies, and the alert type. Note that the changes you make to a watch rule in Cognos Viewer are made also in the My Watch Items area of the portal.
Steps
1. In IBM Cognos Connection, click the set properties button next to the report.
2. On the Report tab for Report Studio reports, the Query tab for Query Studio reports, or the Analysis tab for Analysis Studio reports, under Advanced options, select the Enable comments in saved output versions check box. 3. Click OK. You must now run the report and save the report output in HTML, PDF or XML format before users can add comments to it.
Steps
1. Open the saved report output in Cognos Viewer. 2. On the toolbar, click Add Comments and then click Add a Comment. 3. In the Add a Comment window, type the comment name and description. 4. Repeat steps 2 to 3 to add further comments as required. 5. Click Finish to save the comment. Each comment is added to a drop-down list available from the Add Comments button.
370
Chapter 25: Reports and Cubes The Modify Comments window appears. 3. Edit the comment name or description. 4. Click Finish.
If selection-based interactivity is enabled in IBM Cognos Connection, a user can perform drill up and down and drill-through actions in Report Viewer or Query Studio. If selection-based interactivity is disabled in IBM Cognos Connection, the ability to perform drill up and down and drill-through are disabled regardless of how the drill through definitions and settings are authored in Report Studio and IBM Cognos Connection. Selection-based interactivity is enabled by default. Tip: You can instead enable or disable selection-based interactivity for the current run only. Click Run with options next to the report and then click Advanced options. Click Enable selectionbased interactivity in HTML reports.
Steps
1. In IBM Cognos Connection, click the set properties button right of the report. on the actions toolbar to the
2. Click the Report tab for a Report Studio report, the Query tab for a Query Studio report, or the Analysis tab for an Analysis Studio report. Tip: Disabling selection-based interactivity on an Analysis Studio report has no effect. 3. Click Advanced options.
Chapter 25: Reports and Cubes 4. Clear the Enable selection-based interactivity in HTML reports check box. Note that disabling selection-based interactivity on an Analysis Studio report has not effect.
Steps
1. In IBM Cognos Connection, in the upper-right corner, click Launch, IBM Cognos Administration. 2. On the Configuration tab, click Dispatchers and Services. 3. Click the dispatcher you want. 4. For the ReportService, in the Actions column, click the set properties button. 5. Click the Settings tab. 6. For the Environment category, next to Advanced settings, click the Edit link. 7. Select the Override the settings acquired from the parent entry check box. 8. In the Parameter column, type rsvp.removeblankpages. 9. In the Value column, type true. 10. Click OK.
Distributing Reports
You can distribute reports to other users to share information with them. In IBM Cognos 8, you can distribute reports by saving them (p. 373) where other IBM Cognos 8 users can access the reports at their convenience sending them to users by email (p. 373) printing them (p. 373) bursting them (p. 374)
You can schedule the distribution of your reports so that recipients receive the reports regularly (p. 299). Recipients must have read permissions for the report and traverse permissions for the folder that contains the report. When you attach a report to an email, the report is no longer secured by the IBM Cognos security system.
372
Chapter 25: Reports and Cubes When sending a report by email, note that if you choose the recipient from a list, such as a group, role, or distribution list, you must have read access to both the list and the recipients email account. Otherwise, the report delivery fails. However, if you type the email address manually, read access is not required. To distribute reports to more than one recipient, you can create distribution lists (p. 374), which contain references to users, groups, and roles. If a recipient is not part of the IBM Cognos security system, you can create a contact (p. 374) for that person and add it to a distribution list.
Saving a Report
You can share a report with others by saving the report in a location that is accessible to other users, such as in the public folders. Public folders typically contain reports that are of interest to many users. You can save a report when you set options for the current run (p. 350) or you can use advanced report options (p. 351) to save a report in Report View (p. 354). To share a report that is currently located in your personal folders, copy the report (p. 251), move the report (p. 252), or create a shortcut to the report (p. 240) and save it in the public folders. For information about saving reports, see Query Studio User Guide, the Report Studio Professional Authoring User Guide, or the Analysis Studio User Guide.
Printing a Report
It may be convenient for you to have a printed copy of a report. You may need to review a report when your computer is not available, or you may need to take a copy of a report to a meeting. You can use run options to print a report and choose a printer (p. 351).
Chapter 25: Reports and Cubes You can set up printers for users to select from. For more information, see "Set Up Printers" (p. 48).
Tip: To remove a distribution list, select the entry and click the delete button. 5. Type a name and, if you want, a description and screen tip for the distribution list, and click Next. 6. If you want to add to the distribution list, click Add and choose how to select entries:
374
Chapter 25: Reports and Cubes To choose from listed entries, click the appropriate namespace, and then select the check boxes next to the users, groups, or roles. To search for entries, click Search and in the Search string box, type the phrase you want to search for. For search options, click Edit. Find and click the entry you want. To type the name of entries you want to add, click Type and type the names of groups, roles, or users using the following format, where a semicolon (;) separates each entry: namespace/group_name;namespace/role_name;namespace/user_name; Here is an example: Cognos/Authors;LDAP/scarter; 7. Click the right-arrow button and when the entries you want appear in the Selected entries box, click OK. Tips: To remove entries from the Selected entries list, select them and click Remove. To select all entries in a list, click the check box in the upper-left corner of the list. To make the user entries visible, click Show users in the list. 8. Click Finish. You can now choose this list when you specify recipients for a report.
Tip: To remove a contact, select the entry and click the delete button. 5. Type a name and email address for the contact and, if you want, a description and screen tip, and click Finish.
Steps
1. Run the report in IBM Cognos Connection and view it in Cognos Viewer. Tip: Alternatively, you can open an Analysis Studio report or Query Studio report in their respective studios. 2. Right-click the report item you want to drill on and click Drill Up or Drill Down .
You can also navigate from a report or analysis authored in one package to more detailed information in a report which was authored in another package. For example, this is useful when you want to drill from a summarized OLAP source, such as your sales information, into the detailed relational or transactional information, such as your inventory volumes. Drilling through from one report to another is a method of passing information from the source (your starting report) to the target (your ending report). For example, you may be evaluating a
376
Chapter 25: Reports and Cubes report and discover something you need to investigate in a certain product line. You can drill through to the detailed target report which provides a focused view of that product line. When drilling through to the target, the product line you selected in the source is passed and the target report is run with that filter, making a more focused report. By default, the ability to drill through from one report to another is enabled. You can disable it by using the Enable selection-based interactivity option. For more information, see "Disable Selectionbased Interactivity" (p. 371). For information about drill-through concepts and setting up drill-through access, see "Drill-through Access" (p. 401). Before you can navigate to another target, a drill-through definition must be created in either the Report Studio source report or in IBM Cognos Connection.
Steps
1. Run the report in IBM Cognos Connection and view it in Cognos Viewer. Tip: Alternatively, you can open an Analysis Studio report or Query Studio report in their respective studios. 2. Right-click the report item from which you want to navigate and click Go To Links. The Go To page appears, showing the available targets. Note: If there is only one possible target for the column, the reports runs and appears in Cognos Viewer. 3. Click the target you want to navigate to. Depending on how the drill-through definition was set up and the report type, the target opens in either Cognos Viewer, Query Studio, PowerPlay Studio, or Analysis Studio. , Related
Steps
1. Run the report in IBM Cognos Connection and view it in Cognos Viewer.
Chapter 25: Reports and Cubes Tip: Alternatively, you can open an Analysis Studio, Query Studio, or PowerPlay Studio report in their respective studios. 2. Ctrl+click to select more than one value in a column. If hyperlinks appear in the column in which you are attempting to select cells, click in the empty area around the hyperlinks. If there are no visible hyperlinks but you know that a drill-through target exists, select the cells you want to use as the filter, regardless of whether they are in the same column. Note that when you select multiple values from different columns, the resulting filter in the target report performs an and rather than an or operation with the values passed, for example, Canada and Camping Equipment; United Kingdom and Fax.
3. Right-click in one of the selected cells from which you want to navigate, and from the menu that appears, do one of the following: Under Go To, click the drill-through target name, if one exists. Under Go To, click Related Links. On the Go To page, click the target report you want to run.
The target report runs and if it can be filtered by the selection made in the source report, the target is filtered by those values.
378
Chapter 25: Reports and Cubes Alternatively, PowerPlay 7.3 can be configured to use IBM Cognos Connection rather than Upfront as a portal. However, if you are accessing content from other IBM Cognos applications or versions previous to PowerPlay 7.3, the administrator may still depend on the Upfront portal. When you access Series 7 entries from IBM Cognos Connection, consider the following things: If the Series 7 namespace and the IBM Cognos 8 namespace are different, you must log on to both. Otherwise, you cannot see content in both areas. If you log off when you are in Upfront, you can no longer access Series 7 entries in IBM Cognos Connection. You should always log off in IBM Cognos Connection. If you belong to several Series 7 user classes, you are unable to select a different user class when you access Upfront through IBM Cognos Connection. If you use an Upfront theme other than standard70, an error message may appear when you click the More link in the Actions column. You cannot access Series 7 entries. If you want to cut, copy, and paste Series 7 entries, use the More link in the Actions column, and then use the Upfront toolbar. If you perform a search in IBM Cognos Connection, the Series 7 entries are not included in the search. You cannot combine IBM Cognos 8 entries and Series 7 entries in a single folder or NewsBox.
For information about working with Series 7 entries in Upfront, see the IBM Cognos Series 7 Web Portal User Guide.
Single Signon
Single signon ensures that users who are logged on to one IBM Cognos application are not prompted for authentication when they run another IBM Cognos application. You can ensure that your users benefit from single signon by ensuring that both IBM Cognos 8 and PowerPlay use the same Series 7 namespace as their authentication source. Alternatively, you can ensure that the authentication namespaces used for both IBM Cognos 8 and PowerPlay are configured to use an external single signon mechanism for authentication, such as operating system signons for Series 7 PowerPlay or LDAP provider with External Identity Mapping in ReportNet. For instructions about setting up Series 7 single signon, see the Access Manager Administrator Guide. For instructions about setting up single signon for ReportNet, see the Installation and Configuration Guide.
PowerPlay administrators can restrict who can open cubes. For information about publishing Series 7 PowerPlay reports and cubes in IBM Cognos 8, see the PowerPlay Enterprise Server Guide. If you use secured Series 7 cubes, the namespace against which the cubes are secured must be configured as an authentication source in IBM Cognos 8. This namespace need not be the only authentication namespace or the primary logon for the user. For more information about configuring authentication namespaces see the Installation and Configuration Guide. Before you can run or open Series 7 PowerPlay reports and cubes directly from IBM Cognos 8, you must have both PowerPlay 7.3 and IBM Cognos 8 installed and configured. You also must have the following permissions: execute and read permissions to run or open a report or cube read and traverse permissions to access the folder that contains the report or cube read and write permissions to set properties for cubes and reports
Step
In IBM Cognos Connection, click the report that you want.
Depending on the default action for the report, the report runs in either PDF format (default) or opens with PowerPlay Web Explorer. If you have the required permissions, you can change the run options for Series 7 PowerPlay reports and cubes (p. 381). For information about using PowerPlay Web Explorer and PowerPlay Web Viewer, see the IBM Cognos PowerPlay Web User's Guide.
380
Chapter 25: Reports and Cubes Tip: To run any Series 7 PowerPlay report in PowerPlay Web Explorer, click the open with PowerPlay Explorer button in the actions toolbar. You can also click More next to the report you want and then open the report in Analysis Studio or Report Studio. The migration tools must already be installed. For information about installing these tools, see the IBM Cognos 8 Migration Tools Installation and Configuration Guide. When you open the report, it is upgraded to the format of the studio that you opened it in. If you save the report, it is saved in the upgraded format. There may be differences between the original PowerPlay report and the IBM Cognos 8 version of the report. If you do not save the report, it remains a Series 7 PowerPlay report. For more information about upgrading Series 7 PowerPlay reports, see the IBM Cognos 8 Migration Tools User Guide.
For HTML format reports, you can choose to open the report in design mode (without data). Opening a report in design mode is useful to quickly view the structure of the report. For PDF format reports, you can choose to be prompted for values that filter the range of data included in a report. For example, you can specify a date range that is a subset of the dates available in the report. If the Series 7 PowerPlay report was created with prompt values, you are prompted to enter values when the report runs.
Steps
1. In IBM Cognos Connection, click the set properties button right of the report you want to run. 2. Click the PowerPlay report tab. 3. Under Default action, select the default action for when the report is run. 4. For HTML reports, if you want to open the report without data, design mode, select the Open in design mode check box. Tip: You can also click the open with PowerPlay Web Explorer in design mode button it appears in the actions toolbar. 5. For PDF reports, if you want to be prompted for values, select the Prompt for values check box. Tip: The Prompt for values check box appears only if prompt values are created for the report. You can also click More next to the report you want and then click the run the report in PDF format and prompt for values button . if on the actions toolbar to the
Step
In IBM Cognos Connection, click the cube that you want.
382
You can schedule agents to run at a specified time or based on a trigger, such as a database refresh or an email. You can also view the run history of scheduled agents. For more information, see "Schedule Management" (p. 299).
Run an Agent
Usually, agents run automatically according to the schedule specified by the agent author. However, you can run the agent manually at any time if you want to check for occurrences of specified events and perform specified tasks if those events occur. For example, an agent is created to send an email to sales staff when they reach 75 percent of their sales quota for the month. The agent prompts for the sales region. A sales manager specifies Spain, and emails are sent only to sales staff in Spain. You must have execute permission to run an agent. You must have traverse permissions for the folder that contains the agent.
Steps
1. In IBM Cognos Connection, click the run with options button to the agent you want to run. on the actions toolbar next
2. Under Time, click Now to run the agent now or click Later to specify a later date and time.
Chapter 26: Agents 3. If you want the agent to prompt for values to filter the results it retrieves, under Prompt Values, select the Prompt for values check box. 4. Click Run. The confirmation page appears. You are prompted for values if the agent specification or model includes prompts or if you have access to multiple data source connections or signons. 5. To view the run history of the agent, select View the details of this agent after closing this dialog. 6. Click OK. The options override the default agent options for the current run only.
Steps
1. In IBM Cognos Connection, click the set properties button the agent you want to run. 2. Click the Agent tab. The tasks in the agent are shown. 3. Under Default action, specify the default action for the agent. 4. If you want the agent to prompt for values to filter the results that it retrieves, under Prompt Values, select the Prompt for values check box. The Prompt for values check box appears only if prompt values are created for the agent in Event Studio. 5. If you want the agent to run using the owner credentials, click the check box next to the owner listed under Run as the owner. 6. To allow users to add themselves to the alert list for the agent, click the Allow users to add themselves to the alert list check box. 7. Click OK. The next time the agent runs, it uses these properties instead of the original defaults. on the actions toolbar next to
384
If you want to change the properties of an agent and do not need to retain an agent with the original properties, change the default agent properties (p. 384). If you want to use a generic agent as the basis for a new agent, make a copy of the agent (p. 251). If you want an agent to appear in more than one location, create a shortcut (p. 240). To create an agent view, you must have execute or read permissions for the original agent.
Steps
1. In IBM Cognos Connection, locate the agent you want to use to create the agent view. 2. Under Actions, click the agent view icon 3. In the Name box, type the name of the entry. 4. If you want, in the Description and in the Screen tip box, you can type a description of the entry. The description appears in the portal when you set your preferences to use the details view (p. 260). The screen tip, which is limited to 100 characters, appears when you pause your pointer over the icon for the entry in the portal. 5. If you do not want to use the target folder shown under Location, choose another location, click Select another folder, select the target folder, and click OK. 6. Click Finish. In the portal, agent view entries are identified by the agent view icon . next to the agent.
The agent view has the same run options and properties as the original entry. For information about changing agent properties, see "Entry Properties" (p. 243).
To create a new agent in Event Studio, do the following: Administration and Security Guide 385
Chapter 26: Agents In IBM Cognos Connection, in the upper-right corner, click Launch, Event Studio.
For information about using Event Studio, see the Event Studio User Guide.
Steps
1. In IBM Cognos Connection, click the set properties button next to the agent for which you want to enable an alert list. 2. Click the Agent tab, and select the Allow users to add themselves to the alert list check box. Emails are sent whenever the agent is run interactively or in the background according to a schedule.
386
Chapter 26: Agents Note the change for the alert list in the watch item list. To view your watch items, from the My Area menu, click My Watch Items.
Steps
1. In IBM Cognos Connection, locate the agent. 2. In the Actions column, click More. 3. Click Remove all from the alert list.
Product number
NEW EVENTS
Sales person
Quantity sold
Product number
3345 3345 2256
Sales person
Ashley McCormick Bayard Lopes Alessandra Torta
Quantity sold
25 15 100
The second time the agent runs, it finds the following product sales.
Product number
3345 3345 2256 2256
Sales person
Ashley McCormick Bayard Lopes Ashley McCormick Alessandra Torta
Quantity sold
35 15 15 150
If you now view the most recent events list, you see the following list:
Product number
NEW EVENTS 2256 ONGOING (UNCHANGED) 3345 ONGOING (CHANGED) 3345 2256
Sales person
Quantity sold
Ashley McCormick
15
Bayard Lopes
15
35 150
Steps
1. In IBM Cognos Connection, locate the agent you want. 2. Under Actions, click the set properties icon. 3. Click the Agent tab. 4. Under Default action, click View most recent event list.
388
390
Steps
1. Start IBM Cognos Connection. 2. Click the New metric package button .
3. Type a name and description for the Metric Studio application to represent this metric package, and click Next. 4. Click New data source. 5. Type a name and description for the data source connection for the metric store that contains the content for this metric package, and click Next. 6. In the Type box, click the database type. 7. Select the isolation level, and click Next. 8. Specify the information required for your database type: For a Microsoft SQL Server database, type the name of the database server and the database. Under Signons, select the Password and Create a signon that the Everyone group can use Administration and Security Guide 391
Chapter 27: Metric Studio Metrics check boxes, and type the user ID and password of the user account with access to the database. For an Oracle database, type the connection string. Select User ID, select the Password and Create a signon that the Everyone group can use check boxes, and type the user ID and password of the user account with access to the database. For a DB2 database, type the name of the database, the connection string, and the collattion sequence. Select User ID, select the Password and Create a signon that the Everyone group can use check boxes, and type the user ID and password of the user account with access to the database. Tip: To test whether the parameters are correct, click Test. 9. Click Next and then click Finish. 10. Click the new data source and click Next. 11. Click Next and follow the prompts to provide the information necessary to initialize the database. When you see the page that summarizes the data source details and the metric store settings, click Initialize. 12. Select Open this package with Metric Studio after closing the wizard and then click Finish. Metric Studio opens, and the new metric package appears in IBM Cognos Connection.
To change the default action of the package, do the following: In the Actions column, click the Set properties button for the package and select the default action you want.
392
Chapter 27: Metric Studio Metrics Tip: Unless you changed the default action for the package, clicking the package name will cause the package to open in Metric Studio. 2. Click Metric maintenance, and click the metric task that you want to run.
Steps
1. In IBM Cognos Connection, in Public folders or My folders, select the check boxes next to the tasks you want to delete. 2. Click the delete button on the toolbar.
Steps
1. In IBM Cognos Connection, in Public folders or My folders, open the Metric Studio package that you want. 2. Click the set properties button you want to modify. on the actions toolbar to the right of the metric task that
3. Depending on what you want to change, click the Metric maintenance, Metric import, or the Metric export tab. 4. Select or clear the check boxes for the options you want to change.
Import and Transfer Data From Files Into the Metric Store
You can use this task to load data from all data sources into the staging tables and then transfer it into the metric store. The data will be appear in Metric Studio but no derived values or calculated metrics will be visible. This task also updates the search index.
Transfer Data From the Staging Area Into the Metric Store
You can use this task to move data from staging tables into the metric store. The data in the staging tables can be from imported tab-delimited files, or from another source such as Metric Designer. You can run this task after importing data from files into the staging tables. This task also updates the search index.
Steps
1. Click the new data integration task button import from files. 2. Type the name and description to represent this new import task and if necessary, change the location to place the task, and click Next. 3. Click the Transfer data from staging area into metric store to change the pre- and post- import options for the task. Click the options you want to use when the task is run. Click Next. 4. Select the action you want: To run now or later, click Save and run once and click Finish. Specify the time and date for the run. Then click Run. Review the run time and click OK. To schedule at a recurring time, click Save and schedule and click Finish. Then, select frequency and start and end dates. Then click OK. on the toolbar, and then click New metric
394
Chapter 27: Metric Studio Metrics Tip: To temporarily disable the schedule, select the Disable the schedule check box. To view the schedule status, see . To save without scheduling or running, click Save only then click Finish.
Property
Description
Import data options: Transfer data from staging Check box to add pre- and post- import data area into metric store options. Pre-import data options Options to clear history and calendar data, and rejected data logs. Options to recalculate derived values, send emails from Metric Studio Watchlist, and maintain the search engine index. Whether to use the owner credentials (p. 218) when the task is run.
Chapter 27: Metric Studio Metrics Warning:Clearing data store metric history and calendar data completely reinitializes the metric package database. All work will be lost.
Steps
1. Click the new data integration task button maintenance. 2. Type the name and description to represent this new maintenance task and if necessary, change the location to place the task, and click Next. 3. Click the options you want to use when the task is run, and click Next. 4. Select the action you want: To run now or later, click Save and run once and click Finish. Specify the time and date for the run. Then click Run. Review the run time and click OK. To schedule at a recurring time, click Save and schedule and click Finish. Then, select frequency and start and end dates. Then click OK. Tip: To temporarily disable the schedule, select the Disable the schedule check box. To view the schedule status, see . To save without scheduling or running, click Save only then click Finish. on the toolbar, and then click New metric
396
Property
Metric data options
Description
Options to move data from the staging area to the metric store and compute derived values and summary data. Options to clear history and calendar data, and rejected data logs. Options to send emails from Metric Studio Watchlist, synchronize user information, and maintain the search engine index. Whether to use the owner credentials (p. 218) when the task is run.
Additional options
Metric object
Scorecards
Content exported
Exports all scorecards in the metric store (does not include associated metrics, reports, or diagrams). Exports all metric types and metric type properties including equations. Exports all metrics (does not include metric values, or associated reports, diagrams, or comments). Note that you will need the associated scorecards, metric types, and qualifiers in order to load these metrics into another metric store. Exports the Metric Studio business calendar including calendar levels and periods. Exports all qualifiers. Exports all reports that have been associated with scorecards, metric types, strategies, projects, and metrics. Exports all diagrams that have been associated with scorecards, metric types, strategies, projects, and metrics.
Metric Types
Metrics
Business Calendar
Qualifiers Reports
Diagrams
Metric object
Actions and Projects
Content exported
Export all actions and projects that have been associated with metrics. Exports language tables and group associations for the Strategies feature. Exports all permissions that have been set on Metric Studio objects. Exports flat file and relational import sources that have been defined in Metric Studio. Exports cube import sources that have been defined in Metric Designer along with their associated time levels and time period mappings, currency mappings, and reportlet dimension selections. Exports user defined column definitions. Exports any special units you have defined. Examples of default units are Currency and Percent. Exports all links including metric, scorecard, report, diagram, projects, strategies, and so on. You must export links in order for metrics to appear on scorecards and for reports and diagrams to appear on scorecards or metrics. Exports any special parameters you have staged against Metric Studio objects for use as URL parameters. Exports all watch lists to which you subscribe.
Strategies
Permissions
Import Sources
Object Links
Watch Lists
Use the new metric export wizard to create a new task to export metric data to files.
Steps
1. Click the new data integration task button export. 2. Type the name and description to represent the new export task and if necessary, change the location to place the task, and click Next. 3. Click to clear the objects you do not want to export, and click Next. 4. Select All data for selected objects, or choose to export data created or changed after a specified date, and click Next. 398 on the toolbar, and then click New metric
Chapter 27: Metric Studio Metrics 5. Under Metrics period, click All Values to export values for the entire time period, or Values for the period to export values created during a specified time period. Under Available value types, select the values you want to export, and click Next. 6. Select the currencies, and click Next. 7. Select the format to use when exporting security references. Note: Using IBM Cognos 8 security references will execute faster. The Metric Studio 2.2 format exports users and groups by name, requiring directory searching. 8. Click Next. 9. Select the languages, and click Next. 10. Select an existing metric data archive to export to, or create a new one. Select the character set encoding and decimal separator value, and click Next. 11. Review your selected options for the export task, and click back if you want to change any options. When you are ready to proceed with the export, click Next. 12. Select the action you want: To run now or later, click Save and run once and click Finish. Specify the time and date for the run. Then click Run. Review the run time and click OK. To schedule at a recurring time, click Save and schedule and click Finish. Then, select frequency and start and end dates. Then click OK. Tip: To temporarily disable the schedule, select the Disable the schedule check box. To view the schedule status, see . To save without scheduling or running, click Save only then click Finish.
Steps
1. In the Actions column, click the set properties button to export. 2. Click the Metric export tab. The metric export properties appear. 3. In the Run as the owner box, choose whether to use the owner credentials (p. 218) when the task is run. 4. Click Update the metric export. The Review the summary page appears, showing the current settings for the metric export. for the metric object that you want
Chapter 27: Metric Studio Metrics 5. Press Back as needed to change the settings. 6. Click Save.
400
Chapter 28: Drill-through Access from one existing report to another report using Report Studio (Professional authoring mode)(p. 422) between Cognos Viewer reports authored in Report Studio, Query Studio, PowerPlay Studio, and Analysis Studio from Series 7 PowerPlay Web cubes to IBM Cognos 8 reports (p. 426) from Metric Studio to other IBM Cognos 8 reports by passing parameters using URLs. For more information, see the Metric Studio User Guide.
Drill-through Paths
You can create a drill-through path in a source report in Report Studio (Professional authoring mode), or using Drill-through Definitions in IBM Cognos Connection. A drill-through path is the definition of the path that is taken when moving from one report to another, including how the data values are passed between the reports. Using Drill-through Definitions, you can create a drill-through path from any report in the source package to any target report in any other package in IBM Cognos Connection. This type of drillthrough definition is stored in the source package. Users of any report in the package can use the drill-through definition to drill between any combination of Analysis Studio, Query Studio, PowerPlay Studio, or Cognos Viewer reports in any package. For any target report that contains parameters, you should map the target parameters to the correct metadata in the drill-through path. This ensures that the values from the source report are passed to the correct parameter values, and that the target report is filtered correctly. If you do not map parameters, then the users may be prompted for values when the target report is run. A report-based drill-through path refers to a path created and stored in a Report Studio source report (Professional authoring mode). This type of drill-through path is also called "authored drill through". The path is associated with a specific data column, chart, or cross tab in the source report, and is available only when users select that area of the report. If an authored drill-through definition is available, a hyperlink appears in the source report when it is run. Report-based drill-through is limited to Report Studio source reports (Professional authoring mode) and any target reports. Use this type of drill-through access when you want to pass data item values or parameter results from within a source report to the target report, pass the results of a report expression to a target report, or a use URL link as a part of the drill-through definition.
Selection Contexts
The selection context represents the structure of the values selected by the user in the source. In Analysis Studio, this includes the context area. When a package drill-through definition is used,
402
Chapter 28: Drill-through Access the selection context is used to give values for mapped parameters (parameterized drill-through) or also to map the appropriate data items and values. Drill-through links can also be defined to open the target object at a bookmark. The content of this bookmark may also specified by the selection context. Drill-through access is possible between most combinations of the IBM Cognos 8 studios. Each studio has been optimized for the goals and skills of the audience that uses it, and in some cases for the type of data source it is designed for. Therefore, you may need to consider how the various studios manage the selection context when you drill through between objects created in different studios, and how the data sources are conformed. During testing or debugging, you can see how source values are being mapped in different contexts using the drill-through assistant.
Bookmark References
When you drill through, the values that you pass are usually, but not always, used to filter the report. IBM Cognos 8 Business Intelligence supports bookmarks within saved PDF and HTML reports so that a user can scroll a report to view the relevant part based on a URL parameter. For example, you have a large inventory report scheduled to run daily or weekly during off hours because of resource considerations. Your users may want to view this report as a target because it contains detailed information, but you want them to view the saved output rather than run this large report. Using this Action option and bookmark settings, users can drill through from another source location based on products to open the saved report to the page that shows the product they want to focus on. When a bookmark in the source report is used in a drill-through definition, it provides the value for the URL parameter. When report consumers drill through using this definition, they see the relevant section of the target report. Bookmark references are limited to previously run reports that are output as PDF or HTML and contain bookmark objects.
404
Chapter 28: Drill-through Access In IBM Cognos 8, the methods of drilling through available are Dimensional (member) to Dimensional (member) Dimensional (member) to Relational (data item value) Relational (data item value) to Relational (data item value)
If the target parameter is a member, the source must be a member. The source and target should usually be from a conformed dimension (p. 406). However, if the data will support it, you may also choose to define a mapping using different properties of the source metadata item. If the target parameter is a value, the source can be either a value or a member. If the source is a dimensional member, you must ensure that the level or dimension is mapped to the target data item correctly in the drill-through definition. The business key from which the member is sourced should usually match the relational target value, which is most often the business key (p. 407). However, if the data will support it, you may also choose to define a mapping from the caption of the source metadata item.
Chapter 28: Drill-through Access Ensure that the business keys and dimension metadata structure are the same in the production and test environments. Do not change the business keys in Framework Manager in the production environment. Resolve the non-unique keys in a dimension in the data source before you build the cube. Ensure that there are no duplicate source values in all levels of a dimension before you build a PowerCube. We do not recommend using the tilde character (~) in the category codes. For more information, see the section about uniqueness in the IBM Cognos Series 7 Step-byStep Transformer. For information about PowerCubes migrated from IBM Cognos Series 7, see the IBM Cognos 8 BI PowerPlay Migration and Administration Guide.
Conformed Dimensions
If you work with more than one dimensional data source, you may notice that some dimensions are structured the same, and some are not. The reason that dimensions can be structured differently is that the data sources may serve different purposes. For example, a Customer dimension appears in a Revenue data store, but not in an Inventory data store. However, the Products dimension and the Time dimension appear in both data stores. Dimensions that appear in multiple data stores are conformed if their structure is identical for all of the following: hierarchy names level names level order internal keys
Drilling through is possible between different dimensional data stores only if the dimensions are conformed, and if the dimension data store is of the same vendor type, such as IBM Cognos PowerCube as the source and the target. For example, in two data stores for Revenue and Inventory that contain Products and Time dimensions, it is possible to define the Products and Time dimensions differently for each data store. However, for drill-through between the Products and Time dimensions to work, their structures must be identical in each data store. If you are not sure whether your dimensions are conformed, then you should check with the data modeler to ensure that the drilling through will produce meaningful results.
406
Business Keys
When drill-through access is defined from a member to a relational value, the business key of the member is passed by default. This means that your relational target parameter must be set up using the data item with a matching value, which is most often the business key data item. You can also choose to pass the caption of the source metadata item. For example, employees are usually uniquely identified by an employee number, not by their name, because their name is not necessarily unique. When you drill through from a dimensional member to a relational data item, the value provided is the business key. Therefore, the parameter in the target report must be defined to accept a business key value. The exact logic used to define the business key value supplied depends on the cube vendor. For IBM Cognos PowerCubes, the business key value is the Source property defined for the level in IBM Cognos Transformer. IBM Cognos Series 7 Transformer PowerCubes pass the source value if the drill-through flag was enabled before the cube was built. Otherwise, the category code is used. In Report Studio (Professional authoring mode), you can determine what the member business key is using an expression such as roleValue('_businessKey',[Camping Equipment]). This expression is case sensitive. SSAS 2005 multi-part business keys are not supported in drill-through operations. Tip: When other users run your drill-through report, you may not want them to be prompted for a business key. In Report Studio, you can build a prompt page with a text that is familiar to the users, but filters on the business key. Your Framework Manager modeler can also set the Display Item Reference option for the Prompt Info property to use the business key when the data item is used in a prompt.
Scope
Scope is specific to drill-through definitions created using Drill-through Definitions in IBM Cognos Connection (package drill-through definitions). The scope you set defines when the target report is shown to the users, based on the items they have in the source report. Usually, you define the scope of a drill-through path to match a parameter that it passes. For example, if a target report contains a list of employees, typically you only want to display the report as an available drill-through choice when a user is viewing employee names in a source report. If employee names are not in the source report and the scope was set on the employee name in the drill-through definition, the employee report does not appear on the list of available drill-through target reports in the Go To page. You can set the scope to a measure or to an item in the report. In report-based drill-through access, where the drill-through path is associated with a specific report column, the column serves as the scope.
Mapped Parameters
Drill-through targets may contain existing parameters, or you may choose to add parameters to the target for greater control over the drill-through link. You usually map all parameters in a drillthrough target to items from the source. When you map source items that are OLAP or DMR members to target parameters, you can select from a set of related member properties to satisfy the requirements of the target parameter. For a Administration and Security Guide 407
Chapter 28: Drill-through Access dimensional target, a dimensional source item uses the member unique name by default. For a relational target, a dimensional source item uses the business key by default. For example, you could change the source member property that is used for a mapping to the member caption instead of the business key to match the parameter in a relational target. For a dimensional target, you could define a parameter that accepts a particular property (such as business key or parent unique name), then pass the appropriate source property to satisfy that target. Note that if you define drill through between non-conformed dimensions, you should test carefully to ensure that the results behave as expected. If you do not specify parameter mappings, then by default, you will be prompted for any parameters required in the target when you use the drill-through link. To customize this behavior, use the display prompt pages setting. When the action is set to "Run using dynamic filtering", then additional filtering is applied if names from the context in the source report match names of items in the target. Use this action as well when there are no parameters defined in the target. If parameters are not mapped correctly, then you may receive an empty report, the wrong results, or an error message. The source and target cannot contain identical parameter names when they are from different packages, even if the data structure is conformed. If the source and target are from the same package, there is no restriction. If you have the necessary permissions, you can use the drill-through assistant to look at what source parameters are passed, and what target parameters are mapped for a given drill-through link.
Also ensure that the drill-through definition maps the parameter at the dimension level and that the PowerCube date level is not set to suppress blank categories. Enabling the option to suppress blank categories in the Transformer model before you build the cube may cause the drill-through on dates to be unsuccessful. This happens because there are missing values in the range.
Chapter 28: Drill-through Access Connection, a drill-through definition is associated with a source package. The drill-through path defined in the drill-through definition is available to any report based on the source package it is associated with. The target can be based on any target package in IBM Cognos Connection and can be stored anywhere. For example, all reports authored in the GO Data Warehouse (analysis) sample package or in a folder linked to this package can access any drill-through definition created in this package. Note: For reports created in Report Studio (Professional authoring mode), you can define drillthrough access in specific reports by setting up the drill-through definition in the report instead of in the package, or restrict drill-through access by changing report settings so that the report is unavailable as a drill-through target. For more information, see the Report Studio Professional Authoring User Guide. Reports created in Report Studio Express are not supported as drill-through targets. You can define drill-through definitions between reports created in the different IBM Cognos 8 studios, and reports based on different packages and data sources (p. 403). The target report must exist before you start creating the drill-through definition in IBM Cognos Connection. Drill-through targets can be reports, analyses, report views, PowerCube packages and queries. Drill-through definitions support both dimensional and relational packages, and are available to Analysis Studio, Query Studio, PowerPlay Studio, and Cognos Viewer.
Chapter 28: Drill-through Access 7. Follow the instructions on the screen: If you wish, restrict the scope to a query item or a measure in the source. If the target contains parameters, you should set the scope to the parameters that are mapped to the target report. For more information, see "Scope" (p. 407). Select the target from any package available in IBM Cognos Connection. If IBM Cognos 8 BI PowerPlay targets are available, then you must choose whether to set the target as a report or a PowerCube. Click Next.
8. In the Action section, specify how to open the target object when the drill-through link is run and if you chose to run the report, in the Format section, specify the format to run the report in. Users may be able to change the Action settings when they use the drill-through link.If you are using bookmarks in the target, then you must select the action View most recent report. 9. In the Parameter values table, specify how to map the source metadata to any parameters that exist in the target report or object. For example, if you drill through between OLAP data sources, then members are mapped to each other. If you drill through from an OLAP to a relational data source, then the source value (member) is mapped to the query item name (value). Usually, every parameter that exists in the target should be mapped to the source metadata. If not, then the report user may be prompted for any missing values when the drill-through link is used. 10. Click Map to metadata, or click the edit button. In the screen that appears, select the metadata from the source to map to the target parameter. If the source package is dimensional, you can select what property of the source metadata item to use in the mapping. By default, the business key is used for a relational target, and the member unique name is used for a dimensional target. Repeat for each parameter in the list.
11. In the Display prompt pages section, specify when the prompt pages will appear. You can only set this action when there are parameters in the target report and the target report will be run. If you change the action to View most recent report, for example, for bookmark references, the Display prompt pages property is disabled because you will use a previously-run report. If you choose to open the report directly in Analysis Studio, then the the Display prompt pages property is also disabled. You specify prompt settings in IBM Cognos Connection (Report Properties, Prompt for Values). 12. Click Finish.
410
Chapter 28: Drill-through Access 13. Run a report from the source package, and test the drill-through link. Note: The drill-through definition is associated and stored with the source. Errors related to the target are only generated when you run the drill-through links, not when you save the drillthrough definition.
3. Create a parameter that will serve as the drill-through column, or that will be used to filter the report. (Data menu, Filters). For example, to drill through or filter on Product line, create a parameter that looks like this:
[Product line]=?prodline_p?
Tip: Use the operators in or in_range if you want the target report to accept multiple values, or a range of values.
Chapter 28: Drill-through Access 4. In the Usage box, specify what to do when a value for the target parameter is not passed as part of a drill-through: To specify that users must click a value in the source report, click Required. If a value for the target parameter is not passed, users are prompted to choose a value. To specify that users do not need to click a value in the source report, click Optional. Users are not prompted to choose a value and so the value is unfiltered. To specify not to use the parameter, click Disabled. The parameter is not used in the report, and therefore not available for drill-through definitions. For more information about defining report parameters, see the Report Studio Professional Authoring User Guide. Tip: If the parameter is needed in the report for other reasons, then you can also specify not to use it in the drill-through definition (Parameters table, Method, Do not use parameter). The drill-through definition controls when prompt pages or parameters are displayed.
3. Create a filter that will serve as the drill-through parameter, or that will be used to filter the report. Select the column that you want to filter on, and click the filter button. Change the settings as needed, and click OK.
412
Chapter 28: Drill-through Access You can set multiple parameters in an analysis target. However, you cannot pass members within a selection set in Analysis Studio.
Steps
1. In Analysis Studio, create a cross-tab analysis using the package that was set up for drill-through analysis. 2. If you want, add as a row or column the data item that you want to be the prompt. 3. Move or add the dimension or level that you want to be a target parameter to the Context area. Note: You cannot pass members within a selection set in Analysis Studio. 4. View the list for the item in the Context area and click Use as "Go To" Parameter. 5. Save this analysis as your target report in IBM Cognos Connection. You can now create the drill-through definition under a source package. When you create the drill-through definition (p. 408) and use the cross-tab analysis as a target, the Go To parameter item in the analysis appears as a drill-through parameter. You can map to this parameter the same way that you drill through to Report Studio or Query Studio reports.
The target report shows data for the context of the source: the Special order method type, and the year 2005.
2. In the Actual vs Planned Revenue report in Report Studio, confirm that you have parameters for order method and time. Open the query explorer tab and select Query 1. In the Detail Filters box, confirm that a filter parameter exists for each of Order Method and Year, and note the parameter names. 3. From the Data Items box, note the name of the measure that you plan to use for the scope (Revenue). 4. Close the Actual vs Planned Revenue report. 5. Open the source report, Custom Rank Sample, in Analysis Studio. Go to IBM Cognos Connection. In the Public Folders, open the package Sales and Marketing (cube), and then open the folder Analysis Studio Report Samples. 414 Select the report Custom Rank Sample, and click the Open with Analysis Studio icon.
Chapter 28: Drill-through Access 6. In the Custom Rank Sample report in Analysis Studio, check the name of the measure that you want to use to restrict scope (Revenue). 7. Check the rows and columns in the report and confirm that the data structure will match the parameters in the Actual vs Planned Revenue report. Tip: Pause the mouse over a label in the crosstab to see the path. 8. Leave the Custom Rank Sample report open for testing.
8. Set Display Prompt Pages to Only when required parameter values are missing. 9. Follow the instructions on the screen to save the drill-through definition. 10. Go to the Custom Rank Sample report, right-click outside the report data, and select Go To, Related Links. 11. Go to the Custom Rank Sample report, right-click on a cell in the cross-tab, and select Go To. A list of possible targets for the package and the data that is in scope appears, including the Actual vs. Planned Revenue report. 12. Click the Actual vs. Planned Revenue, and the report runs using the context you selected.
Chapter 28: Drill-through Access The drill-through definition that you have created should be identical to the sample definition MeasureDrill. You can also try the following: In the drill-through definition, change the prompt settings for the target report. In the Sales and Marketing (cube) package, create a report that does not use the Revenue measure, and confirm that the Actual vs Planned Revenue report is no longer available as a drill-through target. A sample drill-through definition also exists for the same target report, Actual vs. Planned Revenue, from the PowerPlay Studio report Revenue by Order Method. If you use PowerPlay Studio, check the source and target reports and try to recreate the drill through definition. If you have permission to debug drill through definitions, then you can view the parameters passed from the source (View passed source values) and available in the target (from the drop down beside the target report name, select View Target Mapping).
416
The target report shows data for the context of the source: Campaign. Other context, such Time, i s not used by the target.
2. Note what information is available in the target, and how you will filter it. In this example, you filter on the campaign name. 3. Close the target report Promotion Plan Revenue. 4. Open the source report: In IBM Cognos Connection, go to the Sales and Marketing (cube) package and open the Analysis Studio Report Samples folder. Select Top 10 Promotions by Retailer, and open it in Analysis Studio. Note the names of the dimension and level that you want use to drill through. In this example, you will drill through on Campaign.
Chapter 28: Drill-through Access 5. Keep the Top 10 Promotions by Retailer report open for testing.
418
Use Value Shows the value that IBM Cognos reports and analyses use when retrieving the data item or the member. For OLAP members, this is the member unique name (MUN). For example:
[great_outdoors_company].[Order Method].[Order Method].[Order Method1]->: [PC].[@MEMBER].[2] is the MUN for the Telephone member in the Order Method dimension.
Target Mapping
If you chose to use parameters in the target, then the target mapping shows the name of each parameter that was mapped in the drill-through definition, and the values that the source is attempting to pass to that parameter. Parameter Name
Chapter 28: Drill-through Access Shows a list of valid target parameters mapped in the drill-through definition to receive information from the query item, level, or hierarchy on which you performed the drill-through action. You can see only parameters for which there is a valid mapping and only the names of the parameters. For example, if the target report contains a parameter for Product Type and the drill-through definition maps that target parameter to the source Product Type level metadata, you see this target parameter only if you attempt to drill through on the Product Type level in the source report. Drilling through on the Product Line level does not display this parameter target. You must ensure that the target parameters in your drill-through definitions are mapped correctly. Incorrectly mapped parameters can receive information from the wrong source metadata, especially where you have data values that are not unique. If you cannot see any target parameters or the parameters you expected to see in the View Target Mapping list, check the parameter mapping in the drill-through definition. Display Value Shows the value that users see when using a data item or member. For OLAP members, this is the member caption or label. For example: Telephone is a member from the Order Method dimension Use Value Shows the transformed value that the drill-through definition uses when passing a data item value or member to the target parameter. OLAP members passed to relational target parameters obtain the business key from the members MUN and pass only the business key. Using the above example of the Telephone member in
Order Methods, the business key is 2. If you are unsure of what the business key is for a
OLAP members passed to a target parameter based on another OLAP package of the same OLAP type show a transformed MUN. Using the above Order Methods example, the MUN is now transformed and the drill-through definition uses the value of [great_outdoors_
company].[Order Method].[Order Method].[Order Method1]-> [Order Method1]. [2]:[PC].[@MEMBER].[2]. The middle portion of [Order Method1][2] is where the drill-
through definition finds the correct member in the target when the OLAP data sources are different. To see the MUN for a specific member, you can look at the properties of the member in Report Studio (Professional authoring mode) and look at the Member Unique Name property.
420
Chapter 28: Drill-through Access To use this functionality, you must have the required permissions for the Drill-Through Assistant secured function in IBM Cognos Administration (p. 221).
Steps
1. Select a link in your source report, right-click the link, and select Go To, or from PowerPlay Studio, click the drill-through button. The Related links page appears, showing the list of available target reports. If your target report is not shown, review the scope settings in your drill-through definition. Tip: If only one target is available, then when you select Related links, the target is opened without showing the Go To page. 2. Click View passed source values to see the values that are available for passing by the source report. 3. Next to the target report, click the down arrow and choose View Target Mapping. A list of the valid mapped data appears, showing the available source values, and the use and display values. 4. For either set of values, click More information to see the XML for the selection context (passed source) or the drill-through specification (target mapping.
Parameter Name
Prod Line Param Product Type Param Product Name Param
Display Value
Camping Equipment Cooking Gear Trail Chef Water Bag
Use Value
1 1 1
Having all three parameters mapped to the Products dimension is correct if the use values are not duplicated in the dimension. In the above table, you can see that members from all three levels have the same use value. In this case the drill-through operation cannot determine which level is the correct one because the scenario indicates that all levels are valid. In this situation, the first level encountered with a valid business key or use value is fulfilled by the drill-through definition. This can result in unexpected behavior.
Chapter 28: Drill-through Access This example shows why it is important to always ensure that your data warehouses and OLAP sources are designed with unique business keys or source values. To correct this situation, the drillthrough definition should have each individual target parameter mapped to each associated level in the source metadata rather than in the dimension.
422
Chapter 28: Drill-through Access view which parameters were passed from the source and how they are mapped in the target object from the Go To page using the drill-through assistant. For more information, see the IBM Cognos Administration and Security Guide.
2. Save the Employee Satisfaction 2006 report with a new name, such as Employee Satisfaction 2006 New. This is to keep the original report and drill-through definition intact for comparison. 3. In the table Employee rankings and terminations by department, select the column Positiondepartment (level 3). 4. In the properties pane, review the data item properties, to confirm that the data item names match values in the target report. 5. In the properties pane, under Data, double-click Drill-through definitions. 6. Select the definition DrilltoHiddenRep and delete it. Note: In the following steps, you recreate the drill-through definition. For comparison, use the original sample report. 7. In the Drill-through Definitions box, click the new drill-through definition button. 8. Click the rename button, and type a name for the drill-through definition. Tip: This is the name that consumers see when they select from a list of possible drill-through definitions in the final report. 9. In the Target Report tab, select the target report: Under Report, click the ellipsis button (...). Navigate to GO Data Warehouse (query), Report Studio Report Samples, and select the Compensation (hidden) report. Tip: If you dont see the report, go to IBM Cognos Connection and confirm that you can see hidden reports (My Preferences, General tab). 10. Under Action, select Run the report. 11. Under Parameters, click the edit button. A table of parameters available in the target report appears, showing the parameter pPosition. 12. Map the parameter from the Compensation (Hidden) report to the metadata in the Employee Satisfaction 2006 report: In the Method column, select Pass data item value, because the target report is based on a relational data source.
424
Chapter 28: Drill-through Access In the Value column, select Position-department (level 3). Tip: In this report, you pass values from the column where the drill-through is defined. In other cases, you might pass a related parameter. For example, you could drill through on employee name, but pass the employee number. 13. Save the report. 14. Run the report, and click a department to test the drill-through definition. When you test the drill-through link, the Compensation (hidden) report appears, filtered by the department you selected. The report appears as a drill-through target whether or not it is hidden in IBM Cognos Connection. If your administrator has given you the capability to debug drill through, then you can see additional information you right-click on the link and select Go To see a list of drill-through targets. From the Go To page, you can see what source values are passed, and what target parameters are mapped.
Steps
1. Right-click the drill-through object and click Drill-Through Definitions. 2. If more than one drill-through definition exists for the object, in the Drill-Through Definitions box, click a drill-through definition. 3. Click the Label tab. 4. To link the label to a condition, in the Condition box, do the following: Click Variable and click an existing variable or create a new one. Click Value and click one of the possible values for the variable.
5. In the Source type box, click the source type to use. 6. If the source type is Text, click the ellipsis (...) button beside the Text box and type text. 7. If the source type is Data Item Value or Data Item Label, click Data Item and click a data item. 8. If the source type is Report Expression, click the ellipsis (...) button beside the Report Expression box and define the expression. 9. If the label is linked to a condition, repeat steps 5 to 8 for the remaining possible values. When users run the source report and click a drill-through link, the Go to page appears. The drillthrough text you specified appears for each target. If you did not specify the drill-through text for a target, the drill-through name is used.
426
Chapter 28: Drill-through Access an = operator but you want to pass a date range, you should change the parameter operator in the target to in_range.
Steps
1. Start Report Studio (Professional authoring mode) and create a new report. 2. Add the data items and other objects you want. 3. From the Data menu, click Filters. 4. In the Detail Filters tab, click the add button. 5. In the Expression Definition box, create the parameterized filter you want by typing the filter expression. 6. Click OK. 7. In the Usage box, click Optional. If you do not make the filter optional, a prompt page appears when you drill through to the report. 8. Repeat steps 4 to 7 for other parameterized filters you want to add. 9. Save the report. The report name must match what you specified as a target in the PowerCube, other cube, or IBM Cognos Visualizer report. 10. Test the drill through in the PowerPlay report or IBM Cognos Visualizer report.
428
Portlets
A portlet is a mechanism for displaying Web content as part of a portal page. The portlets supported by IBM Cognos Connection include Cognos portlets (p. 429) and other portlets (p. 432). The Cognos portlets are available to users by default. If you want to make other portlets available, you must import them. Managing portlets involves the following tasks: Importing portlets (p. 432) Controlling access to portlets (p. 433) Configuring the portlet cache (p. 434) Modifying portlets (p. 435)
As an additional task, you may want to change the dispatcher settings to allow the HTML code to be executed in RSS Viewer and Cognos Navigator (p. 436). For information about using portlets in IBM Cognos Connection pages, see "Pages and Dashboards" (p. 267).
Cognos Portlets
Portal Services provides portlets that users can add to their personal pages in IBM Cognos Connection (p. 267), or in an existing enterprise portal (p. 441). All Cognos portlets conform to the Web Services for Remote Portlets (WSRP) standard. Users can interact with the portlets without installing IBM Cognos products on their computers. The content that appears in the portlets, such as reports, or metrics, and the ability to perform specific actions on that content depend on the users access permissions. Users must have the required access permissions for the individual entries and for the IBM Cognos 8 secured functions and features. For more information, see "Secured Functions and Features" (p. 221). The following portlets are available.
Portlet
Cognos Navigator (p. 717)
Description
Shows the IBM Cognos Connection folder hierarchy. Users can browse the hierarchy and open IBM Cognos 8 entries. Provides a search tool to help users find published IBM Cognos reports and other entries, and open them. Opens a default report or lists reports that users can open.
Portlet
Bookmarks Viewer (p. 732) HTML Viewer (p. 733)
Description
Registers and shows active Web links. Inserts any Web page into an IBM Cognos Connection page. Inserts an image and shows it in a page. Shows the content of a Real Simple Syndication (RSS) 1.0 or 2.0 news feed. RSS is a format for syndicating news and is used by many Web sites. An RSS news feed is specified by a URL address.
430
Chapter 29: Managing Portlets and Styles For information about creating extended applications, see the Developer Guide.
Cognos Metrics
Cognos Metrics provide the capability to view performance metrics in a page. The metrics are created using Metric Studio. If Metric Studio is installed, these portlets are automatically registered and available in IBM Cognos Administration. They can also be deployed to other portals. The following portlets are available in this group:
Portlet
Metric List (p. 726)
Description
Use to add performance metrics to a page. You can configure the portlet to show the following types of metric lists: Watch list Contains the metrics that a user wants to monitor closely. Accountability list Contains the metrics that a user owns. Scorecard metric list Contains metrics associated with a scorecard. Strategy metric list Contains metrics associated with a strategy. To show the metrics grouped by scorecards, select the Apply a scorecard filter check box.
Use to add a metric history chart to a page. The history chart is a graphical illustration of the historical performance of a metric. Use to display impact diagrams associated with a metric. Use to display custom diagrams associated with a scorecard.
Metrics Impact Diagram (p. 730) Metrics Custom Diagram (p. 731)
Dashboard Portlets
The dashboard portlets provide the framework and content for the dashboard pages in IBM Cognos Connection.
Portlet
Multi-page (p. 738)
Description
Use to create a dashboard with multiple pages.
Other Portlets
The other portlets include non-Cognos portlets that conform to the Web Services for Remote Portlets (WSRP) standard, such as Oracle portlets, or Sun portlets. Verification and support for these remote portlets may be incomplete because WSRP is a new standard for remote portlets that is still in the process of implementation by many vendors. The single signon for other portlets may not be available because this functionality is outside the scope of the WSRP standard. Other portlets must be imported into IBM Cognos Connection (p. 432).
Import Portlets
You can import non-Cognos portlets (p. 432) into IBM Cognos Connection if the portlets conform to the WSRP standard. This procedure is not necessary for Cognos portlets because they are automatically registered and available in IBM Cognos Connection if the applicable IBM Cognos component, such as Metric Studio or Software Development Kit, is installed.
Steps
1. In IBM Cognos Connection, click Launch, IBM Cognos Administration. 2. On the Configuration tab, click Portlets. 3. Click the import portlets button .
The Specify a producer page appears. 4. Choose the producer Web service. If a Web Services Description Language (WSDL) definition file exists, in the Web Service Description box, type its URL address. Here is an example: http://wsrp.netunitysoftware.com/WSRPTestService/WSRPTestService. asmx?Operation=WSDL If a WSDL definition file does not exist, click Web Services for Remote Portlet (WSRP) interfaces, and type the URL required by the portlet producer. Tip: To import the Cognos portlets, click IBM Cognos producer, and choose the available group. 5. Click Next.
432
Chapter 29: Managing Portlets and Styles 6. If the Specify the registration properties page appears, provide the registration information as required, and click Next again. 7. In the Specify a name and description page appears, do the following: Type a name and, if you want, a description and a screen tip for the portlet group. Choose the portlets to import by selecting or clearing the check boxes next to the portlets. Click Finish.
Alternatively, click the More link, and then click Lock portlet settings. The icon changes to locked.
Parameter
-1 (default) 0 1 or an integer greater than 1
Value
Saves unlimited number of portlet markups Disables markup caching Limits the number of markups to a specified number
You must provide run-time values for this parameter for every application server that runs the presentation service. properties.config.cps.cache.timeToIdleSeconds Specifies the length of time, in seconds, to keep the page markup fragments in the cache during a period of inactivity. If the page is not accessed during that time, its cache contents are deleted. The default value is 1800 (30 minutes). properties.config.cps.cache.timeToLiveSeconds Specifies the length of time, in seconds, to keep the page markup fragments in the cache. After this time, the markup is deleted even if the cache is still active. The default value is 86400 (24 hours). properties.config.cps.cache.checkExpiryIntervalSeconds
434
Chapter 29: Managing Portlets and Styles Specifies the length of time, in seconds, that represents the frequency with which the system checks for expired markup fragments in the cache. The default value is 300 (5 minutes). To enable or disable encryption of the portlet markup fragments, use the parameter encryptTemporaryFiles of the Environment category in IBM Cognos Configuration. For more information, see the IBM Cognos Configuration User Guide.
Steps
1. In IBM Cognos Connection, click Launch, IBM Cognos Administration. 2. On the Configuration tab, click Dispatchers and Services. 3. Click the dispatcher you want. 4. For PresentationService, click the set properties button. 5. Click the Settings tab. 6. For the Environment category, next to Advanced settings, click the Edit link. 7. If it appears, select the Override the settings acquired from the parent entry check box. Otherwise, proceed to the next step. 8. In the Parameter column, type the required parameter specified in this section. For example, type CPSMaxCacheSizePerPortlet. 9. In the Value column, type the required value for the parameter. 10. Click OK. 11. Click OK again. 12. Click the Configuration link in the path at the top of the page. You return to the list of dispatchers. 13. If you have more than one dispatcher configured, perform steps 3 to 12 for each remaining dispatcher. 14. Restart the IBM Cognos 8 service.
Modify a Portlet
You can define the default content and appearance of portlets. The settings become the default for all users who use the portlet. You can lock the portlet for editing if you want to prevent other users from changing the settings. If the portlet is not locked for editing, users can change their instance of the portlet. They retain their custom settings even if you reset the portlet. Users inherit the settings you configure when they use the portlet instance you configured, or when they reset their portlet instance using the reset button in the portlet edit mode.
Chapter 29: Managing Portlets and Styles Applications that appear in the Cognos Extended Applications portlet may include editable application parameters with default values defined by the developer. To change the parameter values that users see as defaults, you must edit the applications.xml file. For information about modifying application parameters, see the Developer Guide. The configurable properties for the Cognos portlets vary. For more information, see "User Reference Help for Portal Services" (p. 717).
Steps
1. In IBM Cognos Connection, click Launch, IBM Cognos Administration. 2. On the Configuration tab, click Portlets. 3. Click the portlet group you want. 4. Next to the portlet you want to modify, click the More link. 5. Click View and customize this portlet. The Cognos portlet appears. 6. In the portlet toolbar, click the edit button . , which
When you modify the Cognos Content portlets, you can use the configure button gives you access to additional functionality. The portlet properties page appears. Tip: To exit the properties page without saving the changes, click the return button title bar or click Cancel. 7. Change the portlet properties as required. Tip: To restore the default settings, click the reset button 8. Click OK. .
in the
Display the HTML Code From the Source RSS Feed in RSS Viewer and Cognos Navigator
Some RSS channels contain HTML code sequences as part of their title and description fields. For security reasons, the HTML code, if present in the source RSS feed, is disabled in the news list view in the portlets RSS Viewer and Cognos Navigator. Instead, a series of HTML control characters is displayed in the title and description fields of both portlets. You can override this setting and allow the HTML code to be executed in RSS Viewer and Cognos Navigator to display the code as intended by the publisher of the RSS feed. To do that, specify the CPSRssAllowUnsafeCharacters run-time parameter with a value of "true" for the dispatcher presentation service. The default value for this parameter is "false".
436
Chapter 29: Managing Portlets and Styles Warning: Allowing execution of the HTML code from external sources represents a security threat.
Steps
1. In IBM Cognos Connection, click Launch, IBM Cognos Administration. 2. On the Configuration tab, click Dispatchers and Services. 3. Click the dispatcher you want. 4. For the PresentationService, in the Actions column, click the set properties button. 5. Click the Settings tab. 6. For the Environment category, next to Advanced settings, click the Edit link. 7. If it appears, select the Override the settings acquired from the parent entry check box. 8. In the Parameter column, type the parameter CPSRssAllowUnsafeCharacters 9. In the Value column, as a value for this parameter, type true 10. Click OK. 11. Click OK again. 12. Click the Configuration link in the path at the top of the page. You return to the list of dispatchers. 13. If you have more than one dispatcher configured, perform steps 3 to 12 for each remaining dispatcher.
Styles
A style is a defined set of resources, such as images and cascading style sheets, that controls the appearance of the IBM Cognos 8 Web interface. The branding images and fonts are also part of the style. The resources for the styles are located in the c8_location/webcontent/skins directory. The following predefined styles are available in IBM Cognos 8:
Style
business classic contemporary corporate
Description
Uses soft colors. Creates clean and simple, professional look. Matches the style used by Metric Studio. Uses bolder, more vivid colors. Matches the IBM Cognos corporate branding. This is the default style in IBM Cognos 8.
Style
modern presentation
Description
Matches the style used by IBM Cognos ReportNet. A variation of the corporate style. Uses larger fonts and increased contrast. Intended for projections.
If the predefined styles do not meet your requirements, you can create your own style and make it available in IBM Cognos 8 (p. 480). At run time, individual users can choose any of the available styles to use in their Web interface (p. 260). Ensure that all users have access to at least one style. The initial style settings for new users are determined by the default user profiles. For information about changing the user profiles, see "Managing User Profiles" (p. 339). Managing styles involves: Adding new styles (p. 438) Controlling access to styles (p. 439) Modifying styles (p. 440)
Steps
1. In IBM Cognos Connection, click Launch, IBM Cognos Administration. 2. On the Configuration tab, click Styles. The new style wizard appears. 3. Click the new style button .
4. Type a name for the style and, if you want, a screen tip and description. The style name can be any word or phrase you want. It does not need to match the name of the product directory where the style resources are located. Tip: You can specify the style name, description, and screen tip only in the product language you currently use. To specify these values for different languages, you can later modify the style (p. 440).
438
Chapter 29: Managing Portlets and Styles 5. Click Next. 6. Specify the location of the style resources: In the Style location name box, type the name of the style directory where the style resources are located. You can specify one of the predefined style directories, such as corporate, classic or modern, or a custom directory, if it exists. In the Preview image URL box, type the URL address where the preview resource for the style is located. An example of a preview resource can be a Web server page, a video, or an image. 7. Click Finish.
Steps
1. In IBM Cognos Connection, click Launch, IBM Cognos Administration. 2. On the Configuration tab, click Styles. 3. Click the properties button for the style you want. 4. Click the Permissions tab. 5. Select the Override the access permissions acquired from the parent entry check box. 6. Grant the required type of access permissions. For end users, grant execute permissions for the users, groups, or roles you want to have access to this style. For administrators, grant read, write, or set policy permissions.
For more information, see "Set Access Permissions for an Entry" (p. 216).
Modify a Style
You can modify an existing style to change the style name, description, and screen tip You can rename any of the predefined or custom styles to use style names that are more appropriate for your Web interface. add, change, or remove the style name, description, and screen tip for different language versions of the product You may want the style name, description, and screen tip match the users product language. change the style directory You can associate an existing style with a different style directory in c8_location/webcontent/skins. You may need to do this when, for example, the names of the style directories change as a result of the product translation into different languages. For more information about the style general properties, see "Entry Properties" (p. 243)
Steps
1. In IBM Cognos Connection, click Launch, IBM Cognos Administration. 2. On the Configuration tab, click Styles. 3. Click the properties button for the style you want. 4. On the General or Styles tab, modify the properties as required. 5. Click OK.
440
If you want to use the ReportNet 1.1 portlets in IBM Cognos 8, you may need to upgrade them (p. 464). By default, the root name of file paths in the portlets is Cognos. You can change the root name (p. 464). As an additional security measure, you can disable the mechanism to transfer the IBM Cognos 8 passport ID as a URL parameter between users' browsers and the IBM Cognos 8 gateway (p. 465). After you deploy the portlets, you can enable single signon between the portlets and your portal (p. 467). Notes 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.
Deploying Cognos Portlets to WebSphere Portal 5.0, 5.1, 6.0, and 6.1
Before users can add Cognos portlets to their portal pages, you must deploy the portlets to the portal server. You can deploy the following portlets: Cognos Content This group includes Cognos Navigator, Cognos Search, Cognos Viewer. Cognos Extended Applications This group includes the Cognos Extended Applications portlet.
Chapter 30: Deploying Cognos Portlets to Other Portals Cognos Metrics This group includes Metric List, Metric History Chart, Metrics Impact Diagram, and Metrics Custom Diagram. Before you start deploying the portlets, ensure that IBM Cognos 8, including IBM Cognos Connection and Portal Services, is installed and configured. For the Cognos Extended Applications portlet, IBM Cognos 8 Software Development Kit must also be installed. If IBM Cognos 8 Software Development Kit is not installed or not available, the portal administrator should disable the Cognos Extended Applications portlet after the portlet applications file is installed (p. 442). For the Cognos Metrics portlets, Metric Studio must also be installed. If Metric Studio is not installed or not available, the portal administrator should disable the Cognos Metrics portlets after the portlet applications file is installed (p. 442). You must first log on to the portal with administrator privileges. The deployment process consists of the following tasks: Installing the portlet applications file Configuring the portlet applications Configuring the portlet cache Customizing the content of Cognos portlets
After you deploy the portlets, you can configure security for your WebSphere Portal environment (p. 467). For more information, see the Installation and Configuration Guide. Note: The tasks documented in this section may vary slightly for the different versions of WebSphere Portal.
Steps
1. At the top of the portal page, click the Administration tab.
442
Chapter 30: Deploying Cognos Portlets to Other Portals 2. From the menu on the left, click Portlet Management, Web Modules, and then click Install. Tip: To update the CognosBIPortlets.war file, click Web Modules, select the file name, and click the update web module button .
3. Click the Browse button, and, in the c8_location\cps\ibm\portlets directory, select the CognosBIPortlets.war file. 4. Click Next. 5. Click Finish. A message confirms that the portlets were successfully installed.
Steps
1. On the Administration tab, click Portlet Management, Web Modules. 2. Click the CognosBIPortlets.war file. A list of the Cognos portlet applications appears. 3. For the application you want, click the edit portlet application button The edit page appears. 4. For the Active Credential Type property, enter one of the following values to specify the single signon mechanism used in your installation. LtpaToken HttpBasicAuth SiteMinderToken WebSealToken .
For more information about configuring single signon for Portal Services, see "Configuring Security for Portal Services" (p. 467). 5. For the IBM Cognos 8 WSRP WSDL Location property, modify the URL as required to connect to the CPS server. The URL must contain the correct protocol, server name, port number, and server path. By default, the protocol is http. If IBM Cognos 8 is configured to be accessed through Secure Sockets Layer (SSL) connections, change the protocol to https. The server path must point to an IBM Cognos 8 gateway.
Chapter 30: Deploying Cognos Portlets to Other Portals For the Cognos Navigator, Cognos Search, and Cognos Viewer portlets, the path is c8_gateway/wsrp/cps4/portlets/nav?wsdl&b_action=cps.wsdl. For the Cognos Extended Applications portlet, the path is c8_gateway/wsrp/cps4/portlets/ sdk?wsdl&b_action=cps.wsdl. For the Cognos Metrics, the path is c8_gateway/wsrp/cps4/portlets/cmm?wsdl&b_ action=cps.wsdl.
6. Click OK. The Cognos portlets are now available to be added to pages by users. You can configure Cognos portlets so that their default settings are the same for all users. 7. Repeat steps 3 to 6 for the Cognos Extended Applications Portlets and the Cognos Metrics. Note: You can create the Cognos Extended Applications portlets only if IBM Cognos 8 Software Development Kit is installed. For information about creating extended applications for Portal Services, see the Developer Guide.
Steps
1. On the Administration tab, click Portlet Management, Web Modules. 2. Click the portlet applications file CognosBIPortlets.war. 3. In the portlet applications list, click the application you want. 4. For the portlet you want to set the cache size, click the configure portlet button .
5. For the Maximum Cached Pages property, enter the maximum number of pages you want to cache. 6. Click OK. 7. Repeat steps 4 to 6 for each portlet. 8. Restart the IBM Cognos 8 service.
444
Chapter 30: Deploying Cognos Portlets to Other Portals If the portlet is not locked for editing, users can customize the content for their instance of the portlet. Users retain their custom settings even if you reset the portlet. Users inherit the settings you configure only when they view the instance you configured, or when they reset the portlet using the reset button in the edit page of the portlet. Applications that appear in the Cognos Extended Applications portlet may include editable application parameters with default values defined by the developer. To change the parameter values that users see as defaults, you must edit the applications.xml file. For information about modifying application parameters, see the Developer Guide. The configurable properties for the Cognos portlets vary. For more information, see "User Reference Help for Portal Services" (p. 717).
Steps
1. Go to the page where you added the Cognos portlets. 2. Click the configure button 3. Edit the settings as required. These become the default settings for user instances of this portlet. 4. Click OK. for the portlet that you want to configure.
Deploying Cognos Portlets to SAP Enterprise Portal 6.0, 6.4, and 7.0
Before users can add Cognos portlets to their portal pages, you must deploy the portlets to the portal server. You can deploy the following portlets: Cognos Content This group includes Cognos Navigator, Cognos Search, Cognos Viewer Cognos Extended Applications This group includes the Cognos Extended Applications portlet. Cognos Metrics This group includes Metric List, Metric History Chart, Metrics Impact Diagram, and Metrics Custom Diagram. Before you start deploying the Cognos portlets, ensure that IBM Cognos 8, including IBM Cognos Connection and Portal Services, is installed and configured. For the Cognos Extended Applications portlet, IBM Cognos 8 Software Development Kit must also be installed. If IBM Cognos 8 Software Development Kit is not installed or not available, the portal administrator should disable the Cognos Extended Applications portlet after the IBM Cognos business package is installed (p. 446).
Chapter 30: Deploying Cognos Portlets to Other Portals For the Cognos Metrics portlets, Metric Studio must also be installed. If Metric Studio is not installed or not available, the portal administrator should disable the Cognos Metrics portlets after the IBM Cognos business package is installed (p. 446). In SAP Enterprise Portal, portlets are named iViews. Portions of this document refer to iViews as portlets. You must first log on to the portal with administrator privileges. The deployment process consists of the following tasks: Installing the IBM Cognos business package Editing properties for the iViews Setting the default iViews content and appearance
After you deploy the portlets, you must configure security for your SAP Enterprise Portal environment. For more information, see the Proven Practices on the Cognos Software Services Web site.
Notes
Portal Services in IBM Cognos 8 supports SAP portals 6.0, 6.4, and 7.0. This document describes administrative tasks for version 6.0. The tasks may vary slightly for the versions 6.4 and 7.0.
Steps
1. In the portal, click the System Administration tab. 2. On the Transport tab, click Import. 3. Next to Source for Package Files, click Client. If Client is not functional, click Server. 4. Click Browse to locate the com.cognos.cognos.epa file, and click Open. The com.cognos.cognos.epa file is located in the c8_location\cps\sap\package directory. If you clicked Server in the previous step, browse for the com.cognos.cognos.epa file in the SAP_installation\usr\sap\env\SYS\global\pcd\Import directory, where env represents a directory that is different for different environments. The com.cognos.cognos.epa file must first be copied to this directory. 446
Property
CPS: Connection Server
Description
Represents the URL required to connect to the Portal Services server. The URL must contain the correct protocol, server name, port number, and server path. By default, the protocol is http. If IBM Cognos 8 is configured to be accessed through Secure Sockets Layer (SSL) connections, change the protocol to https. The server path must point to an IBM Cognos 8 gateway. For the Cognos Navigator, Cognos Search, and Cognos Viewer iView, the path is c8_gateway/wsrp/ cps4/portlets/nav?wsdl&b_action=cps.wsdl For the Cognos Extended Applications iView, the path is c8_gateway/wsrp/cps4/portlets/sdk?wsdl&b_ action=cps.wsdl For the Cognos Metric List and Metric History Chart iView, the path is c8_gateway/wsrp/cps4/portlets/ cmm?wsdl&b_action=cps.wsd
Specifies the SAP role whose members, typically administrators, can modify the default iView properties (p. 448). These users can see the link Edit the properties for all users at the bottom of the iView properties page, and use it to modify the default iView properties. Only one SAP role can be specified to modify the default iView properties. Default: content_admin_role
Steps
1. Log on to the portal with administrator permissions. 2. Click the Content Administration tab. 3. In the window on the left, on the Browse tab, expand the Portal Content folder.
Chapter 30: Deploying Cognos Portlets to Other Portals 4. Continue expanding the folders until you see Cognos iViews. By default, Cognos iViews are imported into the Portal Content, Content Provided by Other Vendors, End User Content, com.cognos.pct.cognos8, iviews folder. 5. Double-click the iView you want to modify. The Property Editor appears in the main window. 6. In the Property Category drop-down list, click Show All. 7. Edit the properties as required. 8. Click Save. 9. Repeat steps 5 to 8 for each Cognos iView. 10. If you want to test the connection between IBM Cognos 8 and Portal Services, click the Preview button.
Set the Default iView Content and Appearance for All Users
An administrator can define the default content and appearance for Cognos iViews. When end users add the iViews to their pages, the default properties are enabled. For example, in the Cognos Navigator iView, the administrator can define the default display folder or package. When users add this iView to their pages, they see the folder or package that was specified by the administrator. End users can change the Cognos iView properties to personalize their pages. Their changes do not affect iViews of other users or other pages. The personalized settings are not affected if the administrator changes the default properties for the iView. Users can click the Reset button to revert to the current administrative defaults. To change the iView properties for all users, you must be a member of the SAP role that has the required access permissions. This role is specified by the CPS: Configuration Mode Role property. For more information, see "Edit Properties for the iViews" (p. 447).
Steps
1. Log on to the portal with administrator permissions. 2. Browse to the page that contains Cognos iViews. 3. For the iView you want to modify, click the option menu button in the upper-right corner of the iView, and select Personalize. The iView properties page appears. 4. At the bottom of the page, click the link Edit the properties for all users. 5. Change the properties as required. These settings become the default settings for user instances of this portlet. 6. Click Save. 7. Repeat steps 3 to 6 for other Cognos iViews.
448
After you deploy the portlets, you can configure security for your ALUI 6.1 or 6.5 environment (p. 467). For more information, see the Installation and Configuration Guide.
Chapter 30: Deploying Cognos Portlets to Other Portals You can deploy the remote server to another server. Ensure that the settings are configured properly so that the remote server can access an IBM Cognos 8 gateway. You can start the remote server in its default configuration state. However, the default remote server works only if the following conditions are met: IBM Cognos 8 is configured with a CGI gateway. The remote server runs on the same server as the IBM Cognos 8 gateway, which can be accessed using http://localhost/cognos8.
If these conditions do not apply to your installation, you must change the configuration settings for the remote server before you start it. To start the remote server, you must deploy the remote server into an active webapps folder: For Tomcat, copy the cps-alui.war file from the c8_location\cps\bea_aqualogic\gadgets directory into the c8_location\webapps folder. Tomcat automatically updates all affected directories and starts the remote server. The process may take a few minutes. For other application servers, follow the instructions in their administration guides.
You can now import the Cognos Portlet Package File (p. 452).
450
Parameter
cps_endpoint
Description
Specifies the URL to connect to the IBM Cognos 8 server and extract the WSDL information. The default value of http://localhost/cognos8/cgi-bin/cognos.cgi/ wsrp/cps4/portlets/[package]?wsdl&b_action=xts.run specifies that the IBM Cognos 8 gateway is configured on the same server as the remote server that it is running. In this situation, IBM Cognos 8 can be accessed through a CGI gateway. If not, this parameter must be modified accordingly. Here are a few more examples of values for this parameter: http://myserver/servletgateway/wsrp/cps4/portlets/ [package]?wsdl&b_action=cps.wsdl Specifies an IBM Cognos 8 servlet gateway installation on the server named myserver. http://myserver/ISAPIgateway/wsrp/cps4/portlets/ [package]?wsdl&b_action=cps.wsdl Specifies an IBM Cognos 8 ISAPI gateway installation on the server named myserver.
forward_cookies
Specifies the names of cookies that must be forwarded to the IBM Cognos 8 server for single signon purposes. If the single signon mechanism for the installation depends on a specific active credential cookie, it is necessary to pass this cookie from the ALUI 6.1 or 6.5 server to the IBM Cognos 8 server. Default: null
cps_auth_secret
Specifies the value of the shared secret key. This parameter is optional. Use it only when your environment is configured to use the shared secret single signon mechanism. When this parameter is specified, the user's identity is sent to the IBM Cognos 8 server through an HTTP header variable that is encrypted using the value of the shared secret. The value of this parameter must be identical to the one specified in IBM Cognos Configuration. For more information, see "Configuring Security for Portal Services" (p. 467).
cps_auth_namespace
Steps
1. Stop your application server, such as Tomcat, or stop the remote server application.
Chapter 30: Deploying Cognos Portlets to Other Portals 2. Remove the existing remote server by doing one of the following: For Tomcat, delete the cps-alui folder and the cps-alui.war file from the c8_location\webapps directory. For other application servers, follow the instructions in their administration guides.
3. Open the cpsalui.properties file. The file is located in the c8_location/cps/bea_aqualogic/webapps/gadgets/WEB-INF/classes directory. 4. Change the settings as required and save the file. 5. Rebuild the remote server by running the following batch file: for Windows, c8_location\cps\bea_aqualogic\build.bat for UNIX or Linux, c8_location\cps\bea_aqualogic\build.sh
The configuration settings for the remote server (cps-alui.war) are changed. 6. Start the remote server (p. 449). You can now import the Cognos portlet package file (p. 452).
Chapter 30: Deploying Cognos Portlets to Other Portals 7. Click Select Utility and click Migration - Import. 8. Select Folder Information, click Browse. 9. Select the folder you created to store the new resources, and click OK. 10. Under General Info, click Browse to locate the CognosBEAAquaLogic61PortletPackage.pte. This file is located in the c8_location/cps/bea_aqualogic/gadgets directory. 11. Click Open, and then click Load Package. 12. Click Finish, and click OK. The Cognos portlets appear in the Portal Services folder. You can now connect to the remote server (p. 453).
Steps
1. Click the folder that contains the Cognos portlets. 2. Expand the Remote Server folder, and click IBM Cognos Portal Services. 3. In the Edit Remote Serverpage, in the Remote Server Properties box, change the Base URL from http://localhost:9300/ to the following, where gadget server is the name or IP address of the server that hosts the IBM Cognos 8 remote server, and port is the port number used by the remote server.http://gadget_server:port The default port number is 9300. Here is an example: http://myserver:9300/ 4. Click Finish. Administration and Security Guide 453
Steps
1. Go to the page where you added the Cognos portlets. 2. Click the configure button for the portlet you want to configure. 3. Edit the settings as required. These become the default settings for user instances of this portlet. 4. Click Done.
Deploying Cognos Portlets to Microsoft SharePoint Portal Server 2003 and 2007
You deploy Cognos portlets to the portal server so that users can add the portlets to their pages. In SharePoint Portal Server, portlets are named Web Parts. Portions of this document refer to Web Parts as portlets. You can deploy the following portlets: Cognos Content This group includes Cognos Navigator, Cognos Search, Cognos Viewer Cognos Extended Applications This group includes the Cognos Extended Applications portlet. To deploy this portlet, IBM Cognos 8 Software Development Kit must also be installed. Cognos Metrics This group includes Metric List, Metric History Chart, Metrics Impact Diagram, and Metrics Custom Diagram. To deploy these portlets, IBM Cognos 8 Metrics Manager Server must also be installed.
454
Chapter 30: Deploying Cognos Portlets to Other Portals Before deploying the Cognos portlets, ensure that IBM Cognos 8, including IBM Cognos Connection and Portal Services, is installed and configured. Also ensure that the following conditions are met: You have administration access to the IIS server computer that hosts SharePoint. You have administration access to the IBM Cognos 8 installation directory c8_location/cps/sharepoint. WSS Language Template Pack required for other supported languages is installed, one for each language.
For information about recommended operating system and SharePoint-related updates, and about the required OS patches, see the conformance information on the IBM Cognos Resource Center Web site (http://www.ibm.com/software/data/support/cognos_crc.html). For SharePoint Portal Server 2007, contact Microsoft for information about required OS patches. To deploy Cognos portlets to a SharePoint Portal Server, perform the following tasks: Set up virtual directories and change the gateway URIs (p. 455) This step applies if Microsoft Internet Information Services (IIS) is your Web server. Copy the Cognos Web Parts resources to the IIS HTTP root directory (p. 456) Set up the IBM Cognos security trust file (p. 457) Modify the .NET Framework web.config file (p. 458) Modify the Cognos Web Parts catalog files (p. 461) Restart IIS (p. 461) Add Cognos Web Parts to a SharePoint page (p. 462) Customize the content of Cognos Web Parts (p. 463)
After you deploy the portlets, you can configure security for your SharePoint Portal Server environment (p. 467). For more information, see the Installation and Configuration Guide.
For more information, see the Proven Practices on the Cognos Software Services Web site.
Chapter 30: Deploying Cognos Portlets to Other Portals Specify the path to c8_location/webcontent. Grant read permissions to this directory. Enable anonymous access. Ensure that Integrated Windows authentication is not selected.
2. Under the cps virtual directory, create another directory named cgi-bin, and assign the following properties for this directory: Specify the path to c8_location/cgi-bin. Grant execute permissions to this directory. Enable anonymous access. Ensure that Integrated Windows authentication is not selected.
Copy the Cognos Web Parts Resources to the IIS HTTP Root Directory
IBM Cognos software provides the resources required for the integration of SharePoint Portal Server with IBM Cognos 8. These include the Web Part DLLs for different languages, and catalog files for each Cognos Web Part. You must copy these resources to the IIS HTTP root directory to make them available to SharePoint.
Steps
1. Go to the c8-location/cps/sharepoint directory. 2. Copy all files from this directory to the IIS HTTP root directory, as specified in the following table. An example of the IIS HTTP root directory can be C:/Inetpub/wwwroot for SharePoint Portal Server 2003, and C:/Inetpub/wwwroot/wss/VirtualDirectories/80 for SharePoint Portal Server 2007.
456
File
Cognos.BI.WebPart.dll Cognos.BI.WebPart.resources.dll Cognos.BI.WebPart.resources.dll Cognos.BI.WebPart.resources.dll Cognos.BI.WebPart.resources.dll CognosNavigator.dwp CognosSearch.dwp CognosViewer.dwp CognosSDK.dwp CognosWatchList.dwp CognosHistoryChart.dwp CognosImpactDiagram.dwp CognosCustomDiagram.dwp dialog_error.gif
Later you can edit the Cognos*.dwp catalog files (p. 461).
Steps
1. Go to the c8_location/cps/sharepoint/config directory.
Chapter 30: Deploying Cognos Portlets to Other Portals 2. Copy the wss_cognostrust.config.sample file: If you use SharePoint Portal Server 2003, copy the wss_cognostrust.config.sample file from the c8_location/cps/sharepoint/config/wss.2003 directory to the C:/Program Files/Common Files/Microsoft Shared/web server extensions/60/CONFIG directory. If you use SharePoint Portal Server 2007, copy the wss_cognostrust.config.sample file from the c8_location/cps/sharepoint/config/wss.2007 directory to the C:/Program Files/Common Files/Microsoft Shared/web server extensions/12/CONFIG directory.
Steps
1. Go to the IIS HTTP root directory, for example, C:/ Inetpub/wwwroot for SharePoint 2003, and C:/Inetpub/wwwroot/wss/VirtualDirectories/80 for SharePoint 2007. 2. Open the web.config file in an XML editor, such as XML Spy. 3. Edit the web.config file as required (p. 458), and save the file.
458
to
<trust level="WSS_Cognos" originUrl="" />
Chapter 30: Deploying Cognos Portlets to Other Portals In the system.web section, add the following pages element.
<pages enableSessionState="true" enableViewState="true" enableViewStateMac="true" validateRequest="false" />
If this element already exists, change the value of its enableSessionState attribute to true. In the system.web section, add the following element to the httpHandlers element:
<add verb="*" path="CognosResources/*.axd"type="Cognos.Portal.Services. HttpResourceHandler, Cognos.BI.WebPart, Version=1.0.0.0, Culture=neutral, PublicKeyToken=cb3c72729d0875cd" validate="false"/>
The soapExtensionTypes element represents all SOAP extensions that are available to your Web service at run time. If the webServices and soapExtensionTypes elements are already defined, add only the add element.
The elements in the Cognos element represent the different configuration settings. Use the SoapLog element to specify the location for the Web Services log files.
460
Chapter 30: Deploying Cognos Portlets to Other Portals Use the Log element to specify a different location for the log file, and to enable the different logging features by changing the attribute values from false to true. Use the SSO element to specify the IBM Cognos Security Namespace ID of the CPS trusted namespace named cps_auth_namespace, and the shared secret password named
cps_auth_secret.
This parameter is optional. Use the PortalContext element to specify the URL attributes for IBM Cognos gateway and IBM Cognos Web content, as shown in the following example: PortalContext gatewayURL="http://localhost/cps/cgi-bin/cognosisapi.dll" webContentURL="http://c8_host_computer/cps"
This parameter is optional. Use the Fault element to display the call stacks in the error page when a fault is caught by a Web Part.
Steps
1. Go to the IIS directory where the catalog files were copied. For example, for SharePoint Portal Server 2003, go to C:/Inetpub/wwwroot, and for SharePoint Portal Server 2007 go to C:/Inetpub/wwwroot/wss/VirtualDirectories/80. 2. In each Cognos Web Part catalog file, Cognos*.dwp, change the URL in the WSDL element to point to your IBM Cognos 8 gateway. Here is an example:
<WSDL xmlns="http://developer.cognos.com/webpart/v1"> http://localhost/cps/cgi-bin/cognosisapi.dll/wsrp/cps4/portlets/nav?b_ action=cps.wsdl&wsdl</WSDL>
Tip: The ampersand characters (&) in the URL must be XML-encoded as & 3. Save the file.
Restart IIS
You must restart Internet Information Services (IIS) for the configuration changes to take effect.
Step
Restart IIS using its management console, or the iisreset.exe command line tool.
Chapter 30: Deploying Cognos Portlets to Other Portals The Cognos Web Parts are now available in SharePoint Portal Server, and can be added to the portal pages (p. 462).
462
Chapter 30: Deploying Cognos Portlets to Other Portals 11. Specify the Portlet handle property. 12. Click Apply to make changes without closing the pane, or click OK when you are done. 13. Repeat steps 4 to 12 for each Cognos Web Part you want to add to the page. You can now customize the content of the Cognos Web Parts (p. 463).
Chapter 30: Deploying Cognos Portlets to Other Portals 2. From the list of Actions on the left side, click Edit Page. 3. In the Web Part, click the down arrow in the upper-right corner, and click Edit Preferences. The Web Part properties page appears. 4. Specify the settings as required. For more information, click the help button in the upper-right corner of the properties page. 5. Click OK.
Migrating Cognos Portlets from IBM Cognos ReportNet 1.1 to IBM Cognos 8
When you upgrade ReportNet 1.1 to IBM Cognos 8, you must update the portlets using the latest portlet package file installed with IBM Cognos 8. For a WebSphere portal, use the CognosBIPortlets.war file located in the c8_location\cps\ibm\portlets directory (p. 441). For SAP Enterprise Portal 6.0, use the com.cognos.cognos.epa file located in the c8_location\cps\ sap\package directory (p. 445). Importing the new package into the portal creates a new and distinct set of Cognos portlets and resources. The upgraded portlets are not compatible with ReportNet 1.1, and the personalized settings are lost. You must configure and test the new portlets as required for IBM Cognos 8.
464
Chapter 30: Deploying Cognos Portlets to Other Portals If you want to specify root names for different locales, you must create new properties files for the required locales in the c8_location/webapps/p2pd/WEB-INF/classes directory. For example, to specify root names for English, French, German, and Japanese locales, create the following properties files, and provide the root name value in each of them: cpsinavcrnmsgs_custom_en.properties cpsinavcrnmsgs_custom_fr.properties cpsinavcrnmsgs_custom_de.properties cpsinavcrnmsgs_custom_ja.properties
Steps
1. Open the cpsinavcrnmsgs_custom.properties file in a text editor that supports UTF-8 encoding format. The file is located in the c8_location/webapps/p2pd/WEB-INF/classes directory. 2. Change the value 0f the property nav.root.name as follows, where root_name represents the value you change:
nav.root.name=root_name
3. Save the cpsinavcrnmsgs_custom.properties file. 4. If you want to specify root names for different locales, create the required properties files now. 5. Restart the IBM Cognos 8 server.
Chapter 30: Deploying Cognos Portlets to Other Portals same applies when IBM Cognos 8 is integrated with IBM Cognos Series 7 and the active credential is passed as a URL parameter.
Steps
1. In IBM Cognos Connection, in the upper-right corner, click Launch, IBM Cognos Administration. 2. On the Configuration tab, click Dispatchers and Services. 3. Click the dispatcher you want. 4. For the PresentationService, in the Actions column, click the set properties button. 5. Click the Settings tab. 6. For the Environment category, next to Advanced settings, click the Edit link. 7. Select the Override the settings acquired from the parent entry check box. 8. In the Parameter column, type the parameter names: CPSPropagatePassport This parameter controls the transfer of the IBM Cognos 8 passport ID as a URL parameter. When set to 0, it stops the transfer. CPSPropagateTicket Controls the transfer of the IBM Cognos Series 7 ticket ID as a URL parameter. When set to 0, it stops the transfer. The parameters are case sensitive. 9. In the Value column, type 0 for each parameter. 10. Click OK. 11. Click OK again. 12. Click the Configuration link next to the path at the top of the page. You return to the list of dispatchers. 13. If you have more than one dispatcher configured, perform steps 3 to 12 for each remaining dispatcher.
466
Steps
1. In IBM Cognos Connection, in the upper-right corner, click Launch, IBM Cognos Administration. 2. On the Configuration tab, click Dispatchers and Services. 3. Click the dispatcher you want. 4. For PresentationService, in the Actions column, click the set properties button. 5. Click the Settings tab. 6. For the Environment category, next to Advanced settings, click the Edit link. 7. If it appears, select the Override the settings acquired from the parent entry check box. Otherwise, proceed to the next step. 8. In the Parameter column, type CPSProtocolScheme. 9. In the Value column, type http or https. 10. Click OK twice. 11. Click the Configuration link in the path at the top of the page. You return to the list of dispatchers. 12. If you have more than one dispatcher configured, perform steps 3 to 11 for each remaining dispatcher.
Chapter 30: Deploying Cognos Portlets to Other Portals If your security infrastructure requires you to use another method for single signon, use one of the following methods: "Enable Single Signon for WebSphere Portal Using the Application Server" (p. 476) "Enable Single Signon for BEA ALUI Portal Using Basic Authentication" (p. 476) "Enable Single Signon for BEA ALUI Portal Using SiteMinder" (p. 477)
Configure IBM Cognos 8 components for SSL access, if required. For instructions, see the Installation and Configuration Guide.
Steps
1. Start IBM Cognos Configuration. 2. In the Explorer window, under Security, Authentication, click Cognos. 3. In the Properties window, ensure that Allow anonymous access is set to False. 4. From the File menu, click Save. 5. Repeat steps 1 to 4 on all servers where you installed IBM Cognos 8 components.
Chapter 30: Deploying Cognos Portlets to Other Portals Cognos Portlet Application (WebSphere Portal) remote server (BEA ALUI Portal) Cognos WebPart (SharePoint Portal)
You are not required to configure access to the Portal Services Web content. However, if you deploy the portlets to another portal, you can configure access to an alternate URI for Portal Services images and Web content.
Chapter 30: Deploying Cognos Portlets to Other Portals For Shared Secret, type the key to be used for single signon. This parameter represents the authorization secret that must be shared between the Cognos portlets and the IBM Cognos server. Consider this as a secret password. You must use the same character string when you configure the portlet application. You must use a single word as the key. For security reasons, we recommend you specify a non-null value. 6. Under Environment, for Gateway Settings, set the Allow Namespace Override property to true. 7. From the File menu, click Save. 8. Restart the IBM Cognos 8 service.
Chapter 30: Deploying Cognos Portlets to Other Portals http://172.0.16.1:9500/wsrp/cps4/portlets/nav?wsdl&b_action=cps.wsdl For Cognos Extended Applications Gateway_URI/wsrp/cps4/portlets/sdk?wsdl&b_action=cps.wsdl Example for a CGI gateway: http://myserver/cognos8/cgi-bin/cognos.cgi/wsrp/cps4/portlets/sdk?wsdl&b_action=cps. wsdl Example for a servlet gateway: http://172.0.16.1:9500/wsrp/cps4/portlets/sdk?wsdl&b_action=cps.wsdl For Metrics Manager Watchlist portlets Gateway_URI/wsrp/cps4/portlets/cmm?wsdl&b_action=cps.wsdl Example for a CGI gateway: http://myserver/cognos8/cgi-bin/cognos.cgi/wsrp/cps4/portlets/cmm?wsdl&b_action=cps. wsdl Example for a servlet gateway: http://172.0.16.1:9500/wsrp/cps4/portlets/cmm?wsdl&b_action=cps.wsdl
Chapter 30: Deploying Cognos Portlets to Other Portals http://myserver/cognos8/cgi-bin/cognos.cgi/wsrp/cps4/portlets/sdk?wsdl&b_action=cps. wsdl Example for a servlet gateway: http://172.0.16.1:9500/wsrp/cps4/portlets/sdk?wsdl&b_action=cps.wsdl For Metrics Manager Watchlist portlets Gateway_URI/wsrp/cps4/portlets/cmm?wsdl&b_action=cps.wsdl Example for a CGI gateway: http://myserver/cognos8/cgi-bin/cognos.cgi/wsrp/cps4/portlets/cmm?wsdl&b_action=cps. wsdl Example for a servlet gateway: http://172.0.16.1:9500/wsrp/cps4/portlets/cmm?wsdl&b_action=cps.wsdl
Steps to Configure the Remote Server for BEA Aqualogic User Interaction (BEA ALUI) Portal
1. Using a plain ASCII editor, such as Notepad, edit the cpspt.properties file in the c8_location/ cps/bea_aqualogic/webapps/gadgets/WEB-INF/classes directory. 2. Configure the following settings.
Parameter
cps_endpoint
Value
The URL to connect to the Application Tier Components and extract the WSDL information. Specify the URI to the gateway. For a servlet or ISAPI gateway, replace the localhost/cognos8/ cgi-bin/cognos.cgi portion with the values to target the gateway. For example, http://host_name/cognos8/cgi-bin/cognos.isapi/wsrp/cps4/ portlets/[package]?wsdl&b_action=cps.wsdl For instructions, see the topic about changing the gateway in the Installation and Configuration Guide.
forward_cookies=
The names of the cookie that should be sent to the Application Tier Components for single signon. Leave blank.
472
Parameter
cps_auth_secret
Value
The shared secret code IBM Cognos 8 uses to encrypt an HTTP header variable that carries the user identity. This parameter represents the authorization secret that must be shared between the Cognos portlets and the IBM Cognos 8 server. Consider this as a secret password. Use the same value that you used for Shared Secret in IBM Cognos Configuration. For security reasons, we recommend you specify a non-null value.
cps_auth_namespace
3. Go to the c8_location/cps/bea_aqualogic directory and run the following build file: On UNIX or Linux, build.sh On Windows, build.bat
This creates a cps-alui.war file in the c8_location/cps/bea_aqualogic/gadgets directory. 4. If IBM Cognos 8 components are running using Tomcat, Stop IBM Cognos 8. Copy the cps-alui.war file to the c8_location/webapps directory. Tomcat automatically expands the WAR file and starts the remote server. Start IBM Cognos 8.
5. If IBM Cognos 8 components are running under another type of application server, copy the cps-alui.war file to the application server. For instructions, see the administration guide for your application server. Single signon is configured.
Steps to Configure Properties for the Cognos WebPart for SharePoint Portal
1. Using a plain ASCII editor, such as Notepad, edit the web.config file in the drive\Program Files\Common Files\Microsoft Shared\web server extensions\12\CONFIG directory. 2. Find the following string:
<SSO cps_auth_namespace="" cps_auth_secret="" />
3. Set cps_auth_namespace to the namespace ID for the Custom Java Provider namespace. 4. Set cps_auth_secret to the value that you used for Shared Secret in IBM Cognos Configuration.
Enable Single Signon for SAP EP with the SAP Logon Ticket
If you enable single signon with the SAP Logon Ticket, you must configure IBM Cognos 8 components with an SAP namespace that links to an SAP BW server. Then you must copy the certificate that was generated during SAP EP installation to the SAP BW personal security environment. Users must have the same user ID in all SAP systems that are accessed through single signon. Before you start, ensure that you have configured IBM Cognos 8 components to use an SAP authentication source For more information, see the Installation and Configuration Guide. enabled single signon between IBM Cognos 8 components and SAP BW For more information, see the Installation and Configuration Guide. installed the latest service packs on the SAP BW server Service packs can be downloaded from SAPNET. installed the latest hot patches for the SAP portal installed the Enterprise Portal plug-in that corresponds to the SAP EP release or SAP BW server For SAP releases earlier than 6.2, on SAPNET, download EP50_PLUG-IN for Basis 620 (SAPKINE32A). Using transaction SAINT, install SAPKINE32A. installed the SAP Security Library on the SAP BW servers From sapservX, under /general/misc/security/SAPSECU/platform, download sapsecin and sepsecu.dll and place both files in the /run directory of the SAP BW server. To enable SSO for SAP EP, complete the procedures for single signon with SAP logon tickets in the SAP Enterprise Portal Security Guide.
474
Chapter 30: Deploying Cognos Portlets to Other Portals 3. In IBM Cognos Configuration, configure a namespace to authenticate portal users. For instructions, see the topic about configuring LDAP, NTLM, or IBM Cognos Series 7 authentication providers in the Installation and Configuration Guide. 4. If you use an LDAP namespace, configure the following properties: For the Use external identity property, change the setting to True. For the External identity mapping property, set it to (uid=${environment("REMOTE_USER")}) Other properties may be required. For more information, see the topic about configuring IBM Cognos 8 components to use LDAP in the Installation and Configuration Guide.
For more information, see the SAP Enterprise Portal Administration Guide. 2. For each Cognos iView, enable user mapping for the data source by entering the name of the system alias at the iView level, in an attribute called CPS: User Mapping Datasource. For more information, see the SAP Enterprise Portal Administration Guide. 3. For each Cognos iView, set the CPS: Authentication Namespace ID property to the namespace that you want to use for authentication. 4. Register the IBM Cognos credentials for the portal users. Users can enter their own user IDs and passwords. For more information, see the SAP Enterprise Portal Administration Guide. We recommend that you enable secure communication between SAP EP and IBM Cognos 8.
Chapter 30: Deploying Cognos Portlets to Other Portals module as a complementary product. To enable SSL, you must purchase and install the Enhanced Encryption Module for OpenSSL on top of IBM Cognos 8 components. For more information, see the IBM Cognos Enhanced Encryption Module for OpenSSL Installation and Configuration Guide. To enable SSL between SAP EP and IBM Cognos 8 components, see your SAP EP security documentation. For more information about configuring SSL in IBM Cognos 8 components, see the topic about configuring the SSL protocol in the Installation and Configuration Guide. After SSL is enabled, edit properties for the all iViews so that the cpsserver: CPS Connection Server property uses https instead of http.
Enable Single Signon for WebSphere Portal Using the Application Server
The Portal Services portlets can use the Active Credentials objects provided by WebSphere Portal to connect to IBM Cognos 8 components. Portal Services supports the following Active Credentials objects: HttpBasicAuth, LtpaToken, SiteMinderToken, and WebSealToken. Credentials for the portal user are passed to the gateway using this object. For more information about Active Credential objects, see the documentation for IBM WebSphere Portal. To use application server single signon, see the documentation for IBM WebSphere Application Server. For information about SSL for IBM Cognos 8 components on a WebSphere Application Server, see the topic about enabling SSL in the application server chapter of the Installation and Configuration Guide.
Enable Single Signon for BEA ALUI Portal Using Basic Authentication
You can configure a portlet in BEA ALUI Portal to send the username and password as an HTTP Basic authentication header. The header can be used with an NTLM, LDAP, or IBM Cognos Series 7 authentication namespace to provide single signon.
Steps
1. In IBM Cognos Configuration, configure a namespace to authenticate portal users. For instructions, see the topic about configuring LDAP, NTLM, or IBM Cognos Series 7 authentication providers in the Installation and Configuration Guide. 2. Install an alternate CGI or ISAPI or servlet gateway in IBM Cognos 8. For instructions, see the topic about installing IBM Cognos 8 in the Installation and Configuration Guide. 3. Configure the gateway. For instructions, see the Installation and Configuration Guide. 4. In the administration console of the Web server, configure the virtual directories to access the gateway. For more information, see the documentation for your Web server.
476
Chapter 30: Deploying Cognos Portlets to Other Portals 5. Configure the BEA ALUI remote server to access IBM Cognos 8: Edit the cpspt.properties file in the c8_location/cps/bea_aqualogic/webapps/gadgets/WEBINF/classes directory. Change the cps_endpoint property to indicate the URL of the gateway. For a CGI gateway, you can use the default setting if the gateway and the remote server are on the same computer. Otherwise, replace the localhost portion with host_name:port For a servlet or ISAPI gateway, replace the localhost/cognos8/cgi-bin/cognos.cgi portion with the values to target the gateway. For example, http://host_name:port/cognos8/cgi-bin/cognos.isapi/wsrp/cps4/portlets/[package]?wsdl&b_ action=cps.wsdl Set the cps_auth_namespace property to the namespace that you want to use for authentication.
Steps
1. In IBM Cognos Configuration, configure a SiteMinder authentication namespace. For instructions, see the topic about configuring SiteMinder authentication namespaces in the Installation and Configuration Guide. 2. Configure the remote server to forward the authentication token: Edit the cpspt.properties file in the c8_location/cps/bea_aqualogic/webapps/gadgets/WEBINF/classes directory. Change the forward_cookies property to include the name of the active authentication token that SiteMinder provides. Change the cps_endpoint property to indicate the URL of the gateway. For a CGI gateway, you can use the default setting if the gateway and the remote server are on the same computer. Otherwise, replace the localhost portion with host_name:port. For a servlet or ISAPI gateway, replace the localhost/cognos8/cgi-bin/cognos.cgi portion with the values to target the gateway. For example, http://host_name:port/cognos8/cgi-bin/cognos.isapi/wsrp/cps4/portlets/[package]?wsdl&b_ action=cps.wsdl Administration and Security Guide 477
Chapter 30: Deploying Cognos Portlets to Other Portals Change the cps_auth_namespace property to the namespace that you want to use for authentication.
478
For more information about IBM Cognos 8 customizations, see "Customizing the Functionality of IBM Cognos 8" (p. 501).
Customizing Styles
You can change the appearance of all the product component interfaces by using a different style (p. 437) in the c8_location/webcontent/skins directory. The style can be either a modified version of an existing predefined style (p. 480) or your own custom style (p. 480). The IBM Cognos 8 predefined styles include: business classic
Chapter 31: Customizing the Appearance of IBM Cognos 8 contemporary corporate (product default) modern presentation windows
Note: The windows style is used only with Report Studio. It adopts the display scheme specified by the Windows settings. This style must not be modified and none of the customization techniques described in this document apply to it.
Modifying a Style
You can modify an existing style, including the predefined styles, so that it matches your organization Web interface. You can change colors, fonts, images, and some layout properties. Modify the associated style sheets in the c8_location/webcontent/skins/style directory. Rename the styles using IBM Cognos Administration so that the names are more appropriate for your environment (p. 440). Rename the style directories in the c8_location/webcontent/skins directory. Do not rename the corporate directory (p. 481).
480
Chapter 31: Customizing the Appearance of IBM Cognos 8 We recommend that you use the existing style resources as a starting point. Change the style sheets, graphics, and fonts as required, but ensure that the structure of the custom style directory matches the structure of the predefined styles directories.
Steps
1. In the c8_location/webcontent/skins directory, make a copy of an existing style directory. 2. Rename the copied directory. 3. In the new directory, modify the style sheets, graphics, or fonts as required. 4. In IBM Cognos Administration, add a new style object (p. 438) and associate it with the style directory created in step 2.
Chapter 31: Customizing the Appearance of IBM Cognos 8 Tip: To change the text in a graphic, such as the acronym BI, open the relevant file in a graphics editor, replace the text, and resave the graphic in .GIF format.
482
Chapter 31: Customizing the Appearance of IBM Cognos 8 c8_location/webcontent/schemas The file in this location is used by Cognos Viewer for HTML output. c8_location\reportstyles The file in this location is not currently used. c8_location\webcontent\reportstyles The file in this location is used by Report Studio. The files in all directories must be modified to ensure that reports are rendered properly on both the server and the client systems. In a multiple server configuration, the style sheets on all systems must be modified. On the IBM Cognos 8 server system, this is the file in the c8_location/bin directory. On the Web server systems, this is the file in the c8_location/webcontent/schemas directory. For example, if you have 2 IBM Cognos 8 servers and 3 Web servers, you must update 5 copies of the GlobalReportStyles.css file. You can also add styles to this style sheet; however, a simpler alternative is to add a style to a template in Report Studio. Any changes you make to this style sheet are lost if you reinstall or upgrade IBM Cognos 8. If this happens, you must reapply your changes. For more information, see "Migrating Changes to Future Releases" (p. 483) Both Report Studio and Query Studio use the GlobalReportStyles.css file to assign classes to report objects. Query Studio does not expose these classes. However, you can use Report Studio or the SDK to modify the class property of any report object. For example, if you create a default report and then click the title, the class property appears as Report Title Text. You can change this property as required. If you decide to modify the GlobalReportStyles.css file, you must be aware that the class names that appear in Report Studio are multilingual and defined in the Report Studio resource files. Instead of modifying this style sheet, it may be simpler to add a new style into your report. For more information about creating or modifying class styles, see the Report Studio Professional Authoring User Guide. When you work directly with an XML report specification, you can manually set the style of the object. For example, you can edit the report title, which may appear as follows:
<textItem class="reportTitleText"> <text> My report title </text> </textItem>
For more information about modifying styles in a report specification, see the Developer Guide.
Example - Change the Branding Details in the IBM Cognos Connection Main Header
You can customize the IBM Cognos Connection main header by changing the branding details on the left-hand side. You can change the graphic, the title, and the background color. This change affects also Cognos Viewer and the administration tools. The branding details are defined by the OEM parameter in the portal system.xml file. You must modify this file.
Steps
1. Open the system.xml file in a text or XML editor. This file is located in the c8_location/templates/ps/portal directory. 2. Locate the OEM parameter and add the custom branding details as specified in the following code. 484
Chapter 31: Customizing the Appearance of IBM Cognos 8 The sequence in bold font must be repeated for each style in which you want this change to appear.
<param name="OEM"> <customHeader showContext="true" contextDelimiter="-"> <style styleFolderName="corporate"> <!--Insert well-formedHTMLhere --></style> <style styleFolderName="classic"> </style> ... </customHeader> </param>
Setting the showContext attribute to true adds a report or a page name to the title. The
contextDelimiter attribute, which can be represented by any character or sequence of char-
acters, separates the title from the report or page name. Here is a code example for this change:
<customHeader showContext="true" contextDelimiter=""> <style styleFolderName="corporate"> <table style="background-color:#ffffff"> <tr> <td><img src="../skins/corporate/branding/my_logo.gif"/> </td><tdclass="headerTitle" style="padding-right:2px;white-space: nowrap">Mycompany</td> </tr> </table> </style> <style styleFolderName="classic"> <table style="background-color:#cccccc"> <tr> <td><img src="../skins/corporate/branding/my_logo.gif"/> </td><tdclass="headerTitle" style="padding-right:2px;white-space: nowrap">Mycompany </td> </tr> </table> </style> </customHeader>
Example - Change the Background Color in the IBM Cognos Connection Main Header
Suppose you want to change the background color used in the IBM Cognos Connection header. Open the c8_location/webcontent/skins/style/shared/banner.css file in a text editor and, in the code specified below, change the value shown in bold font as required.
mainHeader1 { border-right: #000000 1px solid; border-left: #000000 1px solid; border-bottom: #000000 1px solid; background-color: #669966; height: 25px; background-image: url(Images/title_bar_grapic.gif); background-repeat: repeat-x; background-position: top; }
File
branding/portal_splash.gif
Contents
The splash screen image for IBM Cognos Connection The About box graphic The banner image The animated progress image The IBM Cognos image that appears in the lower-right corner of the Welcome page The watermark image that appears in the background of the About box. The IBM Cognos 8 image that appears in the Welcome pages and in the splash screens
branding/logowatermark.gif
branding/cognos_product_label.gif
Example - Change the Default Fonts for Page Titles and Instructions
Suppose you want to change the initial font settings for the page title and instructions. Depending on the product locale or other circumstances, you can specify a different font style and size. In the c8_location/templates/ps/portal/system.xml file, find the section specified below, and change the values shown in bold font as required.
<param name="myPages"> <param name="fontUnit">pt</param> <!-- pt or px or % --> <param name="defaultTitleFontFace">Tahoma</param> <param name="defaultTitleFontSize">12</param> <param name="defaultInstructionsFontFace">Tahoma</param> <param name="defaultInstructionsFontSize">11</param> </param>
486
Chapter 31: Customizing the Appearance of IBM Cognos 8 The customizable Report Studio style sheets are located in the directory c8_location/webcontent/skins/style/pat, or c8_location/webcontent/skins/style/hal, where style represents a specific style directory (p. 479). The style sheets in c8_location/webcontent/skins/windows/pat and c8_location/webcontent/skins/windows/hal must not be changed. Component-specific graphics are located in the images subdirectories of these directories. The following table describes the contents for theReport Studio style sheets.
File
style/pat/skin.css
Contents
Defines the default interface style for Report Studio, including a section that globally sets the font Defines the default interface styles for menus and toolbars Defines a style that applies the users chosen Microsoft Windows display settings to the Report Studio interface
style/hal/hal_style_skin.css windows/pat/skin.css
File
branding/rs_splash.gif
Contents
The splash screen image specifically used for Report Studio, which appears in a frame, with a progress bar below it The Welcome page banner image specifically used for Report Studio The About box graphic The banner image The animated progress image
branding/rs_welcome.gif
File
QSReport.css
Contents
Defines context menu styles for Query Studio. Uses points to reference font sizes. Defines report styles for Query Studio, such as the appearances of selected columns, columns that are cut, or columns that have the pointer paused over them. Defines styles for the Query Studio and Cognos Viewer interfaces, including the application title area, left pane menu, toolbar, metadata tree, preview pane, and navigation links.
QSSelection.css
QSRVCommonUI.css
488
File
QSRVDialog.css
Contents
Defines styles for the Query Studio and Cognos Viewer dialog boxes. This file is used only to avoid having to include large .css files for every dialog box.
File
branding/about.gif branding/banner_cogsquare.gif branding/progress.gif
Contents
The About box graphic The banner image The animated progress image
Tip: You can specify separators between toolbar buttons or groups of toolbar buttons by inserting a <separator/> tag between buttons. 4. Save and close the file. 5. Open the file c8_location/webcontent/qs/cmd.js in a text editor, and add a Javascript function that corresponds to the JavascriptFunction for the new button. 6. Save and close the file. 7. Start the IBM Cognos 8 service.
490
Chapter 31: Customizing the Appearance of IBM Cognos 8 Tip: To change the function called by a toolbar button, add a new Javascript function to the cms.js file and change the JavascriptFunction in the toolbar.xml file to call the new function.
Tip: You can specify separators between menu items or groups of menu items by inserting a <separator/> tag between menuItems. 4. Save and close the file. 5. Open the file c8_location/webcontent/qs/cmd.js in a text editor, and add a Javascript function that corresponds to the JavascriptFunction for the new menu item. 6. Save and close the file. 7. Start the IBM Cognos 8 service. Tip: To change the function called by a menu item, add a new Javascript function to thecms.js file and change the JavascriptFunction in the menu.xml file to call the new function.
Chapter 31: Customizing the Appearance of IBM Cognos 8 2. Open the file c8_location/templates/ps/qs/ui.xml in an XML or text editor. 3. Delete the XML code that corresponds to the menu item you want to remove, beginning with the <menuItem> tag and ending with the </menuItem> tag. 4. Save and close the file. 5. Start the IBM Cognos 8 service.
Tip: You can specify separators between menu items or groups of menu items by inserting a <separator/> tag between menuItems. 4. Save and close the file 5. Start the IBM Cognos 8 service.
492
Chapter 31: Customizing the Appearance of IBM Cognos 8 change the language of the user interface
File
RVReport.css QSRVCommonUI.css
Contents
Defines report styles for Cognos Viewer. Defines styles for the Query Studio and Cognos Viewer interfaces, including the application title area and navigation links.
Chapter 31: Customizing the Appearance of IBM Cognos 8 8. Go to IBM Cognos Connection. 9. Click My Area , My Preferences.
10. On the General tab, in the Product Language drop-down list, click Greek. 11. Click OK. The Cognos Viewer user interface appears in Greek. However, other components, such as IBM Cognos Connection and the studios, continue using the default product language, which is English. To specify French as the default product language if Greek is used by the Cognos Viewer user interface, add a new product locale mapping using IBM Cognos Configuration. Note: Only languages for which a full translation of the IBM Cognos 8 user interface exists can be specified as the default product languages.
6. Click OK. 7. Save the configuration. When a user opens a report in Cognos Viewer in Greek, the Cognos Viewer user interface also appears in Greek. The user interface of other components, such as IBM Cognos Connection and the studios, appears in French.
494
Note: When you reinstall or upgrade IBM Cognos 8, the changes associated with the custom report templates are not migrated. You may need to redo the above steps (p. 483).
7. Add a new template element as a parent of the report element. 8. Add a name attribute for the template element.
Chapter 31: Customizing the Appearance of IBM Cognos 8 The name you enter appears as the name of the template in the new report dialog box. 9. Save the report specification. Here is an example of the initial part of a report specification created in Report Studio. The portions to delete appear in bold.
<template name="List - corporate"> ... <report xmlns="http://developer.cognos.com/schemas/report/4.0/" expressionLocale="en" template="true"> <queries> <query name="Query1"> <source> <model/> </source> <selection/> </query> </queries> <layouts> <layout> <reportPages> <page class="pg" name="Page1"> <pageBody class="pb"> <contents> <list class="ls" refQuery="Query1"> <style> <CSS value="border-collapse:collapse"/> </style> </list> ................. </report> </template>
496
Steps
1. Open the templates.xml file. This file is located in the c8_location/webcontent/pat/res directory. 2. Copy the XML code for the custom report template into the file. The template element must be a child element of the xmlFragment element. 3. Save and close the file.
Steps
1. Create the icon you want. 2. Copy the image file into the c8_location/webcontent/pat/images directory.
Attribute
idsLabel
Description
Specifies an ID that refers to a Report Studio string resource file, such as reportstudio_en.xml or reportstudio_fr.xml, located in the c8_location/webcontent/pat/res directory, and a label for the template that appears in the new report dialog box. Use this attribute when you want to translate the label into other languages. If you do not wantto translate the label, use the label attribute instead.
Attribute
label
Description
Specifies a label for the template that appears in the new report dialog box. Use this attribute instead of the idsLabel attribute for the custom template when you do not want to translate the label into other languages, which eliminates the need to use the string resource files, such as reportstudio_en.xml or reportstudio_fr.xml, in the c8_location/webcontent/pat/res directory.
icon
Specifies an image file located in the c8_location/webcontent/pat/images directory that is associated with the template. The image appears as an icon in the new report dialog box. Use a previously created image file for the custom report template.
templateName
Steps
1. Open the Resources.xml. This file is located in the c8_location/webcontent/pat/res. 2. Add a new listItem element using one of the following attributes for the custom report template:
label, if you do not want to translate the label into other languages idsLabel, if you want to translate the label into other languages
Ensure that the templateName attribute is the same as specified when creating the report specification for the custom report template. Here is an example of the edited Resources.xml file:
<listView id="New" view="icon" clipLabels="false"> <listItems> <!-- Start custom templates--> <listItem label="List - Corporate" icon="icon_list_corp.gif" templateName=" List - corporate"/> <listItem label="Crosstab - Corporate" icon="icon_crosstab_corp. gif" templateName="Crosstab - Corporate"/> <listItem label="Blank - Corporate" icon="icon_blank_corp.gif" templateName="Blank - Corporate"/> <!-- End custom templates--> <listItem idsLabel="IDS_LBL_NEW_BLANK_REPORT" icon="icon_blank.gif" templateName="Blank"/> <listItem idsLabel="IDS_LBL_NEW_LIST_REPORT" icon="icon_list.gif" templateName="List"/> <listItem idsLabel="IDS_LBL_NEW_CROSSTAB_REPORT" icon="icon_crosstab.gif" templateName="Crosstab"/> <listItem idsLabel="IDS_LBL_NEW_CHART_REPORT" icon="icon_chart.gif" templateName="Chart"/>
498
3. Save and close the file. You must now restart Report Studio for the custom report template to appear in the new report dialog box.
500
For more information about IBM Cognos 8 customizations, see "Customizing the Appearance of IBM Cognos 8" (p. 479).
Chapter 32: Customizing the Functionality of IBM Cognos 8 If the automatic upgrade is not successful, the system.xml file is not upgraded successfully and a message is generated in the server log. You can perform the upgrade manually using one of the following files in the c8_location/templates/ps directory: for UNIX, system_upgrade.sh for Windows, system_upgrade.bat
For more information, see the system_upgrade.txt file in the same directory. Note: As a general approach, we recommend that you edit the system.xml files manually using a UTF-8-based XML or text editor. Perform the following steps when IBM Cognos 8 and ReportNet are installed in different locations.
Steps
1. Back up the original IBM Cognos 8 versions and the customized ReportNet versions of the system.xml files. 2. Copy the required system.xml file from the ReportNet installation directory to the corresponding directory in the IBM Cognos 8 installation directory. Copy all system.xml files that require upgrade. The process cannot be repeated for each file separately. For example: copy the system.xml file from the crn_location/templates/ps directory to the c8_location/templates/ps directory. 3. Restart the IBM Cognos 8 service.
502
Some user interface elements are shared by IBM Cognos Connection and Cognos Viewer, for example the top header (m1). If you hide these shared interface elements in IBM Cognos Connection, they are also hidden in Cognos Viewer. For a list of elements you can hide and add, see "User Interface Elements Reference List" (p. 707). Note: It is important to note that there is a difference between hiding a UI element and disabling it. Hiding means that the element will no longer be visible, but that the functionality is still available. Disabling a UI element means that the element is not visible and that the underlying functionality is no longer available.
You can use URL commands to hide the following IBM Cognos Connection headers or sections of a header: the IBM Cognos Connection top header (h1) that includes the title (t1), the Launch menu (m1), and all right-hand side header options. the tab bar (h3) that includes tabs such as Public Folders, My Folders, and custom pages (t3). the IBM Cognos Connection header (h4) that includes the navigation path (t4), and the toolbar menu (m4).
504
Chapter 32: Customizing the Functionality of IBM Cognos 8 3. To turn off the Cognos Viewer toolbar, type: cv.toolbar=false To turn off the Cognos Viewer header, type: cv.header=false The hidden UI remains hidden for the rest of the user request.
For example, the following XML code hides the entire IBM Cognos Connection header and the New Job button in the toolbar:
<param name="ui_hide"> <CC_HEADER/> <CC_TOOLBAR_BUTTONS_newjobDefinition/> </param>
For information about all the user interface elements that you can hide, see "Elements You Can Hide" (p. 707). Ensure that you match the case of each user interface element you want to hide. 4. Specify one or more groups or roles you want to view the hidden element by adding their IDs as values of the show attribute. Use the group or role IDs as documented in the topic "Reference the Required Groups or Roles in the system.xml File " (p. 507). Separate IDs using spaces. Here is an example:
<param name="ui_hide"> <CRN_HEADER show="Administrators g1 g2 RSUsers"/> </param>
5. Repeat steps 3 to 4 for each element that you want to hide. 6. Save the file.
Chapter 32: Customizing the Functionality of IBM Cognos 8 7. Start the IBM Cognos 8 service. Tip: There can be only one <param name="ui_hide"> element in system.xml. Therefore, all items you want to hide must be placed inside this element.
Steps
1. Stop the IBM Cognos 8 service. 2. Open the c8_location/templates/ps/portal/system.xml file in an XML or text editor. 3. Use the following syntax in the <system> element to add a user interface element:
<param name="ui_add"> <!--list of user interface elements--> </param>
For example, the following XML code adds an option to start a Google search in a new browser window.
<param name="ui_add"> <CRN_HEADER_OPTIONS> <item> <url>http://www.google.com</url> <target>_blank</target> <label xml:lang="en">Google</label> <tooltip xml:lang="en">Google</tooltip> <label xml:lang="fr">Google</label> <tooltip xml:lang="fr">Google</tooltip> <label xml:lang="de">Google</label> <tooltip xml:lang="de">Google</tooltip> <label xml:lang="ja">Google</label> <tooltip xml:lang="ja">Google</tooltip> <icon>action_search.gif</icon> </item> </CRN_HEADER_OPTIONS> </param>
For information about all the user interface elements that you can add, see "Elements You Can Add" (p. 714). Ensure that you match the case of each user interface element you want to add. 4. Specify one or more groups or roles you want to view the new interface element by adding their IDs as values of the show attribute.
506
Chapter 32: Customizing the Functionality of IBM Cognos 8 Use the IDs as documented in the topic "Reference the Required Groups or Roles in the system.xml File " (p. 507). Separate IDs using spaces. Here is an example:
<param name="ui_add"> <CC_VIEW_TOOLS> <item show="Administrators RSUsers g1 g2"> <url>http://my_server_url/myApplication</url> <target>_blank</target> <label xml:lang="en">My_label in English</label> <label xml:lang="fr">My_label in French</label> <label xml:lang="de">My_label in German</label> <label xml:lang="ja">My_label in Japanese</label> </item> </CC_VIEW_TOOLS> </param>
5. Save the file. 6. Restart the IBM Cognos 8 service. Tip: There can be only one <param name="ui_add"> element in system.xml. Therefore, all items you want to add must be placed inside this element.
User
Anonymous
ID
Anonymous
Description
Users who can access IBM Cognos 8 without being prompted for authentication Users who have the administration capability All authenticated users, which includes Administrators, Query Studio Users, and Report Studio Users
Administrators Consumers
Administrators Consumers
User
Query Studio Users Report Studio Users
ID
QSUsers RSUsers
Description
Users who have the Query Studio capability Users who have the Report Studio capability
Steps
1. Stop the IBM Cognos 8 service. 2. Open the c8_location/templates/ps/portal/system.xml file in an XML or text editor. 3. Add a parameter named ui_groups and then do the following: Add the group element for each group or role you want. Specify a unique id attribute for each group or role. The IDs are case sensitive. For the custom groups or roles, the IDs cannot contain more than two characters, and cannot contain spaces. For example, the following IDs can be used: a1, b2, Ab, AB. The following IDs cannot be used: abc, A 1, a bc. For the IBM Cognos 8 predefined groups, use the associated IDs as documented the table above. Specify a value for the id attribute for each group element. Tip: To find the ID in IBM Cognos Connection, open the group or role properties page and, on the General tab, click the View the search path, ID and URL link. The following example shows the syntax of the ui_groups parameter.
<param name="ui_groups"> <group id="g1">xOm5ldyBncm91cHM6dWlHMV9lbg_</group> <group id="g2">xOm5ldyBncm91cHM6dWlfUjI_</group> <group id="55">xOf5ldyBnc4htcHM6dAlfUjI_</group> </param>
Steps
1. Stop the IBM Cognos 8 service. 2. Open the c8_location/templates/ps/portal/system.xml file in an XML or text editor. 508
Chapter 32: Customizing the Functionality of IBM Cognos 8 3. Add the following parameter:
<param name="disableURLObjectCreation">true</param>
4. Save the system.xml file. 5. Restart the IBM Cognos 8 service. The new URL toolbar button is removed, the URL field on the object creation wizard is disabled, and all URL object creation requests on the server handler will be ignored.
Limit the Number of Entries That Users Can Cut, Copy, and Paste
You can limit the number of entries that users can cut, copy, and paste to improve the performance of IBM Cognos 8. This allows you to control the storage space taken up by temporary entries and reduce the time required to execute cut, copy, and paste requests. For example, you can set the limit to 50 entries. If users cut, copy, or paste more than 50 entries, they receive a maximum entries message. For more information about other tasks you can perform to improve the performance of IBM Cognos 8, see "Tune Server Performance" (p. 127). To change the limit, you must have access to the computer where the report server is installed.
Steps
1. On each computer where IBM Cognos 8 is installed, open the c8_location/templates/ps/portal/ system.xml file in an editor. Ensure that your editor supports saving files in UTF-8 format. 2. Find and edit the maxEditEntries parameter as follows:
<param name="maxEditEntries"> 50 </param>
3. Save the system.xml file. 4. Stop and then restart the IBM Cognos 8 service. For more information about stopping IBM Cognos 8, see the Installation and Configuration Guide.
Remove an Action
To remove an action for a class of objects, such as reports, in the IBM Cognos Connection user interface, you must modify the system.xml file. When you remove an action, users no longer have access to it.
Steps
1. Stop the IBM Cognos 8 service. 2. Open the c8_location/templates/ps/portal/system.xml file in an XML or text editor. 3. Locate the following XML code that describes the actions for the objects in IBM Cognos Connection:
<param name="base-object-actions"> <actions> ... </actions> </param>
4. Remove the action For example, the following XML code describes the actions for reports:
<param name="base-object-actions"> <actions> ... <object class="report"> ... <action name="run_options"/> ... </object> ... </actions> </param>
The run options action is no longer available in IBM Cognos Connection for reports. 5. Save the file. 6. Start the IBM Cognos 8 service.
Steps
1. Stop the IBM Cognos 8 service. 2. Open the c8_location/templates/ps/portal/system.xml file in an XML or text editor.
510
Chapter 32: Customizing the Functionality of IBM Cognos 8 3. Locate the following XML code that describes the actions for the objects in IBM Cognos Connection:
<param name="base-object-actions"> <actions> ... </actions> </param>
4. Add the following line of XML code to the actions for the class of objects:
<action name="shortcut" visible="main"/>
For example, the following XML code includes a shortcut action in the actions for folders:
<param name="base-object-actions"> <actions> ... <object class="folder"> <action name="shortcut" visible="main"/> </object> ... </actions> </param>
In the IBM Cognos Connection main view, custom action icons appear to the left of the More link. In the Perform an action dialog box, custom actions appear under the IBM Cognos-specified actions.
Steps
1. Stop the IBM Cognos 8 service. 2. Open the c8_location/templates/ps/portal/system.xml file in an XML or text editor. 3. Locate the following XML code that describes the actions for the objects in IBM Cognos Connection: Administration and Security Guide 511
4. Use the following syntax to add a custom action as a child of the <object> element for the class of object you want to associate the custom action with. The <object> elements are children of the <actions> element. Note that an English tooltip and label are required.
<action name="name" type="custom"> <icon> icon to show for this element </icon> <url> http-encoded URL to execute </url> <label xml:lang="en"> link text </label> <tooltip xml:lang="en"> tooltip text </tooltip> <label xml:lang="language"> link text </label> <tooltip xml:lang="language"> tooltip text </tooltip> <objProperties encode="encoding"> <property> property to be passed to application </property> </objProperties> </action>
For example, the following XML code defines a custom action for a report object that launches an ASP application named myapp. The defaultName and searchPath properties of the report are passed to the application.
<param name="base-object-actions"> <actions> ... <object class="report"> ... <action name="showPath" type="custom"> <icon> action_myaction.gif </icon> <url> /myapp.asp</url> <label xml:lang="en"> View the search path </label> <tooltip xml:lang="en"> View the search path </tooltip> <label xml:lang="fr"> Afficher le chemin d'accs </label> <tooltip xml:lang="fr"> Afficher le chemin d'accs </tooltip> <objProperties encode="shift_jis"> <property>
512
Considerations
Specifying a root folder other than the root content folder does not restrict administrative functions such as schedule management. Restricting content browsing by specifying a new root folder is not a means of enforcing security. Folder access must be controlled using the IBM Cognos 8 security model.
Chapter 32: Customizing the Functionality of IBM Cognos 8 &m_root=url-encoded search path For example, if you want to restrict browsing to the Go Sales package, while hiding the tab bar, toolbar and standard IBM Cognos 8 header options, type the following: &m_root=%2Fcontent%2Fpackage%5B%40name%3DGO%20Sales%5D&ui=m1h3m4.
For example, typing the following sets the root folder to a folder named Folder1 in the package named Pack1.
<param name="consumer-root"> /content/package[@name='Pack1']/folder[@name='Folder1']</param>
514
If you want to change the background color, modify the welcomeToolPanel parameter in the default.css file associated with the style you are using. For more information, see "Example - Customize the Default Welcome Page" (p. 484).
Steps
1. In a text editor, such as Notepad, type the code for the page using the following parameters in the page URL.
Parameter
basewelcome
Values
yes no
Description
This mandatory parameter renders the default Welcome page that only contains the links. This optional parameter specifies where the links appear in the custom Welcome page. Do not include this parameter if you want the links to appear in the same frame.
wtarget
For example, if you want to create a custom Welcome page with only one iFrame that uses the links-only page, the source code for the page could be as follows:
<html> <head></head> <body> <iframe width="100%" height="100%" src="http://localhost/cognos8/cgi-bin/cognos.cgi?b_ action=cognosViewer&m=portal/welcome/welcome.xts&basewelcome=yes&wtarget=top"/ > </body> </html>
Chapter 32: Customizing the Functionality of IBM Cognos 8 2. Save the file.
For more information about setting up virtual directories, see the Installation and Configuration Guide.
516
Chapter 32: Customizing the Functionality of IBM Cognos 8 For example, if the product language is English and the style is Corporate, the welcomeURLOverride parameter is as follows:
<param name= "welcomeURLOverride">/cognos8/my_welcome/%LOCLAE%/%STYLE%/customwel.htm <param>
When the URL is processed, the %LOCALE% parameter is replaced with en, and the %STYLE% parameter is replaced with Corporate. The URL for this example is as follows:
/cognos8/my_welcome/en/Corporate/customwel.htm
If the product locale were set to French and the style to Classic, the URL would be as follows:
/cognos8/my_welcome/fr/Classic/customwel.htm
Steps
1. From the c8_location/templates/ps/portal directory, open the system.xml file. 2. Add the welcomeURLOverride parameter to the file, where customwel.htm is the custom Welcome page. If you use a relative path, the syntax is:
<param name="welcomeURLOverride">/cognos8/customwel.htm </param>
If your Welcome page supports different locales and styles and you use a relative path, the syntax is:
<param name="welcomeURLOverride">/cognos8/my_welcome/%LOCALE%/%STYLE%/ customwel.htm <param>
3. Save and close the system.xml file. 4. Refresh IBM Cognos Connection.
Customize Report Output Formats in IBM Cognos Connection and Cognos Viewer
You can specify which formats are available for users to view their reports. For example, you may want to prevent users from exporting reports in Excel. The report formats available to a user appear in the user preferences (p. 260). The report formats are controlled by the format element of the reportFormats parameter in the system.xml file located in the c8_location/templates/ps directory. The format element has the following attributes:
Attribute
id
Value
Report output formats. For example, HTML or PDF
Description
Specifies the supported report format. This attribute cannot be modified.
Attribute
browserHide
Value
ie safari moz other
Description
Excludes Web browsers in which the report format should be hidden from users. You can modify this attribute.
downloadable
true false
appMode
Specifies the IBM Cognos 8 functions where the report format must be supporadv - advanced run options and ted. scheduling You can modify this attribute. rv - report viewing options
extension
Optional attribute that specifies the file extension of the output format. It is used to control download functionality. Optional attribute that specifies the MIME type. It is used to control download functionality. Specifies the IBM Cognos Application Firewall settings. This attribute cannot be modified.
mime
cafaction
true false
Note: Because the format element settings can be used to control access to output formats, this setting can affect how reports that were saved previously are accessed. For example, if a report is saved in PDF format, users cannot view the saved report if the administrator chooses to make the PDF format unavailable. The following example shows how to remove CSV format from the list of available format options, for example, when setting personal preferences or scheduling reports, while still allowing users access to saved CSV output in the portal.
<format id="CSV" browserHide="" downloadable="true" appMode="" extension="csv"/>
The following example shows how to hide the report output completely.
<!--<format id="CSV" browserHide="" downloadable="true" appMode="" extension="csv"/> -->
Steps
1. Open the system.xml file in the c8_location/templates/ps directory. 518
Chapter 32: Customizing the Functionality of IBM Cognos 8 2. In the following code, remove or comment out the format element associated with the report format you want to disable.
<param name="reportFormats"> <!-- Comments --> <format id="HTML" browserHide="" downloadable="false" appMode="basic adv rv"/> <format id="XHTML" browserHide="" downloadable="false" appMode="adv"/> <format id="HTMLFragment" browserHide="" downloadable="false" appMode="adv"/> <format id="PDF" browserHide="" downloadable="true" appMode="basic adv rv" extension="pdf"/> --> <format id="spreadsheetML" browserHide="safari" downloadable="true" appMode="basic adv rv" extension="xlsx"/> <format id="XLWA" browserHide="safari" downloadable="true" appMode="basic adv rv" extension="xls" mime="application/vnd.ms-excel"/> <format id="singleXLS" browserHide="safari" downloadable="true" appMode="basic adv rv" extension="xls"/> <format id="XLS" browserHide="safari moz other" downloadable="false" appMode="basic adv rv" cafaction="true"/> <format id="CSV" browserHide="" downloadable="true" appMode="basic adv rv" extension="csv"/> <format id="XML" browserHide="" downloadable="true" appMode="basic adv rv" extension="xml"/> </param>
The following example shows how to disable support for the CSV format for advanced run options and scheduling by deleting the adv attribute:
<format id="CSV" browserHide="" downloadable="true" appMode="basic rv"/>
3. Save the system.xml file. 4. Restart the IBM Cognos 8 service. Note that the configuration settings you specify in the system.xml file apply only to the presentation services which includes the portal, portal administration, and Cognos Viewer. The settings do not apply to the report server.
Steps
1. Using IBM Cognos Configuration, stop IBM Cognos 8. 2. Rename the c8_location\templates\ps\async\system.xml.sample file to system.xml. Tip: To restore the regular mode, rename the c8_location\templates\ps\async\system.xml file to system.xml.sample. 3. Using IBM Cognos Configuration, start IBM Cognos 8.
Data format
Date
Examples
19/12/03 December 19, 2003
XML code
formatList name = qsdates
Time
11:05 PM 23:05
Time interval
Negative numbers
-29 (29)
520
Data format
Decimal character
Examples
1.23 1,23
XML code
formatList name = rsnumberinput
By modifying the cogformat.xml file, you can change the order in which data formats are presented in Query Studio. You can also change the text string that appears in Query Studio or delete a data format. If the data formats that you prefer are not available in Query Studio, you can add them to the file. Note: If you upgrade to a new version of IBM Cognos 8, your changes to the cogformat.xml file are not reflected in the new version of the file. Make a copy of the file before the upgrade, then replace the new version with your changed version.
Steps
1. Make a backup of the c8_location/configuration/cogformat.xml file. 2. Stop the IBM Cognos 8 service. 3. Open the cogformat.xml file in an XML or text editor. 4. Make your changes as required: "Change the Order of Data Formats" (p. 521) "Change the Text Strings" (p. 522) "Remove Data Formats" (p. 523) "Add a Data Format to a Locale" (p. 524) "Add Data Formats for a New Locale" (p. 525)
5. Save the file. 6. Test the file. 7. Restart the IBM Cognos 8 service. The changes that you made to the cogformat.xml file are implemented.
Chapter 32: Customizing the Functionality of IBM Cognos 8 December 19, 2003 Friday, December 19, 2003
If your users are most likely to choose the last date format, you might want it to appear first on the list of dates.
Steps
1. In the cogformat.xml file, locate the data format for the locale that you want to modify. For example, the following XML code defines the order of date formats for the en-CA (English Canadian) locale:
... <formatList name="qsdates" xml:lang="en-CA"> <dateFormat dateStyle="short">19/12/03</dateFormat> <dateFormat dateStyle="medium">19-Dec-03</dateFormat> <dateFormat dateStyle="long">December 19, 2003</dateFormat> <dateFormat dateStyle="full">Friday, December 19, 2003</dateFormat> </formatList> ...
2. To change the order in which data formats appear in Query Studio, rearrange the order of the code. For example, to have Friday, December 19, 2003 appear as the first date format, change the XML code as follows:
... <formatList name="qsdates" xml:lang="en-CA"> <dateFormat dateStyle="full">Friday, December 19, 2003</dateFormat> <dateFormat dateStyle="short">19/12/03</dateFormat> <dateFormat dateStyle="medium">19-Dec-03</dateFormat> <dateFormat dateStyle="long">December 19, 2003</dateFormat> </formatList> ...
The dates are now presented in the following order in Query Studio: Friday, December 19, 2003 19/12/03 19-Dec-03 December 19, 2003
522
Chapter 32: Customizing the Functionality of IBM Cognos 8 If your organization uses the standard date format "19/12/03," you can change the text that appears in Query Studio to "Corporate Standard (19/12/03)".
Steps
1. In the cogformat.xml file, locate the date format for the locale you want to modify. For example, the following XML code defines the text strings for date formats for the en-CA (English Canadian) locale:
... <formatList name="qsdates" xml:lang="en-CA"> <dateFormat dateStyle="short">19/12/03</dateFormat> <dateFormat dateStyle="medium">19-Dec-03</dateFormat> <dateFormat dateStyle="long">December 19, 2003</dateFormat> <dateFormat dateStyle="full">Friday, December 19, 2003</dateFormat> </formatList> ...
2. To change the text string for a data format, edit it in the XML code. For example, change the text string for that format as follows:
<dateFormat dateStyle="short">Corporate Standard (19/12/03)</dateFormat>
The dates now appear as follows: Corporate Standard (19/12/03) 19-Dec-03 December 19, 2003 Friday, December 19, 2003
Steps
1. In the cogformat.xml file, locate the data format for the locale that you want to modify. For example, the following XML code defines time interval formats for the en-CA (English Canadian) locale:
... <formatList name="qsintervals" xml:lang="en-ca"> <intervalFormat units="days">2 days</intervalFormat> <intervalFormat>1 day 23 hours 45 minutes 12 seconds 345 milliseconds</ intervalFormat> <intervalFormat units="time" showSeconds="false">1 23:45</intervalFormat> <intervalFormat units="time" showMilliseconds="false">1 23:45:12</ intervalFormat> </formatList> ...
2. To remove an interval format, remove the associated XML code line. For example, to remove milliseconds as an available interval format, remove the following line: Administration and Security Guide 523
Note: For information on removing a locale, see the Installation and Configuration Guide.
Valid Syntax
You must use valid syntax when adding a data format. You can use Report Studio to show you the XML code that you need for a data format. In Report Studio, create a list report that contains the data that you want. Then, select the column and change the Data Format settings in the Report Studio Properties pane to get the format you want. Its a good idea to run the report to make sure the data format looks the way you want it to. Select View XML and use the same code syntax in the cogformat.xml file. (For an XML file that you can copy and paste from, follow instructions to Open and Save a Report Locally.) For example, if you want to add a data format for date, create a report that contains a date column. Change the format of the date. Use the appropriate XML code syntax in the cogformat.xml file. Your syntax might look similar to the bold code shown below:
<formatList name="qsdates" xml:lang="en-CA"> <dateFormat dateStyle="short" datesSeparator="." </dateFormat> <dateFormat dateStyle="full">Friday, December 19, 2003</dateFormat> <dateFormat dateStyle="short">19/12/03</dateFormat> <dateFormat dateStyle="medium">19-Dec-03</dateFormat> <dateFormat dateStyle="long">December 19, 2003</dateFormat> </formatList>
Steps
1. In the cogformat.xml file, locate the data format for the locale that you want to modify. For example, the following XML code defines time formats for the en-CA (English Canadian) locale:
... <formatList name="qstimes" xml:lang="en-ca"> <timeFormat timeStyle="short">1:30 PM</timeFormat> <timeFormat timeStyle="medium">1:30:55 PM</timeFormat> <timeFormat timeStyle="long">1:30:55 EST PM</timeFormat> <timeFormat timeStyle="full">1:30:55 o'clock PM EST</timeFormat> </formatList>...
2. To add another time format, add another XML code line. For example, to add the time format "1:30 EST PM," add the following line:
<timeFormat timeStyle="long" showSeconds="false">1:30 EST PM</timeFormat>
3. Insert the text that you want to appear in Query Studio into the line you copied and pasted. For example:
<dateFormat dateStyle="short" dateSeparator="." show Years="showCentury">19.12.03</dateFormat>
524
Steps
1. Copy and paste a similar block of XML code for each data format type. For example, if you want to add a new locale such as en-xx, copy and paste the XML code that defines time formats for the en-CA (English Canadian) locale:
... <formatList name="qstimes" xml:lang="en-ca"> <timeFormat timeStyle="short">1:30 PM</timeFormat> <timeFormat timeStyle="medium">1:30:55 PM</timeFormat> <timeFormat timeStyle="long">1:30:55 EST PM</timeFormat> <timeFormat timeStyle="full">1:30:55 o'clock PM EST</timeFormat> </formatList>...
2. Change the name of the locale. For example, for the new locale en-xx, change the first line of the copied code to:
<formatList name="qstimes" xml:lang="en-xx">
3. Change the data formats as required, following the instructions in one of the following sections: "Change the Order of Data Formats" (p. 521) "Change the Text Strings" (p. 522) "Remove Data Formats" (p. 523) "Add Data Formats for a New Locale" (p. 525)
4. Make similar changes for the other data format types for the new locale.
Steps
1. Go to the c8_location/configuration directory. 2. Locate the file qrsvpproperties.xml.sample, and rename it to qrsvpproperties.xml. 3. Open the qrsvpproperties.xml file, and in the following code:
<structure> <!-- Default template for reports. --> <!--<property>defaultSystemTemplate</property> --> <!--<value>/content/configuration/reportTemplate[@name='QSdefault']
Un-comment the property and value elements For the value, type the search path of the new template.
Tip: To find the template search path in IBM Cognos Connection, open the template properties page and, on the General tab, click the View the search path, ID and URL link. Following, is an example of the resulting code:
<structure> <!-- Default template for reports. --> <property>defaultSystemTemplate</property> <value>/content/package[@name='GO Sales and Retailers']/folder[@name="Templates "]/reportTemplate[@name='RS template'] </value> </structure>
Steps
1. Start IBM Cognos Connection. 2. In the upper-right corner, click Launch, IBM Cognos Administration. 3. On the Status tab, click System. 4. From the System drop-down menu, click Set properties. 5. Click the Settings tab. 6. Next to Environment, Advanced Settings, click Edit. 7. Enter parameters and values from "CSV Properties and Values" (p. 527), as required. 8. Click OK. After the 30 seconds required for your changes to take effect, your changes are reflected when reports are generated in CSV format.
526
Parameter
RSVP.CSV.ENCODING
Description
The encoding used for CSV output. Enter a supported encoding value (p. 528). LOCALE Encoding is derived from the content locale. The default value is utf-16le.
RSVP.CSV.DELIMITER
The field delimiter character used for CSV output. Enter one of the following: a single character. If you enter more than one character, only the first character is used. TAB (tab) LOCALE Delimiter is derived from the content locale. This is the default vale.
RSVP.CSV.QUALIFIER
The string qualifier used for CSV output. Enter a single character. If you enter more than one character, only the first character is used. The default value is " (quotation mark). If the qualifier appears as part of your data, it is duplicated. For example, if the qualifier is a quotation mark and your data is ab"cd, the CSV output is "ab""cd".
RSVP.CSV.TERMINATOR The line terminator used for CSV output. Enter one of the following a single characters: CR (carriage return) LF (line feed). This is the default value. CRLF (carriage return/line feed) LFCR (line feed/carriage return)
If you enter more than one character, only the first character is used. RSVP.CSV.MIMETYPE The MIME type attributed to the CSV output. The default value is: application/ vnd.ms-excel/
Character set
UTF-8 Western European (ISO 8859-1) Western European (ISO 8859-15) Western European (Windows-1252) Central and Eastern European(ISO 8859-2) Central and Eastern European (Windows-1250) Cyrillic (ISO 8859-5) Cyrillic (Windows-1251) Turkish (ISO 8859-9) Turkish (Windows-1254) Greek (ISO 8859-7) Greek (Windows-1253) Japanese (EUC-JP) Japanese (ISO-2022-JP) Japanese (Shift-JIS) Traditional Chinese (Big5) Simplified Chinese (GB-2312) Korean (EUC-KR) Korean (ISO 2022-KR) Korean (KSC-5601) Thai (Windows-874)
528
Character set
Thai (TIS-620)
Modify Properties for the Batch Report Service and Report Service
You can modify advanced properties for the Batch Report service and the Report service. For example, you can specify that prompt values entered by a user be saved automatically.
Steps
1. Start IBM Cognos Connection. 2. In the upper-right corner, click Launch, IBM Cognos Administration. 3. On the Status tab, click System. 4. From the All Servers drop-down menu, click Services, Batch Report. 5. From the drop-down menu for BatchReportService, click Set properties. 6. Click the Settings tab. 7. For the Environment category, next to Advanced settings, click the Edit link. 8. If it appears, select the Override the settings acquired from the parent entry check box. Otherwise, proceed to the next step. 9. Enter parameters and values from "Batch Report Service and Report Service Properties and Values" (p. 529), as required. 10. Click OK.
Parameter
RSVP.PARAMETERS.SAVE
Description
Specifies that report prompt values entered by a user should be saved automatically. Default: false
Parameter
RSVP.CHARTS.ALTERNATECOLOURS
Description
Specifies that each chart instance assigns colors in palette order, and does not attempt to preserve the color of items from one chart instance to another. Default: false
RSVP.FILE.EXTENSION.XLS
Specifies to use XLS as the file extension on XLS output format email attachments instead of HTML. Default: false
SMTP Rules
Use the <smtpRule> tag to define an SMTP rule and the <smtpError> tag to define the error code for which you are applying a rule. For example:
<smtpRule> <smtpError> <errorCode>502</errorCode> </smtpError> ... <smtpError> <errorCode>550</errorCode> </smtpError> ... </smtpRule>
Note: The priority of rules is determined by the order in which they appear in the XML file. You can define the following types of SMTP errors: transport errors For example, there is no connection to the mail server, the mail server does not exist or is not configured correctly, or the user has no access to the mail server. Use <transport>true</transport> to include this type of error in your rules. recipient errors
530
Chapter 32: Customizing the Functionality of IBM Cognos 8 For example, there are invalid recipients, too many recipients, or no recipients. Use <invalidRecipients>true</invalidRecipients> to include this type of error in your rules. other specified errors Any standard SMTP error code generated by the mail server. Use <errorCode>nnn</errorCode> to include this type of error in your rules. The following actions can be performed for each error type, and are defined as behaviors in the XML file: resend behavior Specifies how many times to resend an email (n) and the resend interval in seconds (x). Use <resends number="n" delaySeconds="x" /> to apply this behavior. Note: To resend an email indefinitely, use <resends number="-1">. keep mail behavior Specifies whether the delivery service should keep the failed email in a separate queue after it has been resent the required number of times and is unsuccessful. The queue is named SMTPBackupQueue. Note: No further action is performed on emails in the backup queue. To add emails from SMTPBackupQueue to the regular SMTPQueue, you must change the queue name in the database table and restart the server. Use <keepMail>true</keepMail> to apply this behavior. fail mail behavior Allows you to customize the email notification that is sent when an email delivery has failed. Use the <failMail> tag to apply this behavior. There are two further optional attributes you can use to specify the email notification subject (<subject>) and recipient (<recipients>). Tip: If you omit these tags, the email notification is sent by default to original recipients list with the subject "Send failed:". To remove all current recipients, use <recipients sendToCurrentRecipients="false">. To send an email notification to the agent owner, use <owner>true</owner> and, if required, use <recipient address="[email protected]"> to specify an email address. default behavior Defines the action to perform when no matching rule is found. Use the <defaultSmtpBehaviour> tag to apply this behavior.
Examples
The first example shows how to set up a rule for the default behavior. Here, the delivery service attempts to resend the undelivered email three times at hourly intervals. If it is unsuccessful, it sends an email notification using the default fail mail behavior.
<defaultSmtpBehaviour> <smtpBehaviour name="default"> <keepMail>false</keepMail> <resends number="3" delaySeconds="3600" /> <failMail /> </smtpBehaviour> </defaultSmtpBehaviour>
The second example shows how to set up a rule for a transport error. Here, the delivery service resends the email indefinitely, at 30 second intervals, until it is successful.
<smtpRule> <smtpError> <transport>true</transport> </smtpError> <smtpBehaviour name="transport"> <keepMail>false</keepMail> <resends number="-1" delaySeconds="30" /> </smtpBehaviour> </smtpRule>
The third example shows how to set up a rule for a recipient error. Here, the email notification is sent to the agent owner using the email address stored in their user ID. The original email recipients are removed from the recipient list.
<smtpRule> <smtpError> <invalidRecipients>true</invalidRecipients> </smtpError> <smtpBehaviour name="invalidRecips"> <keepMail>false</keepMail> <failMail> <recipients sendToCurrentRecipients="false"> <owner>true</owner> </recipients> </failMail> </smtpBehaviour> </smtpRule>
The fourth example shows how to set up a rule for a specified error code. Here, the undelivered email is sent to the backup queue whenever error 550 occurs. It remains there until you process it manually. A customized email subject is set up for the fail mail notification.
<smtpRule> <smtpError> <errorCode>550</errorCode> </smtpError> <smtpBehaviour name="specialErrorCode-550"> <keepMail>true</keepMail> <failMail> <subject>Error code 550 keep mail</subject> </failMail>
532
Steps
1. Copy the c8_location\configuration\smtpRules-sample.xml file to the c8_location\webapps\ p2pd\WEB-INF\classes folder. Note: To use your own file rather than a copy of the sample file, copy it to the same folder. 2. If you are using the sample file, rename the copied file to smtpRules-custom.xml. 3. Open the required file in an XML or text editor. 4. Amend the file to customize the rules. 5. Start IBM Cognos Connection. 6. In the upper-right corner, click Launch, IBM Cognos Administration. 7. On the Status tab, click System. 8. From the All Servers drop-down menu, click Services, Delivery. 9. From the drop-down menu next to DeliveryService, click Set properties. 10. Click the Settings tab. 11. Next to Environment, click Edit. 12. In the Parameter column, type the parameter name smtp.rules.properties.location. 13. In the Value column, type the name of the customized xml file you are using. 14. In the Parameter column, type the parameter name smtp.rules.properties.reread. Although not mandatory, it is useful to set this parameter for testing purposes so that the SMTP rules are read for every request. 15. In the Value column, type true. 16. Click OK. 17. In the Set properties page, click OK. When you have finished testing the rules, you must reset the smtp.rules.properties.reread parameter. 18. Repeat steps 5 to 11 to access the advanced settings. 19. In the Value column for the smtp.rules.properties.reread parameter, type false. 20. Click OK.
Steps
1. Stop the IBM Cognos 8 service. 2. Open the c8_location/templates/ps/portal/system.xml file in an XML or text editor. For pages and dashboards, open the c8_location/templates/ps/system.xml file. 3. Add the following XML code to the <system> element:
<param name="ui_hide"> <CC_RUN_OPTIONS_email_attachment/> </param>
If you hide other user interface elements by modifying the system.xml file (p. 505), the <param
name="ui_hide"> element already exists. In this case, add the following to the element: <CC_RUN_OPTIONS_email_attachment/>
Steps
1. Start IBM Cognos Connection. 2. In the upper-right corner, click Launch, IBM Cognos Administration. 3. On the Status tab, click System. 4. From the All Servers drop-down menu, click Services, Delivery. 5. For the drop-down menu next to DeliveryService, click Set properties. 6. Click the Settings tab. 7. Next to Environment, click Edit. 8. Select the Override the settings acquired from the parent entry check box. 9. In the Parameter column, type the parameter name lotus.compatibility.mode. 10. In the Value column, type true.
534
Chapter 32: Customizing the Functionality of IBM Cognos 8 11. Click OK. 12. In the Set properties page, click OK. Chart reports are converted to .jpg files and appear properly in Lotus Notes.
Steps
1. Stop the IBM Cognos 8 service. 2. Open the c8_location/templates/ps/portal/system.xml file in an XML or text editor. 3. Locate the following XML code in the system element:
<param name="enable-trigger-support"> true </param> <param name="enable-trigger-tab"> true </param>
4. Change the value of both trigger parameters from true to false. The XML code should appear as follows:
<param name="enable-trigger-support"> false </param> <param name="enable-trigger-tab"> false </param>
5. Save the file. 6. Start the IBM Cognos 8 service. The By Trigger tab on the Schedule page no longer appears. Entries that are already scheduled for trigger-based scheduling continue to run, but no further trigger scheduling can occur while support is disabled.
Scripts
Using the Windows script named trigger.bat or the shell script named trigger.sh, you can trigger one or more schedules to run on the server. The script syntax follows where URL is the IBM Cognos 8 server URL, username is a valid username in the specified namespace, password is the password for the username, namespace is the namespace for the username, and triggerlist is a comma separated list of trigger names:
trigger.bat URL [username password namespace] triggerlist
For example, if users want to schedule a report based on a database refresh and want to schedule a second report based on receipt of an email, your custom trigger command line may look similar to this:
trigger.bat http://localhost:9300/p2pd/servlet/dispatch username password namespace databaserefreshtriggername,emailtriggername
Steps
1. If you are setting up a trigger occurrence on a server other than an IBM Cognos 8 server, complete the following tasks: Ensure that the server has a supported version of either a Java Runtime Environment or a Java Development Kit. Copy the following files from c8_location/webapps/p2pd/WEB-INF/lib on an IBM Cognos 8 server to the location on the server where you are setting up the trigger occurrence: activation.jar axis.jar axisCrnpClient.jar commons-discovery.jar commons-logging.jar jaxrpc.jar saaj.jar mail.jar xml-apis.jar xercesImpl.jar Copy the following files from c8_location/webapps/EventTrigger on an IBM Cognos 8 server, to the location on the server where you are setting up the trigger occurrence: trigger.bat trigger.sh trigger.class (a Java utility that can run on any IBM Cognos-supported platform) 2. Ensure that the command line runs when the external occurrence, such as a database refresh or email, occurs.
536
Chapter 32: Customizing the Functionality of IBM Cognos 8 The mechanism that you use to invoke your custom trigger command depends on the application that you are working with, such as a database system or an email application. For information, see the documentation for your application. 3. Inform users that they can now schedule entries based on the trigger occurrence. If a user scheduled an entry based on the occurrence, when the user clicks the schedule button for a report view, occurrence information replaces frequency information on the Schedule page. If a user scheduled an entry based on the occurrence, when the user clicks the schedule button for a report view, occurrence information replaces frequency information on the Schedule page. After the script runs, the trigger method returns an integer value representing the number of schedules that were run. The following integers represent errors: -1 is a usage error, such as invalid parameter or syntax -2 is a communication problem with IBM Cognos 8 server
Steps
1. Stop the IBM Cognos 8 service. 2. Open the system.xml file in a text editor. The file is located in c8_location/templates/ps/portal. 3. Locate the following XML code within the system element:
<param name="enable-history-counts"> true </param>
4. Change the value of the enable-history-counts parameter from true to false. The XML code should appear as follows:
<param name="enable-history-counts"> false </param>
Steps
1. Go to the c8_location/configuration directory. 2. Locate the file named ansproperties.xml.sample, and rename it to ansproperties.xml. 3. Open the ansproperties.xml file, and locate the following code:
<structure> <!-- Enabling the 8.0 Zero Suppression feature will provide compatibility for existing 8.0 customers --> <!-- Enabling the 8.0 feature will disable the new capabilities provided in 8.2 and beyond --> <!-- The default is disabled. 0 == disabled (recommended). 1 == enabled. --> <!--<property>Enable8Dot0Suppression</property> <value type="long">0</value>--> </structure>
4. Remove the comment tags (<!--) and (-->) from the Enable8Dot0Suppression property. 5. Change the value from 0 to 1. 6. Save the ansproperties.xml file. 7. Restart the IBM Cognos 8 server.
538
By learning what troubleshooting resources are available, you are better able to resolve problems while using IBM Cognos 8.
Error Messages
The first indication of a problem is often an error message. Error messages contain information that can be helpful in determining the cause of a problem. You can click the Details link to see the full error message. The administrator can use this information, as well as other information about what product you are using and what you did before the error message appeared, to resolve an issue. If you click OK in response to the error message, IBM Cognos 8 undoes the last action and returns to the previous state.
Log Files
Log files can help you troubleshoot problems by recording the activities that take place when you work with a product. Operations performed in IBM Cognos 8 are recorded in various log files for tracking purposes. For example, if you experienced problems installing IBM Cognos 8, consult the transfer log file to learn what activities the installation wizard performed while transferring files.
Chapter 33: Troubleshooting Resources Before you begin viewing log files, ensure that they contain the information that you need. The number of log files and the information they contain are set by parameters in IBM Cognos Connection and in IBM Cognos Configuration. Use IBM Cognos Administration to learn about logging categories and how to set the level of detail to log for each category. For more information, see the IBM Cognos 8 Administration and Security Guide. Use IBM Cognos Configuration to specify the size, number, and location of log files, and to configure the properties of the log server. For more information, see the IBM Cognos Configuration User Guide. When troubleshooting, the following files can assist you:
540
Steps to Turn Off Core File Creation for IBM Cognos 8.1 MR1
1. On the server where IBM Cognos 8 is installed, open the rsvpproperties.xml file from the c8_location\configuration directory. 2. Change the Win32StructuredExceptionHandling property to 0 (zero) so that it reads
<property>Win32StructuredExceptionHandling</property> <value type="long">0</value>
Steps to Turn Off Core File Creation for IBM Cognos 8.1 MR2 and Later Versions
1. On the server where IBM Cognos 8 is installed, open the cclWin32SEHConfig.xml file from the c8_location\configuration directory. 2. In the configuration element, change the value of the environment variable setting to 0 (zero) so that it reads
<env_var name="CCL_HWE_ABORT" value="0"/>
542
3. To change the file name and path, edit the following line:
<filename>../logs/metricdump.xml</filename>
4. To change the time interval for dumping, in milliseconds, edit the following line:
<interval>15000</interval>
where -1 is unlimited 6. To change the maximum file size before rollover, edit the following line:
<filesize>10000000</filesize>
7. To change the number of metric dump files to keep, edit the following line:
<rollover>1</rollover>
Samples
IBM Cognos 8 uses samples to highlight product features and to help you learn how to use the product. You can also use samples to troubleshoot problems. You can use the samples that come with IBM Cognos 8 to determine if various components are working together as expected. For example, if you are having a problem running a report, you can try running a sample report to see if problem persists. You may discover that the problem is related to connecting to a database. For information about setting up samples, see the IBM Cognos 8 Administration and Security Guide.
544
Steps
1. In Query Studio, open the report that you want. 2. From the Manage File menu, click Report Definition. The Report Properties dialog box appears. It contains a table that lists every filter, report item, and corresponding expression in the report. Tip: Click Query Information to bring up a text box containing information about the query.
Chapter 33: Troubleshooting Resources Tip: You can also use the IBM Cognos diagnostic tools.
Steps
1. Have the following information at hand: your customer identification number your service request number, if it is an ongoing service request the phone number where you can be reached the version of the software you use the version of the operating environment you use a description of what you were doing when the problem occurred the exact wording of any error messages that appear any steps you took to attempt to solve the problem
2. Contact the IBM Cognos Resource Center center nearest you. You are asked whether this is a new or ongoing service request. If it is an ongoing service request, provide your service request number or, if appropriate, your customer identification number. If you dont have support on the software about which you are calling, you will be directed to a support renewal representative.
The diagnostic tools were developed in Java. Each contains a JAR file, a batch file, and a PDF that explains what the diagnostic tool does and the results you can expect. IBM Cognos diagnostic tools are read-only and do not make changes to your environment or to your IBM Cognos products. New diagnostic tools are continually being developed. To check for the most recent updates, as well as for more information about IBM Cognos diagnostic tools, see the IBM Cognos Resource Center Web site (http://www.ibm.com/software/data/support/cognos_crc.html).
546
If you print from an Acrobat 4.0 or later product, you can try the following solution.
Chapter 34: Problems Using Documentation This error occurs if the Netscape browser is not installed on the computer or the browser path is not set correctly. The solution is to either install Netscape if it is not installed, or add a BrowserPath entry to the file cogconfig.prefs. The entry must specify the full path for the browser.
548
Symptoms
Solution
You do not see the splash screen for the IBM Check your Web server configuration. Cognos 8 portal when you start IBM Cognos 8. The service starts but no tables are created in the content store database. The service does not start. Check your content store configuration.
Ensure that you wait a few moments before submitting a request. Check the file permissions and directory names of the application server installation location.
Ensure that you use other software that is supported by IBM Cognos components. You can view an up-to-date list of environments, such as operating systems, patches, browsers, Web servers, directory servers, and database servers on the IBM Cognos Resource Center (http://www.ibm.com/ software/data/support/cognos_crc.html).
CFG-ERR-0106 Error When Starting the IBM Cognos 8 Service in IBM Cognos Configuration
When you start the IBM Cognos 8 service, you may receive the following error message: CFG-ERR-0106 Cognos Configuration received no response from the Cognos 8 service in the allotted time. Check that Cognos 8 service is available and properly configured. There are two possible causes for this problem: The IBM Cognos 8 service needs more time to start. Administration and Security Guide 549
Chapter 35: Installation and Configuration Problems A standby Content Manager computer may be configured incorrectly.
Chapter 35: Installation and Configuration Problems This action starts all installed services that are not running. If you want to start a particular service, select the service node in the Explorer window and then click Start from the Actions menu.
Step
Copy the bcprov-jdknn-nnn.jar file from the c8_location/bin/jre/version/lib/ext directory to the Java_location/jre/lib/ext directory.
Unable to Start the IBM Cognos 8 Service Because the Port is Used by Another Process
You may not be able to start the IBM Cognos 8 service or process if one of the default ports is used by another process. Tip: To view the current network TCP/IP network connections, use the netstat command. Use IBM Cognos Configuration to change the default port that IBM Cognos 8 uses. When you change the port used by the local dispatcher, you must change the value of the Dispatcher URI properties. Because the change affects all the URIs that are based on the local dispatcher, you must change the URIs of all local components. By default, local components contain localhost in the URI. For example, if you install all components on one computer and you want to change the dispatcher port, replace 9300 in all dispatcher and Content Manager URIs with the new port number.
Chapter 35: Installation and Configuration Problems To access the port number for the location of the applications.xml file used by Portal Services, under Environment, click Portal Services. 3. In the Properties window, click the Value box next to the property that you want to change. 4. Change the value from 9300 to the new value. Ensure that you change the ports in all URIs that contain localhost:9300. 5. From the File menu, click Save. 6. From the Action menu, click Start.
If you use a DB2 database for the content store, ensure that the database version and Java version are compatible. For DB2 version 8.2, Java 1.5 is not supported. For DB2 version 9, Java 1.5 is supported on all operating systems except HPUX and Solaris. To review an up-to-date list of environments supported by IBM Cognos products, such as operating systems, patches, browsers, Web servers, directory servers, database servers, and application servers, visit the IBM Cognos Resource Center (http://www.ibm.com/software/data/support/cognos_crc. html).
552
Database
Oracle 9i
Character encoding
AL32UTF8 AL32UTF16
To resolve this problem, you must recreate the content store database using the correct character encoding, or convert the character encoding. For more information, see the database documentation.
Chapter 35: Installation and Configuration Problems CM-SYS-5003 Content Manager is unable to access the content store. Verify your database connection parameters and then contact your database administrator. [IBM][CLI Driver] SQL1013N The database alias name or database name "CM123" could not be found. For Oracle: CM-CFG-5063 A Content Manager configuration error was detected while connecting to the content store. CM-CFG-5036 Content Manager failed to connect to the content store. The connection string is "jdbc:oracle:thin:@localhost:1521:pb1". ORA-01017: invalid username/password; logon denied. For Sybase: CM-CFG-5063 A Content Manager configuration error was detected while connecting to the content store. CM-CFG-5036 Content Manager failed to connect to the content store. The connection string is "jdbc:sybase:Tds:localhost:5000/cm". JZ006: Caught IOException: java.net.ConnectException: Connection refused: connect. If you are using an Oracle database, do not use illegal characters such as an underscore in IBM Cognos Configuration for the Service Name property. If the Service Name includes illegal characters, tables are not created in the content store database when the IBM Cognos 8 service is started.
Chapter 35: Installation and Configuration Problems If you use a Microsoft SQL Server database, type the appropriate values for the Database server with port number or instance name and Database name properties. For a Microsoft SQL Server database, you can choose to use a port number, such as 1433, or a named instance as the value for the Database server with port number or instance name property. To connect to a named instance, you must specify the instance name as a JDBC URL property or a data source property. For example, you can type localhost\instance1. If no instance name property is specified, a connection to the default instance is created. Note that the properties specified for the named instance, along with the user ID and password, and database name, are used to create a JDBC URL. Here is an example: jdbc:JSQLConnect://localhost\\instance1/user=sa/more properties as required If you use a DB2 database, for the Database name property, type the database alias. If you use an Oracle database, type the appropriate values for the Database server and port number and Service name properties. If you use an advanced Oracle database, for the Database specifier property, type the Oracle Net8 keyword-value pair for the connection. Here is an example: (description=(address=(host=myhost)(protocol=tcp)(port=1521)(connect_data=(sid=(orcl))))) If you use a Sybase database, type the appropriate values for the Database server and port number and Database name properties. 7. If you want to change the logon credentials, specify a user ID and password: Click the Value box next to the User ID and password property and then click the edit button when it appears. Type the appropriate values and click OK.
8. From the File menu, click Save. The logon credentials are immediately encrypted. 9. Test the connection between Content Manager and the content store. Tip: In the Explorer window, right-click the new database and click Test. Content Manager connects to the database, checks the database permissions, and creates and populates a table. The table is not deleted and is used each time that the test is repeated.
556
Chapter 35: Installation and Configuration Problems CAM-CRP-1064 Unable to process the PKCS #7 data because of an internal error. Reason: java.lang.IndexOutOfBoundsException.
This issue may occur if you do not have the necessary permissions for the following directories: c8\configuration c8\configuration\csk c8\configuration\encryptkeypair c8\configuration\signkeypair
The solution is to enable the read and execute permissions on the directories listed above for anyone who must start the IBM Cognos 8 service.
No Warning That Installing a Later Version of IBM Cognos 8 Will Automatically Update the Earlier Version of the Content Store
You have a version of ReportNet or IBM Cognos 8 installed on your computer. You install a later version into a new location. You use the same database for the content store for both versions. After you configure the later version and start the IBM Cognos 8 service, the earlier version of ReportNet or IBM Cognos 8 no longer works because all content is automatically upgraded. If you want to use different versions of ReportNet and IBM Cognos 8 after you upgrade, ensure that before you install the later version, you back up the database you use for the content store restore the backup to a new location
Alternatively, you can choose to use the deployment tool to import the entire content store from an earlier version to the later version. All existing content in the content store database is replaced by the imported content. You receive a warning message about this.
IBM Cognos Configuration uses a user ID to bind to the LDAP database. If this user ID is moved to another group, IBM Cognos Configuration can no longer locate it. To correct the problem, move the user ID back to the original group.
To correct the problem, do the following: Start IBM Cognos Configuration on the Content Manager computer. In the Explorer pane, go to Environment, IBM Cognos 8 service. Set the Event management service enabled? property to False.
558
Chapter 35: Installation and Configuration Problems To resolve this issue, install IBM Cognos 8 in the default directory or use a directory name that contains only ASCII Latin-1 characters.
2. If you use the domain userID and password method of authentication, add the user account that starts the IBM Cognos 8 service to the domain that includes Content Manager, the Application Tier Components, IIS Web server, and the data source server (Microsoft SQL Server or Microsoft Analysis Server). 3. If you use an external namespace, such as Active Directory Server, for authentication, add the user account that starts the IBM Cognos 8 service to the domain that includes the authentication provider. This domain must also include Content Manager, the Application Tier Components, IIS Web server, and the data source server (Microsoft SQL Server or Microsoft Analysis Server). For more information about configuring external namespaces for authentication, see the topics about authentication providers in the Installation and Configuration Guide.
You can try opening the same cube with Excel. This will tell you whether the OLAP server is configured and running, and whether the appropriate client software is installed.
The Page Cannot Be Found When Starting IBM Cognos 8 in Windows 2003
After installing IBM Cognos 8 on Windows 2003, the following message may appear when you try to start IBM Cognos 8: The page cannot be found. The page you are looking for might have been removed, had its name changed, or is temporarily unavailable. HTTP Error 404 - File or Directory not found. This error is caused by a security feature in Windows 2003 Internet Information Services (IIS). This security feature does not allow unknown cgi file extensions. To resolve this problem, add a new file extension in IIS for the cognos.cgi file. For more information, see the IIS documentation.
The Page Is Not Shown When Opening a Portal After Installing IBM Cognos 8
After you install and configure IBM Cognos 8, you are unable to connect to the Cognos 8 portal. This may be because the Web server is not properly configured. For example, the virtual directories required for IBM Cognos 8 may not exist or they may point to the wrong physical folders. For information about configuring the Web server, see the Installation and Configuration Guide.
560
Steps
1. From the BouncyCastle Web site, http://www.bouncycastle.org/download/, download a compatible BouncyCastle bcprov .jar file, such as bcprov-jdk14-137.jar. 2. Copy the downloaded .jar file to the WebLogic Java extension directory, WebLogic_location\jdk142_nn\jre\lib\ext. 3. In the WebLogic_location\jdk142_nn\jre\lib\security directory, edit the java.security file and add the following line to the provider list:
security.provider.6=org.bouncycastle.jce.provider.BouncyCastleProvider
562
Alias
cognos8
Path
c8_location\Program Files\ Cognos\c8\webcontent c8_location\Program Files\ Cognos\c8\cgi-bin
Permissions
Read
cognos8\ cgi-bin
Read Execute
Alias
cognos8\help
Path
c8_location\Program Files\ Cognos\c8\webcontent\ documentation
Permissions
Read
Deploying IBM Cognos 8 to an Oracle Application Server or IBM WebSphere Application Server Fails
Deploying IBM Cognos 8 to an Oracle application server or an IBM WebSphere application server may fail with any of the following errors: Browser timeout in administration console Error Message: HTTP 500 Internal Error Error Message: Deployment failed: Base Exception: java.rmi.RemoteException (Oracle) Return to application file selection page (IBM WebSphere)
These errors can occur because the application file that you are trying to deploy is too large. To solve this problem, do the following: If you are using the Build Application Wizard, clear the Include static files from the Webcontent folder check box when you select the application to build.
564
Chapter 35: Installation and Configuration Problems This will reduce the size of the application file. If static content is required, you can manually copy it to the deployed application location after you have successfully deployed IBM Cognos 8 into the application server. If you are deploying the application file manually for an Oracle application server, type the following command: dcmctl deployapplication -f path_and_name_of_ear_file -a application_name -co OC4J_instance_name This command is not supported for Oracle Release 3. For more information about deploying IBM Cognos 8 to an application server, see the Installation and Configuration Guide.
4. Change ="xsd:boolean">true</crn:value> to ="xsd:boolean">false</crn:value>. 5. Restart your dispatcher. 6. Repeat the above steps for every dispatcher in your environment, or copy the cafconfig.xml to each c8_location/configuration directory and restart the dispatchers.
Unable to Deserialize Context Attribute Error When Deploying the p2pd.war File to WebLogic
When you deploy the p2pd.war file to WebLogic, you may see the following error: Error [context]Could not deserialize context attribute java.io.NotSerializableException: com.cognos.logserver.LogService This error does not affect the deployment of the p2pd.war file.
Chapter 35: Installation and Configuration Problems To avoid this problem, add at least one language preference in Internet Explorer.
The differences occurred because the conversion tables that are used for Chinese, Japanese, and Korean were modified to meet global standards. If your report specifications or search filters contain expressions that use constant values, the results may be affected. If you want to use the same conversion table that you used in ReportNet, run the following script in the c8_location/bin directory: On UNIX, type conv_compat.sh On Linux, type conv_compat.sh On Windows, type
566
Accented or Double-Byte Characters May Not Display Correctly When Installing IBM Cognos 8 on Linux
If you are using issetup under a UTF-8 locale, accented or double-byte characters may not display correctly. To resolve this problem when installing in German or French, use a non-UTF-8 locale and then launch issetup to install IBM Cognos 8. To resolve this problem when installing in Japanese, change the encoding setting of X Terminal to Shift-JIS, and then install IBM Cognos 8 using an unattended installation. For more information, see the Installation and Configuration Guide.
RSV-SRV-0066 A soap fault has been returned or RQP-DEF-0114 The user cancelled the request Errors Appear in High User Load Environments
These errors may appear in the C8 cogserver.log if you have a high user load (over 165 users) and interactive reports are running continuously in a distributed installation. To resolve this problem, increasing the async_wait_timeout_ms parameter parameter in webapps/ p2pd/WEB-INF/services/reportservice.xml file. For more information, see the Cognos 8 Installation and Configuration Guide. Also, increase the Queue Time Limit setting to 360. For information, see the IBM Cognos 8 Administration and Security Guide.
Configuration Tool cogconfig.sh Return Values Are Not Compliant with Conventional UNIX Return Values
On UNIX platforms, the configuration tool command cogconfig.sh returns 0 for an unsuccessful execution and 1 for a successful execution. These return values are not compliant with the conventional UNIX return results, where a return value of 0 indicates a successful execution and a nonzero return value indicates an error. The non-compliant behavior will be corrected in a future release. You may be required to make changes to your customer applications and scripts before making use of the new behavior.
When you delete a table, its structural definition and data are deleted permanently from the database. For the metric store, database objects may also be deleted. When you restart the IBM Cognos 8 service, a new set of required database tables are created automatically in the location specified by your configuration settings.
Steps
1. On each computer where Content Manager is located, stop the IBM Cognos 8 service. 2. Go to the appropriate directory: To delete tables from the log database, go to c8_location\configuration\schemas\logging. To delete tables from the content store, go to c8_location\configuration\schemas\content. To delete tables from the notification database, go to c8_location\configuration\schemas\ delivery. To delete tables from the metric store, go to c8_location\configuration\schemas\cmm.
3. Go to the appropriate database directory. 4. Depending on the database and database type, run one of the following scripts in the appropriate database tool to delete the tables.
Database
Content store
Database Type
DB2 Derby Microsoft SQL Server Oracle Sybase
Script Name
dbClean_db2.sql dbClean_derby.sql dbClean_mssqlserver.sql dbClean_oracle.sql dbClean_sybase.sql NC_DROP_DB2.sql
Notification
DB2
568
Database
Database Type
Derby Microsoft SQL Server Oracle Sybase
Script Name
NC_DROP_Derby.sql NC_DROP_MS.sql NC_DROP_ORA.sql NC_DROP_SYBASE.sql LS_dbClean_db2.sql LS_dbClean_derby.sql LS_dbClean_mssql.sql LS_dbClean_oracle.sql LS_dbClean_sybase.sql cmm_uninstall dbalias username password Specify the dbalias only if a database with the same name is already cataloged.
Log
Metric store
DB2
Microsoft SQL
cmm_uninstall metric_store_name database_name Admin_user_name password cmm_uninstalldatabase_name database_user_name password Replace database_name with the name in the tnsnames.ora file that refers to the database SID for Metric Studio
Oracle
570
Chapter 35: Installation and Configuration Problems To resolve this problem, uninstall IBM Cognos 8, remove the c8_location/temp/cam folder, and install IBM Cognos 8 again.
2. Delete the csk, encryptkeypair, and signkeypair directories. 3. In IBM Cognos Configuration, save the configuration and restart the services. 4. Repeat steps 1 to 3 on all computers that have IBM Cognos 8 components installed.
Manually Changing the Installation Directory Name Affects Installations Running Under an Application Server
You installed IBM Cognos 8 using the installation wizard and later renamed the installation directory or manually copied the contents to another directory. When you attempt to run IBM Cognos 8 within an application server, you may have one of the following problems: IBM Cognos 8 does not start. Log directories are empty. Logs contain a linkage error or unsatisfied link error.
When you manually change the installation directory, the information in the IBM Cognos 8 root directory becomes invalid. To resolve the problem, you must either update the IBM Cognos 8 root directory before you create the IBM Cognos 8 application file to deploy to the application server
Chapter 35: Installation and Configuration Problems or you must reinstall IBM Cognos 8 in the original location. If you reinstall IBM Cognos 8, follow the process for upgrading.
Steps
1. In the new or renamed installation directory, open c8_location/webapps/p2pd/WEB-INF/classes/ cogroot.link in a text editor. 2. Replace the path with the new location of the installation directory and save the file. 3. To build the application file to be deployed to the application server, in IBM Cognos Configuration, from the Actions menu, select Build Application Files. 4. If you built and deployed an application file to the application server before updating the cogroot.link file, undo the deployment. 5. Deploy the new application file to the application server. For more information about configuring IBM Cognos 8 for another application server, see the Installation and Configuration Guide.
Unable to Exit a Tab Sequence When Using Keyboard-only Navigation in IBM Cognos Configuration
If you use the Tab key to navigate in IBM Cognos Configuration, you may experience problems exiting a tab sequence. For example, in the Properties window, you can press the Tab key to move from one property to another. However, because IBM Cognos Configuration is a Java application, when you want to close the Properties window, you must press Ctrl+Tab.
572
Chapter 35: Installation and Configuration Problems cannot replace the Cognos namespace. You can recreate it, but you must then recreate your Cognos groups and roles. For more information about creating groups and roles in IBM Cognos Connection, see the Administration and Security Guide.
If you click Regenerate in the error dialog, the IBM Cognos 8 service is stopped and the cryptographic information is regenerated. If you click Exit in the error dialog, you must set the JAVA_HOME environment variable to point to the JRE that you used to save your configuration. On Windows, if you want IBM Cognos 8 components to use the JRE that is installed by default, unset JAVA_HOME or set JAVA_HOME to c8_location/bin/jre. Note: If you want to change from one JRE to another, see the topic on changing the version of JVM that IBM Cognos 8 components use. For more information, see the Installation and Configuration Guide.
Chapter 35: Installation and Configuration Problems This error occurs when IBM Cognos 8 components detect an error in the cogstartup.xml file. This can occur when the cogstartup.xml file is manually edited and there is an error in the changed text. To resolve the problem, replace the cogstartup.xml file with a copy from your backup location.
CM-CFG-029 Error When Trying to Save a Configuration That Specifies a SQL Server Content Store
In IBM Cognos Configuration, you try to save a configuration and the following error message appears in the cogserver.log file: CM-CFG-029 Content Manager is unable to determine whether the content store is initialized. EXECUTE permission is denied on object "sp_tables", database "master", owner "dbo'. This indicates that you do not have the correct permissions to initialize a content store or create a table in the database. The solution is to ensure that the content store user has permissions to use the sp_tables stored procedure in the master database.
Chapter 35: Installation and Configuration Problems To solve this problem, on each distributed computer, start IBM Cognos Configuration and do the following: 1. In the Explorer pane, click Security, IBM Cognos Application Firewall. 2. In the right pane, click in the Value column next to Valid domains or hosts. 3. Click the edit button. 4. Enter the names of all the computers that you are configuring for failover. 5. Save and start the configuration.
As a result, users are prompted for their Active Directory credentials. This problem occurs because the IBM Cognos 8 Active Directory provider uses ADSI protocol and Kerberos delegation for authentication in a single signon environment. When Microsoft Internet Explorer runs on Windows NT, it cannot authenticate to the IIS server using Kerberos delegation. When your system is configured for Windows Integrated Authentication, for the single signon to work with IIS, you must configure IBM Cognos 8 to communicate with the Active Directory server using the LDAP provider. configure the external identity mapping property to read the REMOTE_USER environment variable.
Chapter 35: Installation and Configuration Problems To avoid these errors, add the missing fonts to your Java Runtime Environment by editing the font.properties files. Several font.properties files, which contain standard font environment information, are installed with your Java SDK. You can find these files in the JRE_location/lib directory. For more information, see the Java documentation.
Steps
1. In the c8_location\configuration directory, edit the qfs_config.xml file. 2. Find the following code:
<provider name="DB2OlapODP" libraryName="doodp82" connectionCode="DO"/>
3. Change the library name from doodp82 or doodp81 and save the changes. Hyperion Essbase version 9.3.1 is the default client configuration. If you are installing DB2 OLAP client for either Version 8.1 or 8.2, you must edit the qfs_config.xml file and change the library name for the appropriate client version you are installing.
Steps
1. In the c8_location\configuration directory, edit the qfs_config.xml file. 2. Find the following code:
<provider name="DB2OlapODP" libraryName="essodp93" connectionCode="DO"/>
3. Change the library name from essodp93 to doodp81 or doodp82 and save the changes.
If the privilege is missing, there is no group membership for the authenticated user.
576
Chapter 35: Installation and Configuration Problems To solve this problem, perform the following steps.
Steps
1. From the Start menu, click Settings, Control Panel. 2. Click Administrative Tools, and then double-click Local Security Policy. 3. In the console tree, click Security Settings, Local Policies. 4. Click User Rights Assignment. 5. Add the process identity of IBM Cognos 8 to one of the following policies: Impersonate a client after authentication The default is Administrators, Service. For more information, see http://technet2.microsoft.com/WindowsServer/en/Library/ fe1fb475-4bc8-484b-9828-a096262b54ca1033.mspx Act as part of the operating system The default is Local system. For more information, see http://technet2.microsoft.com/WindowsServer/en/Library/ ec4fd2bf-8f91-4122-8968-2213f96a95dc1033.mspx Both of these privileges give an account the ability to act as another user. The privilege Impersonate a client after authentication is similar to the Act as part of the operating system privilege except that it will only allow a process to impersonate after authentication, whereas the privilege Act as part of the operating system allows a process to impersonate before authentication. For more information, see http://www.microsoft.com/technet/prodtechnol/windowsserver2003/ technologies/security/tkerbdel.mspx
Deploying IBM Cognos 8 to an Oracle Application Server or IBM WebSphere Application Server
You are deploying IBM Cognos 8 to an Oracle application server or an IBM WebSphere application server and you receive the following errors: Browser timeout in administration console Error Message: HTTP 500 Internal Error Error Message: Deployment failed: Base Exception: java.rmi.RemoteException (Oracle) Return to application file selection page (IBM WebSphere)
This error can occur because the application file that you are trying to deploy is too large. To solve this problem, on an Oracle application server, you can deploy the application file manually using the following command:
Chapter 35: Installation and Configuration Problems dcmctl deployapplication -f <path and name of ear file> -a <application name> -co <OC4J instance name> For either IBM WebSphere or Oracle application servers, clear the Include static files from the Webcontent folder option when you use the Build Application Wizard. Not including the static content will reduce the size of the application file. If static content is required, you can manually copy it to the deployed application location after you have successfully deployed IBM Cognos 8 into the application server. For more information about deploying IBM Cognos 8 to an application server, see the Installation and Configuration Guide.
Page Cannot be Found Error Running Reports using IBM Cognos 8 Go! Office
In a Microsoft Office document configured for IBM Cognos 8 Go! Office, you use Run Report but receive a "The page cannot be found" error message. This can occur if the IBM Cognos 8 gateway and dispatcher use "localhost" as the server name values on the IBM Cognos 8 server. To correct this, use the computer name for the gateway and dispatcher host values instead of "localhost".
578
CGI Timeout Error While Connected to IBM Cognos 8 Components Through a Web Browser
When performing operations through your Web browser, you receive the following error message: CGI Timeout, process will be deleted from server. The error occurs when you use Windows Internet Information Services (IIS) as your Web server and the gateway is configured to use CGI. IIS has a default timeout for CGI applications. To resolve this problem, you can configure the gateway to use ISAPI. IIS does not have a default timeout for ISAPI applications. Or, if you want to keep using a CGI gateway, you can increase the CGI timeout in IIS.
Chapter 35: Installation and Configuration Problems javax.servlet.ServletException: [HTTP:101249][ServletContext(id=19023494,name=p2pd,contextpath=/p2pd)]: Servlet class com.cognos.pogo.isolation.ServletWrapperfor servlet cfgss could not be loaded because the requested class was not found in the classpath /host2/bea812/user_projects/ domains/c8/applications/p2pd/WEB-INF/classes.java.lang.ClassNotFoundException: com.cognos.pogo.isolation.ServletWrapper. at weblogic.servlet.internal.ServletStubImpl.prepareServlet (ServletStubImpl.java:799) at weblogic.servlet.internal.WebAppServletContext.preload Servlet(WebAppServletContext.java:3252) To avoid this problem, do not deploy the p2pd application from the WebLogic applications directory. Create the p2pd directory in another location and deploy p2pd from there.
Steps
1. Open IBM Cognos Configuration and configure the Application Tier Components computer. 2. Restart the Content Manager computer. 3. Create a p2pd directory in a location that is accessible by the WebLogic server but is not in the WebLogic applications directory. For example, create a directory named p2pd in the following location: WebLogic_location/user_projects/domain_name 4. Create the p2pd.war file. 5. In the p2pd directory, extract the p2pd.war file to the WebLogic installation using the following command: %JAVA_HOME%/bin/jar xvfm "c8_location/p2pd.war" . 6. Start WebLogic. 7. In the WebLogic Server Console, deploy the p2pd application.
580
Unable to Log On
If IBM Cognos 8 uses an Active Directory Server as the security provider, you may not be able to log on using only your user ID. One of the following errors may appear: Your password has expired. Please change it. The provided credentials are invalid. This problem occurs when the Content Manager service runs under the local system account and runs on a computer that is not part of the Active Directory Server domain.
Chapter 36: Security Problems To log on, you must qualify your user ID using the domain name. For example, when you log on, type domain\user ID If you still cannot log on, contact your IBM Cognos 8 security administrator.
HTTPS DRP-ERR-2068 Error In Log File When No Error is Reported During a Switch to HTTPS
You stopped the services on all computers in a distributed installation and configured the computers to use SSL (HTTPS). You started the services successfully, with no reported errors. However, when you checked the log file, you found an error similar to the following: HTTPS DPR-ERR-2068 The administration request failed. Cannot connect to dispatcher. The error occurred because when you restarted the services, the dispatchers were initializing and could not communicate with each other. During the initialization, a normal administration request could not be processed and a fault was generated. The fault was recognized as an initialization fault and so no error was shown during the startup. However, IBM Cognos Application Firewall does not distinguish between a regular fault and an initialization fault. As a security best practice, all messages are sent to the log file. You can ignore the message in the log file.
Entries Do Not Appear in IBM Cognos Connection for a Member of a Newly Created Group
A user who is a member of a newly created group, which is itself a member of the Query Users group, logs on to IBM Cognos Connection. The user sees that some entries, such as My Folders, are missing. The user name may also be missing from the upper-left corner of the page.
582
Chapter 36: Security Problems The namespace that the user belongs to must have traverse rights to the Query Users group.
Anonymous Access
If IBM Cognos 8 is configured to allow anonymous access, all portlet users are logged on as anonymous.
Multiple Namespaces
If IBM Cognos 8 is configured to use more than one authentication namespace, you must install a separate IBM Cognos 8 gateway and configure it to use the namespace for portal users. You must also change the CPS connection point in the Cognos portlets: For IBM Websphere, change the CPS Endpoint parameter in the portlet application. For SAP EP, change the _cpsserver: CPS Connection Server field in each iView.
Chapter 36: Security Problems A data source was created in the SAP Enterprise Portal, and it refers to the same IBM Cognos 8 URL as in the iViews. The iView generating the error is associated with the IBM Cognos 8 data source in the portal. The user entered valid IBM Cognos 8 credentials in the portal.
These settings are located under user mappings in the personalize portal settings. The user name and password are registered in the namespace used by IBM Cognos 8. The IBM Cognos 8 URL entry point is secured in IBM Cognos 8.
584
Chapter 36: Security Problems This file is located in the c8_location\bin directory. 2. Change the value of the bapiPasswordConv parameter to true, as shown in the following fragment of code:
<bapiAbapDebug value="false"/> <bapiTransCall value="false"/> <bapiCharConv value="true"/> <bapiCmdRecording value="false"/> <bapiCacheReset value="false"/> <bapiCallLocks value="false"/> <bapiSupportCancel value="true"/> <bapiMaxSuspendTime value="200"/> <bapiPasswordConv value="true"/>
3. Save the file. 4. Restart the IBM Cognos 8 service. For more information, see the following SAP Notes: 792850 - Preparing ABAP systems to deal with incompatible passwords 862989 - New password rules as of Web AS ABAP 7.0/NetWeaver 2004
Users Are Repeatedly Prompted for Credentials When Trying to Log On to an SAP Namespace
When users whose user IDs or passwords contain special characters try to log on to an SAP namespace, they are repeatedly prompted for credentials and may not be granted access. This is because SAP BW systems, version 3.5 and older, by default use a non-Unicode code page. Newer SAP systems use a Unicode code page. As a result, the default SAP server code page was modified for the SAP authentication provider to use a Unicode code page, which is SAP CP 4110. To avoid this issue, in IBM Cognos Configuration, modify the default SAP BW Server Code Page parameter for the SAP authentication provider to use a non-Unicode code page, such as SAP CP 1100.
CAM-AAA-0096 Unable to Authenticate User When Using an IBM Cognos Series 7 Namespace
When you try to log on in IBM Cognos 8 using a user account that is deleted from all user classes in Access Manager, you receive the following error message: CAM-AAA-0096 Unable to authenticate because the account can not be accessed. The scenario is as follows: You create a new user in IBM Cognos Series 7 Access Manager and assign them to a user class.
Chapter 36: Security Problems You log on to IBM Cognos 8 as Administrator and assign the same Series7 user to an IBM Cognos 8 role, such as authors. You log off IBM Cognos 8 and log on again as the new Series7 user. In Access Manager, you remove that user from the user class so that the user is not in any user classes. In IBM Cognos 8, when you try to log on as the user, you get the error message.
If you configured an IBM Cognos Series 7 namespace for use with IBM Cognos 8, but a user in that namespace is not a member of at least one Access Manager user class, you cannot log on as that user in IBM Cognos 8. To correct the problem, add the user to at least one user class in Access Manager.
For each ReportNet Content Manager server This computer is part of the Active Directory domain If the process is running as a Local System Account, the Trust computer for delegation attribute is selected
586
Chapter 36: Security Problems If the process is running as a domain User Account, the Account is trusted for delegation attribute is selected.
Steps
1. In SAP R/3, type /ST01 in the command window. 2. Under Trace components, select Authorization check. 3. Select Change trace. 4. In the Options for Trace Analysis Field, under General Restrictions, enter the user name of the IBM Cognos account you are tracing.
Unable to Access IBM Cognos Administration When an NTLM Namespace Is Used and Single Signon Is Enabled
When you are logged into IBM Cognos 8 using an NTLM namespace and single signon is enabled for your system, an IBM Cognos Application Firewall (CAF) error may occur when you try to access IBM Cognos Administration.
Chapter 36: Security Problems To avoid this problem, resolve any possible issues related to the gateway host name. You can either ensure that the gateway host name matches the gateway host or you can add the name of the gateway server to the list of valid domains and hosts.
588
Database vendor
IBM Red Brick Microsoft SQL Server NCR Teradata Type the data source connection, as follows:
Database code
RB SS TD
[^UserID:[^?Password:]];LOCAL;{RBSSTD};DSN=Data_Source[; UID=%s[;PWD=%s]][@ASYNC= {01}][@Connection_Timeout/Reply_Timeout][@COLSEQ=[Collation_Sequence]] The following are examples of connection strings: ^UserID:^?Password:;LOCAL;RB;DSN=DB62SALES;UID=%s;PWD=%s@ASYNC=0 ;LOCAL;SS;DSN=TESTSERVER
To create data source connections to Microsoft SQL Server from UNIX, you must use the DataDirect ODBC driver for SQL Server. For more information, see the Administration and Security Guide.
Cannot Access IBM Cognos Series 7 Reports from IBM Cognos Connection
After modifying IBM Cognos 8 to use an IBM Cognos Series 7 namespace and modifying the system.xml file, the Upfront content is not available in the Public Folder area and the personal content is not available in the My Folder area. The solution is to ensure that the value for the <!-- character encoding used by series7 --> entry uses the series7_character_encoding value. This value can be obtained from the IBM Cognos Series 7 IBM Cognos Configuration Manager. The value can be shown in the Explorer pane by clicking Locale under IBM Cognos Shared.
590
Chapter 37: Report and Server Administration Problems 2. Modify the <!-- Series 7 Integration parameters --> <param name="series7"> <enabled>true</enabled> <!-- character encoding used by series7 --> <encoding>windows-1252</encoding> <!-- host and port to connect to Upfront server --> <host>wottcumarasr2k1</host> <port>8030</port> <!-- Upfront gateway location --> <gateway>/cognos/cgi-bin/upfcgi.exe</gateway> <!-- prefix for IBM Cognos 8 back URLs when linking to series 7 content. (e.g., http://Cognos 8 computer) --> <back-prefix>http://wottcumarasr2k1</back-prefix> </param>
Chapter 37: Report and Server Administration Problems When you create a new database in Oracle, the SID name that is created has no underscore in it. You must use this SID with no underscore as the Service Name in IBM Cognos Configuration.
Not Yet Optimized IBM Cognos PowerCubes May Open Slowly in IBM Cognos 8
If PowerCubes created with previous versions of Transformer take too long to open in the IBM Cognos 8 Web studios, we recommend that you run a command line utility named pcoptimizer, supplied with IBM Cognos 8, to improve run-time performance. This optimization utility is suitable for older PowerCubes when the model no longer exists or the data used to build the PowerCube is
592
Chapter 37: Report and Server Administration Problems no longer available. It is not necessary to run this command line utility for cubes created in Transformer version 8.x.
Steps
1. Back up your target PowerCube, then navigate to the Cognos_8_installation_location/bin directory. 2. On Windows, open a command line window and run PCOptimizer.exe. 3. On UNIX/Linux, enter the following line to run the optimization command line utility:
pcoptimizer [-t] [-v] [-h]cubename
where cubename is the fully qualified PowerCube or time-based partitioned control cube name with the .mdc extension, if the PowerCube resides in the same location as pcoptimizer. Otherwise, cubename is the full path with the .mdc extension. Note: This method only supports metadata extraction. To set up user-configurable drill-through, you must use Transformer. Wildcard character support is not currently available. You must therefore invoke the utility once per PowerCube. If cubename is not provided, the program enters an interactive mode, prompting you for a PowerCube name and accepting keyboard input. The optional parameters are as follows:
-t or test mode; it tests whether the metadata was extracted and loaded into the PowerCube.
The return code indicates the status. 0 if the metadata was extracted and loaded 10 if the metadata was not loaded 20 if an error occurred while accessing the PowerCube
-v or verbose mode; text is output to standard output (stdout), indicating what was done,
including any error messages. If running in interactive mode, -v is assumed. All text is output in English only.
-h for command-line help; if cubename is not provided, it prints the usage and options to
the screen.
594
Chapter 37: Report and Server Administration Problems To access the server administration tool, you must have execute permissions for the Administration secured function.
Tip: If you want to reset a configuration setting to its default value, select its check box and click Reset to parent value. 6. Click OK.
Chapter 37: Report and Server Administration Problems Failed to process the request CPS-WSR-1043 Failed to read the response from target "http://sottcps3:9300/p2pd/servlet/dispatch/ cps2/nav" Stream closed A more detailed description of the error that occurred can be found in the log These messages indicate that there is a problem connecting to the IBM Cognos 8 Server. This problem can be caused by one of the following: The IBM Cognos 8 server is not running or is still initializing. Ensure that the IBM Cognos 8 Server is started properly, and test it by accessing IBM Cognos Connection through a Web browser. The portal server does not have network access to IBM Cognos 8 server. To test connectivity to the IBM Cognos 8 server, use the portal server computer to ping the IBM Cognos 8 server. Use the server name and address that appear in the error message. If the ping is successful, ensure that there is no firewall blocking the port used by Portal Services, which is 9300 by default. The URL for connecting to IBM Cognos 8 is incorrect. For IBM Websphere, locate and modify the CPS Endpoint parameter in each portlet application as required. For SAP EP, locate and modify the _cpsserver: CPS Connection Server field in each iView as required. Java Virtual Machine conflicts exist on the IBM Cognos 8 server. IBM Cognos 8 includes a version of Java Runtime Environment (JRE). Ensure that no other version of the Java Virtual Machine or Java SDK are installed. For information about configuring IBM Cognos 8 to work with Portal Services, see the IBM Cognos 8 Installation and Configuration Guide.
Chapter 37: Report and Server Administration Problems Remove the problematic property from the ALUI 6.1 or 6.5 Global Object Properties Map. Please note that changing the global property settings for one object may affect other objects. Specify any value, for example a space, for the problematic property. The property is not used by Cognos portlets so the value is irrelevant.
The Specify a producer page appears. 3. Click the Web Services for Remote Portlets (WSRP) interfaces option. 4. In the Markup, Service description, Registration, and Portlet Management boxes, type interface://wsrp/cps4/portlets/nav 5. Click Next. 6. In the import portlets wizard, type a name for the portlet group that will contain Safe Mode Viewer. 7. Make sure Cognos Viewer is selected. If you want, you can also select Cognos Navigator and Cognos Search. 8. Click Finish.
603172
598
Steps
1. In SAP R/3, type /SE95 in the command window. 2. Enter an asterisk (*) in the Last Changed By field, to view all notes. 3. Select the type of modification in the Modifications tab.
600
602
Chapter 38: Problems When Using Framework Manager If you are not using a Web server, to use the dispatcher as the gateway, type the following: http[s]://host:port/p2pd/servlet/dispatch 4. If required, change the host name portion of the Gateway URI from localhost to either the IP address of the computer or the computer name. 5. From the File menu, click Save. 6. From the Actions menu, click Restart.
When you define a type-in SQL query subject, an error appears because of the name assigned for the attribute reference in the structured type. To resolve this problem, you have two options: assign a simple correlation name to the column in the original query subject, such as Select
e.emp_no, e.emp_address..street as "ABC" from emp e
use pass-through notation for the query subject by surrounding the column with double curly brackets ({{ }})
QE-DEF-0259 Error
This error occurs if you use braces { } in the wrong position in an expression. IBM Cognos 8 expects anything between the braces { } to be at the same level as a function. If you have used braces elsewhere in an expression, you will see the following error message: QE-DEF-0259 There was a parsing error You can also use braces to send unique syntax to the data source. For example, your database uses a keyword for a function but this keyword is not used in IBM Cognos 8. IBM Cognos 8 does not validate the syntax you enter between braces. The syntax is simply sent to the data source. The solution is to make sure that braces are not used in the wrong positions. For example, you type the following in an expression:
[ss_ole_both].[authors_lith].[au_id] = [ss_ole_both].[authors_latin].[au_id] { collate Lithuanian_CI_AI}
You see the following error message: QE-DEF-0259 There was a parsing error before or near position: 75, text starting at position: 5 "le_both].[authors_lith].[au_id]=[ss_ole_both].[authors_latin].[au_id]{" Meanwhile the following expression is valid: 604
Steps
1. From the Project menu, click Verify Model. 2. Select the security view that references a level and click Repair.
Exporting a Framework Manager Model to a CWM File Fails With Error MILOG.TXT was not found
Exporting a Framework model to a CWM file fails with error MILOG.TXT was not found when the path contains Japanese characters. Do one of the following to solve this problem: Specify an export path that does not use Japanese characters.
Chapter 38: Problems When Using Framework Manager Change the system default language on your computer to Japanese. You can set the system default language in the Control Panel, under Regional and Language Options -> Advanced. For more information on how to do this, refer to the Windows operating system help.
Difference in SQL for Inner Joins After Upgrading to IBM Cognos 8.3
If you migrated from IBM Cognos 8.1 to IBM Cognos 8.2 or 8.3, there can be differences in the generation of SQL used for the INNER JOIN syntax. You can control the SQL syntax used for inner joins by selecting the Server determined setting for the SQL Join Syntax governor. The SQL generated in IBM Cognos 8.1, IBM Cognos 8.2, and IBM Cognos 8.3 produces the same results. If you are using RDBMS materialization technology which can be implemented using either implicit or explicit syntax, you must ensure that you select the same syntax setting for the SQL Join Syntax governor in your model.
Because any manual edits to the ini settings are overwritten by the next installation, you must manually replicate them on all machines where you installed Cognos 8 or Framework Manager.
nbna
606
Chapter 38: Problems When Using Framework Manager upgrade. The governor settings for the top-level parent model are the settings that are applied when publishing. If you run a script that was created in a previous version of Framework Manager, the script bypasses the upgrade process. Review the governor settings before and after running the script to ensure that the settings are what you want.
579031, 580784
608
BAPI Error Occurs After the Prompt Specification File Edited Manually
In Transformer, you create a prompt specification for a SAP-based package. You edit the prompt specification file, prompt.xml, manually and save your changes. After editing the file, you attempt to generate a PowerCube using the command line options, for example,
cogtr -fpromptspecfilename -n cubename.mdl
but the PowerCube is not generated and you receive a BAPI error. The error is caused by an invalid member unique name (MUN). Because editing the prompt.xml file manually is error prone, we recommend that you do not edit the prompt.xml file manually but create an alternate prompt specification instead.
582131
Steps
1. Open the cs7g.ini file and ensure the database type in the connection string is CT, not CT15. Cs7g.ini is located in the <installation_location>\cognos\c8\CS7Gateways\bin directory.
Chapter 39: Problems When Using Transformer 2. In the [Services] section, include the following:
CTDBA=ctdba, ctdba15
3. Save your changes. 4. Open the cogdmct.ini file and in the [UDA USER OPTIONS] section, specify the following:
Attach=SET QUOTED_IDENTIFIER ON
Cogdmct.ini is located in the <installation_location>\cognos\c8\CS7Gateways\bin directory. 5. Save your changes. 6. Open Transformer and import the data source.
588853
Unable to Use an IQD Created in Framework Manager That Contains an Oracle Stored Procedure
In Transformer, when trying to open an IQD created in Framework Manager that contains an Oracle stored procedure, you may receive a message similar to the following: (TR0118) Transformer can't read the database [datasource] defined in <Lan location>\ <datasource><iqd_name>.iqd. DMS-E_General A general exception has occurred during operation 'execute' The native SQL generated in an IQD created in Framework Manager is wrong. The IQD cannot be used in Transformer. To resolve this problem, execute the stored procedure in Framework Manager and set the Externalize Method to IQD. Create a model query subject from the executed stored procedure, then publish the package and open it in Transformer.
610
Whichever strategy you choose, you can then open the .mdl or py?-format model without error.
537305
Framework Manager and Transformer may Display Different Locale Session Parameters for Some Languages
Transformer version 8.x may not return data in the expected locale during test or cube build when the following conditions are encountered: The locale shown in the File/Session information in Transformer is not included in the Framework Manager parameter map for session parameters. The modeler attempts to create a data source in Transformer using a query subject from the package where the locale does not exist.
When this is encountered, the locale of the modelers session parameter does not exist in the Framework Manager parameter map. As a result, the data returned will not be the locale of the Session information shown in Transformer. To avoid this problem, add the locale string that is displayed in the Transformer File/Session information to the Framework Manager parameter list so that Transformer can retrieve the expected data when accessing the data source. However, the model metadata will still be shown in English, or in the Framework Manager design language.
Chapter 39: Problems When Using Transformer This change in functionality does not affect how calculated columns are imported from an IBM Cognos Series 7 model into Transformer version 8.x. Existing calculated columns originally created in IBM Cognos Series 7 will be imported correctly.
Transformer Takes a Long Time to Retrieve Data from an SAP-based Data Source
You are attempting to retrieve data from an SAP-based data source in Transformer with null suppression turned off. The retrieval takes a long time to complete. Ensure that the machine where Transformer is installed has sufficient memory to perform the import. If physical memory is limited, Transformer may perform the operation very slowly. In this situation, you can end the task using Task Manager.
589874
Categories Missing When Creating a Transformer Model Based on an SAP Query Containing a Manually Created SAP Structure
The stream extract interface that reads the fact data doesn't handle certain features of the SAP queries. A manually created structure in the query will look like a dimension when Transformer completes the import from the Framework Manager package, but incomplete data is returned. A dimension added to the SAP query as a characteristic will look like a dimension but no data is returned. If you must use a BEx query with these limitations, consider turning off the stream extract and rely on an MDX query. Note that if the MDX query is large, it may fail.
591834
Steps
1. In the Dimension Map, right-click the lowest level in the ragged unbalanced hierarchy that is marked unique. 2. Click Properties and on the Source tab, click Move. 3. From the Run menu, click Generate Categories. 4. From the Run menu, click Create PowerCubes.
589899
Chapter 39: Problems When Using Transformer this time, the cube build may fail, with Transformer error TR0787 indicating that the cube is being used by another application. To avoid this situation, do one of the following: Do not use the Publish wizard to publish the cube. Wait for the file lock to be released, and then rebuild the cube. Build the cube in a location that is different from the location where the cube is published.
596414
Not Yet Optimized IBM Cognos PowerCubes May Open Slowly in IBM Cognos 8
If PowerCubes created with previous versions of Transformer take too long to open in the IBM Cognos 8 Web studios, we recommend that you run a command line utility named pcoptimizer, supplied with IBM Cognos 8, to improve run-time performance. This optimization utility is suitable for older PowerCubes when the model no longer exists or the data used to build the PowerCube is no longer available. It is not necessary to run this command line utility for cubes created in Transformer version 8.x.
Steps
1. Back up your target PowerCube, then navigate to the Cognos_8_installation_location/bin directory. 2. On Windows, open a command line window and run PCOptimizer.exe. 3. On UNIX/Linux, enter the following line to run the optimization command line utility:
pcoptimizer [-t] [-v] [-h]cubename
where cubename is the fully qualified PowerCube or time-based partitioned control cube name with the .mdc extension, if the PowerCube resides in the same location as pcoptimizer. Otherwise, cubename is the full path with the .mdc extension. Note: This method only supports metadata extraction. To set up user-configurable drill-through, you must use Transformer. Wildcard character support is not currently available. You must therefore invoke the utility once per PowerCube. If cubename is not provided, the program enters an interactive mode, prompting you for a PowerCube name and accepting keyboard input. The optional parameters are as follows:
-t or test mode; it tests whether the metadata was extracted and loaded into the PowerCube.
The return code indicates the status. 0 if the metadata was extracted and loaded Administration and Security Guide 613
Chapter 39: Problems When Using Transformer 10 if the metadata was not loaded 20 if an error occurred while accessing the PowerCube
-v or verbose mode; text is output to standard output (stdout), indicating what was done,
including any error messages. If running in interactive mode, -v is assumed. All text is output in English only.
-h for command-line help; if cubename is not provided, it prints the usage and options to
the screen.
614
In all other calculations of this type, the number of decimals in the resulting value is determined by the number of decimals in the currency value. The following examples illustrate this new behavior: $4.00 / $2.00 = $2.00 $4 / $3.0000 = $1.3333 $4 / $3 = $1.333 $4.0 / $3.00 = $1.333
Chapter 39: Problems When Using Transformer Groups corresponding to missing members may appear or disappear when grouped list reports are pivoted to a crosstab. This happens with set expressions using the filter function, and detail filters on members. Ragged and unbalanced sections of the hierarchy are suppressed when set expressions in that hierarchy are used on an edge. When a crosstab is sectioned or is split into a master-detail report, sections corresponding to missing members become empty.
Some of these behaviors may be corrected in a future release, while others may be codified as supported behavior. To prevent these behaviors, avoid the scenarios above. The following scenarios are believed to be safe: one or more nested level references on an edge, with no modifying expression. a hierarchy reference on only one level of one edge. one or more explicit members or sets of explicit members as siblings on only one level of one edge. summaries of the previous three scenarios.
In all cases, reports based on ragged and unbalanced hierarchies should be tested to confirm that hierarchy gaps are handled correctly.
Unable to Open Sample Model, Great Outdoors Sales.mdl, and Generate Cubes
If your setup information for the Great Outdoors Sales.mdl is incorrect, you will be unable to open the sample model for Transformer, Great Outdoors Sales.mdl, or generate cubes. To avoid this problem set up the Great Outdoors Sales.mdl as follows: 1. Modify the Cs7g.ini to contain [Databases] connections. The Cs7g.ini file is located in the installation_location/c8/cs7Gateways/bin directory. 2. Open ODBC Data Source Administrator and create a new ODBC data source named great_ outdoors_warehouse to connect to the SQL server database, GOSALESDW, which is provided with the sample installation. 3. Connect using a valid User Id and password for SQL Server authentication. 4. Open the model. 616
Data Records that Support External Rollup Measure Data are Not Always Created
When PowerCubes are built, data records that support External Rollup Measure data are not created in certain circumstances. To receive a software update, access the IBM Cognos Resource Center (http://www.ibm.com/ software/data/support/cognos_crc.html). After you apply the update, you can rebuild the PowerCube with the expected results.
579654
618
Nested List Report Containing a Data Item That is Grouped More Than Once Does Not Run After Upgrade
When you upgrade a nested list report that contains a data item that is grouped in both lists, the report does not run and an error such as the following appears: OP-ERR-0199: The query is not supported. The dimensions on the edge are inconsistent. The dataItems from dimension="[Product line]" must be adjacent. This error occurs when the report is run against a dimensional data source and both lists are using the same query. This error does not occur if the report is run against a relational data source. For example, you have a list that contains the grouped items Product line and Product type and a nested list that contains the data items Year, Quarter, and Unit sale price. Year, Quarter, and Product line are grouped items in the nested list. To resolve the issue, delete the data item that is grouped in both lists from the inner list.
620
Chapter 40: Problems Authoring Reports 4. In the Groups pane, select the data item that you want and click the delete button.
Chapter 40: Problems Authoring Reports When using named sets, or sets that cover more than one level of a hierarchy, do not use sets from the same dimension in more than one place in the same report. They should appear on only one level of one edge.
567492
622
Chapter 40: Problems Authoring Reports If you are working with a SSAS 2005 data source, these characters may also appear in summary cells if you use an OR filter in the summary. To avoid this problem, do not use OR filters in summaries.
595858
You may also encounter unexpected results if the default member of a hierarchy is a member that doesn't also exist in all other hierarchies in the dimension, and if you query members from different hierarchies in the same dimension. For example a Report Studio crosstab includes the following (using the Adventure Works cube): Rows: Generate([Adventure_Works].[Account].[Accounts],set([Balance Sheet],[Units])) nested with children([Adventure_Works].[Department].[Departments]->:[YK].[[Department]].[Departments]]. &[1]]]) Column: [Adventure_Works].[Account].[Account Number].[Account Number] Measure: [Adventure_Works].[Measures].[Amount]
You run the report and notice that the query renders with some blanks cells. You then apply the simple detail filter [Amount]>1 and run the report. Only row labels are displayed and all data and columns are missing.
Chapter 40: Problems Authoring Reports In the Adventure Works cube, the [Account].[Accounts] attribute has a default member set to [Net Income]. When evaluating the GENERATE set expression, SSAS looks in the entire cube space and looks at all coordinates for the [Account] dimension. These coordinates include both [Account][Account Type].&[] and [Account].[Accounts].[Net Income]. Because these two coordinates don't exist within the same hierarchy, SSAS returns an empty set. To avoid this problem the SSAS administrator must set the default member in the cube to a member that exists in all other hierarchies.
567839, 569506 565153
Report Differences Between TM1 Executive Viewer and IBM Cognos 8 with TM1 Data Sources
When using a TM1 data source, comparable reports created in an IBM Cognos 8 studio and in TM1 Executive Viewer may contain different cell values. This occurs because the TM1 Executive Viewer product uses an algorithm for selecting default members for non-projected dimensions that differs slightly from traditional OLAP clients. To avoid this problem, when filtering your reports in the IBM Cognos studios, use context filters that match the default selections shown in the Executive Viewer user interface. This ensures that the cell values in IBM Cognos 8 match the values in Executive Viewer.
592662
624
Count Summaries in Query Calculations Include Nulls with SAP BW Data Sources
When using an SAP BW data source in Report Studio, null values in the database are returned in the result set and the Count summary function includes the empty cells in the following scenarios: A query calculation includes an arithmetic calculation where one or more NULL operands and an aggregation is performed on the calculation. The result of a query calculation is a constant, such as current_time() and current_date().
The Count summary function should normally exclude NULL values. To avoid this problem, for the first scenario, ensure that both operands do not return null values. For example, the original expression is [num1]+[num2]. Instead, use the following expression: if([num1] is null) then ( 0 ) else ([num1]) if([num2] is null) then ( 0 ) else ([num2]) There is no workaround for the second scenario.
564890, 570900, 568001
Notice that the summary value does not change to represent the total of the new values. This occurs because the within set aggregation that Report Studio uses with dimensional packages does not take into account sets that are nested below the set that is summarized.
Chapter 40: Problems Authoring Reports To show the correct summary values, if the inner and outer sets do not belong to the same dimension, you can nest a copy of the inner summary item under the outer summary item, as follows.
576832
626
Hyperlinks in Email Messages Are Stripped Out When the Agent is Saved
In Event Studio, hyperlinks are stripped out when the agent is saved. The administrator must allow email links to ensure that the links remain in emails created by agents.
CNC-ASV-0001 The Following Agent Service General Error Occurred: java.lang. StackOverflowError
When running a web service task, you may encounter errors when the WSDL that describes the Web service is very large.
628
The summary values for Total(ReturnedProducts) and Minimum(ReturnedProducts) for all rows except Central Europe do not correspond to the member values in the crosstab. This means that the top three products returned in all regions except for Central Europe are not Bug Shield Lotion 89110, Bug Shield Extreme 90110, and Sun Shelter 30 94110. Note that the summary values for Total(Region) and Minimum(Region) do correspond to the visible member values. That is because those summary values represent the total and minimum quantities returned for those three products in each region. You can see what the top three products returned in each region are by dragging the columns to the right of the rows, creating the following single-edge crosstab.
To obtain summary values that reflect the visible members, modify the expression of the data item containing the context-dependent set function so that it includes a tuple that is locked to the default member of every hierarchy that appears on the opposite edge. For this example, modify the expression to the following:
topCount([Product],3,tuple([Return quantity], defaultMember([Retailer site])))
where [Product] is the level and [Retailer site] is the hierarchy. When you run the report, all summary values reflect the visible members in the crosstab.
Unexpected Results for Analysis Studio Reports Using Suppression and Nested Rows
In Cognos Viewer, you run an Analysis Studio report for which page breaks have been set. Detail items appear only on the page that contains the item for which suppression is applied, and only summary items appear on all other pages. This may occur because of the following combined conditions: The report contains nested levels. Suppression is applied to an item nested inside the outermost group.
630
Chapter 41: Problems Running, Viewing, or Printing Reports and Analyses In the report options, the page breaks setting is applied to the outermost groups on rows.
To avoid this result, in Analysis Studio you can do one of the following: In the report options, clear the page breaks setting. Move the outermost group to the context filter area before applying suppression. Remove all suppression. You can also run the report as is. To prevent this message from appearing, from the Run menu, click Report Options. On the Display tab, clear the checkbox under Warning page. If you do not have access to Analysis Studio, contact your administrator.
Unexpected Results May Occur When Using Items from the Same Hierarchy on Multiple Crosstab Edges
A crosstab that contains items from the same hierarchy on more than one edge may have unpredictable results, and may change from release to release. For example, in an analysis that uses items from Years on rows and Quarters on columns, unexplainable More values and Totals, and unexpected blank cells may appear. Also, expected results may be difficult to read because the useful numbers are distributed over a large area of mostly blank cells. For best results, ensure that items from the same hierarchy are on the same crosstab edge before saving.
Chapter 41: Problems Running, Viewing, or Printing Reports and Analyses You can view the timestamp in local time and based on user preferences by opening the analysis in Report Studio and adding a layout calculation with the following expressions CubeDataUpdatedOn (dimension) or CubeSchemaUpdatedOn(dimension) using any cube dimension for either expression.
DPR-ERR-2082 The Complete Error Has Been Logged by CAF With SecureErrorID
You cannot run a report in IBM Cognos Connection, and the following error messages appear: DPR-ERR-2082 An error has occurred. Please contact your administrator. The complete error has been logged by CAF with SecureErrorID: timestamp-#number. RSV-DR-0002 Unable to execute this request. These error messages do not indicate an IBM Cognos Application Firewall problem. You can view a more detailed error message, in the c8server.log file that resides in the logs directory on the IBM Cognos 8 server.
Query Studio Does Not Generate a SELECT DISTINCT statement if a Column is Aliased Without Using the Actual Column Name
When filtering on a column name, the query does not generate a SELECT DISTINCT statement if the referenced column is aliased by manually typing the alias in the SQL of the query subject. To avoid this situation, do not manually type the alias. Instead, in Framework Manager, rename the column by right-clicking on it and selecting the Rename option.
493536
632
Chapter 41: Problems Running, Viewing, or Printing Reports and Analyses QE-DEF-0288 Unable to find the database... If this error does not occur when you are logged on as an administrator, then to solve the problem, ensure that the user has permissions to the signon embedded. If this error always occurs, the data source has not been created. Create the data source with the name mentioned in the error message.
Performance Issues when Showing Multiple Attributes Using Dimensionally Modeled Relational Data Sources
If you display multiple attributes for the items in a set on the crosstab, you can only select one attribute at a time, so Analysis Studio executes a query for each attribute selection. The performance of this approach is an expensive one to execute against a relational data source because of the query necessary to retrieve the attribute and its value. You can select multiple attributes for a selected crosstab set in Analysis Studio by using the Properties pane . By selecting multiple attributes before clicking OK or Apply in the dialog box, only a single query for all selected attributes is executed, instead of one per attribute. Multiple selection in the UI is the preferred approach for enabling the display of more than one attribute for dimensionally modeled relational data source packages, because of the reduced performance impact on the relational data source.
634
Error Occurs in Japanese Internet Explorer 7 When Running an Excel Report in Analysis Studio
An error may occur when you close Japanese Internet Explorer 7 installed on Windows XP SP2 while it is running an Analysis Studio report in Excel format. To solve this problem, Microsoft recommends that you unregister the msctf.dll file using the following command:
Regsvr32/U Msctf.dll
This .dll file is part of the ctfmon.exe speech recognition application. You may turn off any speech recognition application installed on your computer before unregistering the .dll file. For more information about turning off speech recognition, see http://support.microsoft.com/kb/313176/EN-US/
540718
Drilling Through to IBM Cognos 8 from an IBM Cognos Series 7 Product Results in Firewall Error
You use an IBM Cognos Series 7 product that is configured to use a proxy server. When you drill through to IBM Cognos 8, the following error message appears: DPR-ERR-2079 Firewall Security Rejection. Your request was rejected by the security firewall. Please try again or contact your administrator. Administration and Security Guide 635
Chapter 41: Problems Running, Viewing, or Printing Reports and Analyses This is because the IBM Cognos 8 Web server does not recognize the proxy server name and rejects the entry. To correct this problem, add the proxy server name in IBM Cognos Configuration.
Mixed Languages Are Displayed in IBM Cognos Connection When Using Samples
When you restore the Cognos_samples.zip file in the webcontent/samples/content folder it contains multilingual content. When you change the locale setting on your computer, reports appear in the language specified for your computer. This is not true for sample IBM Cognos PowerCubes. When 636
Chapter 41: Problems Running, Viewing, or Printing Reports and Analyses you restore Cognos_powercube.zip or Cognos_powercube_financial.zip, a different folder is set up for each language. If you select a PowerCube from a language folder that is different than the language specified by the locale setting on your computer, a mixture of languages is displayed in IBM Cognos Connection. There are two options for solving this problem: Re-install Cognos_powercube.zip or Cognos_powercube_financial.zip. First ensure that your computer is set to the locale that is consistent with the language of the PowerCube package you are installing. Then, install only the package from the language folder that matches the locale setting. Or, in IBM Cognos Connection, open each PowerCube package, click the Set Properties button, and in the Language box, select the language of the IBM Cognos PowerCube.
Steps
1. In IBM Cognos Connection, click the my area button, and click My Activities and Schedules, Schedules. 2. Click the arrow next to the item to view the Actions menu, and then click View run history. The View run history page appears. 3. To view the run history details, in the Actions column, click the view run history details button.
Chapter 41: Problems Running, Viewing, or Printing Reports and Analyses The solution is to find a suitable replacement in the Insertable Objects pane, and drag it to the New Item column. The report or analysis will then run.
Frank is an invalid recipient. The burst outputs for Canada and France are saved to Content Manager, but not the U.S. output. If you choose to send an email to each recipient and you selected the Include a link to the report check box, the email to Peter will not contain a link to the output for US. The error message that is generated will contain Peter and Frank as values for parameter 2 with no indication as to which is invalid.
638
Chapter 41: Problems Running, Viewing, or Printing Reports and Analyses To resolve this problem, you can configure the gateway to use ISAPI. IIS does not have a default timeout for ISAPI applications. Or, if you want to keep using a CGI gateway, you can increase the CGI timeout in IIS.
Description
Any value from the Scope list in the Schedule Management tool. Entries I Own value from the Scope list in the Schedule Management tool. Public Folders value from the Scope list in the Schedule Management tool.
SMT_SCOPE_entries_i_own
SMT_SCOPE_public_folders
For information about hiding user interface elements, see the IBM Cognos 8 Administration and Security Guide.
640
Note: The nkthread parameter should be double the value of the max_thread_proc parameter. For more information, see the HP Web site.
A Report Upgraded from ReportNet Does Not Retain its Original Look
When you upgrade a report to IBM Cognos 8, a new style sheet is applied that changes the look of the report.
Chapter 41: Problems Running, Viewing, or Printing Reports and Analyses To preserve the formatting that was used in the original report, you can select a different style sheet. This retains the original look of the report and specifies that any new items added to the report, such as list columns or crosstab levels, have the original formatting applied to them.
Steps
1. In Report Studio, from the File menu, click Report Properties. 2. Click Report styles and select 1.x styles.
The Page Cannot Be Found Error Appears When Viewing Report Outputs from Email Links
When a report is distributed by email, no error message appears if the report output from the email link is not available. This can occur when the output is deleted or when the user does not have permissions to the report. Instead, the error "The Page Cannot Be Found" appears. You are unable to view the report output from the email link when Allow Anonymous Access is set to true and when the Anonymous user does not have access to the report output. When you run a secured report from an email link and when Allow Anonymous Access is set to True, a passport is automatically issued to the Anonymous user. The Anonymous user is not prompted to log on and is unable to view the report output.
642
Chapter 41: Problems Running, Viewing, or Printing Reports and Analyses To avoid this problem, ensure that your database clients are properly configured. For more information, see your database vendor documentation. For Oracle 9, you can force the use of Unicode on the client by ensuring that the system environment variable NLS_LANG is set to "xxx.UTF8", where xxx is whatever is needed for other applications on that computer. If there are none, the value can be simply .UTF8. For information about configuring your database for multilingual reporting, see the IBM Cognos 8 Administration and Security Guide. While enforcing the use of Unicode on the database client guarantees that it can handle multilingual data, some characters in some character sets may still appear incorrectly, such as Japanese ShiftJIS. For information about configuring Shift-JIS characters, see the IBM Cognos 8 Administration and Security Guide.
Chapter 41: Problems Running, Viewing, or Printing Reports and Analyses You may be able to correct the problem by modifying the parameter mapping in the drill-through definition. For example, when you drill from a cube to a relational data source, sometimes no value is found, or the wrong data item appears, because the business key values in the two data sources do not match. You can change the drill-through definition to pass the caption of the PowerCube member instead of the business key.
644
Chapter 41: Problems Running, Viewing, or Printing Reports and Analyses If you operate in an environment that requires the Internet Explorer 6.x security level to be set to high, charts may not appear. If you cannot lower the security setting for security reasons, you may want to disable chart transparency. Charts are displayed in Internet Explorer with transparencies displayed in white. You must have the required permissions to access IBM Cognos Administration functionality. See "Secured Functions and Features" (p. 221).
Steps
1. Start IBM Cognos Connection. 2. In the upper-right corner, click Launch, IBM Cognos Administration. 3. On the Status tab, click System. 4. In the upper-left corner of the Scorecard pane, click the arrow to view the Change view menu. Click Services, Report Data 5. Click the arrow next to the service to display the Actions menu, and then click Set Properties. 6. Click the Settings tab. 7. For the Environment category, next to Advanced settings, click the Edit link. 8. If it appears, select the Override the settings acquired from the parent entry check box. Otherwise, proceed to the next step. 9. In the Parameter column, type EnableChartTransparencyIE. 10. In the Value column, type False to disable chart transparency in Internet Explorer. 11. Click OK. 12. Click OK again.
Portal Problems
The topics in this section document problems you may encounter with a portal when viewing reports.
Chapter 41: Problems Running, Viewing, or Printing Reports and Analyses [Microsoft][ODBC SQL Server Driver] [SQL Server] Login failed for user '(null)'. Reason Not associated with a trusted SQL The solution is to change the Network Library Configuration for SQL Server to use TCP/IP instead of Named Pipes.
The My Folders Tab Does Not Appear After Logging On to IBM Cognos Connection
A user is a member of a new group, and this group is a member of the Query Users group. When this user logs on, the My Folders and the personalized pages tabs do not appear in IBM Cognos Connection. Also, the user name does not appear in the upper-left corner of IBM Cognos Connection. To avoid these problems, the namespace to which the user belongs must have traverse permission to the Query Users group.
Chapter 41: Problems Running, Viewing, or Printing Reports and Analyses This problem can be caused by improper settings in IBM Cognos Configuration.
IBM Cognos does not provide or download ActiveX controls as part of IBM Cognos 8. Report Studio uses the native Internet Explorer XML support, which is an integral component of the browser. Because Microsoft implements XML using ActiveX, you must enable ActiveX support for Report Studio.
648
Chapter 41: Problems Running, Viewing, or Printing Reports and Analyses When you define the network address for the printer in IBM Cognos Connection, use the following syntax: For Windows: \\server_name\printer_name For UNIX: printer_name
When you define the network address for the printer, try using the IP address of the printer instead of the computer name. Ensure that IBM Cognos 8 users have the correct access permissions for the printer.
Tip: In IBM Cognos Connection, from the Launch menu, click IBM Cognos Administration. On the Configuration tab, click Printers. Click the arrow next to the printer to view the Actions menu, and then click Set properties. Click the Permissions tab. Ensure that the Directory Administrators group has all the access permissions granted and that the group Everyone has Read, Execute, and Traverse access permissions granted. Ensure that you can print a test page on the printer. If Tomcat is used as an application server, the crn_ROOT environment variable must not be defined. Ensure that users have read, execute, and traverse permissions for the printer object in IBM Cognos Connection. The printer name consists of only the first 127 ASCII characters.
650
To resolve the problem, first ensure that the correct map file is open. If it is, then resend the original exported file for translation and specify that the contents must not be sorted, deleted, added to, or modified except to add translated features. If required, export the translation features and languages again.
652
Also, log files (p. 653) can help you troubleshoot problems by recording the activities that take place when you work with Metric Studio. If you must contact customer support for assistance with a Metric Studio issue, attaching the support bundle (p. 654) will help expedite your case.
The load_summary.log file contains the number of loading errors and the associated error codes. The sql_history.log file is useful when tuning performance. It is a tab-delimited file that you can open using Excel. It contains SQL commands, the rows affected, and the time elapsed for each SQL statement. The debug_info.log file is a tab-delimited file and contains debugging information. The amount of information in this file depends on the level of logging detail selected. For information about setting the level of logging, see "Logging Settings" in the Metric Studio User Guide. installation_location/logs/MetricStoreInstall/databasename-timestamp installation_location/logs/MetricStoreUpgrade/databasename-timestamp Administration and Security Guide 653
For example, if a SQL Server database contains your metric store, issue a command such as cmm_support_bundle dbserver1 prod_db sa topsecret sqlserver or on UNIX sh cmm_support_bundle.sh dbserver1 prod_db sa topsecret sqlserver By default, this will create output in the installation location/_SUPPORT_FILES directory.
Chapter 43: Problems With Metrics The reference bug for Oracle is 5864217. If you encounter this error, you can resolve it by installing Oracle 10.2.0.3, Patch 5, which is officially named 5946186. You can obtain this patch from the Oracle Support's Metalink site which is available through your existing support agreement. Apply the patch as directed by the instructions included with the download from Oracle Support.
567585
Metric Studio Errors Occur When Loading Data into an Oracle Database
The application is disconnected from Oracle with ORA-07445 and ORA-3113 errors. You can see these errors in the database alert log. The database errors then cause errors in Metric Studio. This is a known issue with Oracle (Bug 5026836 - Ora-7445 [Kxccres()+3052] Updating View With Instead Of Trigger). The workaround is for the database administrator to run the following command while logged in as SYS: If an SPFILE is in use, ALTER SYSTEM SET optimizer_features_enable='10.1.0' SCOPE=BOTH. If an SPFILE is not in use, ALTER SYSTEM SET optimizer_features_enable='10.1.0'. If an SPFILE is not in use, the database administrator should also add this setting to the init.ora file for the database instance.
530992 510492
531440
Chapter 43: Problems With Metrics If you encounter this error, you can resolve it by installing Service Pack 1 for SQL Server 2005 (or later).
577840
Data from a Relational Database Source or a Flat File Data Source Does Not Appear
You use IBM Cognos Connection to load data into the metric store. If IBM Cognos Connection encounters a problem while loading data from a relational database source or a flat file import source, the data will not appear. Typical problems include text fields that are too long required fields are missing duplicate rows references to non-existent objects
To find the error, run the batch file or shell script from the command line and check the status of each step. Alternatively, you can repeat the loading process in two stages through the user interface and check the success of each stage.
The logs from the attempt to load each tab-delimited file can be found at installation_location/logs/Metric Maintenance/databasename-timestamp/BulkLoad, and may contain more descriptive error messages than are available from the user interface. 3. If you find errors, correct them and repeat steps 1 and 2. 4. After the data appears in the staging tables, in IBM Cognos Connection, under the Metric Maintenance folder for your package, click Transfer data from staging area into metric store. 5. Check whether the data appears in Metric Studio. If it does not, check the last three columns of the kpi_value_stage_rejects table for error information.
656
You Do Not Have Permission to Access This Metric Package. Contact Your System Administrator.
You must have Read, Execute, and Traverse permissions to open Metric Studio using the link on the Welcome page or in IBM Cognos Connection. Ask your system administrator to check your access permissions. For more information, see the Administration and Security Guide.
Failed to Check the Metrics Store Install Status Error When Using DB2 8.2.3
When you try to create a metric package using DB2 8.2.3 as the data source, you may receive the following error message: Failed to check the metrics store install status. If the version of the DB2 client on the Metric Studio computer is not the same version as the DB2 server, or you upgraded your DB2 instance, you must run commands to bind the DB2 client to the database. Run the commands on the Metric Studio computer. On Windows, run the commands in a db2cmd window from DB2InstallDir\sqllib\bnd. On UNIX, run the commands from DB2InstanceDir/sqllib/bnd. Type the following commands: db2 connect to database user userName db2 bind @db2ubind.lst blocking all grant public db2 bind @db2cli.lst blocking all grant public db2 bind db2schema.bnd blocking all grant public sqlerror continue db2 terminate
Errors Occur When Importing Tab-delimited Files into a DB2 Metric Store
When Metric Studio is installed on Windows and the DB2 metric store is installed on UNIX, errors occur when you run metric maintenance tasks to import tab-delimited files into the staging tables or into the metric store. The run history indicates that there were problems loading some of the tab-delimited files. The individual log files for the tab-delimited files indicate that the last column of the tab-delimited file data was truncated because it exceeded the target column width.
Chapter 43: Problems With Metrics Ensure that the tab-delimited files use end-of-line characters that are suitable for UNIX, such as a linefeed character and not the carriage return and linefeed character combination that is typically used by Windows.
Required User Permissions for the Metric Store Database (MS SQL Server)
The user account for the metric store database must be the database owner. You must use the owner user-account to log on to the IBM Cognos 8 data source used in the Metric Package. For information about setting user permissions, see the MS SQL Server documentation for the sp_changedbowner utility.
Error When Viewing a History Chart or Diagram on a DB2 Server with the 8.2 JDBC Driver
When the user tries to view a history chart or diagram, they see the following error: The IBM Cognos Gateway is unable to connect to the IBM Cognos BI server. The server may be unavailable, or the gateway may not be correctly configured. Please try again or contact your administrator. This problem is known to occur only when Metric Studio is installed on an HP/UX Itanium server. This problem is caused by a bug in the DB2 8.2 JDBC driver (APAR IY92903). IBM plans to fix this problem in FixPak 15. The only workaround for this problem is to use DB2 9.1.
Oracle 9.2 Package Initialization Error if NLS_LANG Environment Variable is Not Set Appropriately Before Starting Up IBM Cognos 8 Tomcat Server
You will encounter an exception error when trying to initialize a CMM package if the Oracle specific environment variable NLS_LANG is not set correctly. Workaround: IBM Cognos 8 requires that the Oracle specific environment variable NLS_LANG be set appropriately before starting up IBM Cognos 8 Tomcat server. Please ensure that the character set portion of this variable is set to UTF8. For example, in the United States, this may be something like AMERICAN_AMERICA.UTF8.
658
Chapter 43: Problems With Metrics Metric Designer does not recognize joins where more than one column is required for a join condition. In this case, enter the IQD files into Metric Designer as separate import sources or combine them into a single IQD using Impromptu.
440049
660
Chapter 44: Troubleshooting IBM Cognos 8 for Microsoft Office and the Report Data Service
Use this troubleshooting information to help solve problems you may encounter during or after the installation of IBM Cognos 8 for Microsoft Office, IBM Cognos 8 Go! Office, IBM Cognos 8 BI Analysis for Microsoft Excel, and Report Data Service (RDS) components. For more troubleshooting information search the Knowledge Base of the IBM Cognos Resource Center Web site (http://support.cognos.com/kb-app/knowledgebase).
Configuration Issues
The following issues are related to configuration and setup.
The IBM Cognos 8 for Microsoft Office Interface Fails to Initialize in Microsoft Office
IBM Cognos 8 for Microsoft Office may not initialize when the Microsoft .NET Framework is not installed or the version is not correct. The required Microsoft .NET Framework version is 2.0. Another possible reason for this condition is that the IBM Cognos 8 for Microsoft Office COM add-in is either not installed or not registered. If you are running the wrong version of Microsoft .NET Framework, uninstall it and then reinstall Microsoft .NET Framework version 2.0. To install the IBM Cognos 8 for Microsoft Office COM add-in, run the .msi program that is found on the installation disk. For more information, see the installation guide. Before you attempt to install Microsoft .NET Programmability Support, you must have installed Microsoft .NET Framework version 2.0.
Chapter 44: Troubleshooting IBM Cognos 8 for Microsoft Office and the Report Data Service
IBM Cognos 8 for Microsoft Office Fails to Initialize in Microsoft Internet Explorer
If you use Internet Explorer to browse IBM Cognos 8 and open a workbook, document, or presentation published by IBM Cognos 8 for Microsoft Office, the document launches in Microsoft Office, but without full functionality. To configure Internet Explorer to open Microsoft Office files in Microsoft Office instead of in Internet Explorer, you must use the Folder Options tool to update browse options. It is also possible to do this in Windows Registry.
Steps to Configure Internet Explorer to Open Microsoft Office Documents in Microsoft Office Applications
1. Open My Computer. 2. From the Tools menu, click Folder Options. 3. On the File Types tab, under Registered file types, click Microsoft Excel Worksheet, and then click Advanced. The Edit File Type dialog box appears. 4. Clear the Browse in same window check box and click OK. 5. Complete the same steps for Microsoft Office PowerPoint presentations and Microsoft Office Word documents.
Microsoft Office Does Not Open a Microsoft Office Document Published from IBM Cognos 8 for Microsoft Office
If you observe Microsoft Office trying to open a published document twice when you double-click the workbook, document, or presentation from Windows Explorer, the file association is either corrupted or not installed properly. There are two options to resolve this issue. You can start the Microsoft Office application first, and then open the document using the Open command from the File menu, or you can reregister the file type.
662
Chapter 44: Troubleshooting IBM Cognos 8 for Microsoft Office and the Report Data Service You can adapt this command to your environment by providing the proper local drive and location.
Unable to Open Published Microsoft Office Documents from IBM Cognos Connection
If the browser does not prompt you to open or save the workbook, document, or presentation, it may mean that the option to prompt before opening was cleared. Reset this option. You must enable the File Download and Automatic prompting for file downloads in Internet Explorer.
Chapter 44: Troubleshooting IBM Cognos 8 for Microsoft Office and the Report Data Service 2. From the Tools menu, click Internet Options. 3. From the Security tab, click the Web content zone for which you are updating these options, and then click Custom Level. 4. Scroll down to the Downloads section and click Enable for the File download and Automatic prompting for file downloads options. 5. Click OK twice.
Error Messages, the .NET shortcut, or the .NET Console Are Not in the Language of the .NET Framework 2.0 That Was Installed
When you install a non-English version of .NET Framework in a non-English operating system, you will notice that the error messages, .NET shortcut and .NET Console are in English. To solve this issue, you must apply the .NET Framework Language Pack for your language. The subkey numbers relate to the language as follows: 1033=en-en, 1036=fr-fr, 1031=de-de, and 1041=ja. If you are missing the language pack subkeys, you must install the .NET language pack, which is available from the Microsoft support Web site.
664
Chapter 44: Troubleshooting IBM Cognos 8 for Microsoft Office and the Report Data Service
Reports Unavailable in IBM Cognos Connection Jobs after Using Save As Command in Report Studio
After opening a report in Report Studio and saving a copy using the Save As command, you may find that if the report is included in a job, it is not available in the IBM Cognos Connection portal. Do not use the Save As command in Report Studio to save changes when a report is included in a job. Instead, make a copy of the report, make changes to the copy, and then copy the updated report to the IBM Cognos Connection portal. Use this method to overwrite the report in the job without breaking the report links.
For more information, see the installation guide for the specific product.
Steps
1. From the Windows Start menu, click Run. 2. In the Open box, type Regedit, and then click OK. 3. In the Registry Editor, go to the Registry branch:
Chapter 44: Troubleshooting IBM Cognos 8 for Microsoft Office and the Report Data Service HKEY_CURRENT_USER\SOFTWARE\Microsoft\Office\version\Excel\Options 4. In the right pane, under Name, right-click OPEN, and then click Modify. 5. In the Value Data box, type /A "CognosOfficeUDF.Connect" 6. Click OK, and then close the Registry Editor.
Processing Issues
The following issues are related to processing and rendering reports.
RDS Data Limit Exceeded When Importing from Large Report Outputs
While attempting to import all or part of a large report, the application attempts to open the entire report. A provisional governor limit restricts the size of report output allowed and might result in an error (even if you are trying to import only part of a report). To resolve this problem, you can adjust the size limit for report data by changing the Governor limit setting.
Steps
1. Start IBM Cognos Connection. 2. In the upper-right corner, click Launch, IBM Cognos Administration. 3. On the Status tab, click System. 4. In the upper-left corner of the Scorecard pane, click the arrow to view the Change view menu. Click Services, and then click Report Data. 5. Click the arrow next to ReportDataService to view the Action menu, and then click Set Properties. 6. Click the Settings tab. 7. In the Value column, change the number for Governor limit (MB), and then click OK.
666
Chapter 44: Troubleshooting IBM Cognos 8 for Microsoft Office and the Report Data Service To resolve this problem, restart RDS. RDS restarts when the IBM Cognos 8 service is restarted.
The Dispatcher Is Unable to Process the Request. The Request Is Directed to an Unknown Service Name: Content
The IBM Cognos Report Data Service (RDS) cannot bring report elements into a Microsoft Office document. Some combinations of text and images are beyond the scope of the target application. To resolve this problem, evaluate the report and attempt to simplify the content requirements so that IBM Cognos 8 Go! Office can render the report.
Chapter 44: Troubleshooting IBM Cognos 8 for Microsoft Office and the Report Data Service To resolve this problem, you must rename the report without the single quotation mark.
In this example, the selected prompt value is "Golf Equipment" which is displayed properly in the Display Value prompt property. In cases where this occurs, you must know that the equivalent format in the Specified Value is the value with which you want to refresh the report. In the example, [great_outdoors_company]. [Products].[Products].[Product line]->:[PC].[@MEMBER].[5~236] is equivalent to Golf Equipment. To refresh the report, we recommend that you use the Always Prompt option. That way, users can select the value from the reports own prompt dialog box.
Steps to Log On
1. In the report list, right-click the top node item. 2. Click Log On. 3. Provide your authentication credentials as prompted and click OK.
668
Chapter 44: Troubleshooting IBM Cognos 8 for Microsoft Office and the Report Data Service
This item cannot be expanded. Microsoft Excel has reached the maximum number of rows or columns for this worksheet
The number of rows and columns is limited in Microsoft Excel. Expanding the current item is not possible because it would shift rows or columns beyond this worksheet limit. Microsoft Office Excel cannot shift nonblank cells off the worksheet. Manually move items so that the row or column item can expand without reaching the limit, or move your exploration or analysis to another worksheet. Or, you can move the data to a new location and try again.
Steps
1. On the IBM Cognos 8 for Microsoft Office toolbar, click the Options button 2. In the left navigation pane, IBM Cognos 8 BI Analysis. 3. Under Exploration Settings, in the Data Display Row Limit box, increase the number of rows so that you can display more or all of the remaining members in the list, and then click OK. .
Security Issues
The following issues are related to security setup.
Chapter 44: Troubleshooting IBM Cognos 8 for Microsoft Office and the Report Data Service
RDS-ERR-1000 Report Data Service Could Not Process the Response from the Content Provider
The cause for this error varies based on the application server. In WebSphere, this error occurs if another XML parser, such as Xalan is colliding with the one RDS uses. In BEA WebLogic, this error occurs if the JAVA_OPTIONS variable has not been set with the correct parser information. This error can also occur if a package from a previous version of IBM Cognos 8 (or ReportNet) was deployed to IBM Cognos 8 without the report specifications being upgraded. 670
Chapter 44: Troubleshooting IBM Cognos 8 for Microsoft Office and the Report Data Service Another possible reason for this error message is that RDS cannot handle the report. For example, this error occurs if a Report Studio report contains a block with either of the following: a repeater or repeater table inside a block or a table a layout object, such as a list, crosstab, chart, or text object in a conditional block inside another block or a table
RDS-ERR-1001 The PowerPlay Report Name Could Not Be Run. The Expected Response Was Not Returned by PowerPlay
PowerPlay failed while running the report or RDS cannot understand the output. To resolve this problem, ensure that PowerPlay is functioning properly. The user should check to see that the PowerPlay server is running, or check the PowerPlay logs for errors. If IIS is being used for the Web server, ensure that Anonymous Access is enabled. For more information, see the IBM Cognos 8 Installation and Configuration Guide.
Chapter 44: Troubleshooting IBM Cognos 8 for Microsoft Office and the Report Data Service
RDS-ERR-1005 The Logon Requirements for IBM Cognos 8 Could Not Be Obtained. You May Already Be Logged into this Namespace, or the Target Namespace Does Not Exist
Generally, this error occurs when trying to log on to the same namespace twice. In some cases, it may indicate a problem with a security setup such as SiteMinder. Ensure that you are not already logged in.
RDS-ERR-1012 IBM Cognos Content Service was Unable to Discover the Content Providers
This error usually appears in conjunction with RDS-ERR-1028 and means that RDS could not communicate with any PowerPlay providers. (RDS-ERR-1028 can occur separately if there is more than one PowerPlay server, and only one has failed). Check that all instances of PowerPlay Enterprise Server are running properly.
RDS-ERR-1014 Report Data Service Was Unable to Create the Document Object Object Name
Content Manager is not responding. Ensure that Content Manager is running. Check the server log for error messages related to Content Manager.
RDS-ERR-1015 Report Data Service Was Unable to Create a New Document Version
Content Manager is not responding. Ensure that Content Manager is running. Check the server log for error messages related to Content Manager.
RDS-ERR-1016 Report Data Service Was Unable to Create a New Document Content Object
Content Manager is not responding. Ensure that Content Manager is running. Check the server log for error messages related to Content Manager.
672
Chapter 44: Troubleshooting IBM Cognos 8 for Microsoft Office and the Report Data Service
RDS-ERR-1018 The IBM Cognos 8 Report Name Could Not Be Run. The Expected Response Was Not Returned by IBM Cognos 8
An error was returned by IBM Cognos 8 when the report was run or refreshed. One of the following may be the cause: PowerPoint does not contain the necessary facilities to recreate the rich formatting and layout of this report. Check the IBM Cognos 8 error log for troubleshooting information. If the report in question was not able to be rendered, adjust the report to remove the formatting and layout to expose the data in PowerPoint, where you can modify formatting and layout. You tried to refresh a Series 7 PowerPoint report that was migrated to IBM Cognos 8. Series 7 content is no longer accessed from the Series 7 PowerPlay Enterprise Server, and the IBM Cognos 8 Report Data Service (RDS) is attempting to resolve the path of the PowerCube datasource. In IBM Cognos 8 Go! Office, ensure that the value of the Search Path property of the report matches the search path of the same report that was migrated to IBM Cognos 8 and published to IBM Cognos Connection. For more information, see the IBM Cognos 8 Go! Office User Guide. For prompted reports in IBM Cognos 8 Go! Office using Microsoft Excel, if you have set, in the Properties pane, prompt values to be retrieved from a cell reference and the value in the cell reference is invalid for the prompt, you receive this error message. We recommend that you select Always Prompt as this is the best practice for prompted reports. For more information, and to determine if this is the exact cause for this error message, see the IBM Cognos 8 server log file. Search for this error message, RDS-ERR-1018 and then look for error messages similar to the following: "Failure QFS-ERR-0139 The request has multiple errors. RQP-DEF-0354 The query contains one or more unresolved prompts. QE-DEF-0385 Invalid format for prompt 'Parameter1'. Expected format is unknown."
RDS-ERR-1019 IBM Cognos Content Service Was Unable to Retrieve the Portal Information from IBM Cognos Connection
IBM Cognos 8 may have stopped processing. Ensure that IBM Cognos 8 is started.
RDS-ERR-1020 The Currently Provided Credentials are Invalid. Please Provide the Logon Credentials
Your user name and password are not correct. Ensure that you typed a valid user name and password.
Chapter 44: Troubleshooting IBM Cognos 8 for Microsoft Office and the Report Data Service
RDS-ERR-1021 The IBM Cognos 8 Report Name Could Not be Run Because it Contains Unanswered Prompts. Please Provide the Prompt Answers, and Run the Report Again
The report has prompts that have not been set. You must open the report and then save a version of the report with the desired prompt answers before importing the content into IBM Cognos 8 Go! Office.
RDS-ERR-1023 The Report Name Could Not Be Run Because It Exceeds the Report Data Service Data Size Limit Set by the Administrator
A report fails because it exceeds the data size limit set by the administrator. The default limit for IBM Cognos 8 Go! Office is 10 MB. Increase the size limit for report data by changing the Governor limit setting. For more information, see the IBM Cognos 8 Administration and Security Guide.
RDS-ERR-1027 The Encoding for the PowerPlay Server Name Could Not Be Determined. ISO-8859-1 Will Be Used as the Encoding
This condition can be caused if PowerPlay is not responding. Ensure that PowerPlay is started and functioning properly.
RDS-ERR-1030 A Security Error Occurred While Trying to Establish a Connection with Name
The CA certificate was not installed into RDS. Install the CA certificate.
RDS-ERR-1031 Report Data Service was unable to retrieve the metadata for Name
The provider, such as IBM Cognos 8 or PowerPlay is not responding. Ensure that IBM Cognos 8 or PowerPlay is running. Check the server log for error messages related to these providers.
RDS-ERR-1033 Report Data Service Was Unable to Create the Report View Name
Content Manager is not responding. Ensure that Content Manager is running. Check the server log for error messages related to Content Manager.
674
Chapter 44: Troubleshooting IBM Cognos 8 for Microsoft Office and the Report Data Service
RDS-ERR-1034 The Report Specification for Name Could Not Be Retrieved From IBM Cognos 8
This message occurs if the metadata could not be retrieved from IBM Cognos 8. Ensure that IBM Cognos 8 is running. Check the server log for error messages related to IBM Cognos 8.
RDS-ERR-1039 The Request Could Not Be Cancelled. The Request is No Longer Running
This error occurs if a user (or administrator) tries to cancel an RDS request, but the request no longer exists. This can happen if the user clicks Cancel after the administrator has already restarted RDS. Wait for RDS to restart.
Steps
1. In IBM Cognos Connection, in the upper-right corner, click Launch, IBM Cognos Administration. 2. On the Status tab, click System. 3. In the upper-left corner of the Scorecard pane, click the arrow to view the Change View menu. Click Services, and then Report Data. 4. With the Report data service displayed, click the arrow to view the Actions menu next to the service, and then click Stop immediately. By using this method, RDS supports canceling long running requests, such as running a report.
RDS-ERR-1044 The Output for the Requested Version for Object NameCould Not be Retrieved
The report output version that you want to run cannot be retrieved from the content store. This problem can be caused by one or more of the following: the requested report version name, specified burst key, or burst ID, does not exist the requested version does not have any outputs that meet any of the accepted formats, such as XML, PDF, or HTML The report author did not specify a default format to be used when the report is run. you do not have sufficient access permissions to retrieve this output Administration and Security Guide 675
Chapter 44: Troubleshooting IBM Cognos 8 for Microsoft Office and the Report Data Service To run the report, you must have execute permission for the report and traverse permissions for the folder that contains the report.
RDS-ERR-1045 LayoutDataXML Output Was Not Generated for the Requested Version for Object [Name]
The report version you want to run exists in the content store, but was not saved with the LayoutDataXML output. When the report output version was saved, the report author must have selected the Enable enhanced user features in saved output version check box in IBM Cognos Connection. For more information, see the IBM Cognos Connection User Guide.
676
Chapter 44: Troubleshooting IBM Cognos 8 for Microsoft Office and the Report Data Service
You cannot load IBM Cognos 8 Go! Office content to another Microsoft Office application, such as Microsoft Access, even when there is an add-in that enables these applications to interoperate. Load the report content into one of the supported applications and environments. For a complete listing of supported Excel, Word, and PowerPoint versions, see the IBM Cognos Resource Center Web site.
Chapter 44: Troubleshooting IBM Cognos 8 for Microsoft Office and the Report Data Service
Steps
1. Redesign the report. 2. Resave the report. 3. Import the resaved report into IBM Cognos 8 Go! Office.
678
Chapter 44: Troubleshooting IBM Cognos 8 for Microsoft Office and the Report Data Service
COC-ERR-2305 Microsoft Excel Returned an Error. Ensure That Microsoft Excel is Not in Edit Mode, Then Try Again
Report content cannot be refreshed while one of the cells of the workbook is being edited. Click outside the active cell to return it to a non-edit mode and try again.
COC-ERR-2603 You Must Add a Slide to the Presentation Before Importing Any Content
The presentation has no slides. IBM Cognos 8 Go! Office requires at least one slide in the presentation for the Import Content wizard to start. Add a slide to the presentation and then try to import report content again.
Chapter 44: Troubleshooting IBM Cognos 8 for Microsoft Office and the Report Data Service In IBM Cognos 8 Go! Office, in the Properties pane, for each prompt, ensure that the value specified in the Custom Property box, matches the value specified in the custom document property in the Microsoft Office Properties dialog box (File, Properties, Custom tab). Ensure that there are no leading and trailing character spaces in the name of the custom document property. For more information, see the IBM Cognos 8 Go! Office User Guide.
680
Chapter 44: Troubleshooting IBM Cognos 8 for Microsoft Office and the Report Data Service
COI-ERR-2009 Unable to Perform This Operation Because Microsoft Excel is in Edit Mode
Report content cannot be refreshed while one of the cells of the workbook is being edited. Click outside the active cell to return it to a non-edit mode and try again.
COI-ERR-2010 The Name {0} is Not Valid. A Name Must Not Contain Both a Quote (") Character and an Apostrophe (') Character
When you create a folder, rename a folder, or publish a document, the name can contain an apostrophe or a quote, but not both. To resolve this problem, rename the folder or document. Exclude the apostrophe or quote character from the name.
COI-ERR-2011 The server did not return the expected response. Check that the gateway is valid.
This error message is displayed if the value entered in the System Gateway URI box of the Options dialog box is not a valid IBM Cognos 8 server. To resolve this problem, reenter the System Gateway URI with the gateway address for a valid IBM Cognos 8 server.
Chapter 44: Troubleshooting IBM Cognos 8 for Microsoft Office and the Report Data Service
COR-ERR-2013 Exploration Cannot Be Converted to Formula Based Because at Least One Context Item Contains a Selection
With more than one item in the Context drop zone there is no way for the multiple items to be rendered into the cells of the worksheet. Remove one dimension from the Context drop zone. You must have one item per dimension to convert to a formula-based analysis.
Chapter 44: Troubleshooting IBM Cognos 8 for Microsoft Office and the Report Data Service
COR-ERR-2015 Exploration Cannot Be Converted to Formula Based Because There is a Default Measure and a Measure on Either Rows or Columns
IBM Cognos 8 BI Analysis for Microsoft Excel does not support the mixed case of measures. Remove the default measure or the measure on either rows or columns.
Step
To remove measures from an exploration, on the Exploration bar, Ctrl+click the Reset to blank exploration button.
Chapter 44: Troubleshooting IBM Cognos 8 for Microsoft Office and the Report Data Service
684
If data is requested from a database that has its own automatic mechanism for Shift-JIS to Unicode conversion, IBM Cognos 8 does not call the Round Trip Safety Configuration utility to convert the characters from Unicode to Shift-JIS. The round trip safety of characters in the data cannot be ensured.
To resolve this problem, you can use the Round Trip Safety Configuration utility to ensure that conversion is to 0x8790 and the record is found.
686
Appendix A: Round Trip Safety Configuration of Shift-JIS Characters Such Unicode characters can be considered identical when processed by computers and can be substituted for one another. You can use the utility to ensure that the correct substitution is made (p. 688).
Specify Conversions
If your data contains more than one Shift-JIS character that converts the same Unicode character, use the Round Trip Safety Configuration utility to specify that the Unicode character always converts to the required Shift-JIS character.
Conversion Tab
On this tab, native encoding characters appears in the form 0xYYYY, and Unicode characters appear in the form U+YYYY, where YYYY represents the hexadecimal value of the Unicode character. For example, the character "A" appears as follows: for native encoding, 0x41 for Unicode, U+0041
Each row represents a mapping rule that associates two or three Shift-JIS characters with the Unicode character in the first column. By default, all Shift-JIS characters in a row are converted to the associated Unicode character. For example, the Shift-JIS characters 0x8782 and 0xFA59 both convert to the Unicode character U+2116. You can configure more than one character at a time.
Prerequisite
Before you choose the Shift-JIS character to use in a conversion, determine which Shift-JIS character is currently used in the environment. Only one of the possible Shift-JIS equivalents of a Unicode character can be used in a specific environment.
Steps
1. Start the Round Trip Safety Configuration utility in the c8_location/ bin: for Windows, rtsconfig.exe for UNIX, rtsconfig
2. Click the Conversion tab. Tip: To see the glyph next to the Unicode character, from the View menu, click Glyphs. Depending on the type and size of fonts you use, some glyphs may not be visible. 3. From the Edit menu, click Find a character, and then enter the hexadecimal value of the ShiftJIS character. 4. Click OK. 5. In the First Shift-JIS Character, Second Shift-JIS Character, or Third Shift-JIS Character column, select the Shift-JIS character that you want the Unicode character to convert to. Administration and Security Guide 687
Appendix A: Round Trip Safety Configuration of Shift-JIS Characters 6. Repeat steps 3 to 5 for each Shift-JIS character that you want to configure. 7. Save your specifications using one of the following methods: To only save your specifications, from the File menu, click Save. To save and apply your specifications, from the Tools menu, click Configure.
If you save only, you can apply your specification later (p. 689). You can also restore default settings (p. 689). The specifications are saved in the file shift-jis.xml in the c8_location/bin directory.
Specify Substitutions
After the conversion, the Unicode data may contain characters that are identical in meaning, but different in appearance. For example, a full-width tilde (~) and a half-width tilde have different values in Unicode, but can be considered identical during processing. You can use the Round Trip Safety Configuration utility to specify that specific pairs of similar characters be substituted by a single character. For example, you can specify that both widths of tilde are substituted by a full-width tilde.
Substitution Tab
On this tab, the first column contains pairs of characters that generally mean the same thing, but are represented by different values in Unicode. Each row represents a substitution rule. The first column lists the data before conversion. The second column lists the possible replacement characters.
Steps
1. Start the Round Trip Safety Configuration utility in the c8_location/ bin: for Windows, rtsconfig.exe for UNIX, rtsconfig
2. Click the Substitution tab. Tip: To see the glyph next to the Unicode character, from the View menu, click Glyphs. Depending on the type and size of fonts you use, some glyphs may not be visible. 3. In the Original Code column, click the character that you want to substitute. 4. In the Substitute Code column, click the equivalent character. A list of possible substitution options appears. 5. In the list, click the Unicode character that you want to use, or click Do not substitute. 6. Repeat steps 3 to 5 for each Unicode character that you want to substitute. 7. Save your specifications using one of the following methods: To only save your specifications, from the File menu, click Save. To save and apply your specifications, from the Tools menu, click Configure.
688
Appendix A: Round Trip Safety Configuration of Shift-JIS Characters If you only save, you can apply your specification later (p. 687). You can also restore default settings (p. 689). The specifications are saved in the file shift-jis.xml in the c8_location/bin directory.
When you apply the data, by default, characters are not checked for round trip safety. When you set the configuration mode, you may choose to check for round trip safety by selecting the option that returns a conversion error at run time for characters that are not round trip safe. This can be useful to initially detect which Shift-JIS characters must be configured.
Steps
1. Stop IBM Cognos 8. 2. In the Round Trip Safety Configuration utility, from the Tools menu, click Set the configuration mode. 3. Specify whether you want characters checked for round trip safety. 4. From the Tools menu, click Configure. 5. Start IBM Cognos 8.
Steps
1. Stop IBM Cognos 8. 2. In the Round Trip Safety Configuration utility, from the Tools menu, click Restore defaults. The conversion process is set to use the default values. 3. Start IBM Cognos 8.
Steps
1. Stop IBM Cognos 8. 2. Start the Round Trip Safety Configuration utility (p. 686). 3. From the Tools menu, click Restore defaults. 4. From the Tools menu, click Configure. The conversion tables are set to use the default values in the background. 5. Close the Round Trip Safety Configuration utility. 6. Start IBM Cognos 8.
690
Icon
Permissions
Read Write Execute Set policy Traverse
Folder
/Root /Root/Directory
Contents
All folders below /Root in the hierarchy. Information about authentication providers and other information typically found in a directory service. The Cognos directory namespace containing Cognos groups, data sources, distribution lists, and contacts. Other security namespaces, such as NTLM, LDAP, and Active Directory. All application data in Content Manager.
/Root/Directory/Cognos
/Root/Directory/other providers
/Root/Public Folders
Folder
/Root/Directory/application packages
Contents
A separate folder for each application containing information about the application. Configuration data for all IBM Cognos 8 components and templates. Objects that can be secured through policies that restrict access to functionality, such as Administration, Report Studio, and Query Studio; and to features, such as user defined SQL, and bursting. Deployment information for each archive imported into Content Manager. Deployment information for each archive exported from Content Manager.
/Root/Configuration
/Root/Capabilities
/Root/Import
/Root/Export
Configuration
Public Folders
692
Object
Capabilities Object
Adaptive Analytics
Administration
Directory Administrators Portal Administrators Report Administrators Server Administrators Metrics Administrators Planning Rights Administrators Controller Administrators
Administration/Adaptive Adaptive Analytics AdminisAnalytics Administration trators Directory Administrators Administration/Run activities and schedules Report Administrators
Object
Administration/Configure Server Administrators and manage the system Directory Administrators Administration/Users, Groups, and Roles Directory Administrators
Administration/Set Directory Administrators capabilities and manage UI profiles Administration/Data Sources Connections Administration/ Administration tasks Directory Administrators
Server Administrators
Report Administrators Metrics Administrators Controller Administrators Directory Administrators Administration/ Distribution Lists and Contacts Administration/Printers Administration/Metric Studio Administration Directory Administrators
Directory Administrators
694
Object
Administration/Planning Administration
Administration/Styles and Portal Administrators portlets Directory Administrators Administration/Controller Controller Administrators Administration Directory Administrators Analysis Studio Report Administrators Authors Analysis Users Directory Administrators Cognos Viewer Context Menu Selection Toolbar Authors Consumers Query Users Analysis Users Readers Express Authors Directory Administrators Report Administrators
Object
Cognos Viewer/Run With Report Administrators Options Authors Consumers Query Users Analysis Users Express Authors Directory Administrators Controller Studio Controller Users Controller Administrators Directory Administrators Data Manager Data Manager Authors Directory Administrators Detailed Errors Drill Through Assistant Event Studio Directory Administrators Directory Administrators Report Administrators Authors Metrics Administrators Metrics Authors Directory Administrators Glossary Everyone Directory Administrators Hide Entries Everyone
696
Object
Lineage
Metric Studio
Planning Contributor
Authors
Query Users Report Administrators Directory Administrators Report Studio Authors Report Administrators Directory Administrators Express Authors Administration and Security Guide 697
Object
Report Studio Bursting HTML items in report User Defined SQL
Report Administrators Directory Administrators Report Studio Create/Delete Report Administrators Directory Administrators Express Authors Scheduling Report Administrators Authors Consumers Query Users Metrics Administrators Metrics Authors Controller Administrators Controller Users Analysis Users Directory Administrators Express Authors Scheduling/Scheduling Priority Report Administrators Authors
698
Object
Set Entry-Specific Capabil- Directory Administrators ities Specification Execution Data Manager Authors Directory Administrators Watch Rules Report Administrators Authors Query Users Consumers Metrics Administrators Metrics Authors Controller Administrators Controller Users Analysis Users Express Authors Directory Administrators
Adaptive Analytics Users Directory Administrators Adaptive Analytics Users All Authenticated Users All Authenticated Users Analysis Users All Authenticated Users All Authenticated Users Analysis Users Directory Administrators Anonymous Anonymous Everyone Directory Administrators Authors All Authenticated Users Authors Directory Administrators Consumers All Authenticated Users Consumers Directory Administrators Controller Administrators Controller Administrators Directory Administrators Controller Users All Authenticated Users
700
Object
Directory Administrators Directory Administrators Express Authors Directory Administrators Express Authors All Authenticated Users Everyone All Authenticated Users Anonymous Metrics Administrators Metrics Administrators Directory Administrators Metrics Authors Metrics Authors All Authenticated Users Directory Administrators Metrics Users Metrics Users All Authenticated Users Directory Administrators Planning Contributor Users All Authenticated Users
Object
Planning Rights Adminis- Planning Rights Administrattrators ors Directory Administrators Portal Administrators Portal Administrators Directory Administrators Query Users All Authenticated Users Directory Administrators Query Users Readers Directory Administrators Readers All Authenticated Users Report Administrators Directory Administrators Report Administrators Server Administrators Directory Administrators Server Administrators System Administrators System Administrators
702
For more information on the samples, see "Setting Up the Samples" (p. 63).
Sample Query
The macro in the following sample query uses the runLocale session variable as the Language_lookup parameter map key. It returns the language code to be used as the suffix of the column name. In the following Select statement, where French is the language, the macro generates the column name COUNTRY_FR.
Select COUNTRY.COUNTRY_CODE, #'COUNTRY.COUNTRY_' + $Language_lookup{$runLocale}# as Product_Line
Because Framework Manager is flexible, your multilingual columns do not have to use the naming system used in the samples. In fact, your multilingual columns can use any naming system. You can encode your naming scheme into the parameter map, as required. You can use any session variable as the parameter map key and return any SQL syntax that you require to substitute at runtime. For more information, see the Framework Manager User Guide.
Database
GOSALES GOSALESDW
The samples databases use ISO language codes to identify each row of data.
Sample Query
The macro in the sample query below uses the runLocale session variable as the Language_lookup parameter map key and returns the corresponding language code. The sq() function specifies that the return value of the macro be enclosed in single quotation marks to produce a valid SQL filter predicate. In the following Select statement, where German is the language, the macro identifies the language as DE (German), and product the filter (PRODUCT_MULTILINGUAL."LANGUAGE" = 'DE').
Select P.INTRODUCTION_DATE, P.PRODUCT_TYPE_CODE,
704
Table
ORDER_HEADER RETAILER RETAILER_SITE _MB BRANCH EMPLOYEE
Database
GOSALES GOSALESs GOSALES GOSALES GOSALES
Multiscript Extensions
After defining the query subjects in the model, items with the _MB extension are renamed with a multiscript extension, such as Address 1 (multiscript) to ease use and readability.
Multiscript extensions allow a user in any language to use the same model columns to create an address block and see the address properly formatted for each delivery location. For more information, see the Mailing address data source query subjects in the gosales_goretailers sample model.
706
Description
The IBM Cognos Connection top header (h1) Left-hand side of the IBM Cognos Connection top header (h1) Right-hand side of the IBM Cognos Connection top header (h1) The Launch menu in the upper-right corner of Cognos Connection Not supported Authentication options Refresh button Search options My Area options My Watch Items option in My Area My Preferences option in My Area
<CRN_HEADER_TITLE/>
<CRN_HEADER_OPTIONS/>
<CRN_HEADER_LAUNCH/>
Description
My Activities and Schedules option in My Area Help menu Quick Tour link Getting Started link More Documentation link IBM Cognos on the Web link Go to the Welcome Page link About IBM Cognos Connection link Home option Set View as Home option Deprecated Report Studio link Query Studio link Metric Studio link Event Studio link. Used to be <CRN_ HEADER_OPTIONS_ags> Analysis Studio link. Used to be <CRN_ HEADER_OPTIONS_ps> IBM Cognos Connection link (Cognos Viewer only). Deprecated. Contributor link Controller Studio link Drill-through Definitions link
<CRN_HEADER_HELP/> <CRN_HEADER_HELP_quickTour/> <CRN_HEADER_HELP_getStarted/> <CRN_HEADER_HELP_moreDocs/> <CRN_HEADER_HELP_companyWebsite/> <CRN_HEADER_HELP_welcome/> <CRN_HEADER_HELP_about/> <CRN_HEADER_HOME/> <CRN_HEADER_HOME_setHome/> <CRN_HEADER_OPTIONS_mypages/> <CRN_HEADER_OPTIONS_rs/> <CRN_HEADER_OPTIONS_qs/> <CRN_HEADER_OPTIONS_mm/> <CRN_HEADER_OPTIONS_es/>
<CRN_HEADER_OPTIONS_as/>
<CRN_HEADER_OPTIONS_cc/>
708
Description
Adaptive Analytics link IBM Cognos Connection header (h2). Deprecated Left-hand side of the IBM Cognos Connection header (h2). Deprecated Right-hand side of the IBM Cognos Connection header (h2). Deprecated "home" link. Replaced by <CRN_HEADER_HOME/> "return" link (Cognos Viewer only) "search" link "logon" link "logoff" link "about" link ( Cognos Viewer only). Replaced by <CRN_HEADER_HELP_ about/> "help" link "preferences" link "tools" link. Deprecated "directory" link. Deprecated "capabilities" link. Deprecated "schedule" link. Deprecated "server administration" link. Deprecated Deprecated "content administration" link. Deprecated
<CC_HEADER_TITLE/>
<CC_HEADER_MENU/>
<CC_HEADER_MENU_home/>
Description
"portal administration" link. Deprecated "drill-through definition" link "my preferences" link IBM Cognos Connection header (h3) Left-hand side of the IBM Cognos Connection header (h3) that includes the tabs The page menu button on left-hand side of the portal tabs IBM Cognos Connection header (h4) that includes the path navigation and toolbar Path navigation Toolbar buttons Refresh New Job New Folder New URL
<CC_VIEW_TABS_OPTIONS/>
<CC_TOOLBAR/>
CC_TOOLBAR_BUTTONS_newconfigurationFolder/ New Configuration Folder > <CC_TOOLBAR_BUTTONS_newrole/> <CC_TOOLBAR_BUTTONS_newgroup/> <CC_TOOLBAR_BUTTONS_newnamespaceFolder/> <CC_TOOLBAR_BUTTONS_newdataSource/> <CC_TOOLBAR_BUTTONS_ newdataSourceConnection/>
New Role New Group New Namespace Folder New Data Source New Connection
710
Description
New Contact
<CC_TOOLBAR_BUTTONS_newdistributionList/> New Distribution List <CC_TOOLBAR_BUTTONS_newprinter/> <CC_TOOLBAR_BUTTONS_newadminFolder/> <CC_TOOLBAR_BUTTONS_newportletFolder/> <CC_TOOLBAR_BUTTONS_newcontentTask/> <CC_TOOLBAR_BUTONS_newcmmSystemTask/> <CC_TOOLBAR_BUTTONS_ newimportDeploymentFolder/> <CC_TOOLBAR_BUTTONS_ newexportDeploymentFolder/> <CC_TOOLBAR_BUTTONS_import/> <CC_TOOLBAR_BUTTONS_export/> <CC_TOOLBAR_BUTTONS_cut/> <CC_TOOLBAR_BUTTONS_copy/> <CC_TOOLBAR_BUTTONS_paste/> <CC_TOOLBAR_BUTTONS_delete/> <CC_TOOLBAR_BUTTONS_refresh/> <CC_TOOLBAR_BUTTONS_selectall/> <CC_TOOLBAR_BUTTONS_deselectall/> <CC_TOOLBAR_BUTTONS_list/> <CC_TOOLBAR_BUTTONS_detail/> <CC_TOOLBAR_BUTTONS_properties/> <CC_TOOLBAR_BUTTONS_configuration_ properties/>
New Printer New Admin Folder New Portlet Folder New Content Task New IBM Cognos Metrics Manager task New import deployment folder
New import specification New export Specification Cut Copy Paste Delete Refresh Select all Deselect All List view mode Detailed view mode Current folder properties Configuration folder properties
Description
Order
<CC_TOOLBAR_BUTTONS_deployment_properties/ Deployment Properties > <CC_TOOLBAR_BUTTONS_enable_sched/> <CC_TOOLBAR_BUTTONS_disable_sched/> <CC_TOOLBAR_BUTTONS_view_events/> <CC_TOOLBAR_BUTTONS_page_sizes/> <CC_TOOLBAR_BUTTONS_search/> <CC_TOOLBAR_BUTTONS_add_portet/> <CC_TOOLBAR_BUTTONS_edit_layout/> <CC_TOOLBAR_BUTTONS_new_page/> <CC_TOOLBAR_BUTTONS_delete_page/> <CC_TOOLBAR_BUTTONS_ newmetricsIntegrationTaskGroup/> <CC_TOOLBAR_BUTTONS_newmetricsPackage/> <CC_DIALOG_HEADER/> <CC_DIALOG_HEADER_help/> <CC_RUN_OPTIONS_email_attachment/> <RV_HEADER/> <RV_HEADER_TITLE/> <RV_HEADER_MENU/>
Enable Schedule Disable Schedule View Events Page sizes option in configuration tool Search Add a portlet to custom portal pages Edit the layout of a custom portal page Add a custom portal page Delete a custom portal page New data integration task
New metrics package Not supported "Help" link on dialog screens "Include the report" check box Cognos Viewer header Left hand side of the Cognos Viewer header Right hand side of the Cognos Viewer header "log off" link "logon" link
<RV_HEADER_MENU_LOGOFF/> <RV_HEADER_MENU_LOGON/>
712
Description
"return" link "about" link "home link Not applicable Toolbar options in Cognos Viewer Download toolbar button. This applies when download is enabled. Save toolbar button Save As toolbar button Email toolbar button History toolbar option Run toolbar button HTML format view button PDF format view button XLS format view button CSV format view button XML format view button Excel 2007 format view Excel 2002 format view Excel 2000 format view Excel 2000 single sheet format view Hides the drill down button Hides the drill up button
<RV_TOOLBAR_BUTTONS_SAVE/> <RV_TOOLBAR_BUTTONS_SAVEAS/> <RV_TOOLBAR_BUTTONS_SEND/> <RV_TOOLBAR_BUTTONS_HISTORY/> <RV_TOOLBAR_BUTTONS_RUN/> <RV_TOOLBAR_BUTTONS_HTML/> <RV_TOOLBAR_BUTTONS_PDF/> RV_TOOLBAR_BUTTONS_XLS/> <RV_TOOLBAR_BUTTONS_XLS_CSV/> <RV_TOOLBAR_BUTTONS_XML/> <RV_TOOLBAR_BUTTONS_XLS_SPREADSHEETML/> <RV_TOOLBAR_BUTTONS_XLS_XLWA/> <RV_TOOLBAR_BUTTONS_XLS_XLS/> <RV_TOOLBAR_BUTTONS_XLS_SINGLEXLS/> <RV_TOOLBAR_BUTTONS_DRILLDOWN/> <RV_TOOLBAR_BUTTONS_DRILLUP/>
Description
Hides the go to button Hides the Add this report button Hides the Add to My Bookmarks button Hides the Add to My Folders button Hides the Keep this version button Any choice from the Scope selection in the Schedule Management tool. Entries I Own choice from the Scope selection in the Schedule Management tool. Public Folders choice from the Scope selection in the Schedule Management tool.
<SMT_SCOPE_entries_i_own/>
<SMT_SCOPE_public_folders/>
714
Description
Renders additional options to the right hand side of the IBM Cognos 8 header to the right of the Report Studio link. Only a url, an icon, and a tooltip and label in English are required. Target can be one of _blank, _self, _parent, or _top.
Renders additional options on the right hand side of the IBM Cognos Connection header to the right of the Help link. Only a url and a label in English are required. Target can be one of _blank, _self, _parent, or _top.
Renders additional options to the right of the Help link in dialog boxes.
716
Cognos Navigator
Use this portlet to browse a list of links that open published IBM Cognos reports and other entries. 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 or click Cancel.
Notes:
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
Title
Description
Specifies the title of the portlet. If no title is specified, the folder name is used by default. You can specify a title for each supported language version of the product. Note: The title does not appear in WebSphere, ALUI, and SAP portals.
Language
Specifies the product language version in which the title appears. You can assign the same title for multiple language versions.
Property
Folder View
Description
Specifies the location where the portlet navigation begins. Specifies how entries are shown: To show a list of entry names, use the Navigator list view. This is the default view. To show entry names and detailed information, such as the last modification date, use the Navigator details view. Links open more detailed information about the entry. To show URLs and shortcuts in an RSS-type format, use the News list view. RSS is a way of showing URLs in a Web page as short summaries that contain links to the associated pages.
Open links
Specifies how the links in this portlet are opened. You can open and navigate the linked entries in a new browser window. This is the default option. open and navigate the linked entries in the currently opened browser window. open and navigate the linked entries in a specified HTML frame. Type the name of the window or frame in the provided text box. open and navigate the linked entries in the Cognos Viewer portlet. Type the channel name as specified in Cognos Viewer.
Open navigation links Specifies whether to maximize the portlet view when navigating the folder inside this portlet hierarchy.
718
Property
Features to expose in the Navigator views
Description
Specifies how the IBM Cognos 8 entries are shown in this portlet: To show or hide the parent entry of the starting folder in the IBM Cognos 8 folder hierarchy, use the Parent in path check box. To show or hide the Actions column for the entries, and view the content of container entries in source applications, use the Actions check box. To show or hide the modification date and description of entries in applicable views, use the Additional information check box. To specify in how many columns you want the entries to appear in the details view, use the Number of columns in a details view check box. The default is 2 for the normal portlet view, and 4 for the maximized portlet view. You can specify a different view for normal and maximized windows. Note: The maximized view is not available in SharePoint Portal Server.
Number of entries
Specifies the maximum number of entries to show per page. The menu bar in the portlet shows how many entries are available for a folder.
Separators
Specifies whether separators are used in a list view. To make long lists of entries easier to read, use alternating background colors to separate the entries in the list.
Cognos Search
Use this portlet to find published IBM Cognos reports and other entries. Searches are performed against various types of IBM Cognos entries and folders. Use the advanced search options to perform more complex searches. By default, the search results are shown as links that open entries in a new browser window. You can save your search settings for future use. 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.
Appendix E: User Reference Help for Portal Services 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 or click Cancel.
Notes:
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
Title
Description
Specifies the title of the portlet. If no title is specified, the portlet name is used by default. You can specify a title for each supported language version of the product. Note: The title does not appear in WebSphere, ALUI, and SAP portals.
Language
Specifies the product language version in which the title appears. You can assign the same title for multiple language versions. Specifies the saved results of previous searches. To save your most recent search results, type a name in the Last search box and then click Save. To rename a search, type the new name in the appropriate Saved searches text box. To delete a search, click Delete next to the appropriate Saved searches text box.
Saved searches
Open links
Specifies how the links are opened. You can open and navigate the linked entries in a new browser window. This is the default option open and navigate the linked entries in the currently opened browser window. open the linked entries in a target browser window or frame. Type the name of the window or frame in the provided text box. open and navigate the linked entries in the Cognos Viewer portlet. Type the channel name as specified in Cognos Viewer.
720
Property
Number of results to show per page
Description
Specifies the maximum number of entries to list per page.
Content of entry view Specifies whether to show additional details for the entries in the search results. Use the Show details check box to show the entry modification date. Use the Show actions check box to show the entry actions. For example, you can use this option to view report outputs, run reports with options, open reports for editing, set properties, or set a schedule to run reports directly from the search results view. Search results Specifies how to show the search results. Select the Maximize the view when displaying search results check box when you want to show the results in a maximized view. This is useful when the results list is long.
Notes:
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
Title
Description
Specifies the title of the portlet. If no title is specified, the entry name is used by default. You can specify a title for each supported language version of the product. Note: The title does not appear in WebSphere, ALUI, and SAP portals.
Language
Specifies the product language version in which the title appears. You can assign the same title for multiple language versions. Specifies the location of the entry, such as a report, to display in this portlet. You can search the folders to locate the entry. After you select the entry, the Report Properties link appears. Use this link to access the advanced portlet properties.
Entry
Channel
Enables communication between this portlet and other Cognos portlets. To set up communication between specific portlets, type the same channel name for the portlets that you want to interact. The channel name can contain only letters, numbers, and underscore (_) characters, and must not contain any spaces. For example, Cognos, Cognos_Portlets, or CognosPortlets.
Height (pixels)
Specifies the portlet height in pixels. If the report image is larger than this setting, scroll bars appear when you view the report.
Advanced Properties
Use these properties to override the default Cognos Viewer properties, customize the portlet user interface, and enable interactivity between other portlets in the same page.
Property
Fragment action
Description
Defines the default action when the portlet is invoked in a page. When you select Show a run action, the run button appears in the portlet. When the button is clicked, the report runs. This feature helps to avoid running multiple reports a the same time. When Show most recent saved output is selected and there is no saved report output when the portlet is invoked, you can choose to run the report, or show the run button.
722
Property
Prompt the user
Description
Controls prompted reports in a page or a dashboard. When you select Only when required parameter values are missing, the user is prompted if the report contains required prompts and the values are missing. Otherwise the report runs successfully. When you select Every time, if the report contains optional or required prompts, the user is prompted to enter the prompt values before the report is run. When you select Based on the prompt settings of the report, Cognos Viewer uses the prompts specified in the report. When you select Never and show the report only when required values are provided, Cognos Viewer attempts to run the report, but the page remains hidden until the required prompt values are provided.
Portlet communica- Enables communication between the Cognos Viewer portlets in the same tion options (Prompt page when using prompted reports. values) When you select the Communicate with other portlets check box, communication between this portlet and other portlets that also have this check box selected is enabled. To set up communication between specific portlets, click Portlets using channel and type the channel name. Only the portlets that share the same channel name can interact. By specifying the channel name, you have more control over the page. For example, you can link only reports that have matching parameters. The channel name can contain only letters, numbers, and underscore (_) characters, and must not contain any spaces. For example, sales_reports or AbC are valid channel names.
Property
Drill down and drill up
Description
Enables sharing of drill-down and drill-up actions when a page contains reports based on dimensionally modeled data sources. The item on which the drill action is based must be present in all linked reports in the page. In some cases, the sharing of drill events is not recommended. For example, simultaneous drill requests may have a negative impact on performance. When you select the Communicate with other portlets check box, communication between the portlet and other portlets that also have this check box selected is enabled. To set up communication between specific portlets, click Portlets using channel and type the channel name. Only the portlets that share the channel name can interact. By specifying the channel name, you have more control over the page. For example, you can link only the reports that have matching parameters. The channel name can contain only letters, numbers, and underscore (_) characters, and must not contain any spaces. For example, sales_reports or AbC.
Enables sharing of drill-through actions when a page contains a report with an authored drill-through path. You must select the Communicate with other portlets on the page check box, and type the channel name in the box provided. Only the portlets that share the channel name can interact. The channel name can contain only letters, numbers, and underscore (_) characters, and must not contain any spaces. For example, sales_reports or AbC are valid channel names.
View Options (Show Specify whether the portlet toolbar should appear in the normal or Toolbar) maximized view. The toolbar contains the edit button, help button, and refresh button.
Cognos Viewer
Use this portlet to view and interact with published IBM Cognos reports and other entries in your portal. 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.
724
Appendix E: User Reference Help for Portal Services 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 or click Cancel.
Notes:
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
Title
Description
Specifies the title of the portlet. If no title is specified, the entry name is used by default. You can specify a title for each supported language version of the product. Note: The title does not appear in WebSphere, ALUI, and SAP portals.
Language
Specifies the product language version in which the title appears. You can assign the same title for multiple language versions. Specifies the location of the entry, such as a report, to display in this portlet. You can search the folders to locate the entry.
Entry
Channel
Enables communication between this portlet and other Cognos portlets. To set up communication between specific portlets, type the same channel name for the portlets that you want to interact. The channel name can contain only letters, numbers, and underscore (_) characters, and must not contain any spaces. For example, Cognos, Cognos_Portlets, or CognosPortlets.
Portlet action
Specifies the report run options. You can choose to show the most recent saved report output, show a run option button that a user can activate, or run the report. Specifies whether to show the portlet toolbar in the normal or maximized view. This applies to reports only. Note: The maximized view is not available in SharePoint Portal Server.
Show toolbar
Property
Description
Portlet width in pixels Specifies the portlet width in pixels. If the report image is larger than this setting, scroll bars appear when you view the report. Portlet height in pixels Specifies the portlet height in pixels. If the report is larger than this setting, scroll bars appear when you view the report.
Notes:
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
Application Options
Description
Specifies an application to show in the portlet. Some extended applications include application parameters that you can configure. These parameters affect how the application operates.
Metric List
Use this portlet to add performance metrics to a page. The metrics are created in Metric Studio. You can configure the portlet to show different types of metric lists, such as a watch list, an accountability list, a scorecard, or a strategy list. However, if the Metrics Custom Diagram portlet
726
Appendix E: User Reference Help for Portal Services in a page uses the same channel, the configured metric list may not appear. Instead, a strategy metric list of the Metrics Custom Diagram portlet appears. To see the configured metric list, click Back to default entry. This portlet is interactive. When you click a metric name, the content of the Metric History Chart and Cognos Viewer portlets using the same channel is automatically updated. When you position a pointer over a metric icon, a tooltip appears that shows the history chart associated with the metric. When you click the arrow button , the metric opens in Metric Studio. When you position a pointer over the comment icon for a metric or a strategy, the tooltip shows the latest comment. 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 or click Cancel.
Notes:
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
Title
Description
Specifies the title of the portlet. You can use the default metric list name, or type a new name. If no title is specified, the portlet name is used. You can specify a title for each supported language version of the product. Note: The title does not appear in WebSphere, ALUI, and SAP portals.
Language
Specifies the product language version in which the title appears. You can assign the same title for multiple language versions.
Show title in content area Shows the title in content area of the portlet. This option is useful when the portal does not show the title bar. Metric package Specifies a metric package that contains the metrics.
Property
List type
Description
Use to add performance metrics to a page. You can configure the portlet to show the following types of metric lists: Watch List Contains the metrics that a user wants to monitor closely. Accountability List Contains the metrics that a user owns. Scorecard metric list Contains the metrics included in a scorecard. Strategy metric list Contains metrics associated to a strategy. The metrics can befiltered by a specified scorecard. To select a scorecard, use the Apply a scorecard filter check box. If no scorecard is selected, all metrics in the strategy are shown.
Enables communication between this portlet, the Cognos Viewer portlet, and other Cognos Metrics portlets. When you select the Communicate with other portlets check box, communication between this portlet and other portlets that also have this check box selected is enabled. To set up communication between specific portlets, click Portlets using channel and type the channel name. Only the portlets that share the same channel name can interact. The channel name can contain only letters, numbers, and underscore (_) characters, and must not contain any spaces. For example, sales_reports or AbC are valid channel names.
Number of entries
Specify the maximum number of metrics displayed in the list. For a strategy metric list, and lists viewed with grouping enabled, this value is ignored. Valid range is 1 to 1000.
728
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 or click Cancel.
Notes:
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
Title
Description
Specifies the title of the portlet. Select the Use the entry name check box if you want to use the name of a metric associated with the history chart as a title. If no title is specified, the portlet name is used by default. You can specify a title for each supported language version of the product. Note: The title does not appear in WebSphere, ALUI, and SAP portals.
Language
Specifies the product language version in which the title appears. You can assign the same title for multiple language versions. Shows the title in content area of the portlet. This option is useful when the portal does not show the title bar.
Portlet communication Enables communication between this portlet, the Cognos Viewer portlet, options and other Cognos Metrics portlets. When you select the Communicate with other portlets check box, communication between this portlet and other portlets that also have this check box selected is enabled. To set up communication between specific portlets, click Portlets using channel and type the channel name. Only the portlets that share the same channel name can interact. The channel name can contain only letters, numbers, and underscore (_) characters, and must not contain any spaces. For example, sales_reports or AbC are valid channel names. Image Width Specifies the image width in pixels. The range is 350 to 1000 pixels.
Property
Image Height
Description
Specifies the image height in pixels. The range is 100 to 1000 pixels.
Notes:
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
Title
Description
Specifies the title of the portlet. Select the Use the entry name check box if you want to use the name of a metric associated with the impact diagram as a title. If no title is specified, the portlet name is used by default. You can specify a title for each supported language version of the product. Note: The title does not appear in WebSphere, ALUI, and SAP portals.
Language
Specifies the product language version in which the title appears. You can assign the same title for multiple language versions.
730
Property
Show title in content area
Description
Shows the title in content area of the portlet. This option is useful when the portal does not show the title bar.
Portlet communication Enables communication between this portlet, the Cognos Viewer portlet, options and other Cognos Metrics portlets. When you select the Communicate with other portlets check box, communication between this portlet and other portlets that also have this check box selected is enabled. To set up communication between specific portlets, click Portlets using channel and type the channel name. Only the portlets that share the same channel name can interact. The channel name can contain only letters, numbers, and underscore (_) characters, and must not contain any spaces. For example, sales_reports or AbC are valid channel names. Image Width Image Height Specifies the image width in pixels. The range is 100 to 2000 pixels. Specifies the image height in pixels. The range is 100 to 2000 pixels.
Notes:
In SAP Enterprise Portal, portlets are named iViews. This document may refer to iViews as portlets.
Appendix E: User Reference Help for Portal Services 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
Title
Description
Specifies the title of the portlet. Select the Use the entry name check box if you want to use the scorecard name as a title. If no title is specified, the portlet name is used by default. You can specify a title for each supported language version of the product. Note: The title does not appear in WebSphere, ALUI, and SAP portals.
Language
Specifies the product language version in which the title appears. You can assign the same title for multiple language versions. Shows the title in content area of the portlet. This option is useful when the portal does not show the title bar. Specifies a metric package that contains the scorecard. Specifies the scorecard associated with the configured metric package.
Portlet communication Enables communication between this portlet, the Cognos Viewer portlet, options and other Cognos Metrics portlets. When you select the Communicate with other portlets check box, communication between this portlet and other portlets that also have this check box selected is enabled. To set up communication between specific portlets, click Portlets using channel and type the channel name. Only the portlets that share the same channel name can interact. The channel name can contain only letters, numbers, and underscore (_) characters, and must not contain any spaces. For example, sales_reports or AbC are valid channel names. Image Width Image Height Specifies the image width in pixels. The range is 100 to 2000 pixels. Specifies the image height in pixels. The range is 100 to 2000 pixels.
Bookmarks Viewer
Use this portlet to register and show active Web links in a page.
732
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 or click Cancel.
The following table shows the properties that you can change.
Property
Title
Description
Specifies the title of the portlet. If no title is specified, the name Bookmarks Viewer is used by default. You can specify a title for each supported language version of the product.
Language
Specifies the product language version in which the title appears. You can assign the same title for multiple language versions. Specifies the URL address of the Web page you want to register. You can type an alias next to the URL. The alias will be shown in the portlet instead of the URL. To add boxes for new URLs, click Add a bookmark line. To delete URLs, select the associated check box and click Delete.
Bookmarks
Open links
Specifies how the links in this portlet are opened. You can open and navigate the linked entries in a new browser window. This is the default option open and navigate the linked entries in the currently opened browser window. open the linked entries in a target browser window or frame. Type the name of the window or frame in the provided text box. open and navigate the linked entries in the HTML Viewer portlet. Type the channel name as specified in HTML Viewer.
HTML Viewer
Use this portlet to insert any Web page into a page. The Web page is specified by a URL address.
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 or click Cancel.
The following table shows the properties that you can change.
Property
Title
Description
Specifies the title of the portlet. If no title is specified, the Web page URL address is used by default. You can specify a title for each supported language version of the product.
Language
Specifies the product language version in which the title appears. You can assign the same title for multiple language versions. Specifies the URL address of the Web page you want to insert in the portlet. Enables communication between this portlet and other Cognos Utility portlets in a page. The portlets can communicate using the default, empty channel. To set up communication between specific portlets, type the same channel name for the portlets that you want to interact. The channel name can contain only letters, numbers, and underscore (_) characters, and must not contain any spaces. For example, Cognos, Cognos_Portlets, or CognosPortlets.
HTML content
Channel name
Portlet height in pixels Specifies the portlet height in pixels. If the report image is larger than this setting, scroll bars appear when you view the report.
Image Viewer
Use this portlet to insert an image into a page. The image must be a single file that is accessible by a URL address. The image can also be used as a link. 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.
734
Appendix E: User Reference Help for Portal Services 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 or click Cancel.
The following table shows the properties that you can change.
Property
Title
Description
Specifies the title of the portlet. If no title is specified, the image URL address is used by default. You can specify a title for each supported language version of the product.
Language
Specifies the product language version in which the title appears. You can assign the same title for multiple language versions. Specifies the location of the image. Type the associated URL address.
Image
Target URL
Specifies the Web page where a link to the image or the image appears. Type the appropriate URL address.
Open links
Specifies how the links in this portlet are opened. You can open and navigate the linked entries in a new browser window. This is the default option open and navigate the linked entries in the currently opened browser window. open the linked entries in a target browser window or frame. Type the name of the window or frame in the provided text box open and navigate the linked entries in the HTML Viewer portlet. Type the channel name as specified in HTML Viewer.
Image size
Specifies the size of the image. You can leave the original size of the image, or customize the image by changing its height and width. You can also tile the image.
RSS Viewer
Use this portlet to show the content of a Real Simple Syndication (RSS) 1.0 or 2.0 news feed specified by a URL address. RSS is a format for syndicating news and is used by many Web sites to publish frequently updated content. Administration and Security Guide 735
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 or click Cancel.
The following table shows the properties that you can change.
Property
Title
Description
Specifies the title of the portlet. If no title is specified, the Web page URL address is used by default. You can specify a title for each supported language version of the product.
Language
Specifies the product language version in which the title appears. You can assign the same title for multiple language versions. Specifies the URL address that identifies the RSS channel feed. The RSS channel includes a list of links to specific Web pages. The links may include a title and a short description of the linked story.
URL
Features to expose
Specifies how the entries in this portlet are shown. Use the Show details option to include a description of an entry. Use the Show the RSS channel signature option to include an image, such as a logo, associated with the entry. Use the Alternating backgrounds option to separate entries in long lists with different background colors to make the entries easier to read.
Open links
Specifies how the links in RSS Viewer are opened. You can open and navigate the linked entries in a new browser window. This is the default option. open and navigate the linked entries in the currently opened browser window. open the linked entries in a target browser window or frame. Type the name of the window or frame in the provided text box. open and navigate the linked entries in the HTML Viewer portlet. Type the channel name as specified in HTML Viewer.
736
Property
Maximum displayed entries
Description
Specifies the maximum number of URLs to display in the portlet.
HTML Source
Use this portlet to insert custom text and images into a page. This portlet adds a Freeform HTML code to the page, as typed by the user. For security reasons, the HTML tags that could pose a cross-site scripting threat, or break the integrity of the page, are not supported. If invalid HTML code is added, the portlet may not render it successfully. In this situation, you may need to delete the portlet from the page and start again. For more information about supported tags, see the table in this section. 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 or click Cancel.
The following table shows the properties used to configure this portlet.
Property
Title
Description
Specifies the title of the portlet. If no title is specified, the Web page URL address is used by default. You can specify a title for each supported language version of the product.
Language
Specifies the product language version in which the title appears. You can assign the same title for multiple language versions.
Property
HTML Code
Description
Specifies the HTML code to render in the view mode of the portlet. The code can be in any supported language. Type valid HTML code that contains: supported HTML tags The following tags are not supported: <BODY>, </BODY>, <FORM>, </FORM>, <HTML>, </HTML> These tags are filtered and removed from the code. <HEAD>, </HEAD>, <FRAMESET>, </FRAMESET>, <FRAME></FRAME> These tags are filtered and removed from the code including the content between the start and end tags. <script> JavaScript is not supported. supported attributes for the tags matching start and end tags Ensure that all start tags have matching end tags. When the start and end tags are not matched, the missing tag is removed, but the content remains. absolute URLs in references to images and external resources, such as CSS files The URLs must include server names. Relative URLs are not supported. Note: You must have the required permissions for the Styles and portlets secured feature in IBM Cognos 8 to access this property
Multi-page
Use this portlet to create a dashboard with multiple tabs. 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 or click Cancel.
738
Appendix E: User Reference Help for Portal Services The following table shows the properties that you can change.
Property
Title
Description
Specifies the title of the portlet. If no title is specified, the Web page URL address is used by default. You can specify a title for each supported language version of the product.
Language
Specifies the product language version in which the title appears. You can assign the same title for multiple language versions. Specifies a folder or package in Public Folders where the entries for the portlet tabs reside. The entries can be pages, reports, shortcuts, folders, and so on. Specifies how the tabs appear in the dashboard: horizontally at the top of the page, or vertically on the left side of the page. Shows the icons that represent the type of entry in each tab. For example, if the entry is a shortcut, the shortcut icon will be included in the tab. Specifies the default width in pixels for vertical tabs. Specifies whether to show the tab menu button in the top, left side of the page. The tab menu is used to add, delete, and reorder the page tabs, and to edit the page.
Display Style
740
There are also code samples that show how you can use elements in a command block.
Symbol
Plus sign (+)
Meaning
The preceding element may be repeated more than once but must occur at least once. The preceding element is optional. It may be absent or it may occur exactly once. An asterisk (*) after an element specifies that the element is optional. It may occur zero or more times. If an element has no plus sign (+), question mark (?), or asterisk (*) following it, the element must occur only once. Parentheses group elements. Element groups are controlled using the same symbols as elements. A bar (|) between elements specifies that one of the listed elements must be present.
Asterisk (*)
None
Parentheses
Bar (|)
Symbol
Comma (,)
Meaning
The elements that it separates must be present in the specified order.
commandBlock
Defines a group of commands that the database runs when specific events occur. This is the root element of the schema.
commands
Specifies the set of commands that the database runs. The commands run in the order that they appear within the commandBlock.
sessionStartCommand
Defines a command used to begin a proxy session in the database.
742
Appendix F: Schema for Data Source Commands There should be only one sessionStartCommand per commandBlock. If the commandBlock contains more than one sessionStartCommand, only the last one will be used to create a proxy session.
sessionEndCommand
Defines a command used to terminate a proxy session in the database. If no sessionEndCommand is supplied, the proxy session will be terminated upon disconnecting from the database.
arguments
Specifies the argument values to be used with the command.
argument
Defines an argument value for a call to a database API.
setCommand
This element is reserved for future use.
sqlCommand
Defines a command that represents a native SQL statement to be run by the database.
sql
Specifies the SQL statement for the database to run. The SQL statement must be in native SQL.
name
Identifies the argument to be set. Administration and Security Guide 745
Appendix F: Schema for Data Source Commands The value of the name element must be one of: OCI_ATTR_USERNAME OCI_ATTR_PASSWORD
value
Specifies the value to be used for the argument.
746
748
If you have created your own log database model, you must add the prefix "COGIPF" to the column names of the logging database tables in the model.
Table Definitions
Log messages are recorded in a table in the logging database under certain conditions. These conditions depend on the logging level that you configure in the Web portal. For information about logging levels, see "Log Messages" (p. 80). When a user logs on to IBM Cognos 8, a session ID is assigned and recorded in all log messages. You can use the session ID to identify all actions performed by a user. The database table definitions that are created in the logging database are described in the following table, with a cross-reference to associated column definitions.
Table Name
COGIPF_ACTION (p. 752)
Description
Stores information about operations performed on objects Stores user logon and logoff information Stores information about queries that IBM Cognos 8 makes to other components Stores parameter information logged by a component Stores information about job runs Stores information about job step runs
Table Name
COGIPF_RUNREPORT (p. 759) COGIPF_VIEWREPORT (p. 763) COGIPF_EDITQUERY (p. 761) COGIPF_AGENTBUILD (p. 764) COGIPF_AGENTRUN (p. 766)
Description
Stores information about report runs Stores information about report view requests Stores information about query runs Stores information about agent mail delivery Stores information about agent activity including tasks and delivery
COGIPF_THRESHOLD _VIOLATIONS Stores information about threshold violations for system (p. 766) metrics
Table Interactions
An example of table interactions is shown in the following diagram. Your audit sample may be different depnding on your needs.
750
(1)
COGIPF_ACTION
COGIPF_NATIVEQUERY
COGIPF_VIEWREPORT
COGIPF_AGENTBUILD
COGIPF_AGENTRUN
COGIPF_PARAMETER
COGIPF_RUNREPORT
COGIPF_USERLOGON
COGIPF_RUNJOB
(2)
COGIPF_RUNJOBSTEP
COGIPF_EDITQUERY
1.
Interactions with COGIPF_PARAMETER are COGIPF_REQUESTID= COGIPF_REQUESTID Interactions with COGIPF_USERLOGON are COGIPF_SESSIONID= COGIPF_SESSIONID
2.
COGIPF_REQUESTID= COGIPF_REQUESTID
COGIPF_ACTION Table
The COGIPF_ACTION table contains the following columns.
Column name
COGIPF_HOST_ IPADDR
Description
Data type
The host IP address where the log message VARCHAR2 (15) is generated The host port number NUMBER
The process ID assigned by the operating NUMBER system The local date and time when the log mes- DATE sage was generated NUMBER
COGIPF_LOCAL TIMESTAMP
COGIPF_TIMEZONE_ OFF- The time zone, offset from GMT SET COGIPF_SESSIONID COGIPF_ REQUESTID The identification number of the session The identification number of the request
COGIPF_STEPID
The identification number for the step within a job run (empty if there is none)
COGIPF_ SUBREQUESTID
The identification number of the compon- VARCHAR2 (255) ent subrequest The identification number of the thread where the request is run VARCHAR2 (255)
COGIPF_THREADID
COGIPF_ COMPONENTID The name of the component that generates VARCHAR2 (4) the indication COGIPF_ BUILDNUMBER The major build number for the component NUMBER that generates the indication The level of the indication The action performed on the object The object on which the operation is run NUMBER VARCHAR2 (255) VARCHAR2 (255)
752
Column name
COGIPF_ TARGET_PATH COGIPF_STATUS
Description
The target object path
Data type
VARCHAR2 (512)
The status of the operation: blank if execu- VARCHAR2 (255) tion has not completed, success, warning, or failure VARCHAR2 (2000)
COGIPF_USERLOGON Table
The COGIPF_USERLOGON table contains the following columns.
Column name
COGIPF_ HOST_IPADDR
Description
Data type
The host IP address where the log message VARCHAR2 (15) is generated The host port number NUMBER
The process ID assigned by the operating NUMBER system The local date and time when the log mes- DATE sage was generated NUMBER
COGIPF_ LOCALTIMESTAMP
COGIPF_TIMEZONE_ OFF- The time zone, offset from GMT SET COGIPF_SESSIONID COGIPF_REQUESTID The identification number of the session The identification number of the request
COGIPF_STEPID
The identification number for the step within a job run (empty if there is none)
COGIPF_ SUBREQUESTID
The identification number of the compon- VARCHAR2 (255) ent subrequest The identification number of the thread where the request is run VARCHAR2 (255)
COGIPF_THREADID
Column name
Description
Data type
COGIPF_ COMPONENTID The name of the component that generates VARCHAR2 (4) the indication COGIPF_ BUILDNUMBER The major build number for the component NUMBER that generates the indication The level of the indication NUMBER
COGIPF_LOG_LEVEL COGIPF_STATUS
The status of the operation: blank, success, VARCHAR2 (255) warning, or failure VARCHAR2 (2000) VARCHAR2 (255)
COGIPF_ LOGON_OPERA- Logon, logoff, or logon expired TION COGIPF_USERNAME COGIPF_USERID COGIPF_ NAMESPACE The display name of the user The username of the user The namespace display name
COGIPF_NATIVEQUERY Table
The COGIPF_NATIVEQUERY table contains the following columns.
Column name
COGIPF_HOST_ IPADDR
Description
Data type
The host IP address where the log message VARCHAR2 (15) is generated The host port number NUMBER
The process ID assigned by the operating NUMBER system The local date and time when the log mes- DATE sage was generated NUMBER
COGIPF_ LOCALTIMESTAMP
COGIPF_TIMEZONE_ OFF- The time zone, offset from GMT SET COGIPF_SESSIONID The identification number of the session
VARCHAR2 (255)
754
Column name
COGIPF_REQUESTID
Description
The identification number of the request
Data type
VARCHAR2 (255) NOT NULL VARCHAR2 (255)
COGIPF_STEPID
The identification number for the step within a job run (empty if there is none)
COGIPF_ SUBREQUESTID
The identification number of the compon- VARCHAR2 (255) ent subrequest The identification number of the thread where the request is run VARCHAR2 (255)
COGIPF_THREADID
COGIPF_ COMPONENTID The name of the component that generates VARCHAR2 (4) the indication COGIPF_ BUILDNUMBER The major build number for the component NUMBER that generates the indication The level of the indication NUMBER NTEXT
COGIPF_LOG_LEVEL
COGIPF_PARAMETER Table
The COGIPF_PARAMETER table contains the following columns.
Column name
COGIPF_REQUESTID
Description
The identification number of the request
Data type
VARCHAR2 (255) UNIQUE NOT NULL VARCHAR2 (255)
COGIPF_STEPID
The identification number for the step within a job run (empty if there is none) The action performed on the object The object on which the operation is run The name of the parameter logged by a component
Column name
COGIPF_ PARAMETER_VALUE
Description
The value of the parameter logged by a component
Data type
VARCHAR2 (512)
COGIPF_RUNJOB Table
The COGIPF_RUNJOB table contains the following columns.
Column name
COGIPF_HOST_ IPADDR
Description
Data type
The host IP address where the log message VARCHAR2 (15) is generated The host port number NUMBER
COGIPF_HOST_PORT COGIPF_PROC_ID
The process ID assigned by the operating NUMBER system The local date and time when the log mes- DATE sage was generated While the report is executing, this is the time that the report execution started. After the report execution is complete, this is the end time of report execution. To check if execution is complete, see COGIPF_STATUS. A blank entry means an incomplete execution. A filled entry means execution completed. To calculate the execution start time for a report that has already completed execution, subtract COGIPF_RUNTIME from COGIPF_LOCALTIMESTAMP.
COGIPF_ LOCALTIMESTAMP
COGIPF_TIMEZONE_ OFF- The time zone, offset from GMT SET COGIPF_SESSIONID COGIPF_REQUESTID The identification number of the session The identification number of the request
NUMBER
COGIPF_STEPID
The identification number for the step within a job run (empty if there is none)
756
Column name
COGIPF_ SUBREQUESTID
Description
Data type
The identification number of the compon- VARCHAR2 (255) ent subrequest The identification number of the thread where the request is run VARCHAR2 (255)
COGIPF_THREADID
COGIPF_ COMPONENTID The name of the component that generates VARCHAR2 (4) the indication COGIPF_ BUILDNUMBER The major build number for the component NUMBER that generates the indication The level of the indication The object on which the operation is run The job path NUMBER VARCHAR2 (255) VARCHAR2 (512)
The status of the operation: blank, success, VARCHAR2 (255) warning, or failure VARCHAR2 (2000)
COGIPF_RUNTIME
COGIPF_RUNJOBSTEP Table
The COGIPF_RUNJOBSTEP table contains the following columns.
Column name
COGIPF_HOST_ IPADDR
Description
Data type
The host IP address where the log message VARCHAR2 (15) is generated The host port number NUMBER
COGIPF_HOST_PORT COGIPF_PROC_ID
Column name
COGIPF_ LOCALTIMESTAMP
Description
Data type
The local date and time when the log mes- DATE sage was generated While the report is executing, this is the time that the report execution started. After the report execution is complete, this is the end time of report execution. To check if execution is complete, see COGIPF_STATUS. A blank entry means an incomplete execution. A filled entry means execution completed. To calculate the execution start time for a report that has already completed execution, subtract COGIPF_RUNTIME from COGIPF_LOCALTIMESTAMP.
COGIPF_ TIMEZONE_OFF- The time zone, offset from GMT SET COGIPF_SESSIONID COGIPF_REQUESTID The identification number of the session The identification number of the request
NUMBER
COGIPF_STEPID
The identification number for the step within a job run (empty if there is none)
COGIPF_ SUBREQUESTID
The identification number of the compon- VARCHAR2 (255) ent subrequest The identification number of the thread where the request is run VARCHAR2 (255)
COGIPF_THREADID
COGIPF_ COMPONENTID The name of the component that generates VARCHAR2 (4) the indication COGIPF_ BUILDNUMBER The major build number for the component NUMBER that generates the indication The level of the indication The object on which the operation is run NUMBER VARCHAR2 (255)
758
Column name
COGIPF_ JOBSTEPPATH COGIPF_STATUS
Description
The job step path
Data type
VARCHAR2 (512)
The status of the operation: blank, success, VARCHAR2 (255) warning, or failure VARCHAR2 (2000) NUMBER
COGIPF_RUNTIME
COGIPF_RUNREPORT Table
The COGIPF_RUNREPORT table contains the following columns.
Column name
COGIPF_ HOST_IPADDR
Description
Data type
The host IP address where the log message VARCHAR2 (15) is generated The host port number NUMBER
COGIPF_HOST_PORT COGIPF_PROC_ID
The process ID assigned by the operating NUMBER system The local date and time when the log mes- DATE sage was generated While the report is executing, this is the time that the report execution started. After the report execution is complete, this is the end time of report execution. To check if execution is complete, see COGIPF_STATUS. A blank entry means an incomplete execution. A filled entry means execution completed. To calculate the execution start time for a report that has already completed execution, subtract COGIPF_RUNTIME from COGIPF_LOCALTIMESTAMP.
COGIPF_ LOCALTIMESTAMP
NUMBER
Column name
COGIPF_SESSIONID COGIPF_REQUESTID
Description
The identification number of the session The identification number of the request
Data type
VARCHAR2 (255) VARCHAR2 (255) UNIQUE NOT NULL VARCHAR2 (255)
COGIPF_STEPID
The identification number for the step within a job run (empty if there is none)
COGIPF_ SUBREQUESTID
The identification number of the compon- VARCHAR2 (255) ent subrequest The identification number of the thread where the request is run VARCHAR2 (255)
COGIPF_THREADID
COGIPF_ COMPONENTID The name of the component that generates VARCHAR2 (4) the indication COGIPF_ BUILDNUMBER The major build number for the component NUMBER that generates the indication The level of the indication NUMBER
The object on which the operation is run. VARCHAR2 (255) The values include: ReportService is an interactive report PromptForward ReportService is a report generated after a prompt PromptBackward ReportService is a report generated after the user moved to the previous prompt page BatchReportService is a batch or scheduled run report VARCHAR2 (1024)
COGIPF_ REPORTPATH
COGIPF_STATUS
The status of the operation: blank, success, VARCHAR2 (255) warning, or failure
760
Column name
Description
Data type
VARCHAR2 (2000) NUMBER
COGIPF_RUNTIME
The number of milliseconds it took the report to run The name of the report that was run The package that the report is associated with
COGIPF_MODEL
COGIPF_EDITQUERY Table
The COGIPF_EDITQUERY table contains the following columns.
Column name
COGIPF_ HOST_IPADDR
Description
Data type
The host IP address where the log message VARCHAR2 (15) is generated The host port number NUMBER
COGIPF_HOST_PORT COGIPF_PROC_ID
The process ID assigned by the operating NUMBER system The local date and time when the log mes- DATE sage was generated While the report is executing, this is the time that the report execution started. After the report execution is complete, this is the end time of report execution. To check if execution is complete, see COGIPF_STATUS. A blank entry means an incomplete execution. A filled entry means execution completed. To calculate the execution start time for a report that has already completed execution, subtract COGIPF_RUNTIME from COGIPF_LOCALTIMESTAMP.
COGIPF_ LOCALTIMESTAMP
Column name
Description
Data type
NUMBER
COGIPF_TIMEZONE_ OFF- The time zone, offset from GMT SET COGIPF_SESSIONID COGIPF_REQUESTID The identification number of the session The identification number of the request
COGIPF_STEPID
The identification number for the step within a job run (empty if there is none)
COGIPF_ SUBREQUESTID
The identification number of the compon- VARCHAR2 (255) ent subrequest The identification number of the thread where the request is run VARCHAR2 (255)
COGIPF_THREADID
COGIPF_ COMPONENTID The name of the component that generates VARCHAR2 (4) the indication COGIPF_ BUILDNUMBER The major build number for the component NUMBER that generates the indication The level of the indication The object on which the operation is run The report path NUMBER VARCHAR2 (255) VARCHAR2 (1024)
COGIPF_STATUS
The status of the operation: blank, success, VARCHAR2 (255) warning, or failure VARCHAR2 (2000) NUMBER
COGIPF_RUNTIME
The number of milliseconds it took the query to run The name of the report that was queried The package that the report is associated with
762
Column name
COGIPF_MODEL
Description
Data type
COGIPF_VIEWREPORT Table
The COGIPF_VIEWREPORT table contains the following columns.
Column name
COGIPF_ HOST_IPADDR
Description
Data type
The host IP address where the log message VARCHAR2 (15) is generated The host port number NUMBER
COGIPF_HOST_PORT COGIPF_PROC_ID
The process ID assigned by the operating NUMBER system The local date and time when the log mes- DATE sage was generated While the report is executing, this is the time that the report execution started. After the report execution is complete, this is the end time of report execution. To check if execution is complete, see COGIPF_STATUS. A blank entry means an incomplete execution. A filled entry means execution completed. To calculate the execution start time for a report that has already completed execution, subtract COGIPF_RUNTIME from COGIPF_LOCALTIMESTAMP.
COGIPF_ LOCALTIMESTAMP
COGIPF_TIMEZONE_ OFF- The time zone, offset from GMT SET COGIPF_SESSIONID COGIPF_REQUESTID The identification number of the session The identification number of the request
NUMBER
COGIPF_STEPID
The identification number for the step within a job run (empty if there is none)
Column name
COGIPF_ SUBREQUESTID
Description
Data type
The identification number of the compon- VARCHAR2 (255) ent subrequest The identification number of the thread where the request is run VARCHAR2 (255)
COGIPF_THREADID
COGIPF_ COMPONENTID The name of the component that generates VARCHAR2 (4) the indication COGIPF_BUILDNUMBER The major build number for the component NUMBER that generates the indication The level of the indication The object on which the operation is run The report path NUMBER VARCHAR2 (255) VARCHAR2 (1024)
COGIPF_STATUS
The status of the operation: blank, success, VARCHAR2 (255) warning, or failure VARCHAR2 (2000) NUMBER
COGIPF_RUNTIME
The number of milliseconds it took the query to run The name of the report that was viewed The package with which the report is associated
COGIPF_AGENTBUILD Table
The COGIPF_AGENTBUILD table contains the following columns.
764
Column name
COGIPF_ HOST_IPADDR
Description
Data type
The host IP address where the log message VARCHAR2 (15) is generated The host port number NUMBER
COGIPF_HOST_PORT COGIPF_PROC_ID
The process ID assigned by the operating NUMBER system The local date and time when the log mes- DATE sage was generated NUMBER
COGIPF_ LOCALTIMESTAMP
COGIPF_TIMEZONE_OFF- The time zone, offset from GMT SET COGIPF_SESSIONID COGIPF_REQUESTID The identification number of the session The identification number of the request
COGIPF_STEPID
The identification number for the step within a job run (empty if there is none)
COGIPF_ SUBREQUESTID
The identification number of the compon- VARCHAR2 (255) ent subrequest The identification number of the thread where the request is run VARCHAR2 (255)
COGIPF_THREADID
COGIPF_ COMPONENTID The name of the component that generates VARCHAR2 (4) the indication COGIPF_BUILD NUMBER The major build number for the component NUMBER that generates the indication The level of the indication The operation The object on which the operation is run NUMBER VARCHAR2 (128) VARCHAR2 (255) VARCHAR2 (512)
Column name
COGIPF_ TARGET_PATH
Description
The target path
Data type
VARCHAR2 (1024)
COGIPF_STATUS
The status of the operation: blank, success, VARCHAR2 (255) warning, or failure VARCHAR2 (2000) VARCHAR2 (1024) INTEGER VARCHAR2 (512) VARCHAR2 (512)
COGIPF_AGENT_ PATH
COGIPF_ SCHEDULETIME The target schedule time COGIPF_USER COGIPF_EMAIL The user who created the agent The email address
COGIPF_AGENTRUN Table
The COGIPF_AGENTRUN table contains the following columns.
Column name
COGIPF_ HOST_IPADDR
Description
Data type
The host IP address where the log message VARCHAR2 (15) is generated The host port number NUMBER
COGIPF_HOST_PORT COGIPF_PROC_ID
The process ID assigned by the operating NUMBER system The local date and time when the log mes- DATE sage was generated NUMBER
COGIPF_ LOCALTIMESTAMP
COGIPF_TIMEZONE_OFF- The time zone, offset from GMT SET COGIPF_SESSIONID COGIPF_REQUESTID The identification number of the session The identification number of the request
766
Column name
COGIPF_STEPID
Description
The identification number for the step within a job run (empty if there is none)
Data type
VARCHAR2 (255)
COGIPF_ SUBREQUESTID
The identification number of the compon- VARCHAR2 (255) ent subrequest The identification number of the thread where the request is run VARCHAR2 (255)
COGIPF_THREADID
COGIPF_ COMPONENTID The name of the component that generates VARCHAR2 (4) the indication COGIPF_BUILD NUMBER The major build number for the component NUMBER that generates the indication The level of the indication The operation The object on which the operation is run The target path NUMBER VARCHAR2 (128) VARCHAR2 (255) VARCHAR2 (1024)
COGIPF_STATUS
The status of the operation: blank, success, VARCHAR2 (255) warning, or failure VARCHAR2 (2000) VARCHAR2 (1024) INTEGER VARCHAR2 (512) VARCHAR2 (512) VARCHAR2 (512)
COGIPF_AGENTPATH
COGIPF_ SCHEDULETIME The target schedule time COGIPF_TARGET_ NAME The target name COGIPF_USER COGIPF_EMAIL The user who created the agent The email address
COGIPF_THRESHOLD_VIOLATIONS Table
The COGIPF_THRESHOLD_VIOLATIONS table contains the following columns. For more information, see "System Performance Metrics" (p. 91).
Column name
COGIPF_ HOST_IPADDR
Description
Data type
The host IP address where the log message VARCHAR2 (15) is generated The host port number NUMBER
COGIPF_HOST_PORT COGIPF_PROC_ID
The process ID assigned by the operating NUMBER system The local date and time when the log mes- DATE sage was generated NUMBER
COGIPF_ LOCALTIMESTAMP
The identification number of the compon- VARCHAR2 (255) ent The identification number of the build NUMBER
COGIPF_BUILDNUMBER COGIPF_LOG_LEVEL
The logging level. Should always be 1 to NUMBER ensure that threshold violation information is available. A threshold for the metric has been crossed VARCHAR2 (255) The target type The target name The target path of the dispatcher that conatins the threshold manager VARCHAR2 (255) VARCHAR2 (4) VARCHAR2 (1024) VARCHAR2 (255)
COGIPF_ RESOURCE_PATH The path of the resource that exceeded the VARCHAR2 threshold value (2000) COGIPF_METRIC_NAME The name of the metric VARCHAR2 (1024)
768
Column name
Description
Data type
VARCHAR2 (1024)
The status of the metric: good, average, or VARCHAR2 (512) poor The lower average threshold setting. If COGIPF_LOWER_AVG_THRSHLD_ XCL is 1, the metric score is average when the metric is less than this threshold setting. The metric score is good when the metric is greater than or equal than this value. If COGIPF_LOWER_AVG_THRSHLD_ XCL is 0 (zero), the metric score is average when the metric is less than or equal to this value. The metric score is good when the metric is greater than this value. VARCHAR2 (512)
COGIPF_LOWER_AVG_ THRSHLD_XCL
The flag that indicates if the threshold set- BOOLEAN ting in COGIPF_LOWER_AVG_THRSHLD is included when determining the metric score. If it is 0, the threshold setting is included when the metric score is determined. If it is 1, the threshold setting is not included when the metric score is determined.
COGIPF_LOWER_POOR_ THRSHLD
The lower poor threshold setting. If COGIPF_LOWER_POOR_THRSHLD_ XCL is 1, the metric score is poor when the metric is less than this threshold setting. If COGIPF_LOWER_POOR_THRSHLD_ XCL is 0 (zero), the metric score is poor when the metric is less than or equal to this value.
VARCHAR2 (512)
Column name
COGIPF_LOWER_POOR_ THRSHLD_EXCL
Description
Data type
The flag that indicates if the threshold set- BOOLEAN ting in COGIPF_LOWER_POOR_THRSHLD is included when determining the metric score. If it is 0, the threshold setting is included when the metric score is determined. If it is 1, the threshold setting is not included when the metric score is determined.
COGIPF_UPPER_AVG_ THRSHLD
The upper average threshold setting If COGIPF_UPPER_AVG_THRSHLD_ XCL is 1, the metric score is poor when the metric is less than this threshold setting. If COGIPF_UPPER_AVG_THRSHLD_ XCL is 0 (zero), the metric score is average when the metric is greater than or equal to this value. The metric score is good when the metric is less than or equal to this value.
VARCHAR2 (512)
COGIPF_UPPER_AVG_ THRSHLD_EXCL
The flag that indicates if the threshold set- BOOLEAN ting in COGIPF_UPPER_AVG_THRSHLD is included when determining the metric score. If it is 0, the threshold setting is included when the metric score is determined. If it is 1, the threshold setting is not included when the metric score is determined.
COGIPF_UPPER_POOR_ THRSHLD
The upper poor threshold setting. If COGIPF_UPPER_POOR_THRSHLD_ XCL is 1, the metric score is poor when the metric is less than this threshold setting. If COGIPF_UPPER_POOR_THRSHLD_ XCL is 0 (zero), the metric score is poor when the metric is greater than or equal to this value.
VARCHAR2 (512)
770
Column name
COGIPF_UPPER_POOR_ THRSHLD_EXCL
Description
Data type
The flag that indicates if the threshold set- BOOLEAN ting in COGIPF_UPPER_POOR_THRSHLD is included when determining the metric score. If it is 0, the threshold setting is included when the metric score is determined. If it is 1, the threshold setting is not included when the metric score is determined.
772
You can use the URL Report sample program included with the IBM Cognos 8 Software Development Kit (SDK) to perform basic tasks by clicking embedded links on an active server page. For information about the samples installed with the SDK, see the Developer Guide. However, for complex tasks, such as scheduling, we recommend that you use the SDK to create a custom application. You can use various declarations to identify the requested action, depending on the IBM Cognos 8 component. Note: These declarations are not the same as the SDK methods exposed by the BI Bus API.
If you configured IBM Cognos 8 to use a gateway other than the default CGI program, type the URL that corresponds to your gateway. For information about configuring gateways, see the Installation and Configuration Guide. The supported gateways are listed in the following table:
Gateway
ISAPI Apache Connector (Windows)
URL
http://webservername/cognos8/isapi http://webservername/cognos8/cgi-bin/mod_cognos.dll
Apache Connector (Solaris and AIX) http://webservername/cognos8/cgi-bin/mod_cognos.so Apache Connector (HPUX) Gateway Servlet http://webservername/cognos8/cgi-bin/mod_cognos.sl http://webservername:9300/ServletGateway/servlet/Gateway
Gateway
CGI
URL
http://webservername/cognos8
URL Methods
There are two methods to start IBM Cognos components: parameterized URL and cognosLaunch. Both methods perform the same function and use the same parameters. You can use either method to perform any UI task.
The ArgumentName parameter specifies the type, and the ArgumentValue parameter specifies the value of the called arguments. All names and values must be character strings. This method is easier to begin using than the cognosLaunch method because it does not require advance preparation. However, the longer URL-encoded entries are restrained by browser character limits. You can use these commands to browse content in IBM Cognos Connection or view pages in Cognos Viewer.
followed by the specific component parameters you want to use. If you want to start Cognos Viewer using the parameterized URL method, use the following parameters with this syntax:
http://localhost/cgi-bin/cognos.cgi?b_action=cognosViewer
If you want to start IBM Cognos Connection using the parameterized URL method, use the following URL:
http://localhost/cgi-bin/cognos.cgi?b_action=xts.run&m=portal/cc.xts
The mandatory building blocks for parameterized URL commands are as follows:
gateway
This is the mandatory argument value that specifies the IBM Cognos 8 gateway. The gateway name in this example is http://server/cognos8/cgi-bin/cognos.cgi?
774
Appendix H: Performing Tasks in IBM Cognos 8 Using URLs IBM Cognos Application Firewall validation is enforced on URLs that contain this parameter. For more information see, "URL Validation" (p. 776)
b_action=xts.run
Identifies the action. To specify Cognos Viewer, use b_action=cognosViewer. For more information see, "Starting Cognos Viewer" (p. 783).
m=portal/launch.xts&ui.tool=tool_name
Identifies the IBM Cognos 8 component interface that displays the result. To start IBM Cognos Connection, use m=portal/cc.xts
cognosLaunch Method
The cognosLaunch method uses a JavaScript function to perform tasks and start components. To use the launch utility in a Web page, you must first include the following statement in the HTML file from which you start the specific component:
<script language="JavaScript" src="Cognos8Gateway/cognoslaunch.js"> </script> Cognos8Gateway is the main IBM Cognos 8 gateway defined in IBM Cognos Configuration.
This statement enables the page to open a specified report in the chosen IBM Cognos component using the cognosLaunch JavaScript parameters. This method requires that the parameters use the following format:
"Argument Name","Argument Value"
The Argument Name parameter specifies the type, and the Argument Value parameter specifies the value of the called arguments. All names and values must be character strings. The cognosLaunch method uses a simpler construction than the parameterized URL method, but requires an enabled starting page.
"ui.gateway"
This is the mandatory argument value that specifies the IBM Cognos 8 gateway. IBM Cognos Application Firewall validation is enforced on URLs that contain this parameter. For more information see, "URL Validation" (p. 776)
"ui.tool"
This is the mandatory argument value that specifies the IBM Cognos 8 component.
Specifies the path of the target object. Acceptable values are the Content Manager search path or store ID. For more information, see "Using Search Paths and Page IDs" (p. 788). This parameter is mandatory for Event Studio, Analysis Studio, and Metric Studio.
ui.action
Specifies the action to take. Acceptable values for the Studio components are new and edit. The default is new. Acceptable values for Cognos Viewer are run and view. The default is view. This parameter is mandatory for Event Studio and Query Studio. You cannot use this parameter with Metric Studio.
ui.folder
Specifies the target folder. Acceptable values are the Content Manager search path or store ID. For more information, see "Using Search Paths and Page IDs" (p. 788). You cannot use this parameter with Analysis Studio.
ui.backURL
Specifies the URI to open after you close the selected component. IBM Cognos Application Firewall validation is enforced on URLs that contain this parameter. For more information see, "URL Validation" (p. 776)
ui.drillThroughTargetParameterValues
Use this parameter when the report that you want to drill through contains a prompt. This parameter specifies the values that fulfill that prompt, and display the requested data. The acceptable value is a Web64-encoded XML string. This string must include the name of the prompt parameter you want to fulfill, and its values. Using the example in "Start Parameters" (p. 778), if you wanted to start Cognos Viewer to run the Target report and get information specific to Italy, you would append the URL with the ui.
drillThroughTargetParameterValues argument name, followed by this argument value: <parameterValues SOAP-ENC:arrayType=\"bus:parameterValue[]\" xsi:type=\"SOAP-ENC:Array\"><item xsi:type=\"bus:parameterValue\"><name xsi:type=\"xs:string\">Country</ name><value SOAP-ENC:arrayType=\"bus:parmValueItem[]\" xsi:type=\"SOAP-ENC: Array\"><item xsi:type=\"bus:simpleParmValueItem\"><use xsi:type=\"xs:string\ ">Italy</use></item></value></item></parameterValues>
You cannot use this parameter with Event Studio or Metric Studio.
URL Validation
IBM Cognos Application Firewall validation is enforced on URLs using the following rules. Fully qualified, or absolute URLs:
776
Where protocol is either http or https and the host is validated against the valid domain list, which is specified by the Administrator in IBM Cognos Configuration. For more information, see the Installation and Configuration Guide. URLs relative to the C8 installation web root:
/<install root>/.*
Where <install root> is the gateway file path, taken from the Gateway URI from Cognos Configuration Tool. For example, /cognos8/ps/portal/images/. One of the following specifically allowed URLs:
about:blank (case insensitive) JavaScript:window.close() (case insensitive, with or without trailing semi-colon) JavaScript:parent.close() (case insensitive, with or without trailing semi-colon) JavaScript:history.back() (case insensitive, with or without trailing semi-colon) parent.cancelErrorPage() (case insensitive, with or without trailing semi-colon) doCancel() (case insensitive, with or without trailing semi-colon)
In addition, an advanced configuration setting, RSVP.RENDER.VALIDATEURL, can be used to specify whether these rules are applied to values specified by any URL values contained within a report specification. CAF must be enabled for the RSVP.RENDER.VALIDATEURL setting to take effect.
Start Parameters
Before using either the parameterized URL or cognosLaunch method you must first locate the object you want to access. The easiest way to identify the location of an object, such as a saved report, is to start IBM Cognos Connection and copy the object search path "Using a Page ID Instead of the Object Search Path" (p. 789) into the required URL command. The full path must be copied, as listed in the report properties, including the relevant package name and report names. For example, using the following parameterized URL starts Cognos Viewer and runs the report named 2005 Sales Summary:
http://localhost/cgi-bin/cognos.cgi?b_action=cognosViewer&ui.action=run&ui. object=/content/package[@name='GO Sales (analysis)']/folder[@name='Report Studio Report Samples']/report[@name='2005 Sales Summary']
The following script performs the same function using the cognosLaunch method in an enabled Web page:
cognosLaunch('ui.gateway','http://localhost /cgi-bin/cognos.cgi','ui.tool','CognosViewer','ui.action','run','ui.object','/ content/package[@name=\'GO Sales (analysis)\']/folder[@name=\'Report Studio Report Samples\']/report[@name=\'2005 Sales Summary\']')
The following topics describe each of the parameters used in this example, and examples of some other commonly used parameters.
When starting Report Studio with the parameterized URL method, specify both the gateway (http:
//localhost/cognos8/cgi-bin/cognos.cgi?) and the ui.gateway parameter.
Use the following parameters to start Report Studio with the cognosLaunch method:
cognosLaunch("ui.gateway","http://localhost/cognos8/cgi-bin/cognos.cgi?","ui. tool","ReportStudio","ui.option","/content")
778
Appendix H: Performing Tasks in IBM Cognos 8 Using URLs Editing a report in Report Studio
http://localhost/cgi-bin/cognos.cgi?b_action=xts.run&m=portal/launch.xts&ui. gateway=http://localhost /cgi-bin/cognos.cgi&ui.tool=ReportStudio&ui.object=/content/package[@name='GO Sales (analysis)']/folder[@name='Report Studio Report Samples']/report [@name='2005 Quarterly Sales Forecast']&ui.action=edit
cognosLaunch Examples
This section provides examples for performing specific functions when starting Report Studio using the CognosLaunch method. Starting Report Studio
cognosLaunch('ui.gateway','http://localhost /cgi-bin/cognos.cgi','ui.tool','ReportStudio')
Use the following mandatory parameters to start Query Studio with the cognosLaunch method:
cognosLaunch('ui.gateway','http://localhost /cgi-bin/cognos.cgi','ui.tool','QueryStudio','ui.action','new')
The ui.action parameter is a mandatory for both methods. The following parameters are optional for Query Studio:
cv.header
Specifies whether to display the header. Acceptable values are true and false.
ui.spec
Specifies an XML document that contains an IBM Cognos 8 report specification. For information about IBM Cognos 8 report specifications, see the report specification topics in the IBM Cognos 8 SDK Developer Guide.
run.outputLocale
Specifies the output language. Acceptable values are expressed as a hyphenated language-region pair, in accordance with the RFC3066 standard. The default value is en-us.
Specifies whether the report service issues prompts, so you can enter report option values. Acceptable values are true and false. The default value is true. Use the following parameters for debugging purposes only:
run.outputFormat
Specifies the output format. Acceptable values are CSV, HTML, PDF, singleXLS, XHTML, XLWA, and XML.
asynch.primaryWaitThreshold
Specifies the maximum amount of time, in seconds, that the server can use to process the request before sending a response to the client. Acceptable values are any integer. Use a value of 0 to make the client wait indefinitely. The default value is 7.
asynch.secondaryWaitThreshold
Specifies the maximum amount of time, in seconds, that the server can use to process the request before sending a response to the client. Acceptable values are any integer. Use a value of 0 to make the client wait indefinitely. The default value is 30.
cognosLaunch Examples
This section provides examples for performing specific functions when starting Query Studio using the CognosLaunch method. Starting Query Studio to a specific package
cognosLaunch('ui.gateway','http://localhost /cgi-bin/cognos.cgi','ui.tool','QueryStudio','ui.action','new','ui.object','/ content/package[@name=\'GO Data Warehouse (analysis)\']')
780
When starting Analysis Studio with the parameterized URL method, specify both the gateway (http://localhost/cognos8/cgi-bin/cognos.cgi?) and the ui.gateway parameter. Use the following parameters to start Analysis Studio with the cognosLaunch method:
cognosLaunch('ui.gateway','http://localhost /cgi-bin/cognos.cgi','ui.tool','AnalysisStudio','ui.action','new')
The ui.object parameter is mandatory for both methods. However, if it is missing, you are prompted to select a package.
cognosLaunch Examples
This section provides examples for performing specific functions when starting Analysis Studio using the CognosLauch method. Starting Analysis Studio to a specific package
cognosLaunch('ui.gateway','http://localhost /cgi-bin/cognos.cgi','ui.tool','AnalysisStudio','ui.action','new','ui. object','/content/package[@name=\'Sales and Marketing (cube)\']')
Use the following parameters to start Metric Studio with the cognosLaunch method:
cognosLaunch('ui.gateway','http://localhost /cgi-bin/cognos.cgi','ui.tool','MetricStudio','ui.object','/content')
The ui.object parameter is mandatory for both methods. However, if it is missing, you are prompted to select a package.
cognosLaunch Examples
This section provides an example when starting Metric Studio using the CognosLaunch method. Starting Metric Studio to a specific package
cognosLaunch('ui.gateway','http://localhost /cgi-bin/cognos.cgi','ui.tool','MetricStudio','ui.object','/content/package [@name=\'GO Metrics\']')
Use the following parameters to start Event Studio with the cognosLaunch method:
cognosLaunch('ui.gateway','http://localhost /cgi-bin/cognos.cgi','ui.tool','EventStudio')
The ui.action and ui.object parameters are mandatory. If ui.object is missing, you are prompted to select a package.
782
cognosLaunch Examples
This section provides examples for performing specific functions when starting Event Studio using the CognosLaunch method. Starting Event Studio
cognosLaunch('ui.gateway','http://localhost /cgi-bin/cognos.cgi','ui.tool','EventStudio','ui.action','new','ui.object','/ content/package[@name=\'GO Sales and Retailers\']')
Use the following parameters to start Cognos Viewer with the cognosLaunch method:
cognosLaunch('ui.gateway','http://localhost /cgi-bin/cognos.cgi','ui.tool','CognosViewer')
For a complete list of the Cognos Viewer parameters, see the "URL API Reference" Appendix in the SDK Developer Guide. The following parameters are optional for Cognos Viewer:
run.outputFormat
Specifies the output format. Acceptable values are CSV, HTML, PDF, singleXLS, XHTML, XLWA, and XML. The default value is HTML. Note: To protect IBM Cognos 8 and your servers, the IBM Cognos Application Firewall (CAF) rejects URL-based requests for output in XLS format.
run.outputLocale
Specifies the output language. Acceptable values are expressed as a hyphenated language-region pair, in accordance with the RFC3066 standard. The default value is en-us.
run.prompt
Specifies whether the report service issues prompts, so you can enter report option values. Acceptable values are true and false. The default value is true.
run.xslURL
Specifies the location of an XSL stylesheet that can be applied to the report, thereby rendering it in the requested format. An acceptable value is a URI.
Appendix H: Performing Tasks in IBM Cognos 8 Using URLs When referencing the XSL file, ensure that the specified file is valid, and exists on the application server in the templates/rsvp/xsl directory. Referencing an invalid stylesheet terminates the process.
run.outputEncapsulation
Specifies how output documents in the response are encapsulated. Acceptable values are HTML,
URL, URLQueryString, none.
asynch.attachmentEncoding
Specifies how attachments to the response are encoded. Acceptable values are base64, MIME,
MIMECompressed. The default value is base64.
asynch.primaryWaitThreshold
Specifies the maximum amount of time, in seconds, that the server can use to process the request before sending a response to the client. Acceptable values are any integer. Use a value of 0 to make the client wait indefinitely. The default value is 7.
asynch.secondaryWaitThreshold
Specifies the maximum amount of time, in seconds, that the server can use to process the request before sending a response to the client. Acceptable values are any integer. Use a value of 0 to make the client wait indefinitely. The default value is 30.
cognosLaunch Examples
This section provides examples for performing specific functions when viewing reports using the CognosLaunch method. Viewing saved reports
cognosLaunch('ui.gateway','http://localhost /cgi-bin/cognos.cgi','ui.tool','CognosViewer','ui.action','view','ui.
784
The windowName and windowProperties parameters represent the values specific to starting an IBM Cognos 8 component in a named browser window. The windowName string is the name of the browser window, frame, or iframe in which to start the specified component. If the specified name does not exist, a newly created pop-up browser window appears with the name. To create a new pop-up window, use "_blank" as the value. The windowProperties string defines the properties applied to the new pop-up window. This only applies to newly created windows. The available values depend on the type of the Web browser you are using, and correspond to the values supported by the JavaScript window.open() function. Some options may not work in all browsers. The windowProperties parameter consists of a comma-separated list. Each item consists of an option and a value, separated by the equals sign (=). For example, "fullscreen=yes ,
toolbar=yes". Some common examples include:
channelmode
Specifies whether to display the window in theater mode, and show the channel band. The default is no. Acceptable values are yes and no.
directories
Specifies whether to add directory buttons. The default is yes. Acceptable values are yes and
no.
fullscreen
Specifies whether to display the browser in full-screen mode. This mode hides the browser's title bar and menus. A window in full-screen mode must also be in channelmode. The default is no. Acceptable values are yes and no.
height
Appendix H: Performing Tasks in IBM Cognos 8 Using URLs This integer specifies the height of the window, in pixels. The minimum value is 100.
left
This integer specifies the left position, in pixels, relative to the upper-left corner of the screen.
location
Specifies whether to display the input field for entering URLs directly into the browser. The default is yes. Acceptable values are yes and no.
menubar
Specifies whether to display the menu bar. The default is yes. Acceptable values are yes and
no.
resizable
Specifies whether to display resize handles at the corners of the window. The default is yes. Acceptable values are yes and no.
scrollbars
Specifies whether to display horizontal and vertical scroll bars. The default is yes. Acceptable values are yes and no.
status
Specifies whether to display a status bar at the bottom of the window. The default is yes. Acceptable values are yes and no.
titlebar
Specifies whether to display a title bar for the window. This parameter is only valid if the calling application is an HTML Application, or a trusted dialog box. The default is yes. Acceptable values are yes and no.
toolbar
Specifies whether to display the browser toolbar. The default is yes. Acceptable values are yes and no.
top
This integer specifies the top position, in pixels. This value is relative to the upper-left corner of the screen.
width
This sets the width of the window, in pixels. The minimum value is 100. The ui.gateway, ui.tool, along with some additional parameter values are described in "Start Parameters" (p. 778).
786
Step
In a browser, type a URL using the following parameters:
http://[gateway]?b_action=xts.run&m=portal/cc.xts&m_page=path:[search path]&style=[stylesheet]&ui=h1&m_pagemode=view]
Full prefix that identifies the IBM Cognos 8 gateway. For example, localhost/cognos8/
cgi-bin/cognos.cgi.
m=portal/cc.xts
Identifies an IBM Cognos Connection page. For more information, see "Using Search Paths and Page IDs" (p. 788).
style=[stylesheet]
Identifies the .css file that overrides the default IBM Cognos 8 style. The IBM Cognos Connection pages use the IBM Cognos 8 stylesheet by default. You can use your own corporate style to maintain a consistent look and feel of your page. To do so, edit the URL to set the style=[stylesheet] parameter to the location of the required .css file. For example, style=http://myserver/mystyles.css.
ui=h1
Hides some of the IBM Cognos 8 user interface elements. When an IBM Cognos Connection page appears as a portion of another Web page, some of its user interface elements, such as top headers, links, and toolbars, may became redundant. You can hide these elements and leave only the required content of the page. In this example, h1 hides the main IBM Cognos Connection header. For more information about hiding user interface elements, see the customization chapters in the Administration and Security Guide.
m_pagemode=view
Hides some of the portlet user interface elements, and makes the page read-only.
Appendix H: Performing Tasks in IBM Cognos 8 Using URLs Some of the portlet user interface elements, such as frames around the portlets and title bars, may become redundant when the portlet appears within another page. You can hide these elements.
788
Tip: To find the page search path and ID in IBM Cognos Connection, navigate to the folder that contains the page and click the page properties button. On the General tab, click View the search path, ID and URL.
If you are using the parameterized URL method (p. 774), you can specify the object's page ID using the following m_page parameter format, where page ID is the object's page ID:
m_page=[page ID]
To find the IDs, follow the instructions in "Using Search Paths and Page IDs" (p. 788).
Deployment Considerations
References to deployment objects are based on search paths, not IDs. For a specific IBM Cognos Connection page, the object's page ID remains valid until the application's deployment mechanism transfers the original object to another IBM Cognos 8 server. In the destination environment, all IDs are different. In such an event, you must map all ID references to the new IDs on the system.
790
Glossary
access permissions
Rules defining the access rights to resources. Access permissions can be granted to any combination of namespaces, groups, or users. Examples of resources are reports and folders.
agent
The object type created and edited by Event Studio. An agent contains the event condition and the associated tasks to perform. Once defined, an agent can be scheduled to check for instances of the event.
analysis
A process where a user interacts with data to gain insight and understanding. In IBM Cognos 8, Analysis Studio is designed to facilitate analysis.
anonymous access
A method of accessing resources in which users are not authenticated, and all users gain the same access permissions.
authentication
The process of verifying the identity of users when they log on. Users must be authenticated before they can be authorized to use any secured resources.
authentication provider
The communication mechanism to an external authentication source. Functionality such as user authentication, group membership, and namespace searches are made available through authentication providers.
burst
To create many report results by running a single report once. For example, you can create a report that shows sales for each employee, and run it once, sending different results to regional managers by bursting on region. You set up bursting in Report Studio and enable it in the portal.
burst key
The dimension or level of a query in the report specification that is used to create, or burst, a set of report results. For example, you can create a report that shows sales for each employee, and send different results to regional managers by bursting on region.
capabilities
Capabilities refer to the ability to use certain functions and features within IBM Cognos 8. The Capabilities tool controls access to secured functions such as Administration and the IBM Cognos Query Studio, and secured features, such as User Defined SQL and Bursting. The permissions define
Glossary which of the predefined and built-in Cognos groups and roles have access to which secured functions and features, and the type of access. Access to these capabilities is set by the security administrator. Users can see their access permissions in the Personal area of their Preferences, under Capabilities.
connection
The named information that defines the type of the data source, its physical location, and any signon requirements. A data source can have more than one connection.
contact
A named email address to which reports and agent emails can be sent. Contacts are never authenticated.
content locale
A code that is used to set the language or dialect used for browsers, report text, and so on; and the regional preferences, such as formats for time, date, money, money expressions, and time of day. For IBM Cognos products, you can specify a locale for the product interface (product locale) and for the data in the report (content locale).
Content Manager
The IBM Cognos 8 service that manages the storage of customer applications, including applicationspecific security, configuration data, models, metrics, reports, and report output. Content Manager is needed to publish models, retrieve or store report specifications, manage scheduling information, and manage the Cognos namespace.
content store
The database that contains data that IBM Cognos 8 needs to operate, such as report specifications, published models, and the packages that contain them; connection information for data sources; information about the external namespace, and the Cognos namespace itself; and information about scheduling and bursting reports. Design models and log files are not stored in the content store. The IBM Cognos 8 service that uses the content store is named Content Manager.
credentials
Information stored about the identity of an IBM Cognos user, usually a user name and password. You can assign your credentials to someone else so that they can use resources that you are authorized to use. Credentials are created for IBM Cognos components. If a user schedules or programs an action, credentials must be stored in the content store.
data source
A relational database, dimensional cube, file, or other physical data store that can be accessed through IBM Cognos 8.
792
Glossary
deployment
The process of moving an IBM Cognos 8 application (reports, models, and so on) to a different instance of IBM Cognos 8. For example, you often create reports in a test environment and then deploy them to production. When you deploy an application, you export, transfer, and import it.
deployment archive
A file used for deployment. A deployment archive contains the data from the content store that is being moved.
deployment specification
A definition of what packages to move (deploy) between source and target environments, the deployment preferences, and the archive name. You use deployment specifications for import and for export.
drill down
In IBM Cognos Planning, drill down is a technique used to analyze D-Cube data that was imported by a D-Link. You can drill down on any single cell in a D-Cube. If the cell contains data transferred by a D-Link, drill down opens a view of the source data. If the data was imported from another DCube, drill down opens the appropriate selection from the source D-Cube. If the data was imported from an external source (a mapped ASCII file or an ODBC database), drill down extracts the relevant data from the source file and displays it in a special drill-down results dialog box. In IBM Cognos 8 BI, drill down refers to the act of navigating from one level of data to a more detailed level. The levels are set by the structure of the data. See also drill up.
drill up
The act of navigating from one level of data to a less detailed level. The levels are set by the structure of the data. See also drill down.
event
An exceptional item of data, defined by specifying a query expression against items in a package. When data is detected matching the event condition, it causes an agent to perform tasks.
gateway
An extension of a Web server program that transfers information from the Web server to another server. Gateways are often CGI programs, but may follow other standards such as ISAPI and Apache Modules.
glyph
An image of a character in a font. Letters are glyphs, but in most cases, the term is used in discussions of non-alphabetic writing systems.
Glossary
group
In security, a list of users or other groups that can be used to assign access permissions and capabilities. Groups can be referenced from other authentication sources or can be local to IBM Cognos 8. Local groups are managed from the administration portal. The list of groups that an authentication user is a member of is part of the user's passport for an IBM Cognos 8 session. In reporting, grouping is the action of organizing common values of query item together and only displaying the value once. Headers and footers often appear after each instance of a common value in a grouped column
job
A group of runnable objects, such as reports, agents, and other jobs that you run and schedule as a batch.
job step
The smallest part of a job that can be run separately. Usually, a job step is a report. A job step can also be another job.
locale
A code that is used to set the language or dialect used for browsers, report text, and so on; and the regional preferences, such as formats for time, date, money, and money expressions. For IBM Cognos products, you can specify a locale for the product interface (product locale) and for the data in the report (content locale).
metric
A measure to assess performance in a key area of a business.
metric package
an IBM Cognos Connection representation of a Metric Studio application. A metric package contains connection information, reports, and metric management tasks for that application.
model
A physical or business representation of the structure of the data from one or more data sources. A model describes data objects, structure, and grouping, as well as relationships and security. In IBM Cognos 8 BI, a design model is created and maintained in Framework Manager. The design model or a subset of the design model must be published to the IBM Cognos 8 server as a package for users to create and run reports. In IBM Cognos Planning, a model is a group of D-Cubes, D-Lists, D-Links, and other objects stored in a library. A model may reside in one or more libraries, with a maximum of two for Contributor.
namespace
For authentication and access control, a configured instance of an authentication provider. Allows access to user and group information.
794
Glossary In XML, a collection of names, identified by a URI reference, which are used in XML documents as element types and attribute names. In Framework Manager, namespaces uniquely identify query items, query subjects, and so on. You import different databases into separate namespaces to avoid duplicate names.
news item
A single entry in a rich site summary (RSS) compatible format. It can include a headline, text, and a link to more information. A news item task in an agent can be used to create news items for display in an IBM Cognos Connection portlet.
package
A subset of a model, which can be the whole model, to be made available to the IBM Cognos 8 server. For Metric Studio users, see metric package.
passport
Session-based information regarding authenticated users. A passport is created the first time a user accesses IBM Cognos 8. It is retained until a session ends, either when the user logs off, or after a specified period of inactivity. Passport information is stored in Content Manager memory. Credentials are stored encrypted. A passport is stored in a memory-only browser cookie for the duration of the session.
portlet
A mechanism for displaying Web content as part of a portal page.
product locale
The code or setting that specifies what language, regional settings, or both to use for parts of the product interface, such as menu commands.
project
In Framework Manager, a set of models, packages, and related information for administration, and for sharing model information. In Metric Studio, a project is a task or set of tasks undertaken by a team and monitored on a scorecard. A project tracks the dates, resources and status of the project. In Metric Designer, a project is a group of extracts. Each extract contains the metadata that is used to populate the Metric Studio data store or to create applications.
prompt
A report element that asks for parameter values before the report is run.
Glossary
publish
In IBM Cognos 8 BI, refers to exposing all or part of a Framework Manager model or Transformer PowerCube, via a package, to the IBM Cognos 8 server, so that it can be used to create reports and other content. In IBM Cognos Planning, refers to a function that is used to copy the data from Contributor or Analyst to a datastore, typically so it can be used for reporting purposes.
query
A specification for a set of data retrieved from a data source. A report specification can contain one or more queries. In Query Studio, the type of object created and edited. A query is a subtype of report. In Transformer, models can contain multiple queries as data sources. A query or data source appears as a cylinder icon in the Data Sources list.
report
A set of data deliberately laid out to communicate business information. Depending on the context, "report" may refer to report specification or report output. Report (more precisely, report specification) is the generic term for the objects created or edited by Query Studio, Report Studio, and Analysis Studio.
report output
Report output combines data at the point in time when the report was run with a report specification. It is a document that can be displayed, printed, or emailed. IBM Cognos 8 can produce report outputs in HTML, PDF, Excel, or CSV formats.
report specification
The definition of queries, prompts, layouts, and styles that make up a report. A report specification is combined with data by a run operation to create report outputs. You create report specifications by using Report Studio, Query Studio, Analysis Studio, or through the Software Development Kit.
report view
A reference to another report that has its own properties, such as prompt values, schedules, and results. You use report views to share a report specification instead of making copies of it.
796
Glossary
session
The time during which an authenticated user is logged on to IBM Cognos 8.
task
An action performed by an agent if the event status meets the task execution rules. For example, an agent can send an email, publish a news item, or run a report.
template
A reusable report layout or style that can be used to set the presentation of a query or report.
user
A person accessing an IBM Cognos 8 application. User information, such as the location of personal folders or preferred formats for viewing reports, is stored in IBM Cognos 8. Authenticated user definitions and information, such as passwords and IDs, are maintained in other authentication sources.
watch list
A list of metrics that each user has chosen to monitor closely. If notification is enabled in Metric Studio, the user will receive email notification of changes to these metrics. Users can also choose to display their watch list as a portlet within IBM Cognos Connection.
watch rule
A user-defined condition that determines whether a report is delivered to the user. When the rule is run, the output is evaluated and, if it satisfies the condition or rule, the report is delivered by email or news item. Watch rules limit report delivery to those reports containing data of significance to the user.
Glossary
798
Index
Symbols
.cnv applying substitutions, 689 .css changing IBM Cognos 8 fonts, 482 global changes to appearance, 482 .csv formatting output, 526 properties, 527 .dmp, See core dump files .dwp deploying Cognos portlets to SharePoint Portal Server, 456 .epa deploying Cognos portlets to SAP Enterprise Portal 6.0, 446 .mdl errors calculations with double quotation marks, 611 .NET Framework troubleshooting, 664 version, 661 .NET programmability support, 661 .otl files, 69 .pte deploying Cognos portlets to ALUI 6.1, 452 .xml adding custom report templates, 497 applying conversions, 689 specifying conversions, 687 $nopage>audit logs, See Also troubleshooting #ERROR troubleshooting in Microsoft Excel, 667 #NAME? errors, 665 -- characters, 622 access denied error, 590 access permissions, 225 anonymous, 233 built-in entries, 699, 700 credentials, 218 definition, 791 granting or denying, 215 initial, 691 metric packages, 657 ownership of entries, 215 pages, 270 portlets, 433 predefined entries, 700 secured functions and features, 225, 693 Series 7 reports from IBM Cognos Connection, 52 setting, 216 styles, 439 to entries denied, 581 users, 214 See Also permissions access rights, See access permissions actions adding shortcuts, 510 credentials, 218 customizing in IBM Cognos Connection, 509 permissions, 215 removing, 510 activating services, 110 Active Directory distribution lists as members of groups and roles, 209 Active Directory Server missing group membership, 576 single signon not working, 586 activities managing, 285 adding comments, 370 administration IBM Cognos 8, 43
A
accented characters not displayed properly, 567 access more documentation, 35
Index metrics for Metric Studio, 391 server, 37 Administration secured functions and features, 221 administrators improved user interface, 35 advanced configuration settings RSVP.RENDER.VALIDATEURL, 776 advanced properties report service, 529 affinity settings, 131 agents, 383 adding yourself to alert list, 386 allowing alert list, 386 creating from IBM Cognos Connection, 385 default actions, 40 definition, 791 deleting alert list, 387 most recent event list, 387 news item headlines, 387 opening from IBM Cognos Connection, 385 properties, 249, 384 removing yourself from alert list, 386 rerunning failed, 297 running, 383 viewing, 385 agent service, 105, 106 agent tasks resubmitting on fail, 40 aggregating samples and time dimensions, 60 troubleshooting running totals, 642 AIX error connecting to DB2 database, 558 version, IBM WebSphere, 564 alert lists allowing for agents, 386 allowing for reports, 365 deleting for agent, 387 for agents, 386 for reports, 366 removing for agents, 386 removing from watch items, 264 viewing in IBM Cognos Connection, 264 alerts report, 38 800 All option Error 0\:RSV-BBP-0027 error, 669 ALUI 6.1 customizing Cognos portlets, 454 deploying Cognos portlets, 449 remote servers, 449, 450, 453 unable to edit object properties, 596 Always Prompt (property value), 668 analyses definition, 791 analysis studio limiting hot spots, 139 Analysis Studio changing suppression default, 538 cubes, 347 customizing styles, 480 data tree display settings, 335 Excel reports, 635 Japanese Internet Explorer, 635 report properties, 247 reports, 347 secured functions and features, 221 setting up drill-through targets, 412 troubleshooting, 630, 631, 632 wrong currency symbol, 614, 634 anonymous access definition, 791 APIs, 44 appearance Cognos Viewer, 492 fonts, 482 global changes, 479 migrating changes to future releases, 483 rebranding, 481 style sheets, 482 application errors upgrading a report, 620 application servers problems running IBM Cognos 8, 571 servlet class fails to load in WebLogic, 579 startup script fails, 564 Application Tier Components log server, 79 archives deployment, 308 arithmetic overflow errors, 639
Index ASCII requirements for installation directory, 558 as percentage values, 631 attachments IBM Lotus Notes, 534 attributes metric score, 101 audit logs, 79 audit logs log destinations, 79 See Also log messages audit reports new samples, 36 audits reports, 82 authentication, 201 CAM-AAA-0096 error, 585 definition, 791 expired password, 586 single-signon not working when using Active Directory, 586 unable to authenticate user, 585 unable to authenticate user for Cognos portlets, 587 users, 239 authentication prompts, 216 authentication providers, 201 definition, 791 problems, 585 authoring enabling Report Studio modes, 37 authoring modes Report Studio, 37 authoring profiles express, 227 professional, 227 authorization, 203 automating tasks, 44 restoring files, 197 balanced hierarchies DB2 OLAP, 165 BAP-ERR-0002 errors, 641 BAPI error editing prompt specification file, 609 batch reports, 105 report services, 105 batch report service, 106 BEA AquaLogic User Interaction 6.1, See ALUI 6.1 BEA WebLogic parser collision with Report Data Service, 670 blank pages excluding in PDF reports, 372 BLOB in stored procedures, 601 bo\:heap Buffer Overflow troubleshooting, 662 bookmarks creating for drill-through access, 404 creating for IBM Cognos 8 entries, 242 Bookmarks Viewer, 732 braces in expressions, 604 browser settings, 647 browsing content, 513 controlling external namespaces, 123 built-in entries initial access permissions, 699, 700 bursting deploying results, 308 reports, 374 burst keys definition, 791 burst reports troubleshooting, 638 bursts definition, 791 business keys using for drill-through, 407
B
background colors not appearing in templates, 621 troubleshooting in charts, 619 backing up data, 197
Index
C
caches configuring Cognos portlets in WebSphere Portal, 444 caching disabling for a session, 145 CAF, 776 calculated column converting to regular column, 611 calculations with double quotation marks model errors, 611 CAM.AAA errors, 636 CAM-CRP-1071, 582 CAM-CRP-1157 error, 552 cancel entry run, 285 cannot call the SDK from Event Studio, 628 capabilities administrative, 35 changed, 42 definition, 791 Capabilities secured functions, 221 capacity dispatchers, 129 cast_Date functions troubleshooting, 633 categories missing in Transformer model, 612 CCLOutofMemory Error, 606 cell-based reports #NAME? errors, 665 Certificate Authority (CA) security errors, 674 unable to create trust relationship, 670 CGI timeout error, 579, 639, 640 changed features version 8.3, 41 version 8.4, 34 changes to decimal formats, 615 changing suppression default Analysis Studio, 538 character encoding in PDF files, 134 characters encoding not supported, 553 characters improperly displayed, 567
charts display every second label, 619 gradient backgrounds appear gray, 619 labels overwrite one another, 619 limitations, 648 missing in imported reports, 667 not appearing, 644 transparency, 644 Chinese characters display incorrectly after upgrade, 566 characters in file names, 607 clearing metric history and calendar data for Metric Studio, 395 metric rejects tables for Metric Studio, 395 CLOB in stored procedures, 601 Oracle, 601 cluster compatible mode, 129 cmm_support_bundle, 654 CM-SYS-5001 A Content Manager internal error occurred, 575 CNC-ASV-0001 error, 628 CNC-GEN-2107 errors, 648 COC-ERR-2609, 679 cogconfig.sh return codes not UNIX compliant, 567 cogformat.xml file adding data formats for a locale, 524 modifying, 521 removing data formats for locales, 523 Cognos portlets, 464 portlets, deploying iViews to SAP Enterprise Portal 6.0, 445 Cognos 8, See IBM Cognos 8 Cognos Extended Applications, 726 Cognos namespace recreating, 572 Cognos Navigator, 717 Cognos portlets cannot log on, 583 properties pages not displayed properly, 598 Cognos portlets, See portlets Cognos Search, 719 Cognos Software Services, 539, 545
802
Index Cognos SQL adding comments to SQL statements, 147 Cognos Viewer, 721, 724 changing the product language, 493 customizing, 492 customizing report output formats, 517 customizing styles, 480 disabling session caching, 145 modifying style sheets, 493 secured functions and features, 221 Cognos Viewer portlet drill-down actions, 283 drill-through actions, 283 drill-up actions, 283 global filters, 280 cogroot.link file, 571 cogstartup.lock file, 540 cogstartup.xml file invalid file, 573 collation sequences case-sensitive, 553 colors not appearing in templates, 621 Query Studio menus, 489 Report Studio menus, 487 columns disappearing, 623 Com Add-in Excel workbook closes unexpectedly, 664 commands database, 742 native SQL, 745 starting proxy sessions, 742 stopping proxy sessions, 743 comments, 369 adding in Cognos Viewer, 370 adding to saved reports, 32 Cognos SQL, 147 deleting in Cognos Viewer, 370 enabling, 369 managing in Cognos Viewer, 32 modifying in Cognos Viewer, 370 native SQL, 147 viewing in Cognos Viewer, 370 common symmetric key error in processing a request, 582 Common Warehouse Metamodel exporting to, 605 components global changes to appearance, 479 Report Studio style sheets, 486 Composite Information Server changes in 8.4, 34 composite software, See Also IBM Cognos Virtual View Manager compression algorithm level in PDF files, 134 concurrent query execution, 141 configuration cache size for Cognos portlets in WebSphere Portal, 444 Cognos portlets in a WebSphere Portal, 444 cryptographic information cannot be encrypted, 570 data locked, 572 dispatchers and services, 127 error when encrypting information, 570 folders, 112 iViews, 447 Japanese character encoding, 685 lock file, 540 portlet cache in IBM Cognos Connection, 434 QE-DEF-0177 errors, 633 settings not applied, 574 Shift-JIS characters, 685 unable to open IBM Cognos Configuration, 540 unable to save, 572 Web browsers, 50 configuration issues, 567, 661 connection pool settings Content Manager database, 121 connections data source, 155 data source connections, 67 definition, 792 dispatchers, 131 managing, 121 OLAP data sources, 70 remote servers, 453 setting number, 131 contacting Cognos Software Services, 539, 545 contacts creating, 374 definition, 792 Administration and Security Guide 803
Index content browsing using a URL command, 513 browsing using the system.xml file, 513 setting languages, 260 content compression type in PDF files, 134 content locale definition, 792 Content Manager advanced settings, 121 an attempt to register the dispatcher, 558 control browsing of external namespaces, 123 database connection pool settings, 121 definition, 792 initial access permissions, 691 maximum number of connections, 121 objects, 691 resolving unresponsiveness, 672 service, 105 synchronizing standby, 123 Content Manager error messages, 574 Content Manager service, 106 content store backing up, 197 compatible versions of DB2 and Java, 552 definition, 792 deleting tables from the database, 568 error initializing in Oracle, 578 invalid settings, 553 securing, 237 upgrading, 557 content stores deploying, 309 maintaining, 125 context attribute cannot be deserialized, 565 context error, 565 copying entries, 251 copyright material printing, 29 core dump files, 89, 542 corporate style, 481 creating calculated columns in Transformer, 611 configuration folders, 112 packages, 162 watch rules, 367 804 creating files in Framework Manager, 607 using GB18030 characters, 607 credentials, 239 definition, 792 trusted, 218 credentials invalid, 581 crosstabs overflow errors, 633 troubleshooting, 631 cryptographic error, 573 cogstartup.xml file invalid, 573 JRE error, 573 problems after upgrading, 570 cryptographic information cannot be encrypted, 570 cryptographic keys regenerating, 571 CSV formatting reports, 360 cubes, 347 Analysis Studio, 347 cannot open, 559 data sources, 157 drilling through to relational data gives unexpected results, 643 IBM Cognos Series 7, 379 IBM Cognos Series 7 multilingual properties, 382 opening IBM Cognos Series 7, 382 PowerCubes open slowly, 592, 613 cube update data, 631 currencies displaying mixed, 347 current activities, 285 entries, 285 current run advanced options, 351 report options, 350 customer support contacting Cognos Software Services, 539, 545 customizing Cognos Viewer, 492 custom report template icons, 497 fonts in pages, 486 header background color in IBM Cognos Connection, 485
Index header branding in IBM Cognos Connection, 484 IBM Cognos 8 appearance, 479 IBM Cognos 8 functionality, 501 IBM Cognos Connection, 484, 502, 503 object actions in IBM Cognos Connection, 509 portal graphics, 486 portals, 260 prompt page formats, 494 Query Studio graphics, 489 Query Studio menu colors, 489 Query Studio toolbar buttons, 490 report output formats, 517 Report Studio fonts, 487 Report Studio graphics, 488 Report Studio interfaces, 487 Report Studio menu colors, 487 Report Studio style sheets, 486 report templates, 495 styles, 480 Welcome pages, 484, 514 customizing Cognos portlets for WebSphere Portal, 444 customizing user interface adding elements, 714 hiding elements, 707 Custom Property troubleshooting, 679 locked by IBM Cognos Configuration, 572 multilingual samples, 703 PowerCube not displayed, 656 relational data not displayed in Metric Studio, 656 specifying data sources, 155 viewing lineage, 355 database connection cannot select ODBC as type, 589 connecting to SQL Server, 590 creating, 589 databases bulk load utility missing, 578 command block examples, 192 command blocks, 191 commands, 190, 742 configuring for multilingual, 47 deleting tables, 568 IBM Cognos samples, 63 native SQL commands, 745 returning to original state in Event Studio, 78 sorting of entries for non-English locales, 122 starting proxy sessions, 742 stopping proxy sessions, 743 tables for log messages, 749 data formats adding for a locale, 524 changing the order, 521 customizing for Query Studio, 520 removing for a locale, 523 data integration service, 106 data modeling, 243 data movement, 199 properties, 200 running, 199 data retrieval troubleshooting an SAP-based data source, 612 data schema for log messages, 749 data size limits, 674 data source connections changing, 183 data sources, 155 adding connections, 183 command block examples, 192 command blocks, 191 commands, 741 connection commands, 742 Administration and Security Guide 805
D
dashboards, 40 adding interactivity, 278 creating, 275 drill-through actions, 283 drill-up and drill-down actions, 283 global filters, 278 hiding user interface elements, 504 Multi-page portlet, 275 problems displaying reports, 598 See Also pages data backing up, 197 deploying, 324 exporting, 325 flat file data not displayed in Metric Studio, 656 IBM Cognos samples, 63 importing, 328 in multiple languages, 610
Index connection timeouts, 184 creating, 180 creating signons, 186 cubes, 157 database commands, 190 DB2, 156 DB2 OLAP, 164, 165 definition, 792 deploying, 314 Hyperion Essbase, 164 IBM Cognos Finance, 157 IBM Cognos Now! Cube, 157 IBM Cognos Planning -Contributor, 157 IBM Cognos Planning - Series 7, 157 IBM Cognos Virtual View Manager, 174 IBM Infosphere Warehouse Cubing Services, 168 Informix, 169 isolation levels, 188 Microsoft Analysis Server, 169 Microsoft SQL Server, 171 modifying connections, 183 modifying sources, 186 ODBC, 173 Oracle, 176 paths to file-based data source connections, 181 PowerCubes, 157 samples connections, 67 SAP Business Information Warehouse (SAP BW), 176 securing against multiple namespaces, 216 security, 195 TM1, 178 XML files, 179 data source signons changing, 186 creating, 186 data stores conformed dimensions, 406 data tree display settings, 335 datatypes graphic, 603 dates using for drill-through access, 408 DB2, 560, 603 creating a metric package, 657 Metric Studio, 658 806 supported Java versions, 552 DB2 data source, 156 DB2-ERR-0028, 576 DB2 OLAP data sources, 164, 165 unable to load library, 576 decimal formats changes, 615 default actions for agents, 40 defaults agent properties, 384 data movement properties, 200 iViews content and appearance, 448 PowerPlay reports, 381 report languages, 362 report prompt values, 362 report run options, 348 service, 110 styles, 481 user profiles, 339 users, groups, and roles, 233 delete request fails, 593, 594 deleting dispatchers, 111 entries, 257 IBM Cognos samples, 78 metric tasks for Metric Studio, 393 namespaces, 202 pages, 269 tabs, 274 user profiles, 340 delivery service, 105 delivery service, 106 customizing SMTP error-handling, 530 setting compression for attachments, 140 denying access, 215 deploying archives, 308 Cognos iViews to SAP Enterprise Portal 6.0, 445 Cognos Portlets to ALUI 6.1, 449 Cognos portlets to SharePoint Portal Server, 454 Cognos portlets to WebSphere Portal, 441 command lines, 307 configuration objects, 331
Index data, 324 data sources, 314 directory content, 311 entire content store, 309 exporting, 325 external namespace references, 308, 309 failure on Oracle or WebSphere Application Server, 564 groups, 313 IBM Cognos 8, 577 importing, 328 moving archives, 328 packages, 311 partial deployment, 311 permissions, 324 planning, 308 portlets to other portals, 441 prerequisites, 324 public folders, 311 reports, 307 roles, 313 SAP Enterprise Portal 6.0, 445 security, 216, 308 specifications, 307 testing, 332 updated PowerCubes, 163 deploying System Administrators, 313 deployment, 307 broken links, 599 creating an export specification, 325 definition, 792 reducing details, 36 rules, 315 See Also deploying deployment archives definition, 793 deployment options partial, 312 deployment specifications definition, 793 Detailed Errors secured functions and features, 221 details reducing deployment, 36 diagnostics, See troubleshooting diagnostic tools, 546 diagram error, 658 different values TM1 data sources, 624 dimensions conformed for drill-through access, 406 overlapping named set levels, 621 directories deploying content, 311 directories, See folders directory not found error, 560 disabled access to reports, 347 disabling chart transparency, 644 content maintenance job, 75, 126 creation core dump files, 89 entries, 253 folders when deploying, 312 packages when deploying, 312 portlets, 433 report attachments in emails, 534 secure error messages, 88 selection-based interactivity, 371 session caching, 145 transfer of IBM Cognos 8 passport ID, 465 trigger-based scheduling, 535 disappearing columns, 623 dispatcher does not start on Application Tier Components computer, 579 dispatchers, 105 cluster compatible mode, 129 deleting, 111 failover for multiple, 118 grouping, 112 importing, 331 load balancing, 129 load-balancing, 129 move, 112 renaming, 116 securing, 120 setting scans for servlet gateways, 119 setting status scans, 118 stopping and starting, 108, 110 testing, 117 Administration and Security Guide 807
Index displaying mixed currencies, 347 distributing burst reports, 374 reports, 372, 374 reports by email, 373 distribution lists creating, 374 groups and roles membership, 209 dividing by zero appearing different in lists and crosstabs, 620 documentation access to more, 35 double-byte characters improperly displayed, 567 downloading, 344 downloading IBM Cognos 8 Go! Office documents in IBM Cognos Connection, 344 download of resource fails, 557 DPR-DPR-1035 error, 552 DPR-ERR-2079 errors, 635 DPR-ERR-2079 Firewall Security Rejection, 668 DPR-ERR-2082 error, 632 drill down definition, 793 drill-down actions Cognos Viewer portlet, 283 pages and dashboards, 283 drilling down, 376 drilling through from cubes to relational data, 643 from relational data to cubes, 644 links not active in Safari Web browsers, 642 multiple values, 38, 422 selection contexts, 402 setting up target parameters, 411 troubleshooting PowerCubes, 643 drilling up, 376 drill-through multiple values, 38 one target report, 39 passing multiple values, 377 to target report, 376 drill through, See drill-through access drill-through access, 401 between packages, 403 808 between PowerCubes and packages, 408 business keys, 407 concepts, 402 conformed dimensions, 406 creating reports, 422 debugging, 419 defining access in packages, 408 Drill-through Assistant, 419 formats, 403 members, 404 model-based access, 402 new features in version 8.4, 33 report-based access, 402 setting up for IBM Cognos Visualizer reports, 426 setting up for PowerPlay reports, 426 setting up in packages, 408 setting up targets in Analysis Studio, 412 using bookmarks, 404 using dates, 408 using scope in model-based, 407 using URLs, 404 values, 404 drill-through actions Cognos Viewer portlet, 283 pages and dashboards, 283 drill-through definition, 402 debugging, 419 Drill-through Assistant, 419 drill-through reports hiding, 32 specifying text, 425 drill up definition, 793 drill-up actions Cognos Viewer portlet, 283 pages and dashboards, 283 DSServlet running, 87 dump files, 542 dynamic SQL adding application context, 32
E
East Asian characters, 665 EBA-090034 Error on WebLogic 8, 562
Index editing iViews, 447 pages, 270 reports, 356 emailing reports, 373 emailing reports disabling, 534 emails setting compression for attachments, 140 enabling comments, 369 communication between portlets, 271 entries, 243, 253 queue metrics, 153 encoding values, 528 encryption configuration errors, 570 entries agents, 383 cancel run, 285 copying, 251, 509 creating bookmarks, 242 current, 285 cutting, 509 deleting, 257 disabling, 253 enabling, 243, 253 hiding, 32, 254 managing, 285 moving, 252 ordering, 257 organizing, 251 past, 287 pasting, 509 properties, 243 renaming, 251, 253 rerunning failed, 297 run history, 294 run priority, 293 scheduled, 291 scheduling, 300 scheduling based on occurrences, 305 scheduling last day of month, 301 searching, 259 selecting links, 256 specifying alternative icon, 259 suspend run, 285 upcoming, 289 viewing hidden entries, 255 entries do not appear, 582 environments setting up multilingual, 46 error certificate expired, 582 creating Framework Manager files, 607 Error 0\:RSV-BBP-0027, 669 error messages #ERROR appears in cells with multiple images in a cell, 667 access denied, 590 BAP-ERR-0002, 641 BAPI-MDDATASET_CHECK_SYNTAX, 641 bo\:heap Buffer Overflow, 662 CAM.AAA, 636 CAM-AAA-0096, 585 CAM-CRP-1064, 556 CAM-CRP-1315 Current configuration points to a different trust domain, 571 cannot render this report, 666 CCS-ERR-1005 login requirements for IBM Cognos 8 could not be obtained, 672 CFG-ERR-0106 Cognos Configuration received no response, 549 CGI timeout, 579, 639, 640 CM-CFG-029 Content Manager is unable to determine, 574 CM-CFG-5036, 591 CMM-APP-3254 The initialization of the metrics store failed, 578 CM-SYS-5007, 591 CM-SYS-5063, 591 CNC-ASV-0001, 628 CNC-GEN-2107, 648 COC-ERR-1003 failed to create slide, 676 COC-ERR-1302 no data source available, 676 COC-ERR-2005 import failed, 676 COC-ERR-2006 failed to load the portal tree, 677 COC-ERR-2012 failed to render the list, 677 COC-ERR-2013 unsupported Office application, 677 COC-ERR-2014 refresh failed, 677 Administration and Security Guide 809
Index COC-ERR-2015 failed to open the import wizard dialog, 677 COC-ERR-2019 failed to refresh an image, 678 COC-ERR-2301 logon failed, 678 COC-ERR-2303 report is not valid for rendering, 678 COC-ERR-2304 this is a prompted report, 678 COC-ERR-2305 Microsoft Excel returned an error, 679 COC-ERR-2308 report specification is empty, 679 COC-ERR-2603 you must add a slide to the presentation before importing any content, 679 COC-ERR-2604 cannot render empty list object, 679 COC-ERR-2607, 679 COC-ERR-2609, 679 COI-ERR-2002 Block type is not valid, 680 COI-ERR-2005 this version of Microsoft Office is not supported, 680 COI-ERR-2006 this Microsoft Office product is not supported, 680 COI-ERR-2008 Unable to retrieve from resources, 680 COI-ERR-2009 Unable to perform this operation because Microsoft Excel is in Edit mode, 681 COI-ERR-2010 The name {0} is not valid, 681 COI-ERR-2011 The server did not return the expected response, 681 COR-ERR-2002 Block type is not valid, 681 COR-ERR-2005 Block specification is not valid or missing, 681 COR-ERR-2006 unexpected type, 681 COR-ERR-2007 error retrieving from resources, 682 COR-ERR-2009 Name formula is not valid, 682 COR-ERR-2010 Formula is not valid, 682 COR-ERR-2011 prompted metadata is not supported, 682 COR-ERR-2012 unable to load metadata, 682 COR-ERR-2013 exploration cannot be converted to formula based, 682 COR-ERR-2014 Due to Excel Worksheet Limitations the Results May Be Truncated, 682 COR-ERR-2015 Exploration cannot be converted to formula based, 683 COR-ERR-2016 Unable to retrieve package, 683 COR-ERR-2017 The current selection did not return any data, 683 corrupt cryptographic information, 573 could not deserialize context attribute, 565 credentials invalid, 581 cryptographic information cannot be encrypted, 570 DIS-ERR-3115 Task execution failed, 578 dispatcher is unable to process the request, 667 download of specified resource fails, 557 DPR-ERR-2014, 558 DPR-ERR-2022 No response generated, 563 DPR-ERR-2056 report server not responding, 542 DPR-ERR-2058, 558, 560 DPR-ERR-2079, 574, 635 DPR-ERR-2082, 632 Excel workbook closes unexpectedly, 664 HRESULT, 626 HTTP Error 404, 560 IBM Cognos 8 for Microsoft Office fails to initialize in Microsoft Internet Explorer, 662 IBM Cognos 8 for Microsoft Office Fails to Initialize in Microsoft Office, 661 IBM Cognos 8 for Microsoft Office unable to create trust relationship, 670 imported reports are missing charts or images, 667 java.lang.StackOverflowError, 628 Java Runtime Environment, 573 malformed request, 566 MDS-RUN-3213 Unable to locate database bulk load utility, 578 Microsoft Office Excel does not open a workbook published from IBM Cognos 8 for Microsoft Office, 662 Object reference not set to an instance of an object, 669 OP-ERR-0199, 620 OP-ERR-0201, 621 ORA-00907, 635 out of memory, 641 overflow errors, 633 page not found, 560 password expired, 581, 586 PCA-ERR-0057, 639 prompted reports, 674, 678 PRS-CSE-1255, 556 QE-DEF-0068, 590, 645
810
Index QE-DEF-0177, 603, 633 QE-DEF-0259, 604 QE-DEF-0260 parsing error, 605 QE-DEF-0285, 590, 645 QE-DEF-0288, 632 QE-DEF-0325, 590, 645 RDS Data Limit Exceeded, 666 RDS-ERR-1000 Report Data Service could not process the response from the content provider, 670 RDS-ERR-1001 PowerPlay report could not be run, 671 RDS-ERR-1004 connection could not be established with IBM Cognos 8, 671 RDS-ERR-1012 IBM Cognos Content Service unable to discover the content providers, 672 RDS-ERR-1013 Report Data Service unable to query Content Manager, 672 RDS-ERR-1014 Report Data Service unable to create the document object, 672 RDS-ERR-1015 Report Data Service unable to create a new document version, 672 RDS-ERR-1016 Report Data Service unable to create a new document content object, 672 RDS-ERR-1018 IBM Cognos 8 report could not be run, 673 RDS-ERR-1019 IBM Cognos Content Service unable to retrieve portal information from IBM Cognos Connection, 673 RDS-ERR-1020 currently provided credentials are invalid, 673 RDS-ERR-1021 IBM Cognos 8 report could not be run because it contains unanswered prompts, 674 RDS-ERR-1022 request received by Report Data Service is not valid, 674 RDS-ERR-1023 report could not be run because it exceeds the Report Data Service data size limit set by the administrator, 674 RDS-ERR-1027 encoding for the PowerPlay server could not be determined, 674 RDS-ERR-1028, 672 RDS-ERR-1030 security error occured while trying to establish a connection, 674 RDS-ERR-1031 Report Data Service was unable to retrieve the metadata for report, 674 RDS-ERR-1033 Report Data Service unable to create the report view, 674 RDS-ERR-1034 report specification for report could not be retrieved from IBM Cognos 8, 675 RDS-ERR-1039 request could not be cancelled. request is no longer running, 675 RDS-ERR-1040 conversation with conversation ID has been cancelled, 675 RDS-ERR-1044 The output for the requested version could not be retrieved, 675 RDS-ERR-1045 LayoutDataXML Output was not generated, 676 RDS Server unavailable, 666 Report Data Service (RDS) numbered error messages, 670 reports unavailable in IBM Cognos Connection jobs after using Save As command in Report Studio, 665 RQP-DEF-0114, 567 RSV-DR-0002, 632 RSV-SRV-0025, 626 RSV-SRV-0040, 620 RSV-SRV-0066, 567 SBW-ERR-0020, 599 secure, 88 servlet class fails to load on WebLogic, 579 SoapSocketException, 558 SQL1224N, 558 SQL Server cannot be found, 590 table or view not found in dictionary, 636 This item cannot be expanded, 669 UDA-SQL-0031, 590, 645 UDA-SQL-0107, 590, 603 UDA-SQL-0114, 603, 626, 633 UDA-SQL-0206, 626 UDA-SQL-0208, 590 UDA-TBL-0004, 633 Unable to load balance the request, 558 unable to open published Microsoft Office documents from IBM Cognos 8, 663 unable to view reports after clicking view report, 670 using, 539 you have chosen to download a file, 563 errors calculations with double quotation marks, 611 DB2-ERR-0028, 576 Administration and Security Guide 811
Index importing tab-delimited files, 657 importing translation files to Map Manager, 651 ERWin metadata out of memory error, 602 Essbase, 560 cube sample, 69 See Hyperion Essbase Essbase changes, 621 eTrust SiteMinder namespace, 201 event management service, 106 event management services, 105 events definition, 793 logging, 80 records, 80 viewing most recent, 387 viewing program, security, and systems, 544 Event Studio agents, 383 cannot call the SDK from Event Studio, 628 CNC-ASV-0001 java.lang.StackOverflowError, 628 customizing styles, 480 hyperlinks in email messages are stripped out when the agent is saved, 627 report contains no data, 627 returning databases to original state, 78 samples, 76 secured functions and features, 221 examples Shift-JIS encoding, 686 testing the installation, 545 Excel multipage report type does not work, 565 Excel, See Microsoft Excel Excel formatting reports, 359 Excel reports Analysis Studio, 635 exceptions unhandled, 542 execute permissions, 213 secured functions and features, 225 execution time, maximum, 137 expired password, 586 expired sessions, 668 exporting, 325 creating a specification, 325 data, 325 Exporting to a CWM file, 605 expressions braces, 604 errors, 604 externalized dimensions prompts, 605 external namespaces control browsing, 123 deploying references, 308, 309 eTrust SiteMinder, 201 IBM Cognos Series 7, 201 LDAP, 201 Microsoft Active Directory, 201 NTLM, 201 SAP, 201
F
failed entries rerunning, 297 failovers multiple dispatchers, 118 fails metric maintenance task, 657 features, See secured features file-based data sources paths, 181 files importing map files, 651 not found, 560 file types registering, 662 filter expressions creating for drilling through from IBM Cognos Series 7 to IBM Cognos 8, 426 filtering troubleshooting, 626 filters global, 40 make_timestamp columns, 626 Query Studio, 632 finding information, 29
812
Index firewall errors, 635 firewalls IBM Cognos Application Firewall, 204 firewall security rejection, 668 flicker, 580 folders configuration, 112 creating, 258 deploying public, 311 disabling when deploying, 312 My Folders, 258 ordering, 257 personal, 258 public, 258 font embedding in PDF files, 134 fonts changing, 482 changing defaults, 482 changing Report Studio interface, 487 in PDF files, 134 installing, 47 linking to core fonts, 665 not found when starting IBM Cognos Configuration on UNIX, 575 formats changes to decimals, 615 drill-through access, 403 format strings, 166 formatting .csv outputs, 526 colors, 482 data formats for Query Studio, 520 reports, 357 reports in CSV format, 360 reports in Excel format, 359 reports in HTML, 358 reports in XML, 358 reports show unexpected results, 624 style sheets, 482 text, 482 Framework Manager backing up, 197 cryptographic error, 551 sample models, 76 unable to load DB2 OLAP library, 576 full outer joins, 603 Oracle, 606 functions errors, 604 functions, See secured functions
G
gateway cannot access URI, 602 log file, 541 recommended settings for Microsoft IIS, 579 when to use ISAPI, 579 gateways definition, 793 specifying mappings for report data service, 116 GB18030 characters in names, 607 GB18030 support, 665 global changes fonts, 482 migrating changes to future releases, 483 rebranding, 481 style sheets, 482 global filters Cognos Viewer portlet, 280 drill-through reports, 40 drill-up and drill-down actions, 40 pages and dashboards, 278 prompts, 40 using metrics, 279 GlobalReportStyles.css file, 482 Glossary object capabilities, 229 secured functions and features, 221 See Also IBM WebSphere Business Glossary glyphs definition, 793 Go To page more information, 41 govenor limit, 141 Governor limit (IBM Cognos Connection setting), 674 Governor limits report sizes for report data service, 141 granting access, 215 graphic datatype, 603
Index graphics customizing portal interfaces, 486 interface images, 479 Query Studio, 489 Report Studio, 488 Great Outdoors, See IBM Cognos samples Great Outdoors samples, 57 grouped data items troubleshooting, 620 grouped lists subtotals, 621 grouped reports troubleshooting incorrect running totals, 642 grouping dispatchers, 112 groups, 208 adding and removing members, 211 adding distribution lists, 209 built-in, 233 creating, 210 customizing user interfaces in IBM Cognos Connection, 503 definition, 793 deploying, 313 IBM Cognos Controller, 210 missing membership in Active Directory Server, 576 modifying settings after installation, 236 security, 207 histories deployment, 332 history chart error, 658 history summary counts hiding, 537 home pages setting, 275 hotspots, limiting, 139 HRESULT errors, 626 HTML printed report unsatisfactory, 649 HTML formatting reports, 358 HTML Source, 737 HTML Viewer, 733 HTTP Error 404, 560 Hyperion Essbase data sources, 164 hyperlinks in email messages are stripped out when the agent is saved, 627
I
IBM Cognos business packages in SAP Enterprise Portal 6.0, 446 namespace, 203 samples, 63 Series 7, adding content to the portal, 52 Series 7, using namespace, 52 IBM Cognos 8 accessing IBM Cognos Connection using URLs, 787 dispatchers, 108 does not start on an application server, 571 performing tasks using URLs, 773 service does not start, 552 services, 108 starting components using URLs, 777 using report data in Microsoft Office, 343 IBM Cognos 8 administration, 43 IBM Cognos 8 and PowerPlay single signon, 380 IBM Cognos 8 BI Analysis for Excel cell-based report errors, 665 numbered error messages, 681 IBM Cognos 8 for Microsoft Office configuration and setup issues, 661
H
Han characters troubleshooting, 665 help getting, 29 unable to launch, 547 hidden entries, 254 viewing, 255 hiding drill-through reports, 32 entries, 32, 254 history summary counts, 537 user interface elements, 503, 504, 707 user interface elements in pages and dashboards, 504 hierarchies DB2 OLAP, 165
814
Index failure to initialize in Microsoft Office, 661 numbered error messages, 680 opening published documents, troubleshooting, 662 processing issues, 666 security issues, 669 supported Microsoft Office applications, 680 IBM Cognos 8 gateway addresses, 681 IBM Cognos 8 Go! Office data size limits, 674 deploying the client components, 343 downloading documents in IBM Cognos Connection, 344 error using Run Reports, 578 firewall security rejection, 668 macro seciurity level for Microsoft Office XP, 344 numbered error messages, 676 opening in Microsoft Word, 661 rendering reports, troubleshooting, 666 SSL, 344 unable to view reports, 670 using IBM Cognos report data in Microsoft Office, 343 IBM Cognos 8 samples, 544 IBM Cognos 8 server fails to start, 552 IBM Cognos 8 service server not available, 553 starting, 574 IBM Cognos Administration access denied, 587 Status page, 99 IBM Cognos Application Firewall, 204, 776 IBM Cognos Configuration changing the sort buffer size, 633 font not found error on UNIX, 575 invalid settings, 553 problems opening, 540 problems saving a configuration, 567 problems with keyboard navigation, 572 trouble generating cryptographic keys after install, 570 unable to start, 572 IBM Cognos Connection, 239 accessing using URLs, 787 adding user interface elements, 506 agents, 385 background color in header, 485 customizing, 502 customizing appearance, 484 customizing report output formats, 517 customizing user interface elements, 503 downloading IBM Cognos 8 Go! Office documents, 344 downloading Microsoft Office documents, 344 entries do not appear, 582 header background color, 485 hiding user interface elements, 503 main header branding, 484 Series 7 reports, 52 troubleshooting unavailable reports, 665 unable to open, 560 unable to open published Microsoft Office documents, 663 unable to retrieve portal information, 673 updated look for 8.3, 41 IBM Cognos Connection styles, 260 IBM Cognos Controller security, 210 IBM Cognos Finance data sources, 157 IBM Cognos groups creating, 210 updating, 211 IBM Cognos Now! Cube data sources, 157 IBM Cognos Office Connection, See IBM Cognos 8 Go! Office IBM Cognos Planning - Contributor data sources, 157 IBM Cognos Planning - Series 7 data sources, 157 IBM Cognos PowerCubes open slowly, 592, 613 IBM Cognos Resource Center, 29 IBM Cognos roles creating, 210 updating, 211 IBM Cognos samples, 63 IBM Cognos Series 7 cubes, 157 migrating reports to IBM Cognos 8, 127 opening cubes, 382 opening PowerPlay reports, 380 PowerPlay reports and cubes, 379 reports in IBM Cognos Connection, 378 running PowerPlay reports, 380 Administration and Security Guide 815
Index users, 207 IBM Cognos Series 7 namespace, 201 IBM Cognos Series 7 namespaces single signon, 380 IBM Cognos Series 7 reports cannot access, 590 IBM Cognos Transformer known issues, 609 IBM Cognos Virtual View Manager, See Also composite software IBM Cognos Visualizer reports setting up drill-through access to IBM Cognos 8, 426 IBM Cognos Watchlist, See Metric List IBM DB2, See DB2 IBM Infosphere Warehouse Cubing Services, 168 IBM Lotus Notes attachments, 534 IBM Metadata Workbench, 32 lineage solution, 151, 355 IBM WebSphere AIX version, 564 IBM WebSphere Business Glossary accessing in Cognos Viewer, 356 configuring URI, 152 icon graphics not working in Portal Services, 646 icons custom report templates, 497 specifying alternative for entry, 259 images missing in imported reports, 667 missing in PDF report, 648 multiple images in Microsoft Excel, 667 refreshing, 678 Image Viewer, 734 Import Content wizard failure to open, 677 slides, troubleshooting, 676 importing configurations, 331 data into IBM Cognos 8, 328 metric data for Metric Studio, 394 portlets in IBM Cognos Connection, 432 samples, 74 importing data rules, 315 improving performance, 127 information finding, 29 Informix data sources, 169 initial security settings, 233 inner joins, 606 installation problems, 549 requirements for directory name, 558 testing, 545 installation and configuration issues cannot load DB2 OLAP library, 576 installation directory problems after renaming or moving, 571 installations COM add-in, 661 installing fonts, 47 IBM Cognos 8 on Linux, 567 IBM Cognos business packages in SAP Enterprise Portal 6.0, 446 portlet applications file for WebSphere Portal, 442 Integrated Windows Authentication issues, 575 interactive features controls in reports, 36 interactivity in pages and dashboards, 278 interfaces changing appearance of components, 479 Internet Explorer, See Microsoft Internet Explorer invalid cogstartup.xml file, 573 invalid settings content store, 553 IBM Cognos Configuration, 553 iqd data source troubleshooting Sybase connection error, 609 IQD files unable to use, 610 ISAPI when to use for a gateway, 579 isolation levels data sources, 188 iViews configuring, 447 default content and appearance, 448
816
K
keyboard navigation problems, 572 key figures not added after importing, 601 prompts, 605 Knowledge Base, 539 known issues IBM Cognos Transformer, 609 Metric Studio, 654, 658 Korean characters display incorrectly after upgrade, 566 Korean characters troubleshooting, 665
J
Japanese characters display incorrectly after upgrade, 566 characters in export path, 605 Japanese characters round trip safety, 686 troubleshooting, 665 Japanese Internet Explorer Analysis Studio, 635 jar file error when starting configuration, 573 Java supported versions for DB2 content store, 552 uses all of CPU, 552 JAVA_HOME setting, 573 java.lang.NoClassDefFoundError, 551 Java error when starting configuration, 573 job queue metrics, enabling, 153 jobs, 40 definition, 794 delivery options, 248 properties, 248 rerunning failed, 297 scheduling, 301 services, 105 steps, 301 submission of steps, 248 job service, 106 job steps definition, 794 joins full outer, 603 inner, 606 Oracle, 606 JRE conflicts when using portal services, 595 JVM conflicts when using portal services, 595
L
language conversion tables, 566 does not match, 597 incompatibility after upgrade, 566 language packs troubleshooting subkeys, 664 languages choosing for reports, 360 data does not display properly, 610 defaults for reports, 362 incorrect in SAP BW query, 603 mixed when using samples, 636 new support in version 8.4, 31 OLAP data sources, 631 SAP BW data sources, 361 LDAP namespace, 201 levels member unique names, 405 security, 605 limiting content browsing, 513 lineage configuring, 151 IBM Metadata Workbench, 151, 355 viewing, 33, 355 Lineage object capabilities, 229 secured functions and features, 221 linked fonts, 665 linked models upgrading, 606 Administration and Security Guide 817
Index links broken following deployment, 599 entries, 256 unable to click, 647 Linux characters not displayed properly, 567 list objects rendering empty lists, 679 list reports More or All errors, 669 lists subtotals in grouped lists, 621 load-balancing setting, 129 load balancing dispatchers, 129 loading message saving a report takes a long time, 628 locale mismatch, 597 locales definition, 794 Microsoft Analysis Server, 169 overriding in the prompt cache, 124 sorting of entries, 122 users, 208 locking portlets, 433 log database deleting tables, 568 log destinations types of, 79 log files, 539 for gateway errors, 541 locale configuration, 541 Metric Studio, 653 run-time, 541 silent mode, 541 startup configuration, 540 transfer, 540 transfer summary, 540 uninstallation, 541 logging audit reports, 82 data schema for messages, 749 messages, 80 native queries, 81 report validation levels, 81 818 setting up, 80 logging levels setting, 82 logging levels affect performance, 594 logging off, 239 logging on, 239 multiple namespaces, 216 log messages remote log server, 79 See Also troubleshooting logon problems SAP namespace, 584, 585 logs database tables for messages, 749 message processing, 79 metric maintenance tasks, 657 service, 107 services, 105 Lotus Notes attachments, 534
M
managing packages in non-root folders, 36 Map Manager configuring for multilingual, 46 importing files, 651 importing translated text files, 651 measures format strings, 166 not added after importing, 601 members drill-through access, 404 IBM Cognos groups and roles, 211 member unique names relational metadata, 405 troubleshooting, 637 messages logging, 80 metadata, 243 Metric Designer adding IQD files to an import source, 658 blanks in scorecard hierarchy preview, 659 troubleshooting, 653 Metric History Chart, 41, 728 Metric List, 41, 726
Index metric maintenance task fails, 657 metric package DB2, 657 metric packages access permissions, 657 definition, 794 metric packages for Metric Studio changing default action, 392 metrics definition, 794 resetting, 103 resetting for the system, 103 metric scores attributes, viewing, 101 metric scores in Scorecard pane, 99 Metrics Custom Diagram, 731 metrics for Metric Studio, 391 changing export properties, 399 changing import tasks, 395 clearing metric history and calendar data, 395 clearing metric history data, 396 clearing rejected data logs, 395 clearing rejects tables, 395 creating export tasks, 397 creating import tasks, 394 creating maintenance tasks, 396 creating packages, 391 deleting tasks, 393 importing data into metric store, 394 importing data into staging tables, 394 importing data tasks, 394 maintenance tasks, 395 modifying import tasks, 395 modifying tasks, 393 recalculating derived values, 396 running tasks, 392 scheduling tasks, 392 synchronizing users with namespaces, 396 transferring data to metric store, 394 updating search engine indexes, 396 metrics for system performance, 91 data gathering, 91 jvm, 94 list of metrics, 92 process, 98 queue, 93 request, 95 session, 92 Metrics Impact Diagram, 730 Metrics Manager service, 107 Metrics pane in IBM Cognos Administration, 100 metric store failure, 578 permissions, 658 Metric Studio cmm_uninstall script, 655 creating metrics, 391 data source not displayed, 656 DB2, 658 errors when importing, 657 known issues, 654, 658 metrics, 391 metric store check fails, 657 permission denied, 657 portlets, 34, 41 secured functions and features, 221 SQL Server 2005 error, 655 support bundle, 654 task fails, 657 troubleshooting, 653 user permissions for metric store, 658 metric threshold setting, 101 Microsoft security update affects memory, 552 SharePoint Portal Server, 454 Microsoft .NET Framework, 343 Microsoft .NET support for Microsoft applications is not installed, 679 Microsoft Active Directory, 201 Microsoft Analysis Server data sources, 169 single signon, 169 Microsoft Analysis Services setting up MSAS cube samples, 68 Microsoft Excel #ERROR, 667 #NAME? errors, 665 COC-ERR-2305, 679 COC-ERR-2607, 679 failure to render lists, 677 Administration and Security Guide 819
Index More or All errors, 669 no report content is imported, 667 refreshing content, troubleshooting, 681 row and column restrictions, resolving, 669 supported versions, 677 using IBM Cognos report data in workbooks, 343 workbook closes unexpectedly, 664 Microsoft Excel 2007 support, 39 Microsoft IIS Web servers recommended gateway settings, 579 Microsoft Internet Explorer cannot initialize IBM Cognos 8 for Microsoft Office, 662 IBM Cognos 8 for Microsoft Office, setting options, 676 setting security options, 663 Microsoft Office report data service, 108 supported applications are not installed, 679 using IBM Cognos report data in workbooks and presentations, 343 Microsoft Office documents downloading from IBM Cognos 8, 344 renaming folders or documents, 681 Microsoft Office Excel multipage report type does not work, 565 Microsoft Outlook resolving IBM Cognos 8 Go! Office issues, 661 Microsoft PowerPoint importing slides, troubleshooting, 679 report format and layout, troubleshooting, 673 supported versions, 677 troubleshooting Import Content wizard, 676 using IBM Cognos report data in presentations, 343 Microsoft SharePoint support for Portal 2003, 41 Microsoft SQL Server creating data source connections, 589 data sources, 171 single signon, 171 Microsoft SQL Server 2008, 171 Microsoft Word IBM Cognos 8 Go! Office does not start, 661 supported versions, 677 migrating interface customization to later versions, 483 portlets, 464 ReportNet system.xml files, 501 Migration service, 107 missing items in a report or analysis, 637 missing values dividing by zero, 620 model troubleshooting import error, 609 model-based drill-through access using scope, 407 model errors calculations with double quotation marks, 611 modeling sample models and packages, 61 models, 243 backing up, 197 database samples, 76 definition, 794 modifying for samples, 74 optimizing, 128 monitoring events, 80 services, 105 monitor service, 107 More option Error 0\:RSV-BBP-0027 error, 669 move dispatchers, 112 movement data, 199 moving deployment archives, 328 entries, 252 MSAS, 560 MS Cube, 559 Multi-page, 738 Multi-page portlet, 40 creating dashboards, 275 multiple formats unable to select, 637 multiple languages data does not display properly, 610 multiple values drill-through, 38
820
Index multiscript extensions, 703 My Folders, See folders My Folders tab missing, 646 My Pages adding IBM Cognos Series 7 content, 52 news item headlines receiving, 387 news items definition, 795 non-english characters appear as placeholders, 642 non-English operating system troubleshooting .NET Framework, 664 no response generated, 563 notification database deleting tables, 568 NTLM namespace, 201 access to IBM Cognos Administration denied, 587 null values included in count summaries, 625 null-value suppression, 162 numeric formats, 166
N
named sets limitations, 378 nested or parallel sets overlapping, 621 namespace Active Directory Server missing group membership, 576 cannot log on, 556 recreating, 572 namespaces, 201 browsing external, 123 definition, 794 deleting, 202 deploying external references, 308, 309 IBM Cognos, 203 logging on, troubleshooting, 672 multiple, 201 multiple namespaces, 216 restoring, 202 using from IBM Cognos Series 7, 52 See Also authentication providers See Also external namespaces native language support, 665 native query logging, 81 native SQL adding comments to SQL statements, 147 native SQL commands, 745 nested list reports not running after upgrading, 620 nested reports troubleshooting, 678 nested sets unexpected summary values, 625 network outage services fail to start, 557 new features IBM WebSphere Business Glossary, 32 version 8.3, 35 version 8.4, 31
O
object capabilities, 33, 229 Glossary, 229 Lineage, 229 setting up, 231 See Also secured functions objects customizing actions in IBM Cognos Connection, 509 removing actions, 510 ODBC data source connections, 589 data sources, 173 OLAP data sources, 559, 560 connections, 70 languages, 631 members missing or inaccessible, 576 OLAP source cannot connect, 592 opening agents from IBM Cognos Connection, 385 PowerPlay reports, 380 reports, 348 OP-ERR-0199 errors, 620 OP-ERR-0201 errors, 621 optimizing models, 128 performance, 127 options advanced current run, 351 Administration and Security Guide 821
Index current report run, 350 report run defaults, 348 setting advanced for PDF format, 358 ORA-00907 errors, 635 Oracle CM-CFG-5063, 591 CM-SYS-5007, 591 CM-SYS-5036, 591 content manager connection, 591 deployment errors, 578 failed Metric Studio reports, 654 full outer joins, 606 Metric Studio disconnected from database, 655 NLS_LANG environment variable, setting, 658 unable to use IQD file, 610 Oracle Application Server deploying IBM Cognos 8, 577 IBM Cognos 8 deployment failure, 564 Oracle content store compatibility levels, 578 error initializing, 578 Oracle databases proxy connections, 190, 193 virtual private databases, 190, 194 Oracle data sources, 176 troubleshooting, 635 Oracle full outer joins, 603 ordering entries, 257 folders, 257 organizing entries, 251 outer joins full, 603 Oracle, 606 out of memory error, 602 out of memory errors in HP-UX, 641 output files system metrics, 543 overflow errors in crosstab report, 633 packages, 243, 601 administering, 335 definition, 795 deploying, 312 disabling when deploying, 312 drilling-through, 403 large, 606 managing, 36 publishing, 36 setting up drill-through access, 408 page breaks unexpected results, 630 page not found error starting IBM Cognos 8 in Windows 2003, 560 pages access permissions, 270 adding interactivity, 278 content, 267 creating, 269 creating tabs, 273 customizing fonts, 486 custom Welcome page, 514 deleting, 269 deleting tabs, 274 drill-through actions, 283 drill-up and drill-down actions, 283 editing, 270 global filters, 278 hiding user interface elements, 504 home, 275 managing in IBM Cognos Connection, 267 multiple tabs, 40 properties, 249 sharing, 270 See Also dashboards paper sizes defining, 247 parse errors opening or running upgraded reports, 633 passports definition, 795 password expired, 581 passwords SAP namespace, 584 past entries, 287
P
p2pd.war file for WebLogic, 565 package creating, 162 822
Index past activities, 287 pcactivate deploying updated PowerCubes, 163 PCA-ERR-0057 errors, 639 PDF format character encoding settings, 134 compression algorithm level settings, 134 content compression type settings, 134 excluding blank pages in reports, 372 file settings, 134 font embedding settings, 134 reports, 358 setting advanced options, 358 PDF manual printing, 547 PDF problems charts, 648 missing images in report, 648 printing reports, 648 PDF security setting in reports, 358 performance BAPI errors, 641 logging level, 594 peak times, 130 Query Studio is slow, 641 query takes too long to filter non-ASCII text, 641 running reports, 639 system, 91 tuning, 127 Performance assessement of system, 100 periodical document settings, 138 permissions actions, 215 deleting groups and roles, 216 deploying, 324 deployment, 216 execute, 213 granting or denying, 215 metric store, 658 parent/child, 216 properties, 246 read, 213 secured functions and features, 221, 225 set policy, 213 traverse, 213 write, 213 See Also access permissions personal folders, See folders personalizing portals SAP BW iViews, 448 PIA (Primary Interop Assemblies) installing subkeys, 661 planning deployment, 308 planning data service, 107 planning job service, 107 planning Web service, 107 plannning administration console service, 107 Plumtree portal, See ALUI 6.1 pop-up blocking, 563 portal, 260 errors in starting, 560, 563 portal problems, 645 icon graphics not working, 646 My Folders tab does not appear, 646 styles used in previous version still applied, 647 unable to click links, 647 unable to open, 560 portals, 239 customizing object actions, 509 personalizing IBM Cognos Connection, 260 supported in IBM Cognos 8, 441 portal services conflicts with JREs, 595 only administrator can see portlets using IBM Websphere portal, 597 unable to access portlets, 595 Portal Services, 717 icon graphics not working, 646 protocol schemes, 467 run-time parameters, 434, 465 unable to authenticate user, 587 unable to log on, 587 portlet applications file installing in WebSphere Portal, 442 portlets, 429, 717 access permissions, 433 Bookmarks Viewer, 732 cannot access, 595 Cognos Extended Applications, 726 Cognos Navigator, 717 Administration and Security Guide 823
Index Cognos portlets, 429 Cognos Search, 719 Cognos Viewer, 721, 724 configuring cache in IBM Cognos Connection, 434 definition, 795 disabling, 433 enabling communications, 271 HTML Source, 737 HTML Viewer, 733 Image Viewer, 734 importing into IBM Cognos Connection, 432 locking, 433 Metric History Chart, 41, 728 Metric List, 41, 726 Metrics Custom Diagram, 731 Metrics Impact Diagram, 730 migrating, 464 modifying, 271, 435, 444, 454 Multi-page, 40, 738 new in IBM Cognos Connection, 34, 41 RSS Viewer, 735 Safe Mode Viewer, 598 single signon, 432 WSRP standard, 432 ports already in use, 551 PowerCubes cannot open, 559 creating packages, 162 data sources, 157 error when creating data source connections, 592 incorrect results, 626 location paths, 157 open slowly, 592, 613 optimizing, 157 paths to cube files, 181 pcactivate, 163 troubleshooting drilling through, 643 updating, 33, 163 PowerPlay changing report defaults, 381 connection problems, 672 failure to retrieve metadata from, 674 font conversions Series 7 Web reports, 690 report properties, 247 running reports, troubleshooting, 671 specifying server location for IBM Cognos Connection, 116 unresponsiveness, troubleshooting, 674 using PowerPlay report authoring tools, 379 PowerPlay reports setting up drill-through access to IBM Cognos 8, 426 PowerPlay Web Explorer working with cubes, 382 predefined entries, 234 initial access permissions, 700 preferences viewing hidden entries, 255 preferences, See IBM Cognos Connection styles prerequisites deploying, 324 presentation service, 108 presentation services, 105 preview modes Query Studio, 520 Primary Interop Assemblies (PIA), 661 printers setting up, 48 printing after restarting dispatcher, 658 reports, 373 setting up printers, 48 printing copyright material, 29 printing PDF manuals, 547 printing reports, 648 missing images in PDF, 648 PDF reports, 648 problems, 629 unsatisfactory results when printing HTML reports, 649 prioritizing queries, 143 problems SAP namespace, 585 problems opening IBM Cognos Configuration, 540 processes BI Bus server remains in memory after shutdown, 594 dispatcher capacity, 129 setting number, 131 processing capacity, 129 processing issues, 666
824
Index product languages adding to Cognos Viewer, 493 setting, 260 product locale definition, 795 profiles styles, 437 user, 339 projects backing up, 197 definition, 795 prompt cache overriding locales, 124 prompted reports error messages, 674, 678 incorrect format for the Prompt value, 668 prompts cache data, 301 definition, 795 key figures, 605 page formats, 494 scheduled entries, 299 specifying default report values, 362 properties .csv outputs, 526 agents, 249, 384 changing metric export properties for Metric Studio, 399 changing metric import tasksfor Metric Studio, 395 contacts, 243 data movement, 200 disabling entries, 243 entries, 243 formats, 247 jobs, 248 languages, 243, 247 modifying metric import tasks for Metric Studio, 395 multilingual, 361 multilingual IBM Cognos Series 7 reports and cubes, 382 owners, 243 pages, 249 permissions, 246 prompt values, 247 report output versions, 243 rules, 250 run histories, 243 running as the owner, 247 screen tips, 243 shortcuts, 243 source reports, 243 protocol schemes Portal Services, 467 providers security, 201 proxy connections Oracle databases, 190, 193 proxy sessions starting in databases, 742 stopping in databases, 743 public folders, 258 deploying, 311 published documents opening in Microsoft Office, 662 unable to open from IBM Cognos Connection, 663 publishing definition, 795 packages in non-root folders, 36
Q
QE-DEF-0068 errors, 645 QE-DEF-0177, 603 QE-DEF-0177 errors, 633 QE-DEF-0259, 604 QE-DEF-0260 parsing error, 605 QE-DEF-0285 errors, 645 QE-DEF-0288 errors, 632 QE-DEF-0325 errors, 645 qrsvpproperties.xml.sample file, 525 queries definition, 796 prioritizing, 143 query calculations null values included in count summaries, 625 query execution, concurrent, 141 Query Studio changing the default template, 525 creating reports without data, 354 customizing data formats, 520 customizing graphics, 489 customizing menu colors, 489 customizing styles, 480 Administration and Security Guide 825
Index customizing toolbars and menus, 490 disabling session caching, 145 filters, 632 modifying style sheets, 488 QE-DEF-0260 parsing error, 605 report definition, 545 report properties, 247 reports, 347 secured functions and features, 221 starting in preview mode, 520 query subjects DB2, 603 queue limits setting, 133 queue metrics, enabling, 153 queues managing, 36 quick tours using, 29 removing actions, 510 data formats for a locale, 523 renaming dispatchers, 116 entries, 251, 253 styles, 480 reordering tabs, 275 report contains no data, 627 report data service, 105, 108 specifying gateway mappings, 116 Report data service report size limit, 141 Report Data Service (RDS) cancelling requests, 675 Data Limit Exceeded errors, 666 failure to connect to PowerPlay Enterprise Server, 672 numbered error messages, 670 processing requests, troubleshooting, 667 unavailable server, troubleshooting, 666 report definition in Query Studio, 545 report distribution problems, 627 report link in email notification does not work, 627 ReportNet to IBM Cognos 8 upgrade file, 541 ReportNet reports upgraded reports look different, 641 report output how long to keep, 365 viewing, 364 report output files saving, 148, 363 saving in IBM Cognos 8, 149 saving outside IBM Cognos 8, 149 report outputs definition, 796 saving to a file, 39 reports, 240, 347 accessibility for the disabled, 347 adding custom templates, 495 adding multilingual properties, 361 adding to alert list, 366 advanced current run options, 351
R
ragged hierarchies Report Studio, 615 read permissions, 213 rebranding, 481 recalculating derived metric values for Metric Studio, 396 recreating the Cognos namespace, 572 recursive evaluation errors, 639 refresh caches, 301 Refresh all data (command) troubleshooting, 677 refresh cache data, 301 regular column converting to calculated column, 611 related documentation, 27 relational data drilling through to cubes, 644 relational data sources members missing or inaccessible, 576 remote servers connecting, 453 reconfiguring in ALUI 6.1, 450 starting in ALUI 6.1, 449
826
Index allowing alert lists, 365 Analysis Studio, 347 bursting, 374 cannot access Series 7 reports, 590 cell-based with #NAME? errors, 665 changing PowerPlay defaults, 381 choosing languages, 360 comments, 369 comments in saved reports, 32 configuring for multilingual, 47 contains no data, 627 controlling interactive features, 36 creating, 353 creating distribution lists, 374 creating drill-through access, 422 creating in Query Studio without data, 354 creating views, 354 CSV formats, 360 current run options, 350 customizing output formats in IBM Cognos Connection and Cognos Viewer, 517 customizing reports using styles, 482 default languages, 362 default options, 348 definition, 796 deploying, 307 disabling as email attachments, 534 display problems in dashboards, 598 distributing, 372 drilling down, 376 drilling through, 401 drilling through passing multiple values, 377 drilling through to target report, 376 drilling up, 376 drill-through text, 425 editing, 356 emailing, 373 enabling comments, 369 enabling watch rules, 367 exceeding RDS data limits, 666 Excel formats, 359 excluding blank pages in PDF, 372 format of prompted reports, 668 formats, 357 formatting changes when upgrading, 641 HTML formats, 358 IBM Cognos Series 7, 379 IBM Cognos Series 7 in IBM Cognos Connection, 378 IBM Cognos Series 7 multilingual properties, 382 migrating IBM Cognos Series 7 to IBM Cognos 8, 127 missing charts or images, troubleshooting, 667 nested reports, troubleshooting, 678 no report content is imported in IBM Cognos 8 Go! Office, 667 opening, 348 PDF format, 358 printing, 373 prompted reports in IBM Cognos 8 Go! Office, 668 Query Studio, 347 removing from alert list, 366 report names with quotation marks, 667 Report Studio, 347 rerunning failed, 297 resubmitting failed, 40 running, 240, 348 running IBM Cognos 8 Go! Office reports after expired session, 668 saving, 373 saving report outputs to a file, 39 scheduling, 299 scheduling last day of month, 301 scheduling views, 299 setting queue limits, 133 specifying default prompt values, 362 targeting, 39 troubleshooting, 630 troubleshooting report rendering problems, 666 unable to view reports in IBM Cognos 8 Go! Office, 670 usage audit, 87 user access to Series 7 from IBM Cognos Connection, 52 using alerts, 38 viewing, 348 viewing older versions, 364 watch rules, 366 XML formats, 358 report server managing data source connection timeouts, 184 report server settings, 143 Administration and Security Guide 827
Index report service, 105 advanced properties, 529 advanced settings, 644 report services, 108 report specifications custom template, 495 definition, 796 missing content, 679 upgrading, 332 Report Studio authoring modes, 37 authoring profiles, 227 creating drill-through reports, 422 customizing graphics, 488 customizing styles, 480 custom report templates, 495 disabling session caching, 145 does not start, 563 interface fonts, 487 Map Manager, 46 menu colors, 487 modifying style sheets, 486 nulls included in count summaries, 625 ragged hierarchies, 615 report properties, 247 reports, 347 saving changes in a job, 665 secured functions and features, 221 testing, 545 unbalanced hierarchies, 615 unexpected summary values when using nested sets, 625 Report Studio authoring modes enabling, 37 report subscriptions, 38 report templates custom icons, 497 report validation levels, 81 report views definition, 796 requests load-balancing, 129 processing, 131 requirements installation directory, 558 resetting metrics, 103 system metrics, 103 resources, 539 troubleshooting, 539 Resources.xml file, 497 restoring data, 197 namespaces, 202 samples databases, 64 restricting access to IBM Cognos 8, 53 restricting content browsing, 513 using a URL command, 513 using the system.xml file, 513 resubmitting failed, 40 result set of stored procedure, 601 return values cogconfig.sh not UNIX compliant, 567 rights, See access permissions roles, 208 adding and removing members, 211 adding distribution lists, 209 built-in, 233 creating, 210 customizing user interfaces in IBM Cognos Connection, 503 deploying, 313 IBM Cognos Controller, 210 IBM Cognos Series 7, 209 modifying settings after installation, 236 predefined, 234 running reports, 209 security, 207 root name for Cognos portlets changing, 464 round trip safety applying conversions and substitutions, 689 configuration utility, 686 Japanese characters, 686 restoring default conversion settings, 689 Series 7 PowerPlay Web reports, 690 specifying conversions, 687 routing reports setting server group names, 128 RQP-DEF-0177 errors, 639
828
Index RSS definition, 796 RSS channels displaying the HTML code, 436 RSS Viewer, 735 RSV-DR-0002 error, 632 RSVP.PROMPT.RECONCILIATION settings, 143 RSVP.RENDER.VALIDATEURL, 776 RSV-SRV-0025 errors, 626 RSV-SRV-0040 errors, 620 rules deployment, 315 properties, 250 run history how long to keep, 296 scheduled entries, 300 viewing, 294 running agents, 383 data movement, 199 entry history, 294 metric tasks for Metric Studio, 392 PowerPlay reports, 380 reports, 240, 348 scripts, 606 running reports cannot find database, 632 DPR-ERR-2082, 632 not running as expected, 633 not running as scheduled, 637 ORA-00907 error, 635 performance problems, 639 problems, 629 Query Studio is slow, 641 query takes long time to filter non-ASCII text, 641 roles, 209 scheduled reports fail, 636 table or view not found in dictionary, 636 unable to select multiple formats, 637 running totals troubleshooting, 642 run priority, 293 run-time parameters Portal Services, 465
S
Safari Web browsers drill-through links not active, 642 Safe Mode Viewer, 598 samples, 539 data source connections, 67 deleting, 78 Essbase cubes, 69 Event Studio, 76 general employee information, 60 general financial information, 58 general sales and marketing information, 60 GO data warehouse, 61 GO Sales transactional database, 62 Great Outdoors, 57 Great Outdoors company structure, 58 importing, 74 Metric Designer, 63 Metric Studio, 73 mixed languages, 636 model design, 61 models, 76 MSAS cube, 68 new audit reports, 36 OLAP data sources, 70 restoring samples databases, 64 setting up, 63 using, 544 samples (IBM Cognos) using multilingual data, 703 SAP password policy, 584 SAP Business Information Warehouse (SAP BW) data sources, 176 SAP BW errors running reports, 599 unable to identify SAP permissions, 587 unable to identify version, 599 using non-ASCII text values, 641 wrong language in query, 603 SAP BW data sources languages, 361 query calculations, 625 sectioning reports, 622 SAP data source troubleshooting data retrieval, 612 Administration and Security Guide 829
Index SAP EP customizing Cognos portlets, 447 deploying Cognos portlets, 445 SAP namespace, 201 logon problems, 584, 585 repeated prompts for authentication, 585 SAP package BAPI error when generating PowerCube, 609 SAP portal supported versions, 446 SAP query missing categories in Transformer model, 612 SAP unbalanced hierarchy troubleshooting in Transformer, 612 saving report output files, 148, 363 report output files in IBM Cognos 8, 149 report output outside IBM Cognos 8, 149 reports, 373 taking a long time, 628 schedules creating for last day of month, 301 credentials, 218 entries, 300 entries based on occurrences, 305 jobs, 301 last day of month, 301 manage, 291 manage upcoming activities, 289 managing, 294, 299 metric tasks for Metric Studio, 392 multiple entries, 301 prompts, 299 reports and report views, 299 run history, 300 seting up trigger occurrences on server, 535 setting priority, 36 trigger-based, 304 Scheduling secured functions and features, 221 schema data source commands, 741 scope using in drill-through access, 407 Scorecard pane in IBM Cognos Administration, 99 screen flicker, 580 830 scripts to delete tables from databases, 568 SDK cannot call the SDK from Event Studio, 628 searching entries, 259 sectioning reports SAP BW data sources, 622 secured features access permissions, 225 initial access permissions, 693 See Also secured functions secured functions access permissions, 225 Administration, 221 Analysis Studio, 221 Cognos Viewer, 221 Detailed Errors, 221 Event Studio, 221 Glossary, 221 initial access permissions, 693 Lineage, 221 Metric Studio, 221 Query Studio, 221 Report Studio, 221 Scheduling, 221 secure error messages, view details, 88 securing content store, 237 dispatchers, 120 security access permissions, 213 access to entries denied, 581 access to IBM Cognos Administration denied, 587 application levels, 204 authentication, 201 built-in entries, 233 cannot log on to portlets, 583 change passwords, 581 credentials invalid, 581 data sources, 195 default users, 233 deployment, 216, 308 entries do not appear, 582 events, 544 Everyone group, 53
Index functions and features, 221 IBM Cognos Application Firewall, 204 initial policies, 233 initial settings, 233 issues with Integrated Windows Authentication, 575 levels, 605 metric packages, 657 models, 201 modifying settings after installation, 236 password expired, 581 Portal Services, 465 predefined entries, 234 problems, 581 problems logging on to an SAP namespace, 584 providers, 201 restricting access to IBM Cognos 8, 53 setting for PDF output, 358 setting up, 233, 236, 581 System Administrators role, 234 unable to log on, 581 users, groups, and roles, 207 security issues, 669 segmented models upgrading, 606 selection-based interactivity, 371 Series 7, See IBM Cognos Series 7 Series 7 namespaces do not initialize when services are started, 591 Series 7 PowerPlay Web reports round trip safety, 690 servers administration, 105 concurrent query execution, 141 group names, 128 remote, reconfiguring in ALUI 6.1, 450 starting remote server in ALUI 6.1, 449 services, 105 activating, 110 agent, 106 agent services, 105 batch report, 106 Content Manager, 106, 121 data integration, 106 delivery, 106 delivery services, 105 event management, 106 event management services, 105 fail to start after network outage, 557 IBM Cognos 8, 108 job, 106 job services, 105 log, 107 logs, 105 Metrics Manager, 107 Migration, 107 monitor, 107 monitoring services, 105 planning data, 107 presentation, 105, 108 report, 108 report data, 108 reports, 105 stopping and starting, 108 system, 108 unable to start, 551 session caching disabling, 145 sessions definition, 796 starting proxy, 742 stopping proxy, 743 set policy permissions, 213 sets nested or parallel sets overlapping, 621 setting access permissions, 216 access to secured functions and features, 225 advanced current run options, 351 current run report options, 350 data tree displays, 335 default report options, 348 dispatcher scans for servlet gateways, 119 frequency of dispatcher status scans, 118 home pages, 275 logging levels, 82 maximum execution time, 137 periodical document retention, 138 watch list output retention, 138 Settings pane in IBM Cognos Administration, 100 setting up drill-through access in packages, 408 drill-through targets in Analysis Studio, 412 Administration and Security Guide 831
Index logging, 80 printers, 48 samples, 63 setup issues, 661 SharePoint Portal Server deploying Cognos portlets, 454 sharing pages, 270 Shift-JIS encoding example, 686 shortcuts adding actions, 510 creating, 240 source reports, 240 showing user interface elements, 506 shutdown processes remain in memory, 594 signons data sources, 186 Simplified Chinese troubleshooting, 665 single signon access to IBM Cognos Administration denied, 587 IBM Cognos 8 and PowerPlay, 380 issues with Integrated Windows Authentication, 575 Microsoft Analysis Server, 169 Microsoft SQL Server, 171 non-Cognos portlets, 432 problems with Portal Services, 583 SiteMinder logging on to a namespace, 672 skins, See styles SMTP error-handling delivery service, 530 SMTP queue metrics, enabling, 153 SOAP response error when viewing report outputs from email link, 642 Solaris JRE 1.5, 575 sorting non-English locales, 122 source reports shortcuts, 240 sources deployment environments, 307 832 specifications deployment, 307 SQL adding application context to dynamic SQL, 32 SQL See Cognos SQL See native SQL SQL for inner joins, 606 SQL Server cannot be found, 590 cannot connect using OLE DB connection, 590 creating data source connections, 589 SQL Server 2005 error Metric Studio, 655 SSL additional steps to configure on WebLogic 8, 562 configuring for IBM Cognos 8 Go! Office, 344 starting IBM Cognos 8 components using URLs, 777 services, 108, 110 startup configuration lock file, 540 DB2 returns SQL1224N error when connecting from AIX, 558 download of resource fails, 557 IBM Cognos 8 service, 574 page not found, 560 problems, 549 Report Studio does not start, 563 script fails, 564 unable to download cognos.xts, 563 unable to open IBM Cognos Connection, 560 unable to start service, 551 Startup failure without error, 552 statistics access to system, 35 status snapshot of system, 35 status in Scorecard pane, 99 Status page in IBM Cognos Administration, 99 stopping services, 108 stored procedures unable to use IQD file, 610 unable to view, 601
Index streamlined deployment and administration enabling Report Studio authoring modes, 37 strings changing, 522 studios Essbase changes, 621 styles, 429, 437, 479 access permissions, 439 choosing in IBM Cognos Connection, 260 corporate, 481 creating, 438 customizing, 480 modifying, 440, 480 pages, 269 product default, 481 renaming, 480 user profiles, 437 windows, 479 wrong styles applied, 647 style sheets formatting, 482 modifying Cognos Viewer, 493 modifying prompt pages, 494 modifying Query Studio, 488 subtotals grouped lists, 621 summaries troubleshooting, 629 summary values unexpected when using nested sets, 625 support bundle Metric Studio, 654 suppressing null values, 162 suspend entries, 285 suspend entry run, 285 Sybase data source connection troubleshooting, 609 synchronizing metric users for Metric Studio, 396 standby Content Manager, 123 syntax errors, 604 system access to statistics, 35 performance, 91 snaphot of health, 35 system.xml files disabling reports as email attachments, 534 hiding user interface elements, 504 migrating from ReportNet, 501 setting up triggers for scheduling, 535 using to add custom actions, 511 using to add shortcut actions, 510 using to add user interface elements, 506 using to hide user interface elements, 503 using to remove actions, 510 System Administrators deploying, 313 system events, 544 system metrics output file, 543 resetting, 103 system perfomance assessment, 100 system service, 108
T
tab-delimited files errors, 657 Tab key problems in IBM Cognos Configuration, 572 table or view not found in dictionary, 636 tables database for log messages, 749 deleting from a database, 568 tabs adding, 273 deleting, 274 managing, 273 reordering, 275 target environments deployment, 307 target reports creating for drilling through from IBM Cognos Series 7, 426 task queue metrics, enabling, 153 tasks automating, 44 definition, 797 Metric Studio metrics, 391 performing in IBM Cognos 8 using URLs, 773 Administration and Security Guide 833
Index templates background colors not appearing, 621 changing the default for Query Studio, 525 custom report specifications, 495 definition, 797 Report Studio, 495 templates.xml file, 497 temporary directories deleting before reinstall, 570 testing calculations, 602 components, 544 deployment, 332 dispatchers, 117 installation examples, 545 query subjects, 603 text adding, 479 changing strings, 522 translating, 479 threshold setting, metric, 101 time dimensions creating in Transformer rather than Framework Manager, 610 timeouts, 133 data source connections, 184 specifying for Content Manager database connections, 121 times setting peak, 130 time zones setting, 260 TM1 data sources, 178 TM1 data sources differences, 624 differences in data tree, 624 TM1 Executive Viewer, 624 toolbars Query Studio button functionality, 490 tools diagnostic, 546 totals troubleshooting running totals, 642 TR0787 error Transformer, 612 transfering the passport ID as a URL parameter, 465 Transformer creating calculated columns, 611 rebuilding a PowerCube produces TR0787 error, 612 unable to open IQD file, 610 translation files problems importing into Map Manager, 651 transliterations of multilingual data, 703 traverse permissions, 213 trigger-based scheduling, 304 disabling, 535 trigger occurrences setting up triggers for scheduling, 535 troubleshooting Analysis Studio, 630, 631, 632 data retrieval from an SAP-based data source, 612 distributing reports, 627 logging, 79 logging messages, 80 Metric Designer, 653 Metric Studio, 653 Metric Studio log files, 653 missing categories in Transformer model, 612 report authoring, 619 resources, 539 SAP unbalanced hierarchy in Transformer, 612 summaries in reports, 629 troubleshooting data retrieval SAP data source in Transformer, 612 troubleshooting IBM Cognos 8 BI Analysis for Excel, 661 troubleshooting IBM Cognos 8 for Microsoft Office, 661 troubleshooting IBM Cognos 8 Go! Office, 661 troubleshooting Report Data Service, 661 trust domain error when saving the configuration, 571 trusted credentials, 218 creating, 218 scheduling, 218 tuning server performance, 127 type-in SQL, 603
834
Index
U
UDA-SQL-0031 errors, 645 UDA-SQL-0107, 603 UDA-SQL-0114, 603 UDA-SQL-0114 errors, 626, 633, 639 UDA-SQL-0129 errors, 645 UDA-SQL-0206 errors, 626 UDA-SQL-0564 errors, 639 UDA-TBL-0004 errors, 633 unable to access service at URL, 602 unable to open IBM Cognos Configuration, 540 unbalanced hierarchies DB2 OLAP, 165 Report Studio, 615 unexpected results crosstabs, 631 page breaks, 630 unhandled exceptions diagnosing, 542 unicode, 642 UNIX creating data source connections, 589 font not found error, 575 unregistering dispatchers, 111 namespaces, 202, 203 unsupported characters, 553 upcoming activities, 289 update request fails, 593, 594 updating groups and roles, 211 Upfront NewsBoxes adding to portals, 52 upgrading affect on Chinese, Japanese, or Korean characters, 566 content store, 557 models, 606 problems with cryptographic keys, 570 report specifications, 332 segmented models, 606 upgrading models key figures, 601 upgrading reports applications errors, 620 formatting not retained, 641 URI
report will not open, 633 unable to access service, 602 URLs accessing IBM Cognos Connection, 787 creating, 241 hiding user interface commands, 503 starting IBM Cognos 8 components, 777 using to hide user interface elements, 503 URLS accessing services using, 773 performing tasks in IBM Cognos 8, 773 url_xml, 773 URL validaton, 776 user credentials RDS-ERR-1020, 673 user interface improved for administrators, 35 user interface elements, 707 user interfaces adding elements, 714 customizing elements, 503 hiding elements, 707 hiding elements using the system.xml file, 504 hiding elements using URL commands, 503 showing elements, 506 user profiles default, 339 styles, 437 users, 207 anonymous, 233 anonymous logon, 239 authenticated, 233 built-in, 233 changing profiles, 341 classes and permissions, 214 definition, 797 deleting and recreating, 207 deleting profiles, 340 IBM Cognos Series 7, 207 locales, 208 profiles, 339 security, 207 System Administrators, 234 utilities round trip safety configuration, 686 Administration and Security Guide 835
Index
V
validation URL, 776 values as percentage, 631 vargraphic datatype, 603 versions deploying report output, 312 viewing older reports, 364 viewing reports, 348 viewing events, 544 viewing reports problems, 629, 641 SOAP response error when viewing from email link, 642 virtual private databases Oracle databases, 190, 194
W
watch items, 38 removing alert lists, 264 rule properties, 250 viewing in IBM Cognos Connection, 264 watch list output retention, 138 watch lists definition, 797 watch rule definition, 797 watch rules, 38, 366 creating, 367 deleting in Cognos Viewer, 368 enabling, 367 modifying in Cognos Viewer, 368 viewing in IBM Cognos Connection, 264 Web configuring browsers, 50 web.config file configuring Cognos Web parts, 458 web.config.sample, 458 Web browsers errors in starting the Web portal, 563 errors when starting the web portal, 560 unable to access help, 547
WebLogic could not deserialize context attribute, 565 deploying p2pd.war file, 566 servlet class fails to load, 579 startup script fails, 564 WebLogic 8 problem configuring SSL, 562 WebLogic Application Server IBM Cognos 8 fails, 564 Web parts IBM Cognos, 454 See Also portlets Web services description language importing portlets into IBM Cognos Connection, 432 Web Services for Remote Portlets importing portlets into IBM Cognos Connection, 432 Web Services for Remote Portlets, See WSRP WebSphere parser collisions with Report Data Service, 670 WebSphere Application Server deploying IBM Cognos 8, 577 IBM Cognos 8 deployment failure, 564 startup script fails, 564 WebSphere Portal customizing Cognos portlets, 444 deploying Cognos portlets, 441 installing portlet applications file, 442 Welcome page customizing, 484, 514 Windows Event Viewer, 539, 544 Windows IIS recommended gateway settings, 579 windows style, 479 write permissions, 213 WSRP definition, 797 WSRP standard portlets, 432
X
XML data sources, 179 XML formatting reports, 358
836