Sei sulla pagina 1di 417
 

Cognos ® 8 Planning

CONTRIBUTOR ADMINISTRATION GUIDE

CONTRIBUTOR ADMINISTRATION GUIDE
Cognos 8 Planning CONTRIBUTOR ADMINISTRATION GUIDE

Product Information

This document applies to Cognos ® 8 Planning Version 8.3 and may also apply to subsequent releases. To check for newer versions of this document, visit the Cognos Global Customer Services Web site (http://support.cognos.com).

Copyright

Copyright © 2007 Cognos Incorporated.

Portions of Cognos® 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.

Cognos and the Cognos logo are trademarks of Cognos Incorporated in the United States and/or other countries. All other names are trademarks or registered trademarks of their respective companies.

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

This software/documentation contains proprietary information of Cognos Incorporated. All rights are reserved. Reverse engineering of this software is prohibited. No part of this software/documentation 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 Incorporated.

Table of Contents

Introduction 13

What’s New?

17

New Features in Version 8.3 17 Extended Language support 17 Microsoft Vista Compliance 17 Microsoft Excel 2007 17 Select Folders in Cognos Connection 17 Select a Framework Manager Package for an Administration Link 18

Chapter 1: Cognos 8 Planning - Contributor 19 Extending the Functionality of Contributor 19 Using Contributor Applications 19 Cubes 19 Dimensions 19 e.Lists 19 Access Tables and Saved Selections 20 D-Links 20 Managing Contributor Applications 20

Multiple Administrators Moving Data 20

20

System Links 21 Automating Contributor Tasks Using Macros 21 Publishing Data 21 Creating a Contributor Application 21 Developing the Plan in Analyst 22 Designing the e.List 22 Assigning Rights 22 Creating the Application 22 Creating the Production Application 23 Running Jobs 23 Testing the Web Site 23 The Administrator 24 The Planner 24 The Reviewer 24

The Toolbar

25

Chapter 2: Security

27

Cognos Namespace 27 Authentication Providers 28 Deleting or Restoring Unconfigured Namespaces 29 Users, Groups, and Roles 29 Users 30 Groups and Roles 30

Table of Contents

Setting up Security for a Cognos 8 Planning Installation 32 Configure Cognos 8 to Use an Authentication Provider 33 Add or Remove Members From Planning Rights Administrators and Planning Contributor Users Roles 34 Enabling Planning Roles in Cognos 8 35 Restricting Access to the Everyone Group 35 Recommendation - Creating Additional Roles or Groups for Contributor 36 Configuring Access to the Contributor Administration Console 36 Granting Access Rights to Administrators 37 Access Rights for Macros 40 Assign Scheduler Credentials 42

Chapter 3: Configuring the Administration Console 45

Creating Planning Tables 45 Add a Datastore Server 46 Datastore Server Information 47 Jobs 47 Types of Jobs 47 Run Order for Jobs 48 Actions That Cause Jobs to Run 49 Securing Jobs 49 Managing Jobs 50 Reconciliation 52 Deleting Jobs 53 Managing Job Servers 53 Manage a Job Server Cluster 54 Add a Job Server and Change its Content Store 54 Add Applications and Other Objects to a Job Server Cluster 55 Add Objects to a Job Server 56 Remove Job Servers 57 Monitor Application Folders 57 Creating, Adding and Upgrading Applications 58 Remove Datastore Definitions and Contributor Applications 58 Adding an Existing Application to a Datastore Server 58 The Monitoring Console 59 Managing Sessions 59 Sending Email 61

Chapter 4: Creating a Cognos 8 Planning - Contributor Application 63 Creating a Contributor Application 63 Application Folders 66 Model Details 66 Running the Script.sql file (DBA Only) 67 Application Information 68 Configuring the Contributor Application 68 Configure Global Web Client Settings 69 Set the Cube Order for an Application 69 Set the Order of Axes 70 Change Grid Options 70 Change Application Options 72

4 Contributor

Table of Contents

Create Planner-Only Cubes 75 Creating General Messages and Cube Instructions 76 Maintaining the Contributor Application 76 Save Application XML for Support 77 View Application Details 77 Admin Options 77 Select Dimensions for Publish 79 Set Go to Production Options 79 Datastore Options 80

Chapter 5: The Cognos 8 Planning - Contributor Web Application 83 The Contributor Web Site 83 The Tree 83 The Table 83 Set Web Site Language 84 Contributor for Microsoft Excel 84 Accessing Contributor Applications 85 Configure Contributor Web Client Security Settings 85 How to Link to Earlier Versions of Contributor Applications 86 Independent Web Applications 86 Working Offline 86 Example 87 Steps to Work Offline 87 The Offline Store 88

Chapter 6: Managing User Access to Applications 89

The e.List 89 Multiple Owners of e.List Items 91 Import e.List and Rights 92 Export the e.List and Rights 97 Managing the e.List 98 Rights 103 Actions Allowed for Review e.List Items 104 Actions Allowed for Contribution e.List items 105 Rights File Formats 106 Modify Rights Manually 107 Validating Users, Groups and Roles in the Application Model and Database 109

Chapter 7: Managing User Access to Data 111

Saved Selections 111 Editing Saved Selections 112 Access Tables 114 Access Tables and Cubes 115 Rules for Access Tables 116 Creating Access Tables 119 Large Access Tables 125 Multiple Access Tables 132 Changes to Access Tables That Cause a Reconcile Job to Be Run 133 Access Tables and Import Data 134 Access Levels and Contributor Data Entry 134

Table of Contents

Force to Zero 134 Reviewer Access Levels 134 Cut-down Models 134 When Does the Cut-down Models Process Happen? 135 Limitations 135 Cut-down Model Options 135 Cut-down Models and Translation 136 Cut-down Models and Access Tables 136 Restrictions to Cutting Down Dimensions 137 Estimating Model and Data Block Size 138 Cut-down Model Example 138

Chapter 8: Managing Data

141

Understanding Administration, System, and Local Links 142 Using Links to Move Data Between Cubes and Applications 144 Using Links in Model Design 144 Administration Links 145 Create an Administration Link 148 Map Dimensions Manually 152 View Items in a Dimension 153 Remove a Dimension 153 Running Administration Links 153 Exporting and Importing Administration Links 154 Tuning Administration Links 154 System Links 158 Create a System Link 159 Run a System Link 160 Importing Data from Cognos 8 Data Sources 161 Create a Data Source Connection 161 Create a Framework Manager Project and Import Metadata 164 Create and Publish the Cognos Package 165 Working with SAP BW Data 166 Recommendation - Query Items 167 Recommendation - Hierarchy 167 Recommendation - Hiding the Dimension Key Field 168 Working with Packages 168 Troubleshooting Detailed Fact Query Subject Memory Usage 168 Deploying the Planning Environment and Viewing the Status of Deployments 168 Export a Model 168 Import a Model 169 View the Status of Existing Deployments 171 Troubleshooting Out of Memory Exception When Exporting During a Deployment 171 Importing Text Files into Cubes 172 Creating the Source File 172 Select the Cube and Text File to Load into the Cube 173 Load the Data into the Datastore 174 Prepare the Import Data Blocks 174

Chapter 9: Synchronizing an Application 177 Changes that Result in Loss of Data 177

6 Contributor

Table of Contents

Synchronizing an Application 178 Generate Scripts 178 How to Avoid Loss of Data 178 Example Synchronization 179 Advanced - Model Changes 180 Chapter 10: Translating Applications into Different Languages 183

Assigning a Language Version to a User 183 Translate the Application 184 Translate Strings Using the Administration Console 185 Exporting and Importing Files for Translation 187 Export Files for Translation 188 Import Translated Files 188 Search for Strings in the Content Language or Product Language Tab 189 Translating Help 189 System Locale and Code Pages 190 About Fonts 190

Chapter 11: Automating Tasks Using Macros 191 Common Tasks to Automate 191 Creating a Macro 192 Create a New Macro 192 Create a Macro Step 193 Transferring Macros and Macro Steps 196 Job Servers (Macro Steps) 197 Development (Macro Steps) 200 Production (Macro Steps) 208 Administrator Links (Macro Steps) 216 Macros (Macro Steps) 217 Session (Macro Steps) 219 Running a Macro 220 Run a Macro from Administration Console 221 Run a Macro from Cognos Connection 221

Run a Macro from a Cognos 8 Event 222 Run a Macro using Macro Executor 224

Run a Macro using Command Line

224

Run a Macro using Batch File 224 Troubleshooting Macros 225 Unable to Run Contributor Macros Using a Batch File 225

Chapter 12: Data Validations 227

Setting Up Data Validation 228 The Impact of Aggregation on Validation Rules 229 Define a Validation Rule 233 Define or Edit a Rule Set 235 Edit a Validation Rule 236 Associate Rule Sets to e.List Items 237

Chapter 13: The Go to Production Process 239 Planning Packages 240

Table of Contents

Reconciliation 241 The Production Application 241 Model Definition 241 Data Block 241 Production Tasks 242 Cut-down Models and Multiple Languages 242 The Development Application 243 Development Model Definition 243 Import Data Blocks 243 Run Go to Production 244 Go to Production Options Window 244 Show Changes Window 245 Model Changes Window 246 Import Data Details Tab 250 Invalid Owners and Editors Tab 250 e.List Items to be Reconciled Tab 252 Cut-down Models Window 252 Finish Window 252

Chapter 14: Publishing Data 255

The Publish Data Store Container 256 Access Rights Needed for Publishing 256 Publish Scripts 256 Selecting e.List Items to Be Published 257 Reporting Directly From Publish Tables 257 Model Changes that Impact the Publish Tables 258 Data Dimensions for Publish 260 Selecting a Dimension for Publish for Reporting 261 The Table-Only Publish Layout 262 Database Object Names 263 Items Tables for the Table-only Layout 263 Hierarchy Tables for the Table-only Layout 264 Export Tables For the Table-only Layout 266 Annotations Tables for the Table-only Layout 267 Attached Document Tables for the Table-only Layout 269 Metadata Tables 270 Common Tables 272 Job Tables 272 The P_OBJECTLOCK Table 273 Create a Table-only Publish Layout 273 Options for Table-only Publish Layout 274 Create an Incremental Publish 275 The View Publish Layout 276 Database Object Names 277 Items Tables for the View Layout 277 Hierarchy Tables for the View Layout 277 Export Tables for the View Layout 278 Annotation Tables for the View Layout 278 Views 279

8 Contributor

Table of Contents

Create a View Layout 280 Options for View Layout 281 Create a Custom Publish Container 282 Configure the Datastore Connection 283 Remove Unused Publish Containers 284

Chapter 15: Commentary 287

Annotations 287 User Annotation Behavior 288 Linking to Web Pages, Files, and Email Addresses From Annotations Delete Commentary 289 Attach Documents 290 Configuring the Attached Documents Properties 290 Attaching a Document 291 Viewing and Editing Commentary 291 Publishing Attached Documents 292 Copy Commentary 292

288

Chapter 16: Previewing the Production Workflow 295 Previewing e.List item Properties 295 Preview Properties - General 295 Preview Properties - Owners 296 Preview Properties - Editors 296 Preview Properties - Reviewers 296 Preview Properties - Rights 296 Workflow State Definition 297 Additional Workflow States 298 Workflow State Explained 298

Chapter 17: Using Cognos 8 Planning - Contributor With Other Cognos Products 301 Client and Admin Extensions 302 Client Extensions 302 Admin Extensions 303 Integrating with Cognos Business Intelligence Products 304 Using Cognos 8 BI with Contributor Unpublished (Real-Time) Data 304 The Generate Framework Manager Model Admin Extension 308 Generate Transformer Model 311 Excel and Contributor 313 Contributor for Excel 313 Print to Excel 315 Export for Excel 315 Financial Planning with Cognos Performance Applications and Cognos 8 Planning 315

Chapter 18: Example of Using Cognos 8 Planning with Other Cognos Products 317 Download and Deploy the Sample 317 Run a Contributor Macro to Import Data 319 Create and Publish a Framework Manager Package 319 Create a Report 321 Create an Event Studio Agent 326

Table of Contents

Chapter 19: Upgrading Cognos 8 Planning - Contributor 329 Upgrade the Planning Administration Domain 330 Upgrade Contributor Applications 332 Upgrade Security 335 Accessing Contributor Applications 336 Chapter 20: Cognos 8 Planning - Analyst Model Design Considerations 337

Designing an Analyst Model for Contributor 337 Analyst Library Guidelines 337 D-Cube Restrictions 338 D-Links 339 Dimensions 341 Creating Applications with Very Large Cell Counts 346 Break-Back Differences Between Analyst and Contributor 347 Analyst<>Contributor Links 347 Set Up a Link Between Analyst and Contributor and Between Contributor Applications 348 Analyst>Contributor D-Links 349 Contributor>Analyst Links 349 Contributor>Contributor links 350 Copying Analyst<>Contributor Links 350 Links and Memory Usage 351 Update a Link from a Computer That Cannot Access the Original Datastore 352 Multiple D-Links Using the @DLinkExecuteList Macro 352 Run D-Links While Making Model Changes 352 Effects of Fill and Substitute Mode on Untargeted Cells 353 Effect of Access Tables in Contributor 354

Appendix A: DB2 UDB Supplementary Information 355

The Contributor Datastore 355 Requirements for the DB2 UDB Database Environment 355 Background Information For DB2 UDB DBAs 356 Security and Privileges 356

Naming Conventions

357

Metadata 357 Backup 357 Standards 357 Preventing Lock Escalation 358 Large Object Types 358 Job Architecture 359 Importing and Reporting Data 359 Importing Data: Understanding the Prepare Import Job Process 359 Reporting Data: Understanding the Publish Job Process 360 Data Loading 360 Job Failure 360

Appendix B: Troubleshooting the Generate Framework Manager Model Extension 361 Unable To Connect to the Database While Using Oracle 361 Unable to Create Framework Manager Model 361 Unable to Retrieve Sessions Namespace 362 Unable to Change Model Design Language 362

10 Contributor

Table of Contents

Appendix C: Limitations and Troubleshooting when Importing Cognos Packages 363 Limitations for Importing Cognos Packages 363 Troubleshooting Modeled Data Import 366 Viewing Generated Files 366 Using Error Messages to Troubleshoot 369 Techniques to Troubleshoot Problems with an Import 372

Appendix D: Customizing Cognos 8 Planning - Contributor Help 375

Creating Cube Help 375 Detailed Cube Help 375 Using HTML Formatting 375 Using Images, Hypertext Links, and E-Mail Links in Contributor Applications 377

Appendix E: Error Handling 379

Error Logs and History Tracking 379 Application XML issues 380 Timeout Errors 380 History Tracking 380 Calculation Engine (JCE) error logs 382 General Error Logging 383 How errors are logged in the Administration Console 383 Using the LogFetcher Utility 385

Appendix F: Illegal Characters 387

Appendix G: Default Options 389

Grid Options

389

Application Options

389

XML location and filename

390

Admin Options

390

Go to Production Options

391

Go to Production Wizard Options

392

Publish Options-View Layout

392

Publish Options-Table Only Layout e.List 393 Rights 393 Access Tables 393 Delete Commentary 394

392

Appendix H: Data Entry Input Limits 395 Limits For Text Formatted Cells 395 Limits for Numerical Cells 396

Glossary 397

Index 405

Table of Contents

12 Contributor

Introduction

This document is intended for use with the Cognos 8 Planning - Contributor Administration Console. This guide describes how to use the Contributor Administration Console to create and manage Contributor applications.

Cognos 8 Planning provides the ability to plan, budget, and forecast in a collaborative, secure manner. The major components are Analyst and Contributor.

Cognos 8 Planning - Analyst

Analyst is a flexible tool used by financial specialists to define their business models. These models include the drivers and content required for planning, budgeting, and forecasting. The models can then be distributed to managers using the Web-based architecture of Cognos 8 Planning - Contributor.

Cognos 8 Planning - Contributor

Contributor streamlines data collection and workflow management. It eliminates the problems of errors, version control, and timeliness that are characteristic of a planning system solely based on spreadsheets. Users have the option to submit information simultaneously through a simple Web or Microsoft Excel® interface. Using an intranet or secure Internet connection, users review only what they need to review and enter data where they are authorized.

For more information about using this product, visit the Cognos Global Customer Services Web site (http://support.cognos.com).

Best Practices for Cognos 8 Planning

The Cognos Innovation Centerfor Performance Management provides a forum and Performance Blueprints which you can use to discover new ideas and solutions for finance and performance management issues. Blueprints are pre-defined data, process, and policy models that incorporate best practice knowledge from Cognos customers and the Cognos Innovation Center. These Blueprints are free of charge to existing customers or Platinum and Gold partners. For more information about the Cognos Innovation Center or the Performance Blueprints, visit http://www.cognos.com/ innovationcenter.

Audience

To use this guide, you should have an understanding of Cognos 8 Planning - Analyst. Some knowledge of security and database systems would also be helpful.

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.

Introduction

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 Cognos Global Customer Services Web site (http://support.cognos.com). Logon credentials are available either from your administrator or by request from support.america@cognos. com.

Document

Description

 

Analyst User Guide

Using Cognos 8 Planning - Analyst

Contributor Browser User Using the Cognos 8 Planning - Contributor Web client Guide

Contributor for Microsoft Using the Cognos 8 Planning - Contributor for Microsoft Excel® Excel® User Guide

Cognos Connection User Guide

Using Cognos Connection to publish, find, manage, organize, and view Cognos content, such as scorecards, reports, analyses, and agents

Cognos 8 Administration and Security Guide

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

Framework Manager User Creating and publishing models using Framework Manager Guide

Guidelines for Modeling Metadata

Recommendations for modeling metadata to use in business reporting and analysis

Event Studio User Guide

Creating and managing agents that monitor data and perform tasks when the data meets predefined thresholds

Finding Information

To find the most current product documentation, including all localized documentation, access the Cognos Global Customer Services Web site (http://support.cognos.com). Click the Documentation link to access documentation guides. Click the Knowledge Base link to access all documentation, technical papers, and multimedia materials.

Product documentation is available in online help from the Help menu or button in Cognos products. You can also download documentation in PDF format from the Cognos Global Customer Services Web site.

14 Contributor

You can also read PDF versions of the product readme files and installation guides directly from Cognos product CDs.

 

Getting Help

Introduction

For more information about using this product or for technical assistance, visit the Cognos Global Customer Services Web site (http://support.cognos.com). This site provides product information, services, user forums, and a knowledge base of documentation and multimedia materials. To create a case, contact a support person, or to provide feedback, click the Contact Us link. For information about education and training, click the Training link.

Printing Copyright Material

You can print selected pages, a section, or the whole book. Cognos grants you a non-exclusive, non-transferable license to use, copy, and reproduce the copyright materials, in printed or electronic format, solely for the purpose of operating, maintaining, and providing internal training on Cognos software.

Introduction

16 Contributor

What’s New?

This section contains a list of new features for this release. It will help you plan your upgrade and application deployment strategies and the training requirements for your users.

For information about upgrading, see the Cognos 8 Planning Installation and Configuration Guide.

To review an up-to-date list of environments supported by Cognos products, such as operating systems, patches, browsers, Web servers, directory servers, database servers, and application servers, visit the Cognos Global Customer Services Web site (http://support.cognos.com).

New Features in Version 8.3

Listed below are new features since the last release. Links to directly-related topics are included.

Extended Language support

This release provides support for Japanese and Swedish product strings. Contributor Web Client strings can be translated into these languages without the need to enter translation strings. Japanese and Swedish language content strings are also supported. For more information, see the following sections.

"Translating Applications into Different Languages" (p. 183) "Set Web Site Language" (p. 84)

Microsoft Vista Compliance

The Contributor Web application and Contributor for Excel can be used with Microsoft Vista. For more information about installing and using Vista, see the Cognos 8 Planning - Contributor for Microsoft Excel® Installation Guide. For more information about using Contributor with Excel or the Contributor Web application, see the Contributor for Microsoft Excel® User Guide and Contributor Browser User Guide.

Microsoft Excel 2007

This release supports Contributor and Analyst for Excel using Microsoft Excel 2007. For more information about using Analyst or Contributor with Excel, see the Analyst for Microsoft Excel® User Guide and Contributor for Microsoft Excel® User Guide.

Select Folders in Cognos Connection

This release supports folder selection in Cognos Connection when generating Framework Manager and Transformer models. For more information, see the following sections.

"Run the Generate Framework Manager Model Admin Extension" (p. 310)

Whats New?

"Generate Transformer Model" (p. 311)

Select a Framework Manager Package for an Administration Link

This release supports browsing in Cognos Connection folders to select a Framework Manager package for an Administration Link. For more information, see "Steps to Create Links with Cognos Package as the Source" (p. 150).

18 Contributor

Chapter 1: Cognos 8 Planning - Contributor

Cognos 8 Planning - Contributor is a Web-based planning platform that can involve thousands of people in the planning process, collecting data from managers and others, in multiple locations. Complex calculations are performed on the Web client showing totals as soon as data is entered, preventing unnecessary traffic on the server during busy times. Information is then stored in a data repository, providing an accurate and single pool of planning data.

In addition, users can use Contributor for Excel to view and edit Contributor data using Excel. Administrators use the Contributor Administration Console to create and configure Contributor applications, manage access settings, distribute Cognos 8 Planning - Analyst business plans, and configure the user's view of the business plan.

Extending the Functionality of Contributor

Extensions are provided that extend the functionality of the Contributor Administration Console and Web Client. There are two types of extensions: Admin Extensions and Client Extensions. Admin Extensions run in Administration Console. Client Extensions are activated through buttons on the Contributor grid. For example, you configure an extension to print Excel.

Using Contributor Applications

A Contributor application is an Analyst plan that is made available to users on the Web through the Contributor Administration Console. A Contributor application consists of a series of linked cubes that can be used for data entry by many people at the same time.

Cubes

 

A cube is similar to a spreadsheet. A cube always contains rows and columns and usually at least one other page, making it multidimensional. It is used to collect data. Cells in cubes can contain entered data or calculations.

Dimensions

 

The rows, columns, and pages of a cube are created from dimensions. Dimensions are lists of related items, such as Profit and Loss items, products, customers, cost centers, and months. Dimensions also contain all the calculations. One dimension can be used by many cubes.

e.Lists

The structure of an application is based on an e.List. An e.List is a kind of dimension that contains a hierarchical structure that typically reflects the structure of the organization. For example, it may

Chapter 1: Cognos 8 Planning - Contributor

include cost centers and profit centers. There is one e.List per application, and the e.List item is assigned to a user, group, or role. There are two types of user: planners and reviewers. A planner enters and submits data to be reviewed by a reviewer. There may be several layers of reviewer depending on the structure of the e.List.

Access Tables and Saved Selections

Access to cubes is managed by e.List item, using saved selections and access tables. A saved selection is a collection of dimension items that is assigned to e.List items using access tables. This means that users can view only data that is relevant to them. For example, you may want to show only travel expense items to one user and entertainment expense items to another user where both items are held in the same dimension.

Using access tables, you assign different levels of access to e.List items, saved selections, dimension items and cubes.

For more information, see "Managing User Access to Data" (p. 111)

D-Links

Cubes are linked by a series of D-Links in Analyst. A D-Link copies information in and out of cubes, and sometimes to and from ASCII or text files.

Managing Contributor Applications

There is a single configuration process for all Contributor applications in an installation.

You can use application folders to organize your applications into related groups. When you have created them, you can use the application folders to assign job servers, job server clusters and access rights to these groups of applications.

Multiple Administrators

You can secure individual elements of the Administration Console and therefore allow multiple administrators to access different parts of the Contributor application at the same time. For example, you can give rights to a specific user to create and configure applications on a specific datastore. You can choose to cascade rights to all applications on a datastore, or restrict rights to specific applications. Contributor administrators have access only to those applications and operations that they have rights for.

Moving Data

Administrators can use administration links to move data quickly and easily between applications without having to publish, reducing the need for large applications. You can have several small, focused applications. Smaller e.List structures provide quicker reconciliation times. Also, the need for cut-down models and access tables is reduced.

Administration links give you the following benefits:

20 Contributor

You can achieve a matrix e.List structure.

Chapter 1: Cognos 8 Planning - Contributor

For example, you can have a Company model where Human Resources reports into Country, and this can be linked to a Corporate model where Country reports into Human Resources.

You can import data from Cognos 8 data sources.

using administration links, you can import data into Cognos 8 Planning from packages that were modeled and published in Framework Manager.

System Links

Administrators can set up links so that Web client users and Contributor for Excel users can move data between Contributor cubes in the same or different applications. System links are run from the target application.

Automating Contributor Tasks Using Macros

You can group related tasks into a single macro to run them in sequence. For example, you can group the following tasks: Load Import Data, Prepare Import, and Go to Production. Macros can be run in the Administration Console, from Cognos Connection, used in events created in Event Studio, or by using external scheduling tools.

Publishing Data

Three publish layouts are available.

The table-only layout is designed to give users greater flexibility in reporting on Cognos 8 Planning data, and for use as a data source for other applications. It is used with the Generate Framework Manager Model extension, and the Generate Transformer Model extension.

The incremental publish layout publishes only e.List items that contain changed data. Users can schedule an incremental publish using a macro or through Cognos Connection and Event Studio. You can achieve near real-time publishing by closely scheduling incremental publishes.

The view layout, as supported in Contributor and Analyst version 7.2, is compatible with previous Cognos Planning data solutions.

Data is always published to a separate publish datastore.

Creating a Contributor Application

Creating a Contributor Application involves

developing the plan in Analyst

designing the e.List

configuring rights

creating the application

Chapter 1: Cognos 8 Planning - Contributor

creating the production application

running jobs

testing the application in the Web site

Developing the Plan in Analyst

Create a business model for planning, budgeting, and forecasting using Analyst. This step is typically performed by Analyst Model Builders.

You can specifically design the Analyst model to be optimized for Contributor (p. 337). Part of the model development process involves establishing how the Contributor application is to be used in the organization. This includes looking at who contributes data and reviews data. This information is used to create an e.List.

For more information, see the Analyst User Guide.

Designing the e.List

An e.List is a very important part of the Contributor application. It specifies how the application is distributed to end users, the hierarchy of the application, and security.

An e.List has a hierarchical structure that typically reflects the structure of an organization. The dimension that represents the e.List is created in Analyst. The file containing e.List data is imported into the Contributor Administration Console.

For more information, see "The e.List" (p. 89).

Assigning Rights

Rights determine whether users can view, save, submit, and so on.

For example, you want to allow a planner to view, but not save or submit, or to make and save changes but not submit.

The rights a user can have are also affected by the view and review depth, set in the e.List window, and the Reviewer edit setting in the Application Options window. A user can be directly assigned rights, or inherited rights.

You can set up rights directly in the Administration Console after you create the Contributor application, or you can create and maintain the rights in an external system, and import them.

For more information, see "The e.List" (p. 89).

Creating the Application

After the model is created and tested in Analyst, create the Contributor application using the Administration Console. The application creation wizard helps you create a Contributor application.

After the application is created, you can configure the application

22 Contributor

Chapter 1: Cognos 8 Planning - Contributor

This establishes how the application appears and behaves in the Web browser. import the e.List data and rights

restrict what users can see and do using saved selections and access tables. For example, you may want to hide salary details from some users.

import data from other applications After you set up the application, run the Production process.

Creating the Production Application

There can be two versions of a Contributor application: development and production.

When you run the Go to Production process (p. 239), the development application becomes the production application. The previous production application, if it existed, is archived and a new development application is established. At this stage, the current production application and the new development application are the same.

The production version is the live version of the application. It is the application that is online and that users are working on.

Having two versions of an application means that you can make changes to the application without having to take it offline, reducing the time that users are offline for as little as a minute. This is the time taken to integrate the new e.List items into the hierarchy and set the correct workflow states (p. 297).

Run the Go to Production process to formally commit a set of changes. When the Go to Production process is complete, jobs run to ensure that all the data is up to date using a process named reconciliation (p. 52). Reconciliation happens on the server side or, if the user tries to view or edit the application before the e.List item is processed, reconciliation may happen on the client.

Running Jobs

A job is an administration task that runs on job servers and is monitored by the Administration Console. You can start the process and monitor its progress. All jobs can be run while the application is online.

Using the Monitoring Console (p. 59) in the Administration tree, you can manage and monitor the progress of jobs in Contributor applications.

An example of a job is reconcile, which ensures that the structure of the e.List item data is up to date, if required. This job is created and runs after Go to Production runs.

For more information, see "Jobs" (p. 47).

Testing the Web Site

To test the Web site, run Go to Production and log on as a user with rights to the Contributor application. You should be able to view the application in a web browser.

Chapter 1: Cognos 8 Planning - Contributor

The Administrator

Administration can be divided into separate functions depending on your business needs. A Planning Rights Administrator assigns administrative access to Contributor applications and to functions within applications. Administrators have access only to those applications and operations that they have rights for. In addition, multiple administrators can access different parts of the Contributor application at the same time.

You can restrict administrative access on a per application basis so that someone who can see only database maintenance in application A can create applications in application B.

Administrators see only those applications that they have rights to, and only those functions within those applications.

Depending on the rights assigned to them, administrators can assign functional rights to other administrators add job servers and job server clusters to the Planning Store create and configure a Contributor application create new e.List items make changes to the e.list hierarchy assign rights to e.List items import actual data to the application amend workflow states from the Administration Console where required monitor the progress of jobs

The Planner

Planners are responsible for entering data into the Contributor application using the Web browser, or Contributor for Excel. This data is referred to as a contribution. Planners edit data only in the selection assigned to them by the administrator. They cannot make structural changes to the application. After data is entered, the planner can either save or submit the data. Submitted data is forwarded to a reviewer and cannot be edited further by the planner unless the reviewer rejects it.

A planner can be responsible for more than one e.List item and can view each e.List item individually or view all e.List items in a single view, if configured by the administrator.

The Reviewer

Reviewers are responsible for approving contributions submitted by one or more planners. Reviewers can view data and see the status of all submissions they are responsible for managing at any stage in the planning and review cycle. Reviewers can edit contributions if they have appropriate rights.

After data is submitted, the reviewer has the following options:

reject the data if they are not satisfied with it

24 Contributor

Chapter 1: Cognos 8 Planning - Contributor

Typically, a reviewer sends an email to the planner to give the reason for rejection. accept the data

When a complete set of data is viewed and considered satisfactory, it can be submitted to the next reviewer in the e.List hierarchy.

edit the data, if allowed

After the reviewer takes over editorial control of a contribution, the planner is no longer the owner of the contribution. The reviewer has the right to submit it.

Any user can be both a planner and a reviewer for the same e.List item. When users have both roles, they can view their review items and contribution items in the same Web page.

In addition, reviewers can annotate any changes they make to a Contribution e.List item (p. 287).

The Toolbar

The following functions are available on the Administration Console toolbar.

  • Sends e-mail to users defined in an application using your default email tool.

Email

  • Saves changes to the development application package.

Save

  • Shows the Contributor Administration online help. You can also use the F1 key.

Help

  • Starts the Go to Production process. Go to production can be automated.

Go to Production

  • Makes the application visible in a Web browser. Set Online can be automated.

Set Online

  • Prevents the application from being accessed in a Web browser. Set Offline can be automated

Set Offline

  • Resets the development application to the production application, clearing any changes that were made since you last ran Go to Production.

Reset

Chapter 1: Cognos 8 Planning - Contributor

26 Contributor

Chapter 2: Security

Cognos 8 security is designed to meet the need for security in various situations. You can use it in everything from a proof of concept application where security is rarely enabled to a large scale enterprise deployment.

The security model can be easily integrated with the existing security infrastructure in your organization. It is built on top of one or more third-party authentication providers. You use the providers to define and maintain users, groups, and roles, and to control the authentication process. Each authentication provider known to Cognos 8 is referred to as a namespace.

In addition to the namespaces that represent the third-party authentication providers, Cognos 8 has its own namespace named Cognos. The Cognos namespace makes it easier to manage security policies and deploy applications.

For more information, see the Cognos 8 Security and Administration Guide.

Cognos Namespace

The Cognos namespace is the Cognos 8 built-in namespace. It contains the 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. You must modify the initial security settings for those entries and for the Cognos namespace immediately after installing and configuring Cognos 8.

You can rename the Cognos namespace using Cognos Configuration, but you cannot delete it. The namespace is always active.

When you set security in Cognos 8, you may want to use the Cognos namespace to create groups and roles that are specific to Cognos 8. In this namespace, you can also create security policies that indirectly reference the third-party security entries so that Cognos 8 can be more easily deployed from one installation to another.

The Cognos namespace always exists in Cognos 8, but the use of the Cognos groups and roles it contains is optional. The groups and roles created in the Cognos namespace repackage the users, groups, and roles that exist in the authentication providers to optimize their use in the Cognos 8 environment. For example, in the Cognos namespace, you can create a group named 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 Cognos 8.

Chapter 2: Security

Authentication Providers

User authentication in Cognos 8 is managed by third-party 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 Cognos 8, users must provide valid credentials, such as user ID and password, at logon time. In Cognos 8 environment, authentication providers are also referred to

Chapter 2: Security Authentication Providers User authentication in Cognos 8 is managed by third-party authentication providers.

as namespaces, and they are represented by namespace entries in the user interface.

Cognos 8 does not replicate the users, groups, and roles defined in your authentication provider. However, you can reference them in 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 Cognos Series 7 eTrust SiteMinder LDAP NTLM SAP

You configure authentication providers using 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 Cognos Connection logon page. In this situation, use Cognos Configuration to enable anonymous access.

28 Contributor

Chapter 2: Security

Deleting or Restoring Unconfigured Namespaces

You can preserve namespaces and all their contents in the content store even if they are no longer configured for use in Cognos 8. When a namespace is not configured, it is listed as inactive in the directory tool.

An inactive namespace is one that was configured, but later deleted in Cognos Configuration. The namespace can be deleted from the content store by members of the System Administrators role. You cannot log on to an inactive namespace.

If a new version of Cognos 8 detects a previously configured namespace that is no longer used, the namespace appears in the directory tool as inactive. You can configure the namespace again if you still require the data. If the namespace is not required, you can delete it.

When you delete a namespace, you also delete all entries in My Folders that are associated with that namespace, and their contents.

An active namespace cannot be deleted, but can be updated.

To recreate a namespace in Cognos Configuration, you must use the original ID of the namespace. For information about configuring and recreating namespaces, see the Installation and Configuration Guide.

Delete an Inactive Namespace

If a namespace was removed from Cognos Configuration and is no longer required, a member of the System Administrators role can delete it permanently in the directory tool. Deleting a namespace also deletes all the entries in My Folders that are associated with the namespace.

To access the directory administration tool, you must have execute permissions for the directory secured feature and traverse permissions for the administration secured function.

Steps

  • 1. In Cognos Connection, in the upper-right corner, click Launch, 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 Cognos 8, you must add it using Cognos Configuration.

Users, Groups, and Roles

Users, groups, and roles are created for authentication and authorization purposes. In Cognos 8, you can use users, groups, and roles created in third-party authentication providers, and groups

Chapter 2: Security

and roles created in Cognos 8. The groups and roles created in Cognos 8 are referred to as Cognos groups and Cognos roles.

Users

A user entry is created and maintained in a third-party authentication provider to uniquely identify

a human or a computer account. You cannot create user entries

Chapter 2: Security and roles created in Cognos 8. The groups and roles created in Cognos

in Cognos 8.

Information about users, such as first and last names, passwords, IDs, locales, and email addresses, is stored in the authentication providers. However, this may not be all the information required by 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 Cognos 8, but when addressed in Cognos 8, the information appears as part of the external namespace.

Access Permissions for Users

Users must have at least traverse permissions for the parent entries of the entries they want to access. The parent entries include container objects such as folders, packages, groups, roles, and namespaces.

Permissions for users are based on permissions set for individual user accounts and for the namespaces, groups, and roles to which the users belong. Permissions are also affected by the membership and ownership properties of the entry.

Cognos 8 supports combined access permissions. When users who belong to more than one group log on, they have the combined permissions of all the groups to which they belong. This is important to remember, especially when you are denying access.

Tip: To ensure that a user or group can run reports from a package, but not open the package in a Cognos studio, grant the user or group execute and traverse permissions on the package.

Groups and Roles

Users can become members of groups and roles defined in third-party authentication providers, and groups and roles defined in Cognos 8. 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.

Chapter 2: Security and roles created in Cognos 8. The groups and roles created in Cognos

Groups and roles represent collections of users that perform similar functions, or have a similar status in an organization. Examples of groups are Employees, Developers, or Sales Personnel. Members of groups can be users and other groups. When users log on, they cannot select a group they want to use for a session. They always log on with all the permissions associated with the groups to which they belong.

Roles

Chapter 2: Security and roles created in Cognos 8. The groups and roles created in Cognos

in Cognos 8 have a similar function as groups. Members of roles can be users, groups,

and other roles. The following diagram shows the structure of groups and roles.

30 Contributor

Chapter 2: Security

Group Role User Group User Group Role
Group
Role
User
Group
User
Group
Role

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 that can be deployed are required

In this case, it is best to populate groups and roles in the third-party provider, and then add those groups and roles to the Cognos groups and roles to which they belong. Otherwise, you may have trouble managing large lists of users in a group in the Cognos namespace.

you want to address specific needs of Cognos 8 administration

you want to avoid cluttering your organization security systems with information used only in Cognos 8

Cognos 8 Planning Roles

There are two predefined roles for Cognos 8 Planning:

Planning Rights Administrators

This role enables you to access Contributor Administration Console, Analyst, and all associated objects in the application for the first time following installation. You can then change the roles, groups, and users who can access the Contributor Administration Console and to Analyst.

Planning Contributor Users

This is the default role for users who want to access the Contributor Web client, Contributor for Excel, or Analyst. However, anyone can be assigned rights to use the Contributor Web client, or Contributor for Excel regardless of whether they are a member of the Planning Contributor Users role. Analyst users must be members of the Planning Contributor User role.

Note: You do not have to use these roles, they can be deleted or renamed. If you decide not to use the predefined roles, you must assign the access permissions and capabilities required by Cognos 8 Planning to other groups, roles, or users.

Capabilities

Capabilities are secured functions and features. If you are an administrator, you set access to the secured functions and features by granting execute permissions for specified users, groups, or roles. Users must have at least one capability to be accepted through the Cognos Application Firewall.

Chapter 2: Security

The Planning Contributor Users role has the Planning Contributor capability by default. If you do not want to use this role, you can assign the capability to any groups, users, or roles that you create to replace this role by giving execute permissions to the appropriate members.

The Planning Rights Administrators role has the Planning Rights Administration capability by default. To assign this capability to groups, users, or roles, you must give execute permissions to the appropriate members. You must also give members permissions to traverse the Administration folder.

Tip You change capabilities through Cognos Administration, by clicking the Security tab. For more information, see "Securing Functions and Features" in the Administration and Security Guide.

Capabilities Needed to Create Cognos 8 Planning Packages

You can create a Planning Package during the Go to Production process, giving users access to Cognos 8 studios from the Contributor application and enabling users to report against live Contributor data using the Planning Data Service. To do this, the Planning Rights Administrators role must be granted the Directory capability. Members of the System Administrator role are automatically granted this capability, but Planning Rights Administrator members are not.

Setting up Security for a Cognos 8 Planning Installation

You must set up security for a Cognos 8 Planning installation. To configure security for Cognos 8 Planning, do the following:

Using Cognos Configuration, configure Cognos 8 to use an authentication provider

Using Cognos Administration

add Contributor Administration Console and Analyst administrators to the Planning Rights Administrators role

add Contributor application members and Analyst users to the Planning Contributor Users role

enable Planning Roles in Cognos 8

restrict access to the everyone group

create additional roles or groups for Cognos 8 Planning (optional)

 

Note: We recommend that you add groups of users as defined in your authentication provider to the roles in Cognos 8 Planning, rather than individual users. This means that changes in group membership are reflected immediately in the roles without having to make changes in Cognos 8

To configure Analyst security:

configure integrated Windows authentication if you want to execute macros without interaction

specify a default library

32 Contributor

Chapter 2: Security

assign access at object, library, or item level

Using the Contributor Administration Console set access rights for Contributor administrators to Contributor administration functions

set rights for Contributor application users for Contributor applications

Configure Cognos 8 to Use an Authentication Provider

Cognos 8 components can run with two types of access: anonymous and authenticated. By default, anonymous access is enabled. To use Cognos 8 Planning, you must disable anonymous access so that users are required to log on. Only authenticated users can access your Cognos 8 Planning applications.

For authenticated access, you must configure Cognos 8 components to use a namespace associated with an authentication provider used by your organization. You can also configure multiple namespaces. At run time, users can choose which namespace they want to use.

Note: If you are using the Generate Transformer Model extension, you must add the Cognos Series 7 namespace. Local authentication export (LAE) files cannot be used.

Steps to Disable Anonymous Access

  • 1. On each Content Manager computer, start Cognos Configuration.

  • 2. In the Explorer window, under Security, Authentication, click Cognos. The Cognos resource represents the Cognos namespace. For more information, see the Administration and Security Guide.

  • 3. In the Properties window, ensure that Allow Anonymous Access is set to False.

  • 4. From the File menu, click Save.

Steps to Configure Authentication Providers

  • 1. On each Content Manager computer, start Cognos Configuration.

  • 2. In the Explorer window, under Security, right-click Authentication, and then click New resource, Namespace.

  • 3. In the Name box, type a name for your authentication namespace.

  • 4. In the Type list, click the appropriate namespace and then click OK. The new authentication provider resource appears in the Explorer window, under the Authentication component.

  • 5. In the Properties window, for the Namespace ID property, specify a unique identifier for the namespace.

  • 6. In the Properties window for Authentication, for the Allow session information to be shared between client applications, set the value to True.

Chapter 2: Security

This enables you to have single signon between multiple clients on the same computer. Note that you cannot have single signon between a Windows application, and a Web client application, for example, Contributor administration and Cognos 8.

  • 7. Specify the values for all other required properties to ensure that Cognos 8 components can locate and use your existing authentication provider.

  • 8. Test the connection to a new namespace. In the Explorer window, under Authentication, right-click the new authentication resource and click Test.

  • 9. From the File menu, click Save.

Cognos 8 loads, initializes, and configures the provider libraries for the namespace.

For specific information about configuring each kind of authentication provider, see the Cognos 8 Planning Installation and Configuration Guide.

Add or Remove Members From Planning Rights Administrators and Planning Contributor Users Roles

Using Cognos Administration, add Contributor Administration Console administrators and Analyst administrators to the Planning Rights Administrators role. Add Contributor application and Analyst users to the Planning Contributor Users role.

Steps

  • 1. In Cognos Connection, in the upper-right corner, click Cognos Administration.

  • 2. On the Security tab, click Users, Groups, and Roles.

  • 3. Click on the Cognos namespace.

  • 4. In the Actions column, click the properties button for the Planning Rights Administrators or Planning Contributor Users role.

  • 5. Click the Members tab.

  • 6. To add members, click Add and do the following:

To choose from listed entries, click the appropriate namespace.

To search for entries, click the appropriate namespace and then click Search. 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;

34 Contributor

Chapter 2: Security

  • 7. Click the right-arrow button, and when the entries you want appear in the Selected entries box, click OK. Tip: 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 OK. For more information, see the Cognos 8 Administration and Security Guide.

Enabling Planning Roles in Cognos 8

Planning tasks that require access to the Cognos 8 data store, such as running macros, go to production, and adding job servers, require additional security configuration. Access to the data store is restricted to certain groups through Cognos Administration. You must have a system administrator or a user from one of the following groups perform tasks that require the Cognos 8 data store. Optionally, you can add users to the required groups to perform the tasks.

Group

Tool

Task

Data Manager

Framework Manager

Only members of the Data Manager Authors

You must have a Data Manager Authors group

Authors

group can import from a Framework Manager

data source.

member perform this task.

Directory

Cognos Administration

You must have a Directory Administrator create

Administrators

Configuration, Data Source Connections

a data source named Cognos Planning - Contributor with a connection of type Cognos

Report

Planning - Contributor before performing go to production.

Administrators or

Cognos Administration Configuration, Content

A Report Administrators or Server Administrators group member must publish and run macros in

Server

Administration

Content Administration.

Administrators

Restricting Access to the Everyone Group

The Everyone 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. By default, the Everyone group belongs to several built-in groups and roles in the Cognos namespace. To restrict access, remove the Everyone group the System Administrators role and replace it with authorized groups, roles, or users. Optionally, remove the Everyone group from the Planning Contributor Users role to restrict access to Contributor plans.

Chapter 2: Security

For more information about the Everyone group, and System Administrators role, see "Initial Security" in the Administration and Security Guide.

Recommendation - Creating Additional Roles or Groups for Contributor

To secure your Contributor applications, you may want to create roles or groups for the following users:

Contributor client extensions

Contributor work offline users

for example, create one work offline role per Contributor application and assign the offline users to the relevant role. The application administrator must also belong to this role.

system links

translated applications

Planning Contributor User Roles

When you assign user rights to Contributor applications, the first time you click User, Group, Role in the Rights window, a list of all the Users, Groups, and Roles that are members of the Planning Contributor Users role is displayed. If the Planning Contributor Users role contains a large number of members directly below, you can improve performance by creating a smaller number of groups or roles below the Planning Contributor Users role to act as filters.

Note: Members of roles can be users, groups, and other roles. Groups can contain users and other groups, but not roles.

Planning Rights Administrator Roles

If you have a large number of administrators, you may wish to create a roles, or groups for specific tasks, and then add the individual users to this role or group. For example, a role Allow System Links can be used for this task, and any user added to that role is assigned that right.

For more information about creating groups or roles, see the Administration and Security Guide.

Configuring Access to the Contributor Administration Console

Administrative access can be set for the Cognos 8 Planning environment or the datastore server that it contains. It can also be set for the application or publish container objects in the datastore server, the job server objects in the job server cluster, links, and macros. You can also set rights to individual functions of these objects.

If you are an administrator with no access rights to an object, you cannot view the details for that object in the Administration Console, and cannot select these objects. You will see the datastore servers, even if you have no rights to it, because you may have rights to applications on the datastore server. If you have no rights to any object, the Contributor Administration Console closes.

36 Contributor

Cascade Rights

Chapter 2: Security

If you set rights to operations for the Cognos 8 Planning environment, the datastore server, or the job server, you are prompted to cascade the rights to the lower levels. Regardless of your response, when you grant rights to a datastore server or job server cluster, the user automatically inherits the same rights for any applications, publish containers, or job servers that you subsequently add.

Tips: To always cascade rights without being prompted, on the Access Rights window, click Cascade rights selection.

Rights that are cascaded are indicated by blue text.

Operations are the functions that can be performed in the Contributor Administration Console. Initially, a Planning Rights Administrator grants rights so that other Contributor administrators perform these operations.

Granting Access Rights to Administrators

You can grant rights so that administrators can view who has write access to the development model, select an application and cube as the source and target of a system or administration link, add or remove a datastore server, and add a job server cluster.

Rights

Privileges

Session Details Access

You can grant the write to view who has write access to the development model.

You can grant the right to:

Global Administration Access

run Go to Production to create the production application modify the datastore connection details for applications and publish containers set an application online or offline in the Web client assign access rights You can assign access rights to datastores, applications, publish containers, job server clusters, and job servers.

Links Access

You can secure the ability to create, edit, execute, delete, import, and export administration links. You can also secure previously created administration links (administration link instances).

You secure Administration Link instances individually. To locate them, scroll to the bottom of the Operations tree and look for LinkLink Name.

You can grant the right to select an application and cube as the source and target of a system or administration link.

Chapter 2: Security

Rights

Privileges

Datastores Access

You can grant the right to add or remove a datastore server.

Application Containers

You can grant the right to

Access

upgrade or import a Contributor application from an earlier version of Contributor

link to an existing application create an application

create a script that can be run by a database administrator to create an application. This option is used when the Generate Scripts option is set to Yes in the Admin Options table

remove an application from the Planning environment assign or remove an application from an application folder

Publish Container Access

You can grant rights for administering publish containers:

link to a publish container

create a publish container

create a script that is run by a database administrator to create a publish container.

This option is used when the Generate Scripts option is set to Yes in the Admin Options table.

Publish containers are created the first time someone publishes. The administrator must have the right to create a publish container in order to publish.

For publish jobs to be processed, the publish container must be added to a job server cluster or job server.

To modify a publish datastore connection you must have the Global Administration right Modify connection document.

38 Contributor

Chapter 2: Security

Rights

Privileges

Development Access

You can grant the right to perform the following operations in a development application:

configure the Web client - navigation, orientation, options, planner-only cubes and Contributor help

configure application maintenance options import and maintain the e.List, and rights create and maintain access tables and saved selections import data synchronize set datastore options create and maintain translations

Production Access

You can grant the right to perform the following operations on the production version of the application:

publish data delete annotations

preview data This option is important if you want to hide sensitive data

manage extensions

Job Server Clusters Access

You can grant the right to add or remove a job server cluster.

Job Server Access

You can grant the right to update job server properties for the Planning environment.

Go to a Job server cluster to enable and disable job processing of an application to add and remove job servers from a job server cluster to add and remove applications, and publish containers from the job server to update job server properties

Steps

  • 1. Click Access Rights.

Chapter 2: Security

  • 2. Click Add.

  • 3. Click the appropriate Namespace and select the user, group, or role.

  • 4. Click the green arrow button

Chapter 2: Security 2. Click Add . 3. Click the appropriate Namespace and select the user,

and then click OK.

  • 5. Under Name, select the name.

  • 6. Click the operations needed. Tip: you can filter operations by datastore, application, publish container, job server cluster, and job server.

  • 7. Click Save. Access rights apply as soon as the changes are saved.

Access Rights for Macros

A macro consists of one or more macro steps that you select when you create a macro. For example, a macro that imports data into a cube, named "Import Expenses", might contain the following macro steps:

Upload an Import File

Prepare Import

Go To Production

You can secure the rights to create, edit, execute, delete, and transfer macros, and the ability to create individual macro steps.

By default, when a user with the Create Macro right adds a new macro instance, they are granted all rights to it - edit, execute, delete and transfer. For other users, the access to that instance are determined by their rights.

After a link or macro is created, only a Planning Rights Administrator can change the instance rights.

For example, consider a user who is granted create, edit, and execute macro access rights. By default, this user has all access rights to macros they create. However, they only have edit and execute rights to those created by other users. A Planning Rights Administrator can subsequently grant or revoke any rights to those macros for any user.

The Execute Command Line macro step is secured by default. This is to minimize the risk of unauthorized access to resources.

You can also secure the rights to edit, execute, delete and transfer previously created macro instances, for example, "Import Expenses".

Rights Needed to Transfer Macros

Transferring a macro enables you to copy steps from one macro to another, add steps to another macro, and make a copy of an existing macro. To do this, you must have:

40 Contributor

Chapter 2: Security

transfer rights for the macro instance being transferred to or from

edit rights for the target macro

create macro step rights for all the macro steps that you are transferring

Authentication of Macros

Authentication is based on the security context under which the macros are run. For example, if the macro contains a Go to Production step, the user specified in the authentication details when you create a macro must have the rights to run Go to Production. This is separate from the access rights used to secure the management of macros.

Recommendation - Granting Rights

We recommend that you secure the "Execute Command Line" step to prevent unauthorized access to the functionality that you can execute from the commend line.

Grant the create macro step "Execute Command Line" rights to trusted users only, typically Planning Rights Administrators who can schedule macros on the Contributor server.

Revoke edit, transfer, and delete rights from all macro instances that contain the "Execute Command Line" step to prevent unauthorized change by another user. An administrator would have to re-grant edit, transfer, and delete rights to permit any kind of maintenance changes to the macro.

Set Access Rights for Contributor Macros in Cognos Connection

Contributor macros that are published to Cognos Connection must be secured by the Planning Rights Administrator or the System Administrator to ensure that only the required users, groups, and role have access to execute or schedule macros.

You must be a member of the Planning Rights Administrators or System Administrator roles to change user, group, and role capabilities.

Steps

  • 1. In Cognos Connection, in the upper-right corner, click Cognos Administration.

  • 2. On the Security tab, click Capabilities.

  • 3. Click the actions button next to the Administration capability and click Set Properties button

Chapter 2: Security ● transfer rights for the macro instance being transferred to or from ●

. On the Permissions tab, grant the traverse permission to the required users, groups, and roles and click OK.

  • 4. Click the Administrator capability to show additional functions. Click the actions button next to Run activities and schedules and click Set Properties. On the Permissions tab, grant execute and traverse permissions to the required users, groups, and roles and click OK.

  • 5. On the Configuration tab, click Content Administration.

  • 6. Click the Set Properties button

Chapter 2: Security ● transfer rights for the macro instance being transferred to or from ●

on the Administration page. On the Permissions tab, grant

read, execute, and traverse permissions to the required users, groups, and roles.

Chapter 2: Security

If required, grant write permission if you want the user, group, or role to be able to modify the contents of this folder. Grant set policy permission if you want the user, group, or role to be able to change security permissions on this folder.

7.

Click OK.

Members of the required users, groups, or roles now have access schedule and run Contributor macros in Cognos Connection.

Assign Scheduler Credentials

 

All scheduled macros, and some jobs, run under the identity setup in the Cognos scheduler or the scheduler credentials for a third party scheduler. This is because macros and jobs that run in the background cannot prompt the user for authentication information. Scheduler credentials are also used to lookup Contributor email addresses from workflow pages.

Scheduler credentials are associated with an authenticated user, which can include more than one user logged on to different namespaces. The user, or group or role that they are a member of, must have rights granted in the Access Rights window to run macros, jobs, and lookup email addresses.

If there are users from multiple namespaces in your application, you must have scheduler credentials associated with those namespaces. When the Validate Users job is run, the scheduler credentials must be associated with all the namespaces you imported users from. If you are logged on to only one namespace, users that belong to other namespaces are considered invalid.

Macros that are run directly from the Contributor Administration Console through user interaction run under the currently logged on user account and do not use the scheduler credentials. Macros that are triggered through events run under the identity used to create the event, not the scheduler credentials.

Only users who have the Planning Rights Administrator capability can modify the scheduler credentials. By default, the scheduler credentials are associated with the user who opens the Contributor Administration Console for the first time, if that user is a Planning Rights Administrator. If that user is not a Planning Rights Administrator, a message states that the credentials are invalid, or do not exist, and a Planning Rights Administrator must update the scheduler credentials.

Note that the following Contributor jobs use the scheduler credentials:

Validate Users

Reconcile

Steps

1.

In the Systems Settings pane, click the Scheduler Credentials tab, and click Update.

2.

Click Logon. Initially, the Logon As button is disabled.

3.

Enter the User ID and password to be used as the scheduler credentials and click OK.

4.

If your logon is successful, the Logon button is disabled, and the Logon as button is enabled.

42 Contributor

This enables you to log on to different namespaces.

Chapter 2: Security

You must provide scheduler credentials for all namespaces that users of the applications are imported from.

After you create and configure Contributor applications, the next step is to configure user access. You do this by assigning users, roles, or groups to e.List items in the Rights window in the Contributor Administration Console, either by importing a file, or by manually inserting rights.

Chapter 2: Security

44 Contributor

Chapter 3: Configuring the Administration Console

When you start the Cognos 8 Planning - Contributor Administration Console for the first time you must configure it before you can use it.

Before you can configure the Cognos 8 Planning - Contributor Administration Console, you must be a member of the Planning rights administration capability which by default, is granted to members of the Planning rights administration role. The Planning rights administration capability can be granted to any user, group, or role. (p. 31).

Steps to Configure the Cognos 8 Planning - Contributor Administration Console

Create the Planning tables in the Planning content store (p. 45).

Add a datastore server (p. 46).

Add job server clusters and job servers (p. 54).

Configure administration security for the Contributor Administration Console.

When you have done these tasks, applications can be created, imported, or upgraded (p. 58).

Creating Planning Tables

The first time the Contributor Administration Console is run, a check is run to see if any Planning tables exist in the Planning store. If not, you are prompted to create them.

You can either create the tables by selecting Create and populate tables now or you can choose to create the tables using a script which is then run by a Database Administrator (DBA). Use this option if you do not have access rights to create tables in the database. To choose the script option, you select Generate table scripts and data files and enter the location of where to save the script. The script is then created automatically and the DBA can run the script to create the tables.

If the filesys.ini was not specified during installation, you must specify the path when you create Planning tables. You change this setting if the default path is not used.

If you want to work with a different FileSys.ini, and the associated properties and samples other than the default, select the Allow use of non-default FileSys.ini check box.

The filesys.ini file is a control file used by Analyst. It contains file paths for the Libs.tab, Users.tab, and Groups.tab that control the specific library and user setup. You can edit the filesys.ini path by selecting Tools, Edit FileSys.Ini path.

Planning tables are typically prefixed with a P_, and hold information about

datastore servers

Contributor application datastores

job servers and job server clusters

Chapter 3: Configuring the Administration Console

security

macros administration links

jobs

Add a Datastore Server

When you open the Contributor Administration Console for the first time, you must add an application datastore server.

Steps

  • 1. Right-click Datastores in the Administration tree, and click Add Datastore. Tip: You can also modify the existing application datastore connection by clicking the Configure button on the Datastore server information page (p. 47).

  • 2. Select the Datastore provider. The options are SQL Server, Oracle or DB2.

  • 3. Enter the Datastore server name, or click the browse button (SQL Server only).

Chapter 3: Configuring the Administration Console ● security ● macros administration links ● ● jobs Add

to list the available servers

  • 4. Enter the information as described in the table below:

Setting

Description

Trusted Connection

Click to use Windows authentication as the method for logging on the datastore. You do not have to specify a separate logon id or password. This method is common for SQL Server datastores and less common, but possible, for Oracle.

Use this account

Enter the datastore account that this application will use to connect. This box is not enabled if you use a trusted connection.

Password

Type the password for the account. This box is not enabled if you use a trusted connection.

Preview Connection Provides a summary of the datastore server connection details.

Test Connection

Mandatory. Click to check the validity of the connection to the datastore server.

  • 5. If you want to configure advanced settings, click Advanced.

46 Contributor

Chapter 3: Configuring the Administration Console

Typically these settings should be left as the default. They may not be supported by all datastore configurations.

Enter the following information.

Setting

Description

Provider Driver

Select the appropriate driver for your datastore.

Connection Prefix

Specify to customize the connection strings for the needs of the datastore.

Connection Suffix

Specify to customize the connection strings for the needs of the datastore.

Datastore Server Information

When you click the datastore server name in the tree, the datastore server information is displayed. The datastore server connection area displays the connection string that is used to connect to the datastore server. You can configure the datastore connection, change the datastore server, change the account detail and test the connections by clicking the Configure button.

Jobs

A job is an administration task that runs on job servers and is monitored by the Administration Console.

Additional servers can be added to manage applications, speeding up the processing of jobs. You can run the job and monitor its progress. All jobs can be run while the application is online to Web clients. This means that you can make changes to the development version of an application while the production version is live. It reduces the offline time during the Go to Production process.

Each job is split into job items, one job item for each e.List item. If you are running a Publish job for eight e.List items, eight job items are created. Contributor applications can be added to more than one job server, or to a job server cluster. When a job is created, job items are run on the different job servers, speeding up the processing of a job.

Types of Jobs

The following table describes each type of job:

Job Type

Description

Commentary tidy

Deletes user annotations and audit annotations, and references to attached documents (p. 289).

Chapter 3: Configuring the Administration Console

Job Type

Description

Cut-down models

Cuts down applications (p. 134).

Cut-down tidy

Removes any cut-down models that are no longer required.

Export queue tidy

Removes obsolete items from the export queue.

Import queue tidy

Removes from the import queue model import blocks that are no longer required.

Inter-app links

Transfers data between applications. To run successfully, requires that links are reconciled to e.List items.

Job test

Test the Job sub system using a configurable Job Item.

Language tidy

Cleans up unwanted languages from the data store after the Go to Production process is run. This job is created and runs after Go to Production is run.

Prepare import

Processes import data ready for reconciliation (p. 174).

Publish

Publishes the data to a view format (p. 255).

Reconcile

Ensures that the structure of the e.List item data is up to date. This job is created and runs after Go to Production is run. For more information, see "Reconciliation" (p. 52).

Reporting publish

Publishes the data to a table-only format (p. 262).

Validate links

Updates the validation status of links.

Validate users

Checks to see if the owner or editor of an e.List item has the rights to access the e.List item. For more information, see "Ownership" (p. 91). The job checks the rights of users and updates the information in the Web browser. This job is created only if a change is made to the Contributor model, and runs after Go to Production is run.

Run Order for Jobs

The order in which jobs are run depends on the number of job processors, the hardware used, and the job polling interval. If there is one job processor, jobs are run in no specific order. If there is more than one job processor, the first job processor to poll for a job picks a job in no specific order and runs it. The additional job processors prioritize queued jobs over running jobs and pick one

48 Contributor

Chapter 3: Configuring the Administration Console

of the queued jobs to work on in no specific order. If there are enough job processors, all jobs can be run at the same time.

Because jobs are independent of each other, they do not need to run in a specific order. The exception is the publish job. The publish job can be started when a reconcile is running, but for it to complete successfully, all e.List items that are being published must be reconciled.

Actions That Cause Jobs to Run

The following actions in the Administration Console cause jobs to run.

Action

Job

Import data (p. 141)

prepare import and reconcile *

Running administration links

inter-app links, validate links

Publish data (p. 255)

publish and reporting publish

Delete annotations (p. 289)

annotations tidy

Create a new application

reconcile *

Cut-down model options

cut-down models and cut-down tidy *

Change planner-only cubes

reconcile *

Synchronize with Cognos 8 Planning - Analyst

reconcile *

* Triggered by Go to Production Changes in the following areas do not cause jobs to be run:

navigation

orientation Contributor help text all application settings except for cut-down models the backup file location

Securing Jobs

Some jobs run under scheduler credentials. This is because jobs that run in the background cannot prompt the user for authentication information. Scheduler credentials are associated with an authenticated session, which can include more than one user logged on to different namespaces.

The following jobs run under scheduler credentials:

Chapter 3: Configuring the Administration Console

Validate users

When the Validate users job is run, the scheduler credentials must be associated with all the namespaces you imported users from. If it is logged on to only one namespace, users that belong to other namespaces are considered invalid.

Reconcile all jobs launched by a scheduled macro

Only members of the Planning rights administrator capability can modify the scheduler credentials. For information about setting the scheduler credentials, see "Assign Scheduler Credentials" (p. 42).

Managing Jobs

You can manage and monitor the progress of running jobs in applications from the Job Management branch in the Administration tree, or from the Monitoring Console (p. 59).

You can also monitor the progress of jobs triggered by administration links from the Monitor Links window.

The Job Monitor shows the following information:

Details

Description

Status

The status is one of the following:

creating

ready to run

queued. The job is waiting to be run. The job may have to wait for a job server to become available before it can be run.

running complete - the job has finished running successfully

cancelled - the job has failed and was cancelled. Double-click on the line to find out more.

Succeeded

The number of job items that ran successfully. If all did, All is stated. A percentage is shown.

Failed

The number of job items that failed, if any.

Total Items

The total number of job items that the job is split into. Jobs are broken down into atoms of work known as job items, enabling a job such as Publish to be run over different threads.

Estimated Completion

An estimated date and time of completion for the job in local time.

50 Contributor

Chapter 3: Configuring the Administration Console

Details

Description

Average Duration

The average interval between the completion of job items.

Next Item

The next job item to be run.

Start

The date and time when the job started, in the local format.

Last Completion

The time when the last job item was completed.

Duration (min)

The time in minutes the job task has taken to complete.

Description

A description of the job type.

The lower area shows tasks running on job servers.

Details

Description

Status

Indicates when a job is running.

Start

The date and time when the job started on that processor in local format.

End

The date and time when the job stopped running on that processor.

User

The user account on the job server.

Process ID

The process ID can be used for debugging.

Thread ID

The thread ID can be used for debugging.

Job View Refresh Interval (seconds)

You can change the job view refresh interval to whatever you feel is appropriate. We recommend that you do not set it to less than 5 seconds. For most people's needs, 15 seconds is adequate. If network traffic is an issue, the interval can be longer.

Publish Jobs

The publish process is carried out by the reporting publish job for a table-only layout (p. 262), or the publish job if a view layout (p. 276) is selected.

To monitor publish jobs in the jobs monitor, select the publish container from the box that is available at the top of the job monitor.

Chapter 3: Configuring the Administration Console

Cancelled Jobs

If a Job is cancelled, you can show information about why this happened by double-clicking on the line.

Pausing Jobs

If you want to pause a running job, you must stop the Job Server. To do this, right-click the job server or job server cluster name and click Disable Job Processing.

Reconciliation

Reconciliation ensures that the copy of the application that the user uses on the Web is up to date. For example, all data is imported, new cubes are added, and changed cubes are updated.

Reconciliation takes place after Go to Production runs and a new production application is created. It also takes place when an administration link or an Analyst to Contributor link to the production application is run. However, in this case, only the imported data is updated. The application is reconciled on the job server unless a user tries to access an e.List item before it is reconciled. For more information, see "The Effect of Changes to the e.List on Reconciliation" (p. 101).

All contribution e.List items are reconciled and aggregated if

the application was synchronized with Analyst

changes were made to the Access Tables, Saved Selections, or the e.List that resulted in a different pattern of No Data cells for contribution e.List items that are common to both the development and production applications

Note: Changing an access setting to No data, saving the application, and then changing the access setting to what it was previously also results in reconciliation.

they have import blocks

Note: If you use the Prepare zero data option, an import data block is created for all e.List items, so all e.List items are reconciled.

children were added or removed they are new

Reconciliation on the Server

During reconciliation on the server, the following process occurs for each e.List item:

The data block is loaded onto the job server.

The transformation process occurs

New cubes are added, changes are made to existing cubes such as dimensions added or removed, and access tables are applied.

Data is imported.

Data is saved.

52 Contributor

Chapter 3: Configuring the Administration Console

Reconciliation can be performed across multiple processors and job servers. For more information, see "Manage a Job Server Cluster" (p. 54).

Reconciliation on the Client

If a user attempts to open an e.List item that is not yet reconciled, the e.List item is reconciled on the user's computer. This may take a few minutes.

In the Web application, the user can determine the state of an e.List item by the workflow icon. If an icon is enclosed in a red box, the item is out of date and needs reconciling. For more information, see "Workflow State Definition" (p. 297).

If the Prevent client-side reconciliation check box is selected (p. 79), a user cannot open the e.List item until the e.List item is reconciled on the server side.

Deleting Jobs

You can delete jobs, but we do not recommended it because it can leave your data in an unstable state.

Tip: If you want to pause a running job, you can stop the job server. Right-click the name of the job server or job server cluster and click Disable Job Processing.

Prepare import

If you delete a prepare import job, the next time you run Prepare import, it tidies this up.

Cut-down models

You typically delete a cut-down models job after you cancel the Go to Production process. Clicking the Go to Production button reruns the cut-down models job. If you delete a cut-down models job during Go to Production, Go to Production does not run.

Reconciliation

If you delete a reconcile job, all e.List items that were not reconciled stay unreconciled. e.List items that were already reconciled by the job remain reconciled. When a user attempts to view an unreconciled e.List item in the grid, if client side reconciliation is allowed, the reconciliation process takes place on the client. If client side reconciliation is not allowed, users cannot view the e.List items. Rerun the Go to Production process to trigger a repair reconcile job.

Managing Job Servers

A job server cluster groups the job servers that are used to process administration jobs. You can stop, start, and monitor all job servers in a cluster at the same time. You can also choose to have specific objects run on individual servers.

When you create a Contributor application, you are prompted to choose a cluster or server to run the jobs.

Chapter 3: Configuring the Administration Console

You can add applications and publish containers to multiple job servers. This speeds up the processing of jobs, such as reconciliation, giving near linear improvements per processor.

The following two scenarios provide examples of how this might work.

Scenario 1

If you publish large amounts of data, you might want to assign the publish container to different servers than those that are processing the main application. This is because if you assigned the application container and the publish container to cluster X containing servers A, B,C, D, it is possible that a large job, for example, publishing 5000 e.List items, could consume all the resources in cluster X for some time, preventing other jobs from being processed. So in this case you might want to assign the publish container to, for example, servers A and B, and the application container to server C and D to enable other jobs such as prepare import, and server-side reconciliation to run at the same time as the publish job. There is no control at job level.

Scenario 2

If you have some applications that are in production and are live, you might want to have one or more job clusters with your best hardware to monitor these applications to ensure that they are stable and available. For applications that are in development, you might want to have a different job cluster containing your less efficient hardware.

For more information, see "Jobs" (p. 47). You can also automate job server management (p. 197).

Manage a Job Server Cluster

Before administration jobs can be processed, you must add a job server cluster to the Administration Console. A job server cluster manages a group of job servers. For information on managing job servers, see "Managing Job Servers" (p. 53).

Steps

  • 1. Right-click Job Server Clusters and click Add Job Server Cluster.

  • 2. Type a unique name for the job server cluster.

  • 3. Click Add. The next step is to add job servers to the job server cluster.

  • 4. Remove a job server cluster by right-clicking it and selecting Delete Job Server Cluster.

  • 5. Disable job processing on a cluster by right-clicking the cluster and selecting Disable Job Processing.

  • 6. To test communication with the job server, right-click the job server name and click Test. Any errors are displayed in a message box.

Add a Job Server and Change its Content Store

You must add job servers to a job server cluster so that administration jobs can be processed.

54 Contributor

Chapter 3: Configuring the Administration Console

Job servers can exist in only one Planning content store. You can either manually delete the job server (p. 57) and add it to the new Planning content store, or on the job server, change the content store that it is associated with.

Steps to Add a Job Server

  • 1. Right-click Job Servers and click Add Job Server.

  • 2. Select a job server from Available Servers. Computers that are job servers must have the Planning job service option enabled in Cognos Configuration. For more information, see the Cognos 8 Planning Installation and Configuration Guide.

  • 3. Enter the Polling interval. This sets how often the job server polls the database to see if there are any new jobs. The default is 15 seconds.

  • 4. Enter the Maximum concurrent jobs. The default is -1. This is 1 concurrent job per processor. Typing 0 stops job execution.

  • 5. Click Add. You should now add any applications, publish containers, and other objects to either a job server cluster, or an individual job server. Jobs such as reconcile are not run until an application is added to a job server or job server cluster.

Tip: to modify the properties of a job server, right-click the server name and click Properties.

Steps to Change the Content Store for the Job Server

  • 1. On the job server computer, open Cognos Configuration.

  • 2. Under Data Access, Content Manager, Content Store, change the value for Database server with port number or instance name.

Add Applications and Other Objects to a Job Server Cluster

Adding an object to a job server cluster means that when a job such as Publish is run, the job is run by the job servers in the cluster.

You can monitor applications at cluster level and at job server level. You must add the following objects to run jobs:

a Contributor application

an application folder

View Publish Container You need this if you are publishing using the view layout.

Table-only Publish Container

Chapter 3: Configuring the Administration Console

You need this if you are publishing using the Table-only Layout. a Planning Content Store

Step

Click the job server cluster name, and click Add.

The window contains details about the objects monitored by the cluster. It lists only objects that are directly assigned to the cluster, not those objects that are assigned to individual job servers.

Tip: Start or stop all job servers in the cluster by right-clicking the cluster name and selecting Enable Job Processing or Disable Job Processing as required.

Add Objects to a Job Server

You can add objects to individual job servers.

Tip: You can see whether a cluster or individual job server is started from the icons in the administration tree:

Icon

Description

Job server started.

Job server started.

Job server cluster started.

Job server cluster started.

Steps

  • 1. Click the name of the job server, and then click Monitored Applications.

  • 2. Click Add. Three panes of information appear.

Pane

Description

Monitored objects held in the Shows the objects monitored by the cluster that the job server is in. Job Server Cluster

Monitored objects held in this Job Server

Lists the objects monitored by the job server. It contains only details of objects directly assigned to the server.

You can assign an application folder and its contents to a job server or job server cluster as a monitored object. You can also assign each application within an application folder to a different job server. For more information on monitoring application folders, see "Monitor Application Folders" (p. 57)

56 Contributor

Chapter 3: Configuring the Administration Console

Pane

Description

Job Tasks being processed by Monitors the jobs that are being processed by the server:

this Job Server

data source: If you see N/A by an application folder, this indicates that the folder may have more than one data source (applications within an application folder can be on more than one datastore).

application name job type: the job being processed (p. 47)

Process ID: identifies the process used to execute a job task. Used for debugging.

Thread ID: identifies the thread used to execute the job task. A thread is created for each job task. Multiple threads can be created per process. The number of threads per process is set in the Maximum concurrent jobs option. Used for debugging.

  • 3. Right-click the job server name and select Enable Job Processing or Disable Job Processing as required. You can automate this process, see "Job Servers (Macro Steps)" (p. 197)"Disable Job Processing" (p. 197) or "Enable Job Processing" (p. 197).

Remove Job Servers

A Job server can exist in only one Planning Content store at a time. You can either manually delete the job server from the Planning content store and add it to the new one, or on the job server, change the content store that it is associated with (p. 55).

Step

In the Contributor Administration Console, right-click the job server name and click Delete Job Server

Monitor Application Folders

An application folder can be assigned to a job server or job cluster as a monitored object. This adds the applications held in the folder, which are not already being monitored, to the job server or cluster, allowing a group of applications to be monitored in one single step. If applications are subsequently added to that application folder, they are not automatically assigned to the job server or cluster.

You can also remove an application folder from a job server or cluster in a single step. This removes all the applications contained and monitored in that folder by that job server or cluster. You can

Chapter 3: Configuring the Administration Console

still add individual applications within an application folder to be monitored by different servers or clusters.

To add the contents of an application folder to be monitored, select the application folder row and click Add.

To add individual applications from within an application folder, select the applications required and click Add.

Creating, Adding and Upgrading Applications

You can create new applications, add existing applications to the server, or upgrade applications by right-clicking Applications and selecting one of the following options:

Create New Application(p. 63).

Link to existing Applications(p. 58). This adds Contributor applications that exist on the datastore server to the Administration Console.

Upgrade Application(p. 329). You can import and upgrade Contributor applications created in an earlier version of Contributor.

Remove Datastore Definitions and Contributor Applications

When you remove a Contributor application and datastore definition, only the entries from the Planning content store are removed, the datastores still remain on the server. To delete an application from the server, you must have Database Administrator (DBA) permissions. If you do not, contact your database administrator.

Step

In the Administration Console, right-click on the server name, or the application name in the Administration tree and click Remove Application.

Tip: You can also assign applications to application folders. For more information, see "Application Folders" (p. 66).

Adding an Existing Application to a Datastore Server

There are several circumstances in which you might add an existing application to a datastore server:

During application creation, you selected the Generate datastore scripts and data files option. In this case, before you can add the application, the script must be run by a database administrator, see "Running the Script.sql file (DBA Only)" (p. 67)

You chose to create scripts during an application upgrade

You want to link to an application that was created in another Planning content store.

58 Contributor

Chapter 3: Configuring the Administration Console

To do this, you must first remove the application from the Planning content store table it currently resides in.

Steps

  • 1. Right-click Applications in the Administration tree and click Link to existing Applications.

  • 2. The Add existing applications window lists the applications that exist for the currently selected datastore server. Click the application you require.

  • 3. If the application was created in a different Planning content store, add an application ID. This is used by the Web browser to identify the application. It must be a unique character string.

  • 4. For applications created using the Script.sql file, select the XML package. The location of the package.xml is the same as the location of the script.

  • 5. Click Add. Ensure that the application is added to a job server or job server cluster. For more information, see "Add Objects to a Job Server" (p. 56).

The Monitoring Console

The Monitoring Console enables you to monitor the progress of the following processes running in the Contributor Administration Console from one location:

application(p. 50) job server clusters(p. 56) administration links(p. 50) macros(p. 192) deployment(p. 168)

Managing Sessions

Multiple administrators may administer a Cognos 8 Planning - Contributor application at any one time. However, to prevent data integrity issues, when a change is made to the development model, it is locked. The lock is dropped when the administrator navigates to a different function or closes the Administration Console. You can manually remove the lock by clicking the Remove button on the Session Details area. Use this with caution because it could prevent other users from saving changes.

You can automate the removal of an application lock. See "Remove Application Lock" (p. 219) for more information.

The development model can be changed by the following:

changing navigation

Chapter 3: Configuring the Administration Console

changing orientation selecting grid options selecting application options selecting planner-only cubes creating Contributor help text selecting dimensions for publish modifying e.List, and rights selecting saved selections and access tables synchronizing with Cognos 8 Planning - Analyst modifying datastore maintenance options resetting development to production.

The production model is updated during the Go to Production process. There are checks in place to ensure that two jobs do not run concurrently. Additionally, when you create a job using the Administration Console, you are prompted if a valid job of that type already exists and alerted that this new job may overwrite the existing job.

Example 1

Administration Console 1: User A clicks Navigation in the Administration tree. At this stage, the development model is not locked.

Administration Console 2: User B clicks e.List in the Administration tree, and makes a change. The development model is then locked by User B. A further check is made to ensure that no changes were made to the development application since it was last read by Administration Console 2. If this is true, User B can continue to edit the e.List and save the changes.

Administration Console 1: User A edits Navigation. User A is informed that User B has the application locked and is asked whether they want to take the lock. User A takes the lock from User B. Because User B updated the development model since User A opened the Navigation page, the development model is no longer up-to-date. The user is prompted and Navigation is re-loaded with the updated development model and User A can continue to edit and save changes.

Example 2

Administration Console 1: User A opens Application Options and makes a change.

Administration Console 2: User B opens Orientation and makes a change. User B is prompted that User A has the lock and User B takes the lock.

Administration Console 1: User A clicks Save. User A is prompted that User B now has the lock and that changes made by User A will not be saved. The controls on Application Options are disabled.

60 Contributor

Example 3

Chapter 3: Configuring the Administration Console

Administration Console 1: User A opens Grid Options and makes a change.

Administration Console 2: User B opens the Publish Data and selects the detail for a publish. Because this does not change the development model, there is no need for a lock to be taken. Both User A and User B can work on the application concurrently.

Sending Email

You can send email to a user defined in an application using your default email program.

Steps

  • 1. Click in the application containing the user you are sending an email to.

  • 2. Click Send email in the toolbar

.
.

The first time you do this, you may be asked to supply your mail provider connection details. Refer to your mail provider documentation.

  • 3. Choose to send an email to All Users or All Active Users, as defined in the application.

  • 4. Click on the group of users you want to send email to, then click Mail. This opens up a new email message in your standard email tool.

  • 5. Create and send the email.

You then return to the Send email dialog box.

Chapter 3: Configuring the Administration Console

62 Contributor

Chapter 4: Creating a Cognos 8 Planning - Contributor Application

To create a Cognos 8 Planning - Contributor application, you perform the following steps:

If you have DBA rights to the datastore server, create a Contributor application using the Application Wizard.

If you do not have DBA rights to the datastore server, create a script using the Application Wizard, then send the script to the DBA who will run the script. After the script is run, add the application to the Administration Console, "Adding an Existing Application to a Datastore Server" (p. 58).

These processes create a development application. A development application is not seen by the users, it is simply the application that you work on in the Administration Console.

This means you can make changes to the application without having to take it offline, reducing the amount of time that users are offline to as little as a minute. This is the period of time taken to integrate the new e.List items into the hierarchy and set the correct workflow states.

Modify the application.

 

You can set the order in which the users are asked to go to each cube, click the dimensions that make up the rows, columns and pages, add and modify the e.List, import users, define access rights, and import data.

Run

❑ Run the Go to Production process, see "The Go to Production Process" (p. 239) .

the Go to Production process, see "The Go to Production Process" (p. 239).

This activates a wizard which creates a production application. This makes the application available to end-users.

Creating a Contributor Application

Use the Application Wizard to create a Contributor Application.

Steps

  • 1. In the Administration tree, under the name of the datastore server where the application is to be created, right-click Applications. A check is made to see if you are logged on with appropriate rights. If you are not, you are prompted to log on. Click Next.

  • 2. Select Create New Application from the menu. A check is made to see if you are logged on with appropriate rights. If you are not, you are prompted to log on. Click Next.

Chapter 4: Creating a Cognos 8 Planning - Contributor Application

  • 3. Select a library. This is the Analyst library that your application will be based on. The D-Cube library list is for information only and tells you which D-Cubes the selected library contains. Click Next.

  • 4. Select the e.List. The e.List is a dimension that is used to determine the hierarchical structure of an application. For more information, see "The e.List" (p. 89). When you select an e.List, the right-hand list tells you which D-Cubes in the application contain this e.List.

  • 5. Click Next. The Administration Console checks the library to ensure that it can create the application. If there are any errors or warnings, you can view these and save them to text file for more investigation. If there are errors, the wizard will terminate. You can continue to create the application if you only have warnings.

  • 6. A window listing the statistics for the application will be displayed. This is for information only. See "Model Details" (p. 66) for more information. You can print the details on this window.

  • 7. Enter application details as follows:

Detail

Description

Application Display Name

Defaults to the Analyst library name, but you can change this during application creation. After an application is created, this cannot be changed. There are no character restrictions. The maximum length is 250 characters.

Datastore Name

The name of the datastore application that contains the Contributor application database tables.

This defaults to the Analyst library name, stripping out special characters. Only the following characters are allowed: lowercase letters a to z and numeric characters. No punctuation is allowed except for underscore. Maximum 30 characters (18 for DB2 OS390)

SQL Server only: Reserved keyword words are not allowed, see your SQL Server documentation for more information.

Application ID

This is used by the Web browser to identify the application. Only the following characters are allowed: lowercase letters a to z and numeric characters. No punctuation is allowed except for underscore.

64 Contributor

Chapter 4: Creating a Cognos 8 Planning - Contributor Application

Detail

Description

Location of datastore files

Enter the file path where the SQL Server datastore files will be created on the administration server. You can browse the data server file structure of file locations. Oracle and DB2 users do not see this box, the location of datastore files is determined by your datastore structure.

Location of datastore backup files