ug_fm

COGNOS (R) ENTERPRISE BUSINESS 

INTELLIGENCE 

COGNOS REPORTNET (TM) 

FRAMEWORK MANAGER 

USER GUIDE 

Framework Manager User Guide 

20-08-2003 

Framework Manager 

1.02 MR1 

Cognos ReportNet(TM) Readme 

Framework Manager User Guide 

Framework Manager Version 1.02 MR1 

Version 1.02 

User Guide 

THE NEXT LEVEL 

OF PERFORMANCE TM

Product Information 

This document applies to Framework Manager Version 1.02 MR1 and may also apply to subsequent releases. To check for newer versions of 

this document, visit the Cognos support Web site (http://support.cognos.com). 

This edition published 2003. 

Copyright 

Copyright (C) 2003 Cognos Incorporated 

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. 

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. 

Information about Cognos Products and Accessibility can be found at www.Cognos.com

Table of Contents 

Introduction 9 

Additional Materials 11 

Chapter 1: Framework Manager 13 

Structuring Metadata in the Framework Manager Environment 13 

The Framework Manager Environment 13 

Project Structure Best Practices 14 

Preparing Metadata for Use in Reports 15 

Chapter 2: Designing a Project 19 

Project Files 19 

Create or Open a Project 20 

The Project Page 21 

Naming Conventions for Objects in a Project 24 

Create a Namespace 25 

Importing Metadata 25 

Relational Databases 26 

SAP BW Data Source 27 

Import from a Cognos ReportNet Model 28 

Architect Models and Impromptu Catalogs 29 

Third-party Metadata Sources 29 

XML as a Data Source 30 

Create a Data Source Connection 31 

Parameterized XML Connection Strings 35 

Using a Project with Multiple Data Sets 35 

Modeling with Multilingual Data Sources 37 

Modeling with SAP BW Data Sources 37 

Export Metadata 42 

Managing Projects 43 

Repository Control 43 

Create a Segment 46 

Create a Link 47 

Functions 48 

Choose the Type of Query Processing 48 

Multiuser Modeling 49 

Action Logging 50 

Synchronize Projects 50 

User Guide 3

Chapter 3: Preparing a Model for Reporting 53 

Query Subjects 53 

Create a Query Subject 54 

Modify a Data Source Query Subject 55 

Conform SAP BW Query Subjects 57 

Deconform an SAP BW Query Subject 57 

Optimizing SAP BW Performance 58 

Modify a Model Query Subject 59 

Modify a Stored Procedure Query Subject 60 

Test a Query Subject 60 

SQL Type 61 

SQL Generation 64 

Merge Metadata To Create a New Query Subject 64 

Transform a Relationship into a Query Subject 65 

Relationships 65 

Recursive Relationships 66 

Refine Query Paths 66 

Resolve Ambiguous Relationships 67 

Create a Relationship 67 

Modify a Relationship 68 

Create a Relationship Shortcut 68 

Detect Relationships 69 

Query Items 70 

Format Query Items 70 

Define a Prompt Control 70 

Usage and Aggregate Properties 72 

Modify Usage and Aggregate Properties 73 

Adding Business Rules 75 

Create a Calculation 75 

Create a Filter 76 

Applying a Filter 77 

Example - Create and Apply a Filter 77 

Use a Prompt Value 78 

Create a Parameter Map 79 

Create a Session Parameter 80 

Using a Macro 81 

Example - Using Parameters 84 

Multilingual Support 85 

Use a Macro to Model Multilingual Data 85 

Define Languages 85 

Export a Translation Table 86 

Import a Translation Table 86 

Example - Create a Multilingual Project 87 

Managing the Project 88 

Modify Properties 88 

Create a Folder 89 

Create a Query Item Folder 89 

Check a Project 90 

Dimensional Metadata 91 

SAP BW Hierarchies 92 

Create a Star Schema Grouping 93 

Specify Dimension Information 93 

Chapter 4: Publishing a Project 95 

Set Governors 95 

Create or Modify a Package 97 

4 Cognos ReportNet (TM) Framework Manager

Security in Framework Manager 98 

Add a User, Group, or Role 99 

Add Data Security 100 

Adding Metadata Security 101 

Add or Remove Object-Based Security 101 

Specify Languages 103 

Publish a Package 103 

Analyze the Effects of Changes to a Package 104 

Managing Packages 105 

Modify Package Access 105 

Modify Package Administrative Access 105 

Explore Packages 105 

View Package Inclusion 106 

Appendix A: Troubleshooting 107 

Unable to See Test Results 107 

Errors in Queries That Use Macros 107 

Unable to View the Result Set of a Stored Procedure 107 

Error When Switching the Language in Reporting Application 107 

Required Currency Not Displayed 108 

XML Validation Error During the Import of Third-party Metadata Sources 108 

Expressions Imported from Business Objects Metadata Source Do Not Work 108 

Extended Characters in Names of SQL Objects Imported from ERWin Metadata Source are 

Lost 108 

Unable to Execute Stored Procedures Imported from ERWin Metadata Source 109 

Script Error Occurs When Testing Query Subjects in Framework Manager 109 

Outer Joins Created in SQL 109 

User Guide 5

Appendix B: Data Format Properties 113 

Data Formatting Properties 113 

Calendar Type 113 

Clock 113 

Currency 113 

Currency Display 113 

Currency Symbol 113 

Currency Symbol Position 113 

Date Ordering 114 

Date Separator 114 

Date Style 114 

Decimal Separator 114 

Display AM / PM Symbols 114 

Display As Exponent 114 

Display Days 114 

Display Eras 114 

Display Hours 114 

Display Milliseconds 114 

Display Minutes 115 

Display Months 115 

Display Seconds 115 

Display Time Zone 115 

Display Weekdays 115 

Display Years 115 

Exponent Symbol 115 

Group Size (digits) 115 

International Currency Symbol 115 

Mantissa (digits) 115 

Maximum No. of Digits 116 

Minimum No. of Digits 116 

Missing Value Characters 116 

Negative Pattern 116 

Negative Sign Position 116 

Negative Sign Symbol 116 

No. of Decimal Places 116 

Padding Character 116 

Pattern 116 

Percentage Symbol 116 

Percent Scale (integer) 116 

Scale (integer) 117 

Secondary Group Size (digits) 117 

Thousands Separator 117 

Time Separator 117 

Time Style 117 

Time Unit 117 

Use Thousands Separator 117 

Zero Value Characters 117 

Appendix C: Using the Expression Editor 119 

Operators 119 

Summaries 124 

Constants 129 

Constructs 130 

Business Date/Time Functions 130 

Common Functions 133 


DB2 138 

DB2 Cast 145 

DB2 Math 147 

DB2 Trigonometry 147 

MS Access 148 

MS Access Cast 153 

MS Access Math 153 

MS Access Trigonometry 154 

Oracle 154 

Oracle Math 159 

Oracle Trigonometry 159 

Red Brick 161 

SAP BW 164 

SAP BW OLAP 164 

SAP BW Trigonometry 164 

SAP BW Math 165 

SQL Server 166 

SQL Server Cast 168 

SQL Server Math 169 

SQL Server Trigonometry 170 

Teradata 171 

Teradata Trigonometry 174 

OLAP 176 

OLAP Member 176 

OLAP Set 176 

OLAP Numeric 178 

Appendix D: Formatting Data With Patterns 181 

Language Code: cs 182 

Locale ID: cs 182 

Locale ID: cs_CZ 183 

Language Code: da 185 

Locale ID: da 185 

Locale ID: da_DK 186 

Language Code: de 188 

Locale ID: de 188 

Locale ID: de_CH 189 

Locale ID: de_DE, de_LU, de_AT 191 

Language Code: el 192 

Locale ID: el 192 

Locale ID: el_GR 194 

Language Code: en 195 

Locale ID: en, en_AU, en_CA, en_GB, en_IE, en_NZ, en_SG, en_US, en_ZA, 

en_ZW 195 

Locale ID: en_BE 197 

Locale ID: en_HK, en_IN, en_PH, en_BW 198 

Language Code: es 200 

Locale ID: es, es_AR, es_CL, es_ES, es_PE, es_PY, es_UY, es_VE 200 

Locale ID: es_BO, es_CO, es_CR, es_DO, es_EC, es_GT, es_HN, es_MX, es_NI, 

es_PA, es_PR, es_SV, es_US 201 

Language Code: fi 203 

Locale ID: fi, fi_FI 203 

Language Code: fr 205 

Locale ID: fr, fr_CA, fr_FR, fr_LU 205 

Locale ID: fr_BE 206 

Locale ID: fr_CH 208 

User Guide 7

Language Code: hi 209 

Locale ID: hi 209 

Locale ID: hi_IN 211 

Language Code: hu 212 

Locale ID: hu 212 

Locale ID: hu_HU 214 

Language Code: it 215 

Locale ID: it 215 

Locale ID: it_IT 217 

Locale ID: it_CH 218 

Language Code: ja 220 

Locale ID: ja 220 

Locale ID: ja_JP 221 

Language Code: ko 223 

Locale ID: ko, ko_KR 223 

Language Code: nl 224 

Locale ID: nl, nl_BE, nl_NL 224 

Language Code: no 226 

Locale ID: no, no_NO 226 

Language Code: pl 228 

Locale ID: pl, pl_PL 228 

Language Code: pt 229 

Locale ID: pt, pt_BR, pt_PT 229 

Language Code: ro 231 

Locale ID: ro, ro_RO 231 

Language Code: ru 232 

Locale ID: ru, ru_UA, ru_RU 232 

Language Code: sk 234 

Locale ID: sk, sk_SK 234 

Language Code: sv 236 

Locale ID: sv, sv_FI, sv_SE 236 

Language Code: tr 237 

Locale ID: tr, tr_TR 237 

Language Code: zh 239 

Locale ID: zh, zh_CN, zh_HK, zh_MO, zh_SG, zh_TW 239 

Glossary 241 

Index 249 


Introduction 

This document is available as online help and as an online book. For information about related 

documents, see "Additional Materials" (p. 11). 


Framework Manager is a data modeling product. You can use Framework Manager to import 

metadata from one or more data sources and transform it into a business-oriented model that 

can be used to create reports. 

User Guide 

This document includes the procedures, examples, notes, tips, and other background 

information to help you 

• create a project 

• prepare a model for reporting 

• create and publish a package 

To use this product to create models for relational data sources, you should understand data 

modeling, and know how to write SQL statements. If you use Framework Manager to create 

models for an SAP BW data source you do not need to know how to write SQL. 

Questions or Comments? 

For additional technical information about using ReportNet, visit the Cognos support Web site 

(http://support.cognos.com). 

User Guide 9

Introduction 


Additional Materials 

In the guide, we refer to other documents. Their locations are listed below. 

Topic 

How to install and configure 


How to manage ReportNet 

security, services, and report 

properties 

How to author professional 

reports using Report Studio 

How to create ad hoc reports 

using Query Studio 

How to use the ReportNet 

software development kit 

How to migrate Architect models 

and Impromptu catalogs 

Location 

ReportNet Installation and 

Configuration Guide 

ReportNet Administration and 

Security Guide 

Report Studio User Guide 

Query Studio User Guide 

ReportNet Developer Guide 

ReportNet Metadata Migration 

User Guide 

Formats 

Our documentation includes user guides, tutorial guides, reference books, and other materials 

to meet the needs of our varied audience. 

Online Help 

All information is available in online help. Online help is available from the Help button in a Web 

browser, or the Help menu and Help button in Windows products. All online help is also available 

from the Windows Start menu (Start, Programs, Cognos ReportNet, Documentation). 

Books for Printing 

The information in each online help system is available in online book format (PDF). However, 

the information from a given help system may be divided into more than one online book. Use 

online books when you want to print a document or when you want to search the whole 

document. 

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 providing internal training on, operating, and 

maintaining the Cognos software. 

Online books are available from the introduction to the online help for each component. 

All online books are available on the Cognos documentation CD. 

You can also read the product readme files and the installation guides directly from Cognos 

product CDs. 

User Guide 11

Additional Materials 


Chapter 1: Framework Manager 

Framework Manager is an application that runs in Microsoft Windows and provides a model 

development environment. A model in Framework Manager is a business presentation of the 

structure of the data from one or more databases. A model describes data objects, structure, 

and grouping, as well as relationships and security. 

When you work in Framework Manager, you work in a project. A project contains a model, 

namespaces, data sources, and packages. After you define a Framework Manager project and 

namespace, you can publish one or more packages containing metadata information to the 

ReportNet server for use by authors and query users. 

After a package is published to the ReportNet server, a report author uses the model to create 

reports and queries in the ReportNet server run-time environment. 

While we tend to use the term model regarding metadata, for ReportNet, a model refers to the 

metadata after it has been published to the ReportNet server. 

Structuring Metadata in the Framework Manager 

Environment 

The Framework Manager Environment 

Users of Framework Manager will interact with projects, namespaces, and packages. They will 

create query subjects to represent metadata to report authors. 

Query subjects are the most important object for modelers. In conjunction with relationships, 

you use query subjects to build the queries that get the answers you want. 

Query items are the most important object for report authors. Query items have more properties 

than query subjects. These properties are what the report authors use to build the reports they 

want. 

Projects 

Models 

A project is a set of models, packages, and related information for administration, and for 

sharing model information. Often a single project will span many more databases or tables than 

any set of users requires access to. 

A model is a set of related query subjects, and other objects (p. 19). 

The Framework Manager model is a metadata layer that adds value to a query database in 

several ways. Most importantly, it provides a business presentation of the information in the 

database to report authors and query users to simplify the building of reports and queries. The 

business presentation takes several forms: 

• organization of data items in folders that represent business areas for reporting 

• formatting of data items with numeric, currency, date, time, and other formats 

• presentation of multilingual folder and item names, description, tips, and data so that users 

can operate in their language of choice 

• automation of the generation of SQL queries sent to the database 

• specification of default prompting. This can include having ReportNet prompt the user with a 

descriptive name for ease of use while actually filtering on a code or key value for improved 

query performance. 

User Guide 13


You can modify the Framework Manager model to ensure that queries sent to the database are 

efficient, well-formed, and secure. The Framework Manager modeler can do the following: 

• specify the rules governing query generation 

• restrict user access to specific rows or columns of data 

• model data relationships to hide the complexity of data from report authors 

Namespaces 

A namespace uniquely identifies query items, query subjects and other objects (p. 25). You 

import different databases into separate namespaces to avoid duplicate names. 

Packages 

A package is a subset of the query subjects and other objects defined in the project (p. 97). A 

package is what is actually published to the ReportNet server. 

Query Subjects 

The most important component of the Framework Manager project is the query subject. A 

project is built upon query subjects. 

When you model metadata from a relational database, there are several types of query 

subjects. When you model SAP BW metadata, all query subjects are data source query 

subjects. 

Data Source Query Subject 

The data source query subject is an SQL query that acts as a view into the underlying query 

database(s) (p. 53). 

During the initial metadata import operation, a default data source query subject is created for 

each table you select and creates the default relationships between query subjects for you 

automatically. The query subject uses the following general SQL syntax: 

select * from 

You can refine data source query subjects in various ways. For example, you can add 

calculations or filters, or you can add or modify relationships between query subjects to define 

the query generation rules for report authors. 

A single Framework Manager project may contain data source query subjects from one or more 

databases from one or more vendors. This provides true heterogeneous database access. 

The database columns and calculations returned by the SQL query in the data source query 

subject are referred to as query items. 

Model Query Subject 

The model query subject allows you to define the business presentation for the users (p. 54). 

Model query subjects can contain query items from an arbitrary set of data source query 

subjects. Model query subjects can be enhanced even further, perhaps by adding filters or 

calculations to create more query items. You can also use query subjects from other model 

query subjects. 

Stored Procedure Query Subject 

The stored procedure query subject operates much like a data source query subject in that it 

defines a set of data, query items, available to the model from the underlying query database 

(p. 54). Except for their source, these query items are no different from other query items. 

Project Structure Best Practices 

While OLAP data is inherently structured in a logical presentation that represent business 

requirements, relational data generally is not. You can structure projects that contain relational 

metadata in many ways in Framework Manager (p. 19). There are some best practices for 

structuring your Framework Manager projects to minimize complexity for report authors and to 

assist in model maintenance. 



The basic structure we recommend is a 2-layer model with data source and stored procedure 

query subjects providing a physical query layer and model query subjects providing a 

presentation layer. 

The 2-layer model works well for both report authors and data modelers. The presentation layer 

makes it easier for report authors to find and understand their data, while the physical layer acts 

as the foundation for the presentation layer. 

Where appropriate, create calculations, filters, and other modifications in the physical layer to 

maximize reuse in the presentation layer. 

Example 

A good example of a model structured using this best practice approach is the Great Outdoors 

sample model, GO Sales and Retailers, which presents users a series of business related 

folders of data to create reports with. 

The presentation layer is made up of model query subjects, shortcuts, calculations, and filters 

organized into folders. Both folders and query subjects appear as folders to the report author. 

This organization of information into relevant business categories simplifies the user reporting 

experience as users can locate the information they require more easily. Query items have had 

default data formatting specified. The names and descriptions of query items have been 

translated into 26 different languages; each user will see automatically the folder and item 

names and description appear in their preferred language. 

Underlying this presentation layer is a series of data source query subjects that, while not visible 

to the report author, define the very essence of the model including: 

• Basic data access – SQL queries define the views into the query database 

• Calculations – so that each user does not have to perform the same basic business 

calculations in each report or query 

• Multilingual data access – the sample databases are in 26 languages. Each user sees only 

the data for the language they request. ReportNet is able to do this automatically based on 

the fashion in which the SQL queries are modified at run time according to the rules laid out 

by the Framework Manager modeler. 

• Heterogeneous database access – this model is built atop two databases 

While the sample model does not use all, or even most, of the features and capabilities of 

Framework Manager, it does present the basics of project design. 

Preparing Metadata for Use in Reports 

When you are preparing metadata for use in a reporting application, you must identify the 

relationships and aggregations that are necessary to generate efficient queries that deliver the 

required results. The report author uses the model structure that you provide to plan queries 

automatically, delivering the results expected by report authors with minimal training. 

Before report authors can create reports, you must follow a process in Framework Manager: 

User Guide 15


❑ Analyze the problem. 

Before you start, it is essential to understand the reporting problem you are trying to solve, 

and what data is available to solve it. 

• Do you and the report users (the report authors who will use the published model in 

Report Studio and the business authors who will use it in Query Studio) agree on what 

the reporting requirements are? Issues to resolve include multilingualism, performance, 

security, and how to organize and combine query items and filters. 

• Does the data source contain the data and metadata you need? Without metadata such 

as primary keys, indexes, and foreign keys, your reports may take too long to run, or 

may produce incorrect results. If the data source does not contain the data and 

metadata you need, will it be changed, or will you work around it? 

• Is there more than one source for the data you need? If so, choose the one that most 

closely fits your reporting requirements. If a data warehouse is available, it is typically a 

better choice than an operational database. A data warehouse based on a star schema 

is ideal. If this does not exist, and you expect that your reporting application will be 

heavily used, consider arranging for one to be created. 

• Which data source tables are the fact tables, which are the dimensions, and which are 

both fact and dimension? What are the keys and attributes of each dimension? What 

are the required relationships? 

• Are any required tables denormalized (for example, contain embedded dimension 

information other than foreign keys)? You will need to decide if and where to present the 

denormalized data instead of the normalized data (if it exists). 

In most cases, you will find that even though the data source contains what you need, it has 

to be renamed, reorganized, and enhanced to meet your reporting requirements. 

Framework Manager makes it easy to handle simple changes like these. Some issues, such 

as the absence of certain derivable information, can be modeled by using Framework 

Manager’s more advanced features, such as custom SQL. 

In some cases, you may not have direct access to this information. You should talk to the 

report authors and business authors to determine the requirements. 

Once you have answered the questions that relate to your most important requirements, you 

are ready to start designing and building your model. 

❑ Create a new Framework Manager project (p. 19). 

❑ Import the required metadata as data source query subjects (p. 25). You should import only 

the smallest number of tables and relationships that you need in your project. This is even 

more important if you are importing SAP BW metadata, since you cannot delete query items 

that are based on SAP BW metadata. 

❑ For relational metadata, validate the model objects that were created. In particular: 

• resolve ambiguous relationships by ensuring that there are no redundant relationships 

(p. 66) that can result in incorrect results, and that the correct relationship path is used 

(p. 67). 

• verify the Usage and Regular Aggregate (p. 72) property values of each query item, 

especially if the usage is set to "fact". 

❑ For relational metadata, use star schema groups (p. 93) to isolate fact tables that share 

conformed dimension(s). 

By using shortcuts to separate fact tables into different folders, you can resolve any 

ambiguous relationships. 



❑ For relational metadata, where possible, use shortcuts (p. 89) rather than copies. Shortcuts 

make it easier to maintain metadata in the physical layer by ensuring that changes to the 

target object are reflected in the shortcut. 

For SAP BW metadata, you can use copies to create distinct query subjects that you can 

modify without affecting the original query subject. 

When you use shortcuts, consider where you use them and what the impact is on 

relationships: 

• shortcuts in the same folder as the target query subject use the relationships of the 

target query subject 

• shortcuts in a different folder from the target query subject ignore the relationships of 

the target query subject and use the relationships specified for that shortcut 

❑ For relational metadata, edit data source (p. 55), stored procedure (p. 60), and model query 

subjects (p. 53). When you do this, consider the following: 

• It is helpful to create a folder that contains the model query subjects. This folder acts as 

a presentation layer that lets you organize model objects so that you can distinguish 

them from the data source objects. 

• It is best practice to create relationships only in the data-source layer. 

• Plan your filters carefully so that you can reuse them with multiple query subjects. 

❑ For SAP BW metadata, modify data source query subjects, use filters, group metadata into 

folders, or conform (p. 57) and deconform (p. 60) dimensions. 

❑ For relational metadata, specify dimensional information (p. 93). 

By grouping objects that are based on dimensions, Framework Manager can manage 

parallel-detail (two one-to-many) relationships properly to avoid double counting. You should 

define dimensional information in the presentation layer. 

❑ Define the package(s) to be published to the ReportNet server (p. 97), (p. 103). 

Each package contains the query subjects required to meet a reporting need. For example, 

if your database contains information on many aspects of your business, you might decide 

to create different packages for the HR, Finance, and Sales departments. 

Your packages should be designed to meet a broad but related reporting requirement. If 

packages are too narrow, report authors will have to work with too many packages and may 

be unable to build the reports they require; each report can contain information from a single 

package only. 

User Guide 17



Chapter 2: Designing a Project 

Project Files 

A project is made up of query subjects, query items, relationships, folders, expressions, 

parameter maps, data sources, packages, and related information that is grouped together for 

security, administration, and for sharing information. You design a project in Framework 

Manager to structure and organize the metadata and data you want, in a format that will be the 

most meaningful to report authors. 

When you design a project, you might want to consider where to share and reuse information, 

and where to organize a project according to business needs. You can create segments (p. 46), 

or extend a project to other users by linking to other projects (p. 47), to share and reuse 

information. One way of organizing your project is to create namespaces (p. 25) to allow 

duplicate query subjects or query items in a project. 

After you have designed your project, you can then add and modify objects to better reflect your 

business and prepare for reporting (p. 53). You can also export your project in a Common 

Warehouse Metamodel (.cwm) format (p. 42). 

You can also use Framework Manager for multiuser modeling (p. 49). 

To design a Framework Manager project: 

❑ Create or open a project (p. 20). 

❑ Import metadata from one or more data sources (p. 25). 

❑ Set up project management (p. 43). 

When you work in Framework Manager, you work in the context of a project. The Framework 

Manager project contains objects that you organize for reporting authors according to the 

business model and business rules of your organization. You view these objects in the project 

page (p. 21). 

A Framework Manager project appears as a folder that contains a project file (.cpf) and the 

specific .xml files that define the project. The files in a project folder are unique to each project. 

Tip: The project and the project’s associated files are contained in a project folder. We 

recommend that you do not add any other files to this project folder. 

User Guide 19


Project Folder 

These are the contents of a project folder. 

File name 

.cpf 

model.xml 

Preferences.xml 

customdata.xml 

repository.xml 

Description 

The Framework Manager project file, which 

references the .xsd and .xml files used to 

define a project 

The actual model data created by Framework 

Manager users 

The preferences for Framework Manager 

projects 

The stored diagram information. For example, 

the diagram layout, notation, font, color, etc. 

The logged version history for each project or 

segment that has been added to a repository 

Create or Open a Project 

Before you can import metadata, you must create a project. When you start Framework 

Manager, the Welcome page appears. You can use this page to create or open a project. 

Steps to Create a Project 

1. From the Welcome page, click Create a new project. 

2. In the New Project page, specify a name and location for the project. 

3. If you want to add the project to a source control repository, click Repository, and then 

select the Add to repository check box. 

For information about connecting to a new repository, see "Create a Repository 

Connection" (p. 43). 

4. In the Select Language page, click the default language for the project. 

The language you select cannot be changed after you click OK, but you can add others. 

For information about project languages, see "Define Languages" (p. 85). 

Note: If an SAP BW server does not support the selected language, it uses the content 

locale mapping in Cognos Configuration. If a mapping is not defined, Framework Manager 

connect in the default language of the BW server. 

5. Click OK. 

The Import wizard appears so that you can import your metadata (p. 25). 

6. To continue with the import click Next, otherwise, click Cancel. 

7. Save the project. 

You save the project (.cpf) file and all related XML files in a single folder. When you save a 

file with a different name or format, ensure that you save the project in a separate folder. 

Steps to Open a Project 

1. From the Welcome page, click Open a project. 

2. In the project folder, click the .cpf file, and click Open. 

3. If you want to add the project to a source control repository, click Repository. 

For information about connecting to a new repository, see "Create a Repository 

Connection" (p. 43). 

4. Type the path to new local project folder, or locate an existing folder. 

5. Click OK. 



The Project Page 

After you create or open a project (p. 20), the project page appears. The project page is the 

environment in which you design, package, and publish project metadata. This page contains 

several panes and views that you can use to view and modify the objects in a project. 

Project Viewer 

The Project Viewer shows the objects in a project in a hierarchical view. You can use the Project 

Viewer to view, modify, and create these objects: 

• query subjects (p. 53) 

• data sources (p. 31) 

• namespaces (p. 25) 

• parameter maps (p. 79) 

• folders (p. 89) 

• segments (p. 46) 

• links (p. 47) 

• calculations (p. 75) and filters (p. 76) 

• packages (p. 97) 

Note: Relationships and imported functions are shown in both the Object Diagram View and 

Object Explorer Views. 

The Project Viewer uses the following icons to represent objects and states. A project may use 

some or all of the icons. 

Icon 

Description 

Represents the project. 

Represents the root namespace or any other 

namespace in the project. 

Represents a folder that contains one or more data 

sources. 

Represents a data source. 

Represents a folder that contains one or more parameter 

maps. 

Represents a parameter map. 

Represents a folder that contains one or more packages. 

Represents a package. 

Represents a query subject. 

Represents an invalid query subject. For more 

information about correcting invalid objects, see "Check 

a Project" (p. 90). 

Represents a query subject based on multidimensional 

data. 

Represents an invalid query subject based on 

multidimensional data. For more information about 

correcting invalid objects, see "Check a Project" (p. 90). 

User Guide 21


Icon 

Description 

Represents a query subject that contains query items 

whose Usage property is set to Fact. 

Represents an invalid query subject that contains query 

items whose Usage property is set to Fact. For more 

information about correcting invalid objects, see "Check 

a Project" (p. 90). 

Represents a query item. 

Represents a calculation whose Usage property is set to 

Attribute. 

Represents a calculation whose Usage property is set to 

Identifier. 

Represents an embedded calculation. 

Represents an invalid embedded calculation. 

Represents a calculation with the Usage property set to 

Fact. 

Represents an invalid embedded filter. 

Represents a query item whose Usage property is set to 

Identifier. 

Represents a query item whose Usage property is set to 

Fact. 

Represents a query item that is located under a shortcut 

query subject. 

Represents a calculation. 

Represents an invalid calculation. For more information 

about correcting invalid objects, see "Check a 

Project" (p. 90). 

Represents a filter. 

Represents an invalid filter. For more information about 

correcting invalid objects, see "Check a Project" (p. 90). 

Represents a relationship. 

Represents an invalid relationship. For more information 

about correcting invalid objects, see "Check a 


Indicates that the object is checked in to the repository. 

Indicates that the object is checked out of the repository. 

Indicates that the object is checked out of the repository 

by a different user. 



Icon 

Description 

Indicates a package that has been published. 

Indicates that a linked segment or project has been 

updated. 

dimensional overlay icon 

This overlay icon indicates that the object is linked. 

This overlay icon indicates that the object is a shortcut. 

Tip: To view the corresponding object in the Object Diagram View, you must have the Object 

Diagram View open. In Project Viewer, right-click the object you want and click Locate in 

Object Diagram. 

Object Diagram and Object Explorer Views 

You can use both the Object Diagram and the Object Explorer Views to view, create, and modify 

objects and relationships. You can also create folders and namespaces that group objects. 

The Object Diagram View shows the relationships between objects in a project in a diagram. 

Relationships between query subjects are shown as lines with cardinality notation (p. 66). You 

can expand objects that are grouped in folders to show the hierarchy of the query subjects and 

relationships that it contains. 

In the Object Diagram View, you can also 

• organize objects 

Tip: From the Diagram menu, click Auto Layout. 

• center a query subject 

Tip: Click a query subject and, from the Diagram menu, click Set Focal Point. 

The Object Explorer View shows the contents of a project, similar to any file system. Objects 

can be arranged by name, class, or description. If you have a large number of objects in a 

project, it may be easier to locate them in the Object Explorer. 

Note: The best way to display SAP BW metadata is in the star layout. 

Properties Pane 

The Properties pane shows the properties of the objects you last selected in either the Object 

Explorer View, Object Diagram View, or Project Viewer. Object properties are set during import, 

and some property values can be modified during modeling. You can use the Properties pane to 

add, modify (p. 88), or delete the properties of objects. 

Summary Pane 

The Summary pane shows the statistics and tasks available for a selected object. 

Tip: To select an object, click the object in the Project Viewer, Object Explorer, or Object 

Diagram. 

The Statistics section shows the number of objects, by class, located in the currently selected 

object. If the selected object contains a folder, the contents of the folder are included in the 

number count. Selected objects include projects, namespaces, and folders. The default selected 

object is the project. 

The Tasks section shows actions that are applicable to the currently selected object, based on 

the object class. If you select a folder, actions for the folder are listed. If you select an object in 

that folder, the list includes actions for the object as well as for the folder. 

Note: You can find more information about the object classes in the CR1 Behaviors.xml file. For 

more information, see "Project Files" (p. 19). 

User Guide 23


Search Pane 

When you are working with a large project it can become difficult to locate the objects that you 

need to complete a task. The Search pane lets you quickly find objects by applying different 

criteria that describe the object you want to search for. You can either search for the object name 

alone, or add addition criteria, such as the location, class, or a condition. 

Naming Conventions for Objects in a Project 

All objects in a project have an identifier that is used to reference them. The identifier can 

consist of one, two, or three parts, depending upon the type of object. The parts include 

• an object name, and 

• a location in the project hierarchy, as expressed in the default language of the project. 

If you want to have objects with the same name in a project, these objects need a unique 

identifier. To create a unique identifier for an object, you must create a namespace (p. 25). 

Two-part Identifiers 

Most of the objects in a Framework Manager project have a two-part identifier. The two-part 

identifier consists of the name of the containing namespace and the name of the object. The 

object name must be unique in the nearest containing namespace (p. 25). 

For example, you have a GoSales namespace that contains a query subject named Product. 

The Product query subject has the following name, where the square brackets and periods are 

the syntax Framework Manager uses for object identifiers. 

[Go Sales].[Product] 

One-part Identifiers 

Some objects in a project have a one-part identifier. The one-part identifier must be unique 

across the entire project, even if the namespace contains other namespaces. These are the 

objects that have a one-part identifier: 

• namespaces 

• functions 

• shortcuts to namespaces 

• shortcuts to folders 

Three-part Identifiers 

Some objects in a project have a three-part identifier. The three-part identifier is based on the 

identifier of the containing query subject. Each name must be unique in the containing query 

subject. These are the objects that have a three-part identifier: 

• query items 

• query item folders 

For example, you have a GoSales namespace that contains a query subject named Product, 

and a query item named Product Code. The Product Code query item has the following name, 

where the square brackets and periods are the syntax Framework Manager uses for object 

identifiers. 

[Go Sales].[Product].[Product Code] 



Create a Namespace 

You create a namespace in Framework Manager if you want to have two objects that have the 

same name in a project. Objects in a Framework Manager project must be uniquely identifiable. 

If you have two objects that have the same name, they must reside in two separate 

namespaces. 

Namespaces are containers, like folders. If more than one namespace exists in a project, the 

object names consist of the namespace, and query subject (or folder) names. For more 

information, see "Naming Conventions for Objects in a Project" (p. 24). 

For example, you have a database that contains financial data. In the database, there is a set of 

tables that represent Forecast and Actual information. Both the Forecast and Actual information 

have tables named Accounts Payable and Accounts Receivable. In order to import these tables 

into Framework Manager and use the same table names in the project, you must create two 

namespaces. You can name one namespace Forecast, and the other namespace Actual. 

Note: For SAP BW metadata, shortcuts to namespaces are not supported. 

Steps 

1. Click the project or root namespace and, from the Actions menu, click Create, 

Namespace. 

2. To rename the namespace, right-click the namespace, and click Rename. 

Importing Metadata 

You can import metadata into a new project (p. 20), or an existing project. Importing metadata is 

an operation that can be performed many times to extend the project. You can also export your 

model in a Common Warehouse Metamodel (.cwm) format (p. 42). 

Framework Manager can use the metadata and data from external data sources to build a 

project. 

To import metadata, indicate which sources you want and where they are located. You can 

import metadata from 

• relational databases, such as Oracle, DB2, and Microsoft SQL Server 

• SAP BW data sources 

• existing Cognos ReportNet models 

• Architect models and Impromptu catalogs 

For more information about importing Architect models and Impromptu catalogs, see the 

ReportNet Metadata Migration User Guide on the Cognos support site 


• third-party metadata sources 

• XML as a data source 

If you import a subset of a data source, you cannot reimport the same objects into Framework 

Manager. For example, if you import the query items SalesStaffCode, FirstName, and 

LastName, from the SalesStaff query subject and you want to re-import any objects from the 

SalesStaff query subject, you must do one of the following: 

• delete the previously imported query subject 

• rename the previously imported query subject 

• when you re-import, select the option to create unique name if a duplicate name is found. 

When you import relational data and a duplicate name is detected, you have the option of not 

importing the object, or importing and creating a unique name. The advantage of importing 

everything except these duplicate tables is that you can add new database objects to the 

project, without specifying them individually, and without going through synchronization (p. 50). 

To import data sources that have the same table names and keep them as the query subject 

names, you must import them into different namespaces (p. 25). 

User Guide 25


When you import SAP BW data, Framework Manager assign a unique name to each object. 

Therefore, if you rename an object in the model and then re-import it, Framework Manager 

recognizes that it already exists. To re-import an object with a different unique name you can 

create a new namespace and re-import the object into this namespace. 

Before you can import metadata, there must be a connection to the data source (p. 31). For 

information about the data source types supported by Cognos, see the Cognos support site 


If you want to add a project to a repository, you must set up the repository connection (p. 43). 

Relational Databases 

When you import from a relational database, you can import all the metadata or select the 

particular object types you want to import, such as tables, columns, views, synonyms, stored 

procedures, and functions. 

These database objects are mapped to the following Framework Manager objects 

Database Object 

table 

column 

view 

synonym 

procedure 

function 

Framework Manager Object 

query subject 

query item 

query subject 

query subject 

query subject 

project function 

Steps to Import from a Database 

1. Click the namespace, folder, or segment you want to import into and, from the Actions 

menu, click Import Metadata. 

2. Follow the instructions in the Import wizard. 

• If the data source connection you want is not listed, you must first create it (p. 31). 

• Select the check boxes for the objects you want to import. 

• When a duplicate name is detected, choose to either import and create a unique name, 

or do not import. 

If you choose to create a unique name, the imported object will appear with a number. 

For example, you will see QuerySubject and QuerySubject1 in your project. 

• If necessary, change the criteria to use to generate relationships (p. 65). 

3. Click Import. 

A list of objects that could not be imported appears along with counts of objects that were 

imported. 

4. Click Finish. 

After importing, you should verify usage and aggregation property values (p. 72). Fact 

tables can contain numeric columns that should not be aggregated, such as exchange 

rates. 



SAP BW Data Source 

When you import from an SAP BW data source, you can import all the metadata or only import 

the objects you select. SAP BW objects are mapped to the following Framework Manager 

objects. 

SAP BW Object 

InfoQuery, InfoCube, 

RemoteCube, 

MultiCube 

characteristic 

characteristic with one 

or more presentation 

hierarchies 

dimension 

key figure 

presentation hierarchy 

level 

characteristic value 

SAP BW variable 

Framework Manager Object 

namespace 

dimension query subject with two query 

items that contain 

• the aggregation of all characteristic 

values 

• all characteristic values 

Note: By default, Framework Manager 

imports SAP BW Currency and Unit of 

Measure characteristic. You can remove 

these characteristics if you do not need 

them. 

folder containing a query subject for 

each characteristic and each of its 

presentation hierarchies 

folder containing a query subject for 

each characteristic in the dimension 

fact query subject 

Calculated key figures are not 

distinguished from other key figures. 

query item 

Note: Level names must be defined in 

the Administration Workbench in order 

to be meaningful. 

query item whose Usage property value 

is set to Attribute. 

data source property 

For information about the SAP BW 

variables that Framework Manager 

supports, see SAP BW Variables 

Steps to Access a Secured InfoCube 

1. Create an InfoQuery in BEx that accesses the InfoCube 

2. Create an authorization variable for each InfoObject in the underlying InfoCube for which 

there are authorizations. 

3. For each variable, ensure that the "ready for input" option is disabled. 

By default, this option is enabled. 

4. Enable the query for access through OLE DB for OLAP. 

5. Save the InfoQuery. 

6. In Framework Manager, reference the InfoQuery instead of the InfoCube. 

User Guide 27


Steps to Import from an SAP BW Data Source 




• If the data source connection you want is not listed, you must first create it (p. 31). 


After they are imported, query items cannot be deleted without deleting the entire query 

subject. 

• Identify which name you want Framework Manager to display. 

• Indicate whether you want to create a folder for each level to further organize the 

imported objects. 

• Indicate whether you want to generate conformed dimensions. 

3. Click Import. 

A list of objects that could not be imported appears along with counts of objects that were 

imported. 


After importing, you should verify usage and aggregation property values (p. 72). Fact 

tables can contain numeric columns that should not be aggregated, such as exchange 

rates. 

Note: When you want to recreate an InfoQuery on another SAP BW system, use the SAP BW 

migration mechanism to transport the InfoQuery. This ensures that the technical name of each 

measure remains the same so that any project that references the InfoQuery can be directed to 

either system without any modifications to the project. 

Conformed Dimensions 

When you import metadata from more than one BW data source, Framework Manager lets you 

combine dimensions that have the same physical structure into one query subject. For the 

structure to match, both hierarchies must have the same levels and properties, however the 

order of the properties does not make a difference. By conforming dimensions, Framework 

Manager lets the report author create multi-cube reports without using an SAP BW 

MultiProvider. 

A conformed query subject is represented by a query subject with one or more shortcuts to that 

query subject. The query subject contains a list of data sources in which the dimension exists. If 

you want to retrieve data from a specific data source, ensure that you import the dimension from 

this data source before all others. 

After import, you can also use Framework Manager to conform dimensions within a project. For 

more information, see "Conform SAP BW Query Subjects" (p. 57). 

Note: Framework Manager does not create conformed dimensions for Time Dependent 

hierarchies, because the values of the two dimensions are based on the transactional data of 

the InfoCube. 

Import from a Cognos ReportNet Model 

You can import metadata from an existing Cognos ReportNet model. 

Steps 



2. Click Cognos ReportNet Model, and then click Next. 

3. Locate the Cognos ReportNet model (.cpf file) you want, and then click Next. 








For example, you would see QuerySubject and QuerySubject1 in your project. 

5. Click Next, and click Finish. 

Architect Models and Impromptu Catalogs 

To import metadata from an Architect model or an Impromptu catalog, you must first convert 

them to XML form. For more information, see the ReportNet Metadata Migration User Guide on 

the Cognos support site (http://support.cognos.com). 

Steps to Import an Architect or Impromptu XML File 

1. Ensure that you exported the Architect model or Impromptu catalog. 

For more information, see the ReportNet Metadata Migration User Guide on the Cognos 

support site (http://support.cognos.com). 

2. Click the namespace, folder, or segment you want to import into, and from the Actions 


3. Click either Cognos Architect (.xml) or Cognos Impromptu (.xml), and click Next. 

4. Locate the Architect or Impromptu XML file that contains the metadata to import. 

A message in the XML Preview window confirms success. 

5. Click Next. 

A list of created objects appears. 


Third-party Metadata Sources 

You can use Framework Manager to import metadata from a third-party source. 

For information about troubleshooting third-party metadata sources, see Appendix A: 

Troubleshooting. 

Using Default Options 

When you import from a third-party metadata source, we recommend that you use the default 

options. These default options optimize the third-party metadata import. If you change the 

options, you may see unexpected results. 

Importing Third-party Metadata Sources Based on Multiple Databases 

Some third-party metadata sources might be based on multiple databases. The best way to 

import these multiple data sources into Framework Manager is to perform multiple imports. For 

each import, you select the items that correspond to that specific data source. 

For example, the first time you import from a third-party metadata source, you would select data 

source1 and all the items that correspond to that data source. 

From the project, you would import again. This time, you would select data source2 and the 

items that correspond to that data source. You would continue to import until you have imported 

all the data sources and their corresponding items. 

Steps to Import a Third-party Metadata Source 



2. Click the third-party data source you want to import, and then click Next. 

3. Click the metadata type to import, and locate the file that contains the metadata to import. 


User Guide 29


5. In the Third-Party Specific Import Options dialog box, click the options you want. For 

each option, from the available list, select a value. 

Tip: To accept the default options, select the Use Defaults check box. 

In the Option Description pane, you see a description of the options available. The options 

are based on the selected third-party data source. For more information, see the third-party 

data source vendor documentation. 


7. In the Framework Manager Specific Import Options dialog box, click the options you 

want. For each option, from the available list, select a value. 


are based on the selected third-party data source. 



• From the list of available data sources, click the data source you want. If you do not 

have the data source you want referenced in the third-party metadata, you must create 

a data source connection (p. 31). 





For example, you would see QuerySubject and QuerySubject1 in your project. 


A list of created objects appears. 


XML as a Data Source 

You can import XML as a tabular data source in Framework Manager. An XML data file can be 

consumed locally or from a remote site through a valid URL (via either file or http). You can 

import the XML data file into Framework Manager and use it to model metadata and create a 

package. 

The XML file will be validated and parsed at run time, when the query is processed by either 

Query Studio or Report Studio. If you add "VALIDATE=ON" option to the connection string, 

Framework Manager will partially validate the XML file within the tag that 

describes the metadata. If you use this option, the XML in the file will be partially validated. 

You must use the xmldata.xsd schema to validate the XML file. The schema is located in the 

\crn\bin folder. You do not need to specify the location of the schema in the XML file itself. 

Before you import XML as a data source, there must be a connection to the data source (p. 31). 

To use XML as a data source, you should understand XML, schemas, and other XML-related 

technology. 

Restrictions 

To use XML as a data source, ensure that you do not 

• use Native SQL to access data in an XML file 

• access Binary Large Objects (BLOB) 

You must ensure that 

• only sqlColumns() and sqlTables() metadata calls are used 

Other calls will return an unsupported function error 

• the XML file is well-formed and valid 

Steps to Import XML as a Data Source 



2. Click the XML data source you want to import, and then click Next. 



Create a Data Source Connection 

Each data source can contain one or more physical connections to databases. The data source 

connection specifies the parameters needed to connect to the database, such as the location of 

the database and the timeout duration. A connection can include credential information and 

signons. 

Note: For SAP BW metadata, the isolation level is read-only. 

Multiple Data Source Connections 

If you have access to more than one data source connection in a data source, you will be 

prompted to select a data source connection when you open a Framework Manager project. You 

can use multiple data source connections in a single data source to facilitate the migration from 

one environment to another, and maintain the integrity of a project. 

For example, you can use multiple data source connections to work with metadata from a test 

data source. You create a new project, using the test data source connection for the GoSales 

data source. You create and modify the objects you want in the project, and you test that the 

project is modeled the way you want. When you close the session, and re-open the Framework 

Manager project, you can select the production data source connection. When you publish the 

package to the ReportNet server, report authors choose which data source connection they 

want to use in their report. 

When you create a data source, you also create a data source connection so that ReportNet 

has the connection and authentication information required to connect to the database. 

You can include authentication information for the database in the data source connection by 

creating a signon. This means that users need not enter database authentication information 

each time the connection is used. The authentication information is encrypted and stored on the 

ReportNet server. The signon produced when you create a data source is available to the 

Everyone group. You can later modify who can use this signon or create more signons. 

You can create data sources in the portal or in Framework Manager. Because they are stored on 

the server, data sources appear in both Framework Manager and the portal, regardless of 

where they were created. 

The ReportNet administrator can set up the data sources before any models are created in 

Framework Manager so that all connections are available in the Framework Manager Import 

wizard. 

Data sources are stored in the Cognos namespace and must have unique names. For example, 

you cannot use the same name for a data source and a group. 

Before creating data sources, you must have write permissions to the folder where you want to 

save the data source and to the Cognos namespace. You must also have execute permissions 

for the Administration secured function. 

Isolation Levels 

The isolation level specifies how transactions that modify the database are handled. By default, 

the default object gateway is used. You can select from the following isolation levels. Not all 

types of database support each isolation level. Some database vendors use different names for 

the isolation levels. 

User Guide 31


In increasing order of isolation, the isolation levels are 

• Read uncommitted 

Changes made by other transactions are immediately available to a transaction. 

Database type 

Oracle 

DB2 

MS SQL Server 

Sybase Adaptive Server 

Informix 

Equivalent isolation level 

Not applicable 

Uncommitted read 

Read uncommitted 

Read uncommitted 

Dirty read 

• Read committed 

A transaction can access only rows committed by other transactions. 

Database type 

Oracle 

DB2 

MS SQL Server 


Informix 


Read committed 

Read stability 



Committed read 

• Cursor Stability 

Other transactions cannot update the row in which a transaction is positioned. 

Database type 

Oracle 

DB2 

MS SQL Server 


Informix 



Cursor stability 



Cursor stability 

• Reproducible read 

Rows selected or updated by a transaction cannot be changed by another transaction until 

the transaction is complete. 

Database type 

Oracle 

DB2 

MS SQL Server 



Execute the statement, "SET 

TRANSACTION READ ONLY," 

prior to starting a transaction 

Repeatable read 




Database type 


Informix 




• Phantom protection 

A transaction cannot access rows inserted or deleted since the start of the transaction. 

Database type 

Oracle 

DB2 

MS SQL Server 


Informix 







• Serializable 

A set of transactions executed concurrently produces the same result as if they were 

performed sequentially. 

Database Type 

Oracle 

DB2 

MS SQL Serve 


Informix 


Serializable 


Serializable 

Serializable 


XML Data Sources 

If you create an XML data source, you must use XML as the type of connection and specify the 

location of the XML document in the connection string. 

You can specify the connection string for an XML data source as 

• an HTTP URL that identifies the content store required to connect to the XML document, 

such as 

HTTP://xmltestserver.cognos.com/XML/country.xml 

• a file path, such as 

file:///C:/XML/country.xml 

• a local file, such as 

C:\XML\country.xml;VALIDATE=ON 

To access a local file, use a file path that uses platform-specific syntax. 

To use an HTTP URL, ensure that you create a Web alias for the directory that contains the XML 

file and that you enable directory browsing. 

To test an XML connection string, you must type the following code at the end of the string 

;VALIDATE=ON 

The text of this code is not case sensitive. 

User Guide 33


ODBC Data Sources in a UNIX Environment 

Because ReportNet on UNIX does not support all ODBC drivers, when you create data source 

connections to IBM Red Brick, Microsoft SQL Server, or NCR Teradata databases, you cannot 

select ODBC as the type of data source connection. To create an ODBC connection to these 

database vendors, use the Other type instead. 

For the following database vendors, add the associated database codes when you type the 

connection string. 

Database vendor 

IBM Red Brick 

Microsoft SQL Server 

NCR Teradata 

Database code 

RB 

SS 

TD 

Type the data source connection using the following syntax: 

[^UserID:[^?Password:]];LOCAL;{RB|SS|TD};DSN=Data_Source[; 

UID=%s[;PWD=%s]][@ASYNC={0|1}][@Connection_Timeout/Reply_Timeout][@COLSEQ 

=[Collation_Sequence]] 

The following are examples of connection strings: 

• ^UserID:^?Password:;LOCAL;RB;DSN=DB62SALES;UID=%s;PWD=%s@ASYNC=0 

• ;LOCAL;SS;DSN=TESTSERVER 

To create data source connections to Microsoft SQL Server from UNIX, you must use the 

DataDirect ODBC driver for SQL Server. 

For information about parameterized XML connection strings, see Parameterized XML 

Connection Strings. 

Steps 

1. If you are not already using the Import wizard, click namespace, folder, or segment that you 

want to import into, and click Actions, Import Metadata. 

2. In the Select Data Source window, click New. 

3. In the name and description page, type a unique name for the data source and, if you want, 

a description and screen tip. Select the folder where you want to save it, and then click Next. 

4. In the connection page, click the type of database to which you want to connect, select an 

isolation level, and then click Next. 

The connection string page for the selected database appears. 

5. Specify any parameters that make up the database connection string, specify the timeout, 

and select whether to create a signon. 

Tip: To test whether parameters are correct, click Test. If prompted, type a user ID and 

password or select a signon, and then click OK. 


The data source appears as an entry in the Directory tool in the portal and appears in the Import 

wizard in Framework Manager. 

Notes: If you created a signon, you can now modify the properties of the signon or add more 

signons. You can also add more data source connections. For more information, see the 

Administration and Security Guide. 

Steps to Test a Data Source Connection 

1. In the Data Sources folder, right-click the data source you want to test. 

2. Click Test Data Source. 

A message tells you if test is successful. 



Parameterized XML Connection Strings 

In an HTTP URL connection string for an XML data source, you can use parameters to send 

additional information. In the parameter component of a connection string, you can embed a 

prompt definition string. If the prompt definition is specified in the report, that value will be used. 

If the prompt definition is not specified in the report, then a user is prompted to supply a value. 

A URL has 6 components: addressing scheme, network location, path, parameters, query, and 

fragment identifier. 

An example of a URL components is 

:///;?# 

To send additional information with a parameter, you must encode the parameter component 

with two sets question marks, and embed the prompt definition string between the question 

mark sets. A prompt cannot cross a component boundary. 

An example of a parameterized XML string is 

http://MyNetworkLocation/MyPath/myxml.asp?countrysid=??CanadaPrompt?? 

Restrictions 

• When a URL component is a prompt it can not contain other data. 

• Prompting will not be supported for other types of connection strings 

Limitations 

• Prompts embedded in XML connection strings do not work in Framework Manager. You can 

not import data from a parameterized xml connection string. 

• When you set up a parameterized XML connection string in Cognos Connection, the Test 

button will not work. 

• Validation of the query specification in Report Studio will not work if you are connected to a 

parameterized XML connection string. 

Using a Project with Multiple Data Sets 

You may have to use the same model and reports with different sets of actual data. The data 

sets may be different databases, accounts, or schemas within a single database. You may 

encounter multiple data sets 

• when you use a different data set than the production users 

• in large enterprises, where each division has it own data set 

• in OEM applications, which have no direct control over customer data 

The tables and columns used by the project must be logically the same across all data sets. You 

must also ensure that the correct data set is identified in each case. 

Data sources in Framework Manager contain information that identify the location of any data 

source tables needed for the query subjects that use those tables. This information is the 

mandatory name of the data source in the content store, as well as the optional catalog and 

schema names. You must ensure that the catalog and schema names use the desired data set. 

If different ReportNet content stores are in use, and a different version of the project is deployed 

to each content store, then you can specify the data source information in the project for each 

site. If you only have one content store, you can publish each specific project as a separate 

package. These approaches require a lot of manual maintenance. To reduce this level of 

maintenance, you can use one of the following options. 

Determining the Data Source Information 

The simplest approach is to decide the name of the data source in the ReportNet content store, 

the name of the catalog, if applicable, and the name of the schema in the database. Once these 

names are decided, you can use those names in all the data sets. 

User Guide 35


If some data sets use the same content store, then create a separate connection for each data 

set under a single content store data source. For more information, see the Administration and 

Security Guide. For information about how Framework Manager handles multiple connections, 

see the Framework Manager User Guide. 

Since the data source name in the content store can differ from the name of the customer 

database, this option offers a lot of flexibility. However, this approach still requires that the 

catalog and schema names be identical across all data sets. Even if all the data sets use the 

same database type, this may be difficult to ensure. If different database types are involved, it 

may be impossible. For example, SQL Server has a catalog level, but Oracle doesn’t. 

Using User-based Default Data Set Identification 

Each database user has access to a default schema and catalog, if applicable. If the schema 

and catalog are not defined, or if they are blank in the Framework Manager project data source, 

the default is used. As in the option above, this option may be combined with multiple 

connections to allow different users to use different databases for the same ReportNet data 

source. 

However, when you edit a query subject, Framework Manager uses the catalog and schema 

names in the project’s data sources to match them to items that are dragged into the SQL 

windows from the data source tree. For this reason, the catalog and schema names cannot be 

blank in the project data source while you are modeling. 

Therefore, you must use a macro expression in the catalog and schema of each data source in 

the project. This ensures that the catalog or schema names are blank at runtime, but explicitly 

sets the desired catalog or schema while modeling. 

Steps 

1. Create a single session parameter whose value identifies whether you are in design-time 

mode. When you are in design mode, set the value of this session parameter to a specific 

value. For example, use design. Otherwise, leave the value empty. 

Notes: 

• If you use a project value, you must set it each time you open the model for editing. 

• If you use an override value, you must set it each time you open the model for editing. 

2. For each catalog and schema in each project data source, create a parameter map that 

contains 

• an empty default value 

• a key whose name is the design value of the session parameter above, for example 

design, and whose value is the name of the design-time catalog or schema for that 

data source. 

3. Select the data source, and replace the catalog and schema property values with a macro 

that uses the corresponding parameter map and session parameter. For example, use 

#$DBSchemaName ($DeployOrDesign) # 



Modeling with Multilingual Data Sources 

To enable a project to work with multiple languages, you must set up data sources to support 

multiple languages. 

Multilingual Relational Data Sources 

For relational data bases, you can support multiple languages by using one or more of the 

following: 

• Language-specific database tables 

The database should contain the same tables for each supported language. For example, if 

the Product table supports English, French, and German, the database has tables named 

Product_en, Product_fr, and Product_de. 

• Language-specific columns 

A database table should contain the same column for each supported language. For 

example, if the Product table supports English, French, and German, the table has columns 

for ProductName_en, ProductName_fr, and ProductName_de. 

• Language-specific rows 

A database table should contain an additional column to identify the language of each row 

of data. For example, if the Product table supports English, French, and German, the table 

has a new column named LANG that identifies the language of each row. 

These solutions can make the multilingual data bases large and difficult to manage. 

You can model a single relational query subject to represent all possible data source languages 

by using parameter maps and session parameters in the query subject definition. For more 

information, see "Using a Macro" (p. 81) and "Multilingual Support" (p. 85). 

Multilingual Relational Data Sources 

For SAP BW metadata, you do not need to use parameters to support mulitlingual reporting, 

since SAP BW automatically provides data in the language that matches the logon settings for 

the current user. If there is no metadata for the current user’s language, Framework Manager 

retrieves data in the default language. 

Modeling with SAP BW Data Sources 

SAP BW Variables 

In Framework Manager, each dimension is assigned one hierarchy. If there are multiple 

hierarchies, the first hierarchy that is imported becomes the default characteristic and the others 

become presentation hierarchies. Level names in Framework Manager are only meaningful 

when they have been defined in the administrator workbench. 

SAP BW variable information is included in a single composite custom property called SAP BW 

Variables that only exists if a data source has one or more variables associated with it. The SAP 

BW Variables property contains one or more composite properties each of which must be 

assigned a unique name. Each property represents a description of a single SAP BW variable. 

Framework Manager supports three types of SAP BW variables: characteristic, formula, and 

hierarchy. 

Characteristic Variables 

There are two kinds of characteristic variables: characteristic value and hierarchy node. 

Characteristic value variables select characteristic values. Meanwhile, hierarchy nodes select 

values from any position in a presentation hierarchy. 

Formula Variables 

Formula variables accept typed-in numeric values. Formula variables are used when you want a 

formula component be entered during query execution. For example, you can use a formula 

variable for value-added tax (sales tax) rate to process the respective current tax rate when 

executing a query. You can change the default value for a formula variable and fix the value of 

the variable. 

User Guide 37


Hierarchy Variables 

Variables for hierarchies function as place holders for the hierarchy of a characteristic. All of the 

values for hierarchy variables are read-only. 

The SAP BW variable information is obtained using the SAP BW BAPI 

MDDataProviderBW::GetVariables. The following is a list of properties and their SAP BW 

equivalents. 

• name 

Possible Values 

String value 

SAP BW Value 

VARIABLE_NAME 

Property is Read only. 

• fixedValue (Not applicable to hierarchy variables.) 


Boolean 

Determines whether or not the value of the variable can be changed. If true, report authors 

will not be prompted for the associated variable and the default value will always be applied. 

Default value is false. 

• type 


numeric 

characteristic 

hierarchy 

hierarchicalNode 




• caption 


String value 

(composite, 

locale-dependent) 

The string value for this variable is locale-dependent. Each locale in the model should be 

represented by a custom property whose value is the locale name. 

For example, if the locales "en-ca" and "fr-fr" exist in the model, you would define two 

custom properties called "en-ca" and "fr-fr" . 

• selectionType 

The values and their corresponding SAP BW equivalents are 

Value 

value 

interval 

complex 

SAP BW Value 

SAP_VAR_SEL_TYPE_VALUE 

SAP_VAR_SEL_TYPE_INTERVAL 

SAP_VAR_SEL_TYPE_COMPLEX 


• entryType 


Value 

optional 

mandatory 

SAP BW Value 

SAP_VAR_INPUT_TYPE_OPTIONAL 

SAP_VAR_INPUT_TYPE_MANDATORY 

mandatoryNoInitial SAP_VAR_INPUT_TYPE_MANDATORY_N 

OT_INITIAL 


User Guide 39


• dataType 


Value 

xsdString 

xsdDate 

xsdFloat 

SAP BW Value 

CHAR 

CHAR 

Note: The VAR_TYPE value is 

SAP_VAR_TYPE_MEMBER and reference 

dimension is based on 0CALDAY. 

FLTP 

Default value is xsdString. 

Property is Read only and hidden. 

• dimension (Only applies to characteristic variables.) 


String value 

SAP BW Value 

REFERENCE_DIMENSION 


• hierarchy (Only applies to characteristic variables.) 


String value 

SAP BW Value 

REFERENCE_HIERARCHY 


• defaultLow 


Specifies a range of 

values. 



• defaultLowCaption 


String value 

(composite, 






• defaultHigh 


Specifies a range of 

values. 

Note: Only applicable to variables with a selection type of interval. 

• defaultHighCaption 


String value 

(composite, 






Note: Only applicable to variables with a selection type of interval. 

User Guide 41


• promptType 

The values are 

Value 

typeIn 

pickList 

calendar 

hierarchyPickList 

notApplicable 

Restrictions 

Always for numeric variables. 

Optional for characteristic 

values. 

Optional for characteristic 

variables. 

Only for characteristic 

variables based on 0CALDAY 

Optional for all presentation 

hierarchies. 

Always for hierarchy variables. 

Property is read-only for characteristic and formula variables. 

• trimLevels (Only applicable to hierarchicalNode variables.) 


Numeric 

Restrictions 

Requires promptType 

of hierarchyPickList. 

Default value is 1. 

Export Metadata 

You can export your Framework Manager model as a Common Warehouse Metamodel (.cwm) 

file. CWM is used for exchanging metadata between different data warehouse tools and 

repositories. Each instance of the CWM metamodel is exchanged via XMI (.xml metadata 

interchange) documents. 

You can export query subjects, query items, folders, namespaces, expressions and functions. 

When you export to CWM, we recommend that you use the default options. These default 

options optimize the metadata export. If you change the options, you may see unexpected 

results. 

Steps 

1. Right-click the root namespace of the metadata you want to export, and click Export Model. 

You are prompted to save the project. 

2. Click Yes to save the project, otherwise click No. 

3. Locate a file to use as the target and click Next. 

For example, GoSales_cwm.xml 

4. In the Framework Manager Specific Export Options dialog box, click the options you 

want. For each option, from the available list, select a value. 


are based on the selected third-party data source. 




6. In the Third-Party Specific Import Options dialog box, click the options you want. For 

each option, from the available list, select a value. 

Tip: To accept the default options, select the Use Defaults check box. 


are based on the selected third-party data source. For more information, see the third-party 

data source vendor documentation. 


The input validation results from the export process appear. 

8. Click Next and click Finish. 

Managing Projects 

Repository Control 

You can manage your projects in Framework Manager using repository control (p. 43), 

segmenting (p. 46), and linking (p. 47). These project management features help maintain 

version control, organize a project according to business rules and organizational needs, set 

runtime processing options, and allow other users to access sections of the project. 

You can also identify the vendor specific functions (p. 48) that you want to use for each data 

source you imported into your project. 

Use repository control to help manage your projects in Framework Manager. You control 

versions of a project to ensure that each version of a file is recoverable. Repository control also 

ensures that users in a large organization have access to the most recent changes or versions 

of a project or segment. You can use Framework Manager to 

• connect to a Visual SourceSafe (VSS) or Concurrent Version System (CVS) repository 

• check in and check out a project 

• get the latest version of a project 

• view project history 

Note: The limitations set by the third-party repositories are incorporated into Framework 

Manager. For more information, see the third-party data source vendor documentation. 

Create a Repository Connection 

You can use one of these repositories to manage file versions for Framework Manager: 

• Concurrent Versions System (CVS) 

• Visual SourceSafe (VSS) 

If you use Visual SourceSafe as your repository, we recommend that you connect to Visual 

SourceSafe using your Windows user name and password. To do so, in Visual SourceSafe 

Administrator, create a user that has the same credentials as your Windows account. Then, 

from the Tools menu, click Options, and on the General tab, select the Use network name for 

automatic user log in check box. 

When you open a project stored in Visual SourceSafe, you automatically log on using your 

Windows user name and password. 

For more information about installing and configuring these products, see the documentation 

provided by the vendors. 

In Framework Manager, you can add a project, segment, link or namespace to one of the 

supported repositories. 

You can view an up-to-date version list of repositories supported by Cognos products on the 

Cognos support site (http://support.cognos.com). For more information about installing and 

configuring these repositories, see the documentation provided by the vendor. 

You must set up the path to the Source Control System in Cognos Configuration, before you 

create a repository connection in Framework Manager. For more information, see the Cognos 

Configuration User Guide. 

User Guide 43


Steps to Create a VSS Database 

1. Start Visual SourceSafe Administrator. 

2. From the Tools menu, click Create Database. 

3. Specify where you want to create the database. 

4. Select the New 6.0 Database Format check box, and click OK. 

5. From the Users menu, click Open SourceSafe Database. 

6. Locate the srcsafe.ini file, and click Open. 

7. Click the database you just created, and click Open. 

A list of the users assigned to the database appears. 

8. Close Visual SourceSafe Administrator. 

9. Open the srcsafe.ini file, and type the following command at the end of the file: 

Update_No_Change=Update 

This command ensures the project is updated each time there is a check in. 

10. From the File menu, click Save, and click Exit. 

Steps to Create a VSS Repository Connection 

1. Create a Visual SourceSafe (VSS) database (p. 44). 

2. Start Framework Manager and, from the Welcome page, click Repository, Connection 

Manager. 

Tip: If you have Framework Manager open, from the Repository menu, click Connection 

Manager. 

3. Click the New button. 

4. In the Connection Name box, type a name for the connection. 

5. From the Type list, click SourceSafe://. 

6. In the Settings window, click in the Value pane, and type 

• the location of the srcsafe.ini file 

7. To test the connection, click Test. 

8. Click OK. 

Steps to Configure a CVS Repository 

1. Copy the CVS executable file to the \crn\bin directory. 

2. Create a directory for the CVS repository. 

An example is C:\cvs_repository. 

3. Create a subdirectory named CVSROOT. 

An example is C:\cvs_repository\CVSROOT. 

Steps to Create a CVS Repository Connection 

1. Start Framework Manager and, from the Welcome page, click Repository, Connection 

Manager. 

Tip: If you have Framework Manager open, from the Repository menu, click Connection 

Manager. 

2. Click the New button. 

3. In the Connection Name box, type a name for the connection. 

4. From the Type list, click SCCS://. 

5. In the Settings window, click in the Value pane, and type the path for the repository. 

Do not specify the CVSROOT in the path. The repository location must be different from the 

location where the new project is stored. 

An example is C:\cvs_repository. 

6. To test the connection, click Test. 



7. Click OK. 

Check In and Check Out a Project 

Get the Latest Version 

You can also check your project in and out of one of the supported repositories. 

You must first 

• set up the Source Control System in Cognos Configuration. 

For more information, see the Cognos Configuration User Guide. 

• create a repository connection (p. 43) 

• either create a new project, or open an existing project (p. 20), and add the project to a 

repository 

• open an existing project that is connected to a repository. (p. 20) 

For information about installing and configuring third-party repositories, see the documentation 

provided by the vendors. 

If you have a project checked in to a repository and you make a change, you will be notified that 

you must check out the project or segment before you can make the change. 

Steps to Check In a Project 

1. In Framework Manager, in the Project Viewer, click the project or segment you want to 

check in. 

2. From the Repository menu, click Check In. 

Tip: To keep your project or segment checked out, select the Keep Checked Out check 

box. 

3. You must add a description in the Description box. 

4. Click OK. 

Steps to Check Out a Project 

1. In Framework Manager, in the Project Viewer, click the project or segment you want to 

check out. 

2. From the Repository menu, click Check Out. 

The icon of the project or segment reflects that the object is checked out. 

Steps to Undo Check Out 

1. Click the namespace or segment for which you want to undo the check out, and from the 

Repository menu, click Undo Check Out. 

A message warning about overwriting any edits made to the project appears. 

2. Click OK. 

When you use repository control in Framework Manager, you retrieve the most recent version of 

the project (.cpf), model.xml, and customdata.xml files. For more information, see "The Project 

Page" (p. 21). 

When you see an exclamation mark icon next to project or segment, it is an indication that the 

segment has been updated. On a regular basis, refresh the project or segment by using the 

refresh button (F5). If the project you are working in is checked out, you must first check in all 

projects and segments, in order to get the latest version. 

Steps 

1. Click the project or segment you want. 

2. From the Repository menu, click Get Latest Version. 

3. Click OK. 

User Guide 45


View History 

Every project or segment that is connected to a repository has a detailed record of its history. 

You can see version information, comments, and details about the history of the project. 

The revision history of a project or segment is logged in the Repository.xml file. This file is 

located in the project folder. Each time you check a project in, a label is added to the 

Repository.xml file. 

You can also return the project or segment to a previous version. Any changes or edits made to 

the project since the last check in are lost. 

If you have links in your project or segment, you can view the history of those linked segments or 

projects and see what changes have been made. You will be able to synchronize to those 

changes only if the project you are in owns the link (p. 49). 

Steps 

Create a Segment 

1. Click the object you want to view, and click Repository, View History. 

2. To synchronize the object to a previous version, click the row of the version you want, and 

click Synch. 

3. Click Close. 

You can create a segment so that you can 

• organize a project according to business rules and organizational requirements 

• share and reuse project information 

When you segment a project, it is also a good idea to divide your project into business units. For 

example, human resources, sales, and finance. 

When you create a segment, you create a new project in a new folder, complete with its own 

associated project files (p. 19). 

You divide a project either at the folder or namespace level. By dividing the project, you can 

organize the project according to business needs. For example, you have a project named 

GoSales. You can create two folders, one named Products and the other named Orders. You 

can divide the GoSales project at the Products folder and at the Orders folder. 

You can also link the segments to other projects that contain the same information to maintain 

consistency and reuse information. For example, the project Inventory contains the folder 

Products. You can create a link from GoSales Products to Inventory Products. If any changes or 

additions are made to the Inventory Products folder, they will be reflected in the GoSales 

Products folder. 

Best Practices 

When you work with a main project and segments in the main project, there are things you may 

want to consider. If you 

• create a master project that contains segments, and the master project is connected to a 

repository, any new segments created are automatically added to the repository. 

• have a project or segment checked in to a repository and you make a change, you will be 

notified that you must check out the project or segment before you can make the change. 

• make changes in a segment, you will be notified in the main project that changes have been 

made in the main project. 

Avoid making changes in both the segment and the main project. 

For information about opening a segment, see "Create or Open a Project" (p. 20). 

Steps 

1. Click the folder or namespace you want to divide, and from the Actions menu, click Create 

Segment. 

2. In the Name box, type a name for the new segment. 



3. Make any additional changes you want. 

These optional changes are available only to folders or namespaces that are not connected 

to a repository. 

Goal 

Change the default location 

Add the segment to a source 

control repository 

Action 

Click the folder button next to 

the Location box. In the Select 

Project Location dialog box, 

go to the appropriate folder and 

click OK. 

Click the Repository button. In 

the Repository Settings pane, 

select the Add to Repository 

check box. In the Connection 

list, choose either to use an 

existing connection, or 

configure a new repository 

connection (p. 43). 

Create a Link 

4. Click OK. 

A link is a shortcut to an existing project, folder, or namespace. You create links to help organize 

work across large projects, to maintain consistency, and reuse information. 

For example, the project Inventory contains the folder Products. You can create a link from the 

GoSales Products to Inventory Products. If any changes or additions are made to the Inventory 

Products folder, they will be reflected in the GoSales Products folder. 

You must create the project, folder, or namespace, before you can link to it. You can create links 

only to 

• folders (p. 89) 

• namespaces (p. 25) 

• projects or segments (p. 46) 

Links are defined in the .cpf file of the project that owns them. For example, you have a project. 

and you have a link from the main project to the segment. The main project owns the link 

between the main project and the segment. You can find that link in the main project’s .cpf file 

(p. 19). 

If you link to a namespace and a new data source is added to that namespace, you must add a 

link to that new data source as well. Framework Manager does not automatically update new 

data sources added to a namespace. 

The projects you link must have the same languages defined and the same design language. 

Steps 

1. In the Project Viewer, click the object you want to link. 

Tip: You can create links only to folders, namespaces, and projects. 

2. From the Actions menu, click Link Segment. 

3. Locate the .cpf file of the segment, folder, or namespace, and click Open. 

4. If you want to add the link to a repository, click the Repository button. 

For more information, see "Create a Repository Connection" (p. 43). 

5. Click the segment you want to link and click Add or, to add a link to another project, click 

Add Project. 

6. Click OK. 

A new folder appears in the Project Viewer. 

User Guide 47


Functions 

The Expression Editor provides a list of functions that you can select to create an expression. 

This list includes: 

• common SQL99 functions 

• vendor specific functions 

• functions imported from a data source 

When you import metadata into Framework Manager, you import the functions from the 

metadata source. Functions that you import from a data source are namespace specific. These 

functions are displayed in a folder whose name matches the namespace. This folder is located 

at the bottom of the list of folders in Expression Editor. 

Define Function Sets 

A collection of vendor specific database functions is called a function set. When you create a 

project that contains relational metadata, the Expression Editor lists the function sets for all 

available vendors. However, you can restrict the function sets so that it lists only the vendors that 

you want to use in your project. You customize the function set by identifying the specific vendor 

for each data source defined in the project. 

Note: When you create a project that contains SAP BW metadata, Framework Manager 

automatically only lists the functions that apply to SAP BW data. 

Steps 

1. Click Project, Project Function List. 

2. Select Set function list based on the data source type. 

Tip: To disable this filter, select Include all function sets. 

3. In Function set, click the appropriate data source row. 

4. Select the function set you want to use with this data source. 

5. Repeat steps 2 and 3 until finished. 

6. Click OK. 

For information about how to specify which function sets are included in individual packages, 

see "Create or Modify a Package" (p. 97) 

Choose the Type of Query Processing 

For relational metadata, you can select the type of query processing you want to improve 

performance. 

There are two types of query processing: 

• limited local 

Limited local query processing means that the database server does as much of the SQL 

processing and execution as possible. However, some reports or report sections use local 

SQL processing. 

• database only 

Database only query processing means that the database server does all the SQL 

processing and execution. An error appears if any reports or report sections require local 

SQL processing. 

While the database server can usually execute the SQL and can run reports much faster, local 

processing is sometimes necessary. For example, choose limited local processing if you want to 

create cross database join or if you want report authors to use unsupported SQL99 functions. 

Steps 

1. In the Project Viewer, click the data source you want to change. 

2. In the Properties pane, from the Query Processing list, click either Limited Local or 

Database Only. 


Multiuser Modeling 


Multiuser modeling is the ability to support multiple users accessing an application 

simultaneously. Framework Manager supports multiuser modeling with 

• segmented projects (p. 46) 

Projects can be divided into segments so that different users can look at different parts of 

the same project at the same time. When you create a segment, you create a new project in 

a new folder, complete with its own associated project files (p. 19). 

• links (p. 47) 

Links are created between projects so that different users can refer to a project at the same 

time as another user is working on it. 

• repository control (p. 43) 

You can use repository control to help manage your projects in Framework Manager across 

multiple modelers. 

Segmenting and Linking Best Practices 

You can use Framework Manager to create and link segments, projects, and folders to use in a 

multiuser modeling environment. There are some best practices for using these features to 

minimize complexity and ensure stability in a multiuser modeling environment. 

Note: You can use synchronizing and action logging to revert to earlier versions of the main 

project or a segment (p. 50). 

When you segment a project, it is also a good idea to divide your project into discrete 

submodels, where each submodel can stand on its own or represents a relatively self-contained 

part of the project. For example, human resources, sales, and finance. 

We recommend that you link to relatively static segments and check the integrity of your project 

(p. 90) on a regular basis. 

When you set up your multiuser modeling environment, for best practices, ensure the following: 

❑ the namespace in the main project and any links in the project to folders have the same 

identifier (p. 25) 

For example, you have a main project and a link in the project to a folder. The folder you link 

to must exist in a namespace that has the same name as the main project. If the identifier in 

the main project and that of the linked folder are not the same, any relationships, shortcuts, 

or expressions that reference objects in the link, from the main project, may not work. 

❑ all objects in a project have unique identifiers 

For example, you have a main project that contains a query subject named NewQS, and a 

segment in the project. You open the segment, add a new query subject (p. 53) named 

NewQS, and save the segment. When you open the main project, an error occurs because 

a query subject named NewQS already exists in the main project. 

❑ you update any references in both the main project and any segments in the project 

For example, you have a main project and a segment in the project. In the main project, you 

have a relationship (p. 65) named qs1_qs2 that exists between query subject1 and query 

subject2. The query subject named query subject 2 is in the segment. You open the 

segment, rename query subject2 to query subject3, and save the segment. When you open 

the main project, an error occurs because the relationship qs1_qs2 is broken. In Framework 

Manager, any object that relies on a reference, for example, shortcuts, model query 

subjects, and expressions, also would be affected. For more information, see "Check a 


❑ the main project and any segments in the project have the same languages 

For example, you have a main project and a segment in the project. 

In the segment, you have defined the languages (p. 85) English and French. You open the 

main model, add the language Chinese, and save the segment. When you open the 

segment, an error occurs because the language Chinese is not defined in the segment. 

User Guide 49


Action Logging 

In Framework Manager, you can capture, view, and play back actions performed on the project. 

Each sequence of actions that you perform in Framework Manager is considered a transaction. 

Each transaction is recorded in the project or segment action log file. 

The action log file is an XML file that is designated by the project or segment name, date, and 

time. The log file is stored in the project or segment logs folder. 

You can simply view a log file or play it back entirely to ensure project integrity. You can choose 

to play back individual transactions or a combination of transactions in a log file. You can also 

save individual transactions to a separate log file. 

For example, you make changes to a project in a test environment. When it is time to move the 

project to production, you can play back every action, or series of actions, that you performed in 

the project in the test environment to create an identical project in the production environment. 

Synchronize Projects 

You can use Framework Manager log files to synchronize changes 

• made in the metadata source to a project 

• between multiple versions of the same model. 

When you synchronize your project, you create a new project by replaying, from the log files, all 

the actions you made in the original project starting from its initial creation. You can choose to 

accept the new changes, and create a new project, or return to the original project. If you accept 

the new changes, the original project is deleted. 

You cannot synchronize the projects again until additional changes are made and logged. After 

you save and close a project file, these changes are added to the log file. 

Because every action that you made in your project is rerun, synchronization may take a long 

time. 

Synchronization can be run only on the master project or a stand-alone segment. You cannot 

synchronize linked projects or segments in the master project. If the segments are updated by 

the linked project, the synchronization can produce unpredictable results in the master project. 

Before synchronizing a project, ensure that data source connections have not changed and that 

data sources are online. You can check your connections by testing a few key query subjects. 

For more information about data source connections, see Create a Data Source Connection. 

Steps to View Transaction History 

1. From the Project menu, click View Transaction History. 

Tip: To view the details of a transaction, click the plus sign next to a transaction number. 

2. Click the transactions numbers you want, and click Save as Script. 


Steps to Run Script 

1. From the Project menu, click Run Script. 

Tip: To create a backup of your Framework Manager, select the Backup project into this 

directory check box. 

2. In the Script File box, you will see the name and location of the script file. 

Tip: To locate another log file, click the folder button. 

3. To view the details of a transaction, click the transaction. 

4. If you want to play back all the actions, click Run, or select the check boxes of the 

transactions you want to run, and click Run. 

A list of the transaction details appears in the Transaction Details pane. 

5. To ensure the project stops on any transaction error, select the Stop on Failed Transaction 

check box. 



6. If the playback stops, you can modify the temporary project to correct the problem without 

closing the Synchronize window. After fixing the problem, choose one of the following: 

• To retry the failed action, click Resume. 

• To skip to the next transaction, click Skip to Next. 

7. Click Accept to replace the original project with the contents of the temporary project. 

8. Tip: To return the project to its previous state, click Revert. 

Steps to Synchronize 

1. From the Project menu, click Synchronize. 

2. To ensure the project stops on any transaction error, select the Stop on Failed Transaction 

check box. 

3. Click Run. 

In the Status window, a list of transactions taken from the log file appears. 

4. If the playback stops, you can modify the temporary project to correct the problem without 

closing the Synchronize window. After fixing the problem, choose one of the following: 

• To retry the failed action, click Resume. 

• To skip to the next transaction, click Skip to Next. 

5. Click Accept to replace the original project with the contents of the temporary project. 

Tip: To return the project to its previous state, click Revert. 

User Guide 51



Chapter 3: Preparing a Model for Reporting 

Preparing a model for reporting involves refining the metadata you imported into a project so 

that you can provide the information that your report authors require. Any enhancements you 

make to the data source metadata does not affect the original data source. 

You can prepare relational metadata in your project for report authors by adding business rules, 

such as calculations (p. 75), filters (p. 76), parameter maps (p. 79), and session parameters 

(p. 80). Business rules define the information that users can retrieve in a report. 

To further customize the model for your report authors, you can modify properties (p. 88) that 

control how data is used and formatted in a report. You can also organize model objects into 

logical groups, named folders (p. 89), to reflect the business concepts that you require. 

You can verify the project (p. 90) at any time to ensure that the references between the objects it 

contains are valid. 

Query Subjects 

A query subject is the basic building block in Framework Manager. Each query subject that is 

based on relational metadata is defined by an SQL statement that describes how to retrieve 

data from the data source. 

Framework Manager generates query subjects that represent tabular data from the data source, 

based on the definition of the query subject. For example, a query subject that references an 

entire table contains query items that represent each column in the table. If the SQL selects only 

specific columns, only those columns are represented as query items. 

You use Framework Manager to modify query subjects that are based on relational metadata to 

optimize and customize the data that they retrieve. For example, you can add filters or 

calculations. When you change the definition of a query subject, Framework Manager 

regenerates the associated query items, ensuring that any changes to query item properties are 

reflected in the new query items. 

There are different types of query subjects that you can use in Framework Manager for 

relational metadata. For SAP BW metadata, the only type of query subject that you can use is 

the Data Source type. 

Each type of query subject has its own advantages, depending on how you want the query to 

retrieve information. When you create a query subject (p. 54) that is based on relational data, 

Framework Manager prompts you to identify which of the following you wish to create: a data 

source, model, or stored procedure query subject. When you modify a query subject, the 

changes you can make depend on which type of query subject you want to modify. 

Data Source Query Subjects 

Data source query subjects directly reference data in a single data source. Framework Manager 

automatically creates a data source query subject for each table and view that you import into 

your model. For example, when you import the ConversionRate table from the GOSales sample 

database, Framework Manager creates a query subject using the following SQL statement: 

Select * from [gosales].ConversionRate 

Each data source query subject that is based on relational metadata can reference data from 

only one data source at a time. However, the advantage of data source query subjects is that 

you can directly edit the SQL that defines the data that a data source query subject retrieves. 

By directly editing the SQL of a relational query subject, you can 

• insert parameters that control the data that the query retrieves 

• create query subjects based on arbitrary SQL 

For more information, see "Modify a Data Source Query Subject" (p. 55). 

User Guide 53


Model Query Subjects 

You can create model query subjects that are based on relational metadata. Model query 

subjects contain SQL statements that do not directly reference a data source. Rather, they use 

metadata already in the model, such as query items that exist in other query subjects. Model 

queries can contain references to both model queries and data source queries. 

The main purpose of model query subjects is to create query items that are oriented to reporting 

needs while reusing the underlying data source queries. 

Because model query subjects are based on the metadata in your model, they let you 

• reuse complex SQL statements that exist in the model 

• reference objects from different data sources in the same query subject 

Model queries can only read and test the underlying query subjects that they reference. If you 

edit the SQL of a model query subject, it becomes a data source query subject whose SQL 

corresponds to the data source query upon which it is based. 

For more information, see "Modify a Model Query Subject" (p. 59). 

Stored Procedure Query Subjects 

Stored procedure query subjects are generated when you import any procedure from a 

relational data source that is not identified as a function. After importing metadata, you should 

check to ensure that these generated query subjects represent stored procedures in the data 

source, rather than functions. 

When a query subject is based on a stored procedure that returns a result set, the stored 

procedure must: 

• return a single uniform result set 

If a stored procedure returns multiple result sets, Framework Manager only supports the 

first result set. Each result set must return the same form, such as the same number of 

columns. 

• not have an overloaded signature 

Some database systems let one stored procedure name accept different numbers and 

types of arguments. Framework Manager does not support overloaded signatures, even if 

the result set is the same in all cases. 

To work around these restrictions, you can create multiple stored procedures, each with a 

unique name, and create a separate query subject for each result set or signature. 

After you import, or create, a stored procedure query subject, you must execute it to validate the 

underlying stored procedure and determine the projection list. When a stored procedure is 

updated in the data source, executing the stored procedure in Framework Manager updates the 

query subject with the newly generated query items. 

For information about modifying and executing a stored procedure query subject, see "Modify a 

Stored Procedure Query Subject" (p. 60). 

Create a Query Subject 

You can use Framework Manager to create the following types of query subjects that are based 

on relational metadata: 

• Model query subjects are based on metadata that exists in your model. 

• Data source query subjects directly reference data that exists within a single data source. 

• Stored procedure query subjects leverage the stored procedures in a data source. 

Note: For SAP BW metadata, the only way to create a query subject is to import it. 

For more information, see "Query Subjects" (p. 53). 

You can also create a new query subject that is based on relational metadata by merging 

existing query subjects and query items (p. 64), or transforming a relationship into a query 

subject (p. 65). 



Steps 

1. Select the namespace folder, and click Actions, Create, Query Subject. 

The New Query Subject wizard appears. 

2. In the Name box, type a name for the new query subject. 

3. Select the type of query subject you want to create. 

4. Click the Finish, or Next button. 

5. Complete the steps in the New Query Subject wizard. 

Tip: To ensure that the data source is uniquely identified when you create a data source 

query subject, do not exit the wizard before the Finish button appears. 


The Query Subject Definition dialog box appears. You can use this dialog box to modify 

the query subject. For more information, see "Modify a Data Source Query Subject" (p. 55), 

"Modify a Model Query Subject" (p. 59), and "Modify a Stored Procedure Query 

Subject" (p. 60). 

Tips 

• To organize objects in the diagram, click Diagram, Auto Layout Diagram. 

• To control the model area that is visible in the diagram, click the overview button in the 

bottom right corner and drag the cursor over the diagram. 

Modify a Data Source Query Subject 

After you import or create a data source query subject that is based on relational metadata, you 

can modify it to retrieve different data. While you are in the editor, you can test the query subject 

(p. 60) to view the results that it returns. 

When you embed a filter (p. 77) or calculation (p. 75) in a data source query subject, the data 

source query subject must have a relationship to any query subject(s) that the expression 

references. This relationship is necessary even if the expression references a model query 

subject that is based on the same table as the data source query subject in which you are 

embedding the expression. To create this relationship, you can 

• ensure that there is a join path between the new query subject and the one that contains the 

filter or calculation 

• base the embedded filter or calculation on a query item that is based on a the desired data 

source query subject 

• convert the desired filter or calculation to a stand-alone filter or calculation, so that they are 

not part of the query subject 

• create and use a stand-alone filter or calculation that references the embedded object 

When query subjects are based on SAP BW metadata, you cannot add calculations or edit the 

underlying query. However, you can 

• add, delete, and define filters 

• use prompts in filters to prompt the user for variable values 

• test a query subject 

You cannot test an SAP BW query subject that contains prompts or BW variables. 

• conform or deconform multiple query subjects 

Steps 

1. Click the query subject you want to modify. 

2. Click Actions, Edit Definition. 

The Query Subject Definition dialog box appears. 

User Guide 55


3. Modify the query subject 

Note: For SAP BW metadata, the only modification you can make is to apply or embed a 

filter. 

Goal 

Add data 

source objects 

Edit the SQL 

Apply or embed 

a filter (p. 76) 

Apply or embed 

a calculation 

(p. 75) 

Insert a macro 

(p. 81) 

Insert a data 

source 

reference 

Action 

From Available Database Objects, drag 

objects to the SQL tab. 

Click the SQL tab, and make the changes you 

want. 

Note: Changing the alias of a column 

regenerates the query item that represents that 

column. Any modifications you have made to 

the query item properties are not retained 

because Framework Manager perceives it to be 

a new query item. 

Click the arrow to the right of the filter button, 

and select one of the following 

• Create New to create an embedded filter 

that is only used with this query subject. 

• Select From Model to apply a filter from 

the model. 

Set the usage (p. 77) value to determine how 

the filter is applied. 

Click the arrow to the right of the calculation 

button, and select either 

• Create New to create an embedded 

calculation that is applies to only this query 

subject 

• Select From Model to apply a calculation 

that already exists in the model 

On the SQL tab, select where you want the 

macro and click the insert macro button. 

Because parameter values in data source query 

subjects are not translated, ensure that they do 

not contain European values, such as a comma 

that is used as a list separator. 

On the SQL tab, click the location where you 

want to insert the reference, click the insert data 

source button, select the data source, and click 

OK. 



Goal 

Change the 

SQL type 

(p. 61) 

Action 

Click the options button, select the SQL 

Settings tab and use the SQL Type list to 

select either Cognos, Native, or 

Pass-Through. 

Change how 

the SQL is 

generated 

(p. 64) 

Click the options button and, on the SQL 

Settings tab, set Generate SQL to either As 

View or Minimized. 

4. You can test the query subject (p. 60) to view the result set it returns. 

5. Click OK. 

Framework Manager verifies the SQL before updating the query subject. If any 

modifications have invalidated relationships, other query subjects, calculations, or filters, 

you are warned about this impact. You can choose to continue with the update or to cancel 

it. 

Usage and aggregation property values (p. 74) are regenerated to reflect the changes you 

made. 

Conform SAP BW Query Subjects 

When you import multi-cube InfoQueries there can be two or more query subjects that contain 

the same information. Framework Manager lets you conform these query subjects to create one 

query subject and one or more shortcuts. This reduces the amount of redundant information 

displayed in the model, and ensures that identical query subjects are not changed 

independently. 

Steps 

1. Click Actions, Conform Dimensions. 

The Conform Dimension Wizard appears, listing all dimensionally aware SAP BW query 

subjects that exist in the model. 

2. Select the query subject that you want to conform. 

Note: If you want queries based on these query subjects to retrieve data from a specific 

data source, select the query subject that references the preferred data source. 


4. Identify the query subjects that you want to include in the conformed dimension, and click 

Next. 


Deconform an SAP BW Query Subject 

When you import SAP BW metadata into your project, Framework Manager automatically 

creates conformed dimensions for any two or more hierarchies that have a matching structure. If 

there are dimensions that you do not want conformed you can deconform them by doing the 

following steps. 

Steps 

1. Delete all instances of the query subject from the model. 

The easiest way to do this is to delete the one instance of the query subject that is not a 

shortcut. This removes all of the shortcuts from the project. 

User Guide 57


2. Re-import the query subjects that have been deleted from each of the relevant data sources 

Ensure that the generate conformed dimensions option is not selected. 

3. Ensure that query subjects appear in the project as expected. There should be no shortcuts 

in use for these query subjects. 

Optimizing SAP BW Performance 

You can optimize the performance of query subjects that are based on SAP BW data by 

ensuring that the "ragged" and "balanced" properties are set to the correct values. 

Balanced Hierarchies 

A hierarchy is balanced when each path within a hierarchy descends to the same depth. In SAP 

BW, all leaf nodes of a hierarchy are values of the characteristic, but each path does not have to 

descend to the lowest level of the hierarchy. 

You can define whether a query subject represents a balanced hierarchy by modifying the "type" 

and "balanced" properties of the query subject. The values that you set for these properties 

depend upon the type of object that the query subject represents, and whether you know if the 

hierarchy is balanced. 

When all paths are of the same depth, this property should be assigned a value of "true", 

otherwise it should be set to "false". 

Query subject 

represents 

Type property 

value 

Balanced property 

value 

characteristic read-only true 

hierarchy you know is 

balanced 

hierarchy whose balance 

is unknown 

read-only 

boolean 

true 

false 

Ragged Hierarchies 

If you assign a value of "true" to the "balanced" property of an unbalanced hierarchy, queries 

that involve this query subject will return incorrect data. If you assign a value of 'true" to the 

"balanced" property of a balanced hierarchy, performance will be slowed. 

A hierarchy is ragged when at least one path in the hierarchy skips one of the levels in the 

hierarchy. In SAP BW, this occurs only when there are "not assigned" or "#" nodes in a 

presentation hierarchy. However, the presence of such a node does not guarantee that the 

hierarchy is ragged. You need to investigate the layout of a hierarchy to be certain. 

You can define whether a query subject represents a ragged hierarchy by modifying the "type" 

and "ragged" properties of the query subject. The values that you set for these properties 

depend upon the type of object that the query subject represents, and whether you know if the 

hierarchy is ragged. 

Query subject 

represents 

Type property 

value 

Ragged property 

value 

characteristic read-only false 

hierarchy you know is not 

ragged 

hierarchy whose 

raggedness is unknown 

read-only 

boolean 

false 

true 



If you assign a value of "true" to the "ragged" property of an unragged hierarchy, queries that 

involve this query subject will return incorrect data. If you assign a value of 'true" to the "ragged" 

property of a ragged hierarchy, performance will be slowed. 

Modify a Model Query Subject 

After you create a model query subject you can modify the list of query items it is based on, and 

add any calculations (p. 75) and filters (p. 76) that already exist in the model. While you are in 

the editor, you can test the query subject (p. 60) to view the results that it returns. 

Note: If the query subject references an SAP BW data source, it can only be a data source 


Steps 

1. Click the query subject you want to modify. 

2. Click Actions, Edit Definition. 

The Query Subject Definition dialog box appears. 

3. Modify the query subject. 

Goal 

Add or reuse 

model objects 

Edit the SQL 

Embed a filter 

(p. 76) 

Embed a 

calculation 

Action 

From Available Model Objects, drag objects 

to the Model Objects tab. 

If you add a filter, select the usage (p. 77) value 

to determine how the filter is applied. 

On the Preview tab, click the Edit Definition 

button. 

This converts the model query subject to a data 

source query subject. Do not do this if you want 

the query subject to reference multiple data 

sources. For more information, see "Modify a 

Data Source Query Subject" (p. 55). 

On the Model Objects tab, click the filter 

button, define the expression, click OK. 

Set the usage (p. 77) value to determine how 

the filter is applied. 

On the Model Objects tab, click the calculation 

button, define the expression, and click OK. 

Insert a macro 

(p. 81) 

While creating an embedded calculation or 

filter in the Expression Editor, click the insert 

macro button. 

Change how the 

SQL is 

generated 

(p. 64) 

Click the options button and, on the SQL 

Settings tab, set Generate SQL to either As 

View or Minimized. 


User Guide 59


5. Click OK. 

Framework Manager verifies the SQL before updating the query subject. If any 

modifications have invalidated relationships, other query subjects, calculations, or filters, 

you are warned about this impact. You can choose to continue with the update or to cancel 

it. 

Usage and aggregation property values (p. 74) are regenerated to reflect the changes you 

made. 

Modify a Stored Procedure Query Subject 

After you import or create a stored procedure query subject, you can modify it. To avoid 

inconsistencies, the modified query subject should return the same result set structure as the 

original. 

Steps 

1. Select the query subject and click Actions, Edit Definition. 

2. Modify the query subject: 

Goal 

Edit the name 

of the stored 

procedure 

Edit the data 

source 

Edit an 

argument 

Action 

Click the ellipses button beside the Name field, 

and edit the value. 

To insert a macro expression (p. 81), click the 

Insert Macro button. 

Click the ellipses button beside the Data Source 

field and select a data source. 

In the Arguments tab, select the argument, click 

the Edit button and enter a value. 

To insert a macro expression (p. 81), click the 

Insert Macro button 

Test a Query Subject 

Note: You can click an existing macro to edit it in the Macro Editor dialog box. 


4. Click OK. 

Framework Manager executes the stored procedure and, if the query subject returns a 

result set, validates the query subject. 

Steps to Transform a Stored Procedure to a Function 

1. Select the stored procedure and click Actions, Transform Stored Procedure to Function. 

2. To insert a parameter or enter a string value, select the argument and click Edit. 

3. The Edit Arguments Value dialog appears. 

4. To change the data source, click Select. 

5. To remove the stored procedure query subject from the model, click the Delete the Original 

Stored Procedure check box. 

6. Click OK. 

You can see the results that a query subject returns by testing it. Framework Manager lets you 

modify existing test settings so that you can customize the results that the test displays. 

Note that you cannot test an SAP BW query subject that contains prompts or BW variables. 



Steps 

1. Select the query subject and click Actions, Edit Definition. 

Test settings for stored procedure query subjects are set in the Edit Definition dialog. 

These settings control the number of rows returned and prompt values. 

2. You can modify the test results for model and data source query subjects by clicking the 

options button and selecting the Test Settings tab. 

Test setting modifications remain active only for the current editing session. After you close 

the editor, test settings are reset to their default values. 

Goal 

Restrict the 

rows returned 

Determine the 

level of detail 

Apply relevant 

design mode 

filters 

Apply a security 

filter (p. 100) 

Override 

session 

parameters 

(p. 80) 

Change prompt 

values (p. 78) 

Action 

Click the Number of Results check box and 

enter the required number of rows. 

Drag the Level of Information slider to the 

location that represents the amount of detail 

you require. 

This setting is disabled for query subjects that 

are based on OLAP data sources. 

Click the Design Mode Filter check box. This 

applies all relevant filters whose usage is set to 

design mode in another query subject 

In the Security Filters box, click Edit. 

The Security Filters dialog box appears. 

In the Session Parameters box, click Set. 

The Session Parameters dialog box appears. 

In the Current Prompt Values box, click 

Prompts. 

3. Click the Test button. 

The Test Result field displays the query results. Note: Any result sets that contain Binary 

Large Objects are displayed as [blob]. 

4. For more detailed information on the result set of model and data source queries, click the 

Results Information tab. 

5. Click OK. 

SQL Type 

SQL is the industry-standard language for creating, updating, and querying relational database 

management systems. When you edit the definition of a data source (p. 55) query subject that is 

based on relational data you can use: 

• Cognos SQL 

• Native SQL 

• Pass-Through SQL 

User Guide 61


When choosing the type of SQL in which a data source query subject is generated, you must 

weigh the following factors and decide which are most important 

Type Advantage Disadvantage 

Cognos 

SQL 

Native 

SQL 

Pass- 

Through 

SQL 

• improves query 

subject performance; 

for example, by 

removing unused 

elements at query time 

• SQL works on any 

supported database 

• performance is 

optimized across all 

related query subjects 

• you can use SQL that 

is specific to your 

database 

• you can enter any SQL 

supported by the 

database 

• you can not enter 

non-standard SQL 

• you cannot use SQL that 

the data source does not 

support for subqueries 

• the query subject may not 

work on a different 

database type 

• there is no opportunity for 

Framework Manager to 

automatically optimize 

performance 

• the SQL may not work on 

a different data source 

Note: the SQL Settings tab is disabled for query subjects that are based on OLAP data sources. 

1.1: added the above note. 

Cognos SQL 

By default, Framework Manager uses Cognos SQL to create and edit query subjects. Cognos 

SQL adheres to SQL99 rules and works with all relational and tabular data sources. Framework 

Manager generates the most optimized SQL possible, while preserving its functionality. In this 

way, Cognos SQL offers the most added value. 

Because query subjects in Framework Manager are similar to views in databases, the SQL for 

each query subject must conform to the SQL99 rules that apply to views. For example, you must 

assign aliases to any column that is empty or whose name is not unique. This level of 

conformance allows Cognos SQL to behave more consistently than vendor-specific SQL, which 

does not adhere to SQL99 rules. 

In general, using Cognos SQL is preferable because you can create query subjects that 

• can contain metadata from multiple data sources 

• have fewer database restrictions 

• interact more effectively with Cognos applications 

Native SQL 

When you edit a query subject, you can specify Native SQL. Native SQL is the SQL the data 

source uses, such as Oracle SQL. You can not use Native SQL in a query subject that 

references more than one data source in the project. 

If you are comfortable working with a Native SQL version, you may want to use it for query 

subjects that are based on a single data source. By doing so, you can use keywords that are not 

available in Cognos SQL, and copy and paste SQL from another application into Framework 

Manager. 

When the query is generated, Framework Manager combines the SQL of each query subject 

that uses a given data source connection into a single query. This helps improve the 

performance of the query. However, because the SQL is being generated as a series of 

subqueries, Native SQL queries must adhere to any restrictions that their database vendor 

places on derived tables. 



Therefore, if you change an existing query subject to Native SQL you must ensure that the SQL 

reflects the rules that apply to the native data source so that your query executes properly. 

❑ edit existing table names 

Cognos SQL uses a two-part structure to name query subjects. For example, 

[gosales].[ProductLine] means that the ProductLine query subject comes from the 

gosales database. Therefore, when you switch to Native SQL you must ensure that all table 

names include the parent elements required by the data source vendor. 

For information about Framework Manager object naming conventions, see "Naming 

Conventions for Objects in a Project" (p. 24). 

❑ ensure that the SQL is valid for subqueries 

Framework Manager processes Native SQL query subjects as subqueries. For example, if 

you change the following Cognos SQL 

Select 

P.ProductName, P.Margin From Product P 

to Native SQL, Framework Manager generates the following statement: 

Select 

oracle_plain.ProductName as Productname, 

oracle_plain.Margin as Margin 

From 

(GOSALES1_OR_92_WE...SELECT 

P.PRODUCTNAME, P.MARGIN 

FROM 

PRODUCT P} 

)oracle_plain 

Therefore, you must ensure that the query subject adheres to additional database 

restrictions are imposed on subqueries, such as the inability to use the With clause. 

Pass-through SQL does not have the same restrictions; however, the fact that Native SQL is 

processed as part of a larger query improves its performance. 

To test Native SQL with a query tool, such as Oracle’s SQL*Plus, you must place the SQL in 

the From clause of a Select statement. For example, you can use the following syntax in a 

query tool: 

Select * from () T1 

❑ assign aliases to derived columns 

Assign alias names to any columns whose values are calculated. For example: 

SELECT Length(Country) as LGTH 

FROM Country. 

❑ insert double quotes around alias names 

Changing the SQL Type of a query subject can change the case of alias names. When this 

happens, any query subjects that reference the altered query item become invalid. To 

ensure that there is no case change, insert double quotation marks around the alias. For 

example: 

Select COUNTRY as "test" from COUNTRY 

Note: SQL specified in Framework Manager and processed by the database, whether native or 

pass-through, must be completely self-contained. It must not reference anything outside of that 

SQL, such as database prompts or variables that would normally be supplied by the calling 

application. 

Pass-Through SQL 

Pass-through SQL lets you use Native SQL without any of the restrictions the data source 

imposes on subqueries. This is because Pass-Through SQL query subjects are not processed 

as subqueries. Instead, the SQL for each query subject is sent directly to the data source where 

the query results are generated. 

Because each query subject is sent to the data source as a separate statement, rather than 

being optimized by Framework Manager, the performance is slower. Therefore, in choosing 

between Native SQL and Pass-Through SQL you must decide which is more important: 

performance, or the ability to use SQL that is not permitted in a subquery. 

Generally, you should only use Pass-Through SQL if you need to create a query subject that 

contains data source specific constructs that can not be used inside a derived table, such as a 

With or Order By clause. 

User Guide 63


SQL Generation 

Note: SQL specified in Framework Manager and processed by the database, whether native or 

pass-through, must be completely self-contained. It must not reference anything outside of that 

SQL, such as database prompts or variables that would normally be supplied by the calling 

application. 

The SQL Generation setting determines how Framework Manager generates the SQL that 

retrieves data from relational data sources. You can change how Framework Manager 

generates SQL when you edit a data source (p. 55) or model (p. 59) query subject. 

Tip: To see how this setting affects the generated SQL for a query subject, click the Preview tab 

in the Edit Definition dialog. 

Note: the SQL Settings tab is disabled for query subjects that are based on SAP BW data 

sources. 

The SQL Generation type of a query subject can either be set to either As View or Minimized. 

By default, the SQL Generation type is set to Minimized. This means that the generated SQL 

contains only the minimal set of tables and joins needed to obtain values for the selected query 

items. When the generation type is set to As View, Framework Manager generates queries that 

contain the full SQL statement of the query subject. 

Using Minimized SQL improves performance, resulting in a query that executes significantly 

faster. Generating Minimized SQL is especially beneficial for query subjects that represent 

dimension tables. By using a single model query subject to model a dimension you can get the 

benefit of small SQL queries that execute significantly faster. 

For example, the SQL Generation Type of the following query subject is set to As View. Note that 

this query subject contains a nested select statement. 

select 

New_Query_Subject.COUNTRYCODE as COUNTRYCODE, 

New_Query_Subject.EUROINUSESINCE as EUROINUSESINCE 

from 

(select 

CONVERSIONRATE.COUNTRYCODE as COUNTRYCODE, 

COUNTRY.EUROINUSESINCE as EUROINUSESINCE 

from 

"2 - GOSales1 - OLE-DB".GOSALES1.dbo.CONVERSIONRATE CONVERSIONRATE, 

2 - GOSales1 - OLE-DB".GOSALES1.dbo.COUNTRY COUNTRY 

where 

(COUNTRY.SALESCOUNTRYCODE = CONVERSIONRATE.COUNTRYCODE) 

) New_Query_Subject 

If you change the SQL Generation Type to Minimized, Framework Manager generates the 

following simplified SQL. 

select 

CONVERSIONRATE.COUNTRYCODE as COUNTRYCODE, 

COUNTRY.EUROINUSESINCE as EUROINUSESINCE 

from 

"2 - GOSales1 - OLE-DB".GOSALES1.dbo.CONVERSIONRATE CONVERSIONRATE, 

"2 - GOSales1 - OLE-DB".GOSALES1.dbo.COUNTRY COUNTRY 

where 

(COUNTRY.SALESCOUNTRYCODE = CONVERSIONRATE.COUNTRYCODE) 

Minimized SQL works best when the returned result sets of each query item are equivalent. If 

there are records in one column that do not correspond to records in another column, the result 

of the Minimized query produces additional rows. You can avoid this by setting the SQL 

generation type value to As View. 

For example, if there are ProductTypes that are not used by any of the Products and these 

ProductTypes all have a common ProductLine, a ProductLine is reported for which there are 

ProductTypes, but for which there are no related Products. 

Merge Metadata To Create a New Query Subject 

In addition to creating query subjects from scratch (p. 54), for you can select existing model 

objects and merge them into a new query subject. This lets you reuse existing metadata to 

quickly create query subjects. 



Note: This feature does not apply to SAP BW metadata. 

The objects you can merge include 

• model and data source query subjects and their shortcuts 

• query items, filters, and calculations in model and data source query subjects 

• relationships and relationship shortcuts between model and data source query subjects 

You can merge any number of the same type of objects into a new query in a single operation. 

The merge usually creates a new data source query subject. It creates a new model query 

subject only when the original query subjects are all model queries. 

Framework Manager generates the name of the new query subject by appending the name of 

the first query subject to the name of the last query subject. A unique number is appended to 

duplicate query item names. 

Framework Manager retains any existing relationships between the original query subjects and 

query subjects that are not included in the merge. However any relationships that exist between 

the query subjects that are being merged is ignored, to avoid self-joins. When you merge query 

items, only the relationships that the items participate in are replicated. 

The new query subject contains any filters that exist in the original query subject. No keys or 

indexes are created for the new query subject. 

Steps 

1. Ctrl+click the objects you want to merge into a single query subject. 

Using a shortcut to a query subject or relationship is equivalent to using the referenced 

object. 

2. Click Action, Merge in New Query Subject. 

The new query subject appears. 

Transform a Relationship into a Query Subject 

In addition to creating a query subject from scratch (p. 54), you can create a query subject that 

is based on the metadata in an existing relationship. This process is similar to merging metadata 

to create a query subject (p. 64). 

Note: This feature does not apply to SAP BW metadata. 

Steps 

Relationships 

1. Click a relationship. 

2. Click Action, Transform into Query Subject. 

The new query subject appears. 

A relationship describes a connection between two query subjects. When Framework Manager 

imports metadata, it creates relationships between query subjects based on the joins in the data 

source. You can add or remove relationships between query subjects so that the model better 

represents the logical structure of your business. 

After you import metadata you should verify that the relationships you require exist in the 

project. This is particularly true for data warehouses, since, to increase processing speed, many 

primary and unique key constraints are not specified in a data warehouse. Without these 

constraints, Framework Manager cannot generate the necessary relationships between fact 

tables and dimension tables. 

Tip: In the Summary pane, click Relationship to display all the join objects and highlight the 

columns that participate in relationships. You can also use the Search feature to find an object 

that matches specific conditions. 

User Guide 65


Framework Manager stores relationships in the nearest common parent of the query subjects 

that participate in the relationship. The parent can be either a folder or a namespace. If you 

move one of the participating query subjects outside of the common parent, the relationship 

moves to the next namespace that is common to both ends of the relationship. 

For information about namespaces, see "Create a Namespace" (p. 25). For information about 

folders, see "Create a Folder" (p. 89). 

Cardinality and Notation 

Cardinality is a property of a relationship that describes the association between two query 

subjects, query items, or other model objects. By default, Framework Manager uses Merise 

notation to express cardinality: 

• 0..1 (zero or one match) 

• 1..1 (only one match required) 

• 0..n (zero or more matches) 

• 1..n (one or more matches required) 

Tip: To use Crowsfeet notation, while in the Object Diagram pane, click Diagram, Notation, 

Crowsfeet. 

The first part of the notation specifies whether the relationship is optional (0) or mandatory (1). 

The second part defines the relationship of query items between the query subjects (1=1, 

n=many). When you interpret cardinality, you must consider the notation that appears at both 

ends of the relationship. 

By default, Framework Manager assigns a cardinality of 1:1 to 1:n (inner join) for each data 

source relationship that is based on a primary key and a unique key constraint, respectively. The 

same assumption is made for a relationship between a unique index and non-unique index. If 

both indexes are unique, the cardinality will be 1:1 to 1:1. 

For relational metadata, you can change the criteria for how Framework Manager detects 

relationships and assigns cardinality. For information about importing metadata, see "Importing 

Metadata" (p. 25). For information about detecting relationships, see "Detect 

Relationships" (p. 69). 

For SAP BW metadata, you can override the default behavior of Framework Manager by setting 

the outer join governor to "allow". When you do this, all relationships are generated as outer 

joins. For information about setting governors, see "Set Governors" (p. 95). 

Operators and Expressions 

In Framework Manager, you can create complex expressions by taking two or more 

relationships and joining them using an operator, such as , or =. Use complex expressions to 

create custom relationships that help minimize the complexity of the data in your diagram. 

You can specify the operator by selecting one from the list or by manually changing the 

expression in the Expression Editor. 

Recursive Relationships 

Refine Query Paths 

When you import metadata, Framework Manager displays self-joins in the diagram, but does not 

execute them as queries. While you can view the metadata that defines the relationship, you 

cannot edit a recursive relationship in Framework Manager. 

To modify a relationship that exists as a self-join in the data source you can create a shortcut of 

the query item with which the table has a recursive relationship and define a relationship 

between the query subject and the shortcut. 

You can add and remove relationships between query subjects so that the package better 

represents the logical structure of your business. 

Note: You cannot add or edit relationships between query subjects that are based on SAP BW 

objects. 



There are several things that you can do to optimize query path selection and return accurate 

result sets. The imported metadata may contain ambiguous relationships, which are caused by 

multiple paths between two query subjects in the project. When a query runs, there may be 

more than one way to relate the two query subjects to create a query. 

How you resolve ambiguous relationships depends on whether they are 

• redundant relationships 

Redundant relationships are those that return the same result set. For example, query 

subject A is joined to query subject B both directly and through query subject C. Because 

both of these relationships return the same result set, you do not need them both. While this 

is not a problem in terms of query results, you may want to simplify the project by deleting 

the redundant relationships. 

• non-redundant relationships 

Non-redundant relationships are those that return different result sets. Unintended result 

sets may be returned if the query chooses a different path than the one intended by the 

user, for example, the path between query subject A and query subject B may return a 

different result set than the path that includes query subject C. 

For information about removing resolving ambiguous relationships that return different 

result sets, see "Resolve Ambiguous Relationships" (p. 67). 

Resolve Ambiguous Relationships 

It is common in the design of databases, and in the queries that run against them, for there to be 

more than one way to join tables. Because query results depend on the join selected, you must 

model these relationships so that the report authors can create the reports they need. 

In Framework Manager, relationship weighting is based on scope. Relationships in the same 

folder as the query subject are used first, those in the parent are used second, and so on. For 

example, if query subjects A and B, the relationship between them is also in that folder. 

However, if query subject C is in a sibling folder, the relationship between A and C is in the 

parent folder. 

Direct-Path Relationship 

Framework Manager lets you create shortcuts of query subjects to model more that one 

relationship between query subjects. Shortcuts are duplicate objects with unique names, 

allowing them to participate in different relationships from the original query subject. When you 

create a relationship between one or more shortcuts, you can use a shortcut to one of the 

original relationships (p. 68). 

Framework Manager lets you organize query subjects and relationships into folders (p. 89). 

When a query is executed, ReportNet chooses the relationship in the parent folder of the query 

subjects being joined. Because you create the folder, the report author does not have to 

understand the details of the underlying data structure. 

Indirect-Path Relationship 

When you import metadata, Framework Manager identifies many-to-many joins and generates 

the model objects that are necessary to resolve potential reporting errors. For example, if you 

import three tables that have many-to-many joins, Framework Manager generates a separate 

query for each fact table and joins the result sets. 

Because Framework Manager must interpret the structure of your data source, you should verify 

the relationships that are created to ensure that they correctly reflect your users business 

requirements. 

Create a Relationship 

You create a relationship to join logically related query subjects that report authors want to 

combine in a single report. This is useful for relationships between query subjects that were not 

selected during import, were not joined in the data source, or are from multiple data sources. 

You can also use Framework Manager to automatically generate relationships (p. 69) between 

query subjects based on selected criteria. 

User Guide 67


Steps 

1. Ctrl+click two or more query subjects or query items. 

Note: In the diagram view, you can also select a query item in a shortcut to create a 

relationship. 

2. Click Actions, Create, Relationship. 

If this relationship is a valid target for a relationship shortcut, a dialog appears that asks if 

you want to create a relationship shortcut. 

3. Click OK. 

The Relationship Definition dialog box appears. You can use this dialog box to modify the 

relationship. 

Modify a Relationship 

After you create a relationship in Framework Manager you can rename it, redefine cardinality, 

change the join type, or change the name of the relationship. You can also use the expression 

editor to create complex relationship expressions. For example, you can use functions to join 

query subjects based on similar query items, such as: FirstName + LastName = 

EmployeeName. 

Note: If your metadata is based on an SAP BW data source, you cannot modify a relationship. 

Steps 

1. Click a relationship and click Actions, Edit Definition. 

The Relationship Definition dialog box appears. 

2. Modify the relationship. 

Goal 

Modify existing 

elements 

Create an 

additional join 

Create a 

complex 

expression 

Test the 

relationship 

Action 

In the Relationship Expression tab, select the 

query items, cardinalities, and operator you 

want. 

The query items must have the same data type. 

Click New Link, and define the new 

relationship. 

In the Relationship Expression tab, click the 

ellipses button, define the expression, and click 

OK. 

Tip: If you insert session parameters (p. 80) or 

prompts (p. 70) and you want to specify the 

values that they represent when you test the 

expression, click the options button. 

In the Relationship SQL tab, identify the 

number of rows you want returned and click the 

test button. 

3. Click OK. 

Create a Relationship Shortcut 

A relationship shortcut references an existing relationship. You can use relationship shortcuts to 

reuse the definition of an existing relationship. Any changes to the source relationship are 

automatically reflected in the shortcut. You can also use relationship shortcuts to resolve 

ambiguous relationships (p. 66) between query subjects. 



Detect Relationships 

Framework Manager asks if you want to create a relationship shortcut whenever you create a 

relationship and both of the following conditions apply: 

• At least one of the ends for the new relationship is a shortcut. 

• A relationship exists between the original query subjects. 

Steps 

1. Ctrl+click the query subjects that you want to participate in the relationship shortcut. 

2. Click Actions, Create, Relationship. 

Framework Manager asks if you want to create a shortcut to that relationship. 

3. Click Yes. 

A list appears of all relationships in which one end is a model object and the other end is 

either another model object or a shortcut to another model object. 

4. If you want to perform an exhaustive search, click the Find All button. 

An exhaustive search retrieves all relationships in which both ends can be either a model 

object or a shortcut to a model object. 

5. Click the relationship that you want to be the target of the relationship shortcut. 

6. Click OK. 

You can use Framework Manager to detect and generate relationships between two or more 

existing query subjects in your model. This is useful when you import metadata in stages, or 

when you want to change the criteria that apply to existing relationships, such as whether they 

include outer joins. 

When importing star schema metadata, avoid generating relationship based on matching 

column or query item names. Data warehouses often apply naming standards to columns, such 

as surr_key as the default column name for surrogate keys in dimensions. In this case, 

generating relationships that are based on matching column names would generate 

inappropriate relationships between all dimension tables. 

You can also manually create relationships (p. 67) between query subjects. 

Steps 

1. Ctrl+click two or more query subjects. 

2. Click Actions, Detect Relationships. 

The Detect Relationships dialog appear. 

3. Select the rules you want to apply to each pair of tables. 

Rule 

Result 

Use primary and 

foreign keys 

Use matching 

query item names 

that represent 

uniquely indexed 

columns 

Use matching 

query item names 

Creates joins that are based on primary key 

and foreign key relationships. The query item 

names do not have to match. 

Creates joins between query items whose 

names and data types match, if one or both of 

the underlying columns are uniquely indexed. 

Creates joins between query items whose 

names and data types match. 

This option is recommended if you want to 

generate as many relationships as possible. 

User Guide 69


Query Items 

Format Query Items 

4. Indicate whether you want Framework Manager to detect relationships 

• between the selected query subjects 

• between each selected query subject and every query subject in the project that is not 

selected 

• between the selected query subjects and every other query subject in the project 

5. Identify whether you want Framework Manager to create outer joins, or convert them to 

inner joins, when outer joins exist in the data source. 

6. Click OK. 

Because reports are composed of different query items from one or more query subjects, query 

item properties control many aspects of the final report. When you create a model query 

subject, the query items inherit the properties of the data source query items on which they are 

based. 

You can modify the properties of query items that are based on relational data to 

• set Usage and Aggregation properties (p. 74) to reflect the intended use of the query item 

• format query items to control how data appears in a report 

• identify a column as a prompt, and control how the prompt information is presented to the 

report author 

For SAP BW metadata, you can only modify text-based properties, such as the name, caption, 

or screen tip. 

For information about viewing and modifying properties see "Modify Properties" (p. 88). 

You can use the format property of a query item to define how information appears in a report. 

The format property lets you choose a format type, such as Text, Date, and Currency. Each 

format type contains properties that further specify how the data appears. 

For example, you can assign the Currency format type to a numeric query item, and then use 

the No. of Decimal Places property to specify how many decimal points are displayed in the 

report. 

Some characters are language sensitive and appear properly only when your locale supports 

the applicable font. For example, for Japanese currency symbols to appear correctly, your locale 

must be set to Japanese. 

Steps 

1. In the Project Viewer pane, select the query item you want to format. 

2. In the Properties pane, click the Format property, and then click the ellipses button. 

The Data Format dialog box appears 

3. Select the appropriate Format type. 

Note: For SAP BW metadata with currency values, set this to "currency". This ensures that 

currency formatting is applied to all types of reports. 

4. If you want to format the property for every language defined in the project, select the All 

Languages check box. 

5. In the Properties field, select or type the appropriate property value. 

Define a Prompt Control 

Prompts help users quickly find the information they need from a report. Although prompts are 

generally defined in the reporting tool, you can change the definition of the query subject in the 

model so that a prompt appears automatically when report authors create filters. This is useful 

for query items, such as ProductTypeCode, whose values are not displayed in a report, but are 

useful for filtering data. 



In Framework Manager, prompt behavior is defined through a compound query item property 

named Prompt Info. Prompt Info contains the following properties that affect how prompt 

controls are generated by ReportNet. 

Prompt Type 

The Prompt Type property sets the type of prompt control that the reporting application 

generates at run time, such as an edit box or a pull-down list. The default value for this property 

is Server Determined. 

Value 

Server 

Determined 

Edit Box 

Select Date 

Select Date Time 

Select Interval 

Select Time 

Select Value 

Select With 

Search 

Prompt Control 

One of the prompt controls listed below, based on 

information in the server, such as the data type of 

the query item. 

A simple text box. If the data type of the column is 

date or dateTime, this value generates a date or 

date-time control as well as the text box. 

A date control with a calendar interface. 

A date-time control with a calendar interface. 

For SAP BW metadata, this value is not relevant. 

A date-time interval control. 


A time control that filters data based on the 

selected time period. For example, if you define a 

selectTime prompt for Order Time, the user can 

use the time control to show all orders placed 

after 1:00, or all the orders placed between 10:00 

and 11:00. 

A drop-down list. 

A list control that allows users to search for 

values. 


Cascade On Item Reference 

The Cascade on Item Reference property indicates that the generated prompt is part of a series 

of generated cascading prompts. The query item that you reference in this property is the parent 

item in the cascade. The system will prompt the user for the cascade item before prompting 

them for the current query item. For example, if you want to prompt for the Product Line and 

then the Product within the selected line, set the Cascade On Item Reference property of the 

Product query item to Product Line. 

Display Item Reference 

The Display Item Reference property identifies the query item that the prompt shows if it is 

different from the query item whose properties you are editing. For example, if you want to 

prompt the user for Product Number but show the Product Name to the user, set the Display On 

Reference property of the Product Number query item to Product Name. This property is used 

only for data driven prompt controls whose Prompt Type properties are set to either Select Value 

or Select With Search. 

User Guide 71


Filter Item Reference 

The Filter Item Reference property identifies an alternative query item that is used by any Query 

Studio or Report Studio filters. This property is used only when the reporting tools generate a 

filter. This property helps create more efficient queries, because it is more efficient to filter on an 

indexed numeric column than a non-indexed string column. 

For example, for a report author to create a Product Name filter that uses the values in Product 

Number, you can set the Filter Item Reference property of Product Name to Product Number. 

You can also set the Display Item Reference property of the Product Number query item to 

Product Name, so that the user is prompted to select a name rather than a product number. 

Steps 

1. Click the query item. 

2. In the Properties pane, click the plus sign (+) next to the Prompt Info property. 

3. Modify the prompt properties to reflect the behavior you require. 

Usage and Aggregate Properties 

In addition to being used to drive transformations in Framework Manager (such as the star 

scheme transformation), usage property values are used to determine the aggregation rules of 

query items and calculations. These rules are applied when the report author creates a report 

that aggregates this query item or calculation, unless they override it in the report definition. 

During import, Framework Manager assigns usage and aggregation property values to each 

query item you import. When you create a model query subject, each query item inherits the 

usage and aggregation properties of the query item on which it is based. 

Usage Property 

The usage property identifies the intended use for the data represented by each query item. 

During import, the usage property is set according to the type of data that the query items 

represents in the data source. 

Database 

object 

SAP BW 

object 

Usage 

property 

Purpose 

key, index, 

date, 

datetime 

hierarchy 

level 

Identifier 

Represents a column that is used 

to group or summarize the data in 

a Fact column with which it has a 

relationship. 

numeric, 

timeinterv 

al 

key figure Fact Represents a column that 

contains numeric data that can be 

grouped or summarized, such as 

Product Cost. 

string attribute Attribute Represents a column that is 

neither an Identifier or Fact, such 

as Description. 

Note: If data meets multiple criteria these rules are applied in the order in which they are listed. 

For example, if you import a numeric column that participates in a relationship, the usage 

property is set to "identifier". 

Regular Aggregate Property 

The Regular Aggregate property identifies the type of aggregation that is associated with the 

query item or calculation when you publish it. The report author can either use this default 

setting to perform calculations on groups of data, or use the reporting application to apply a 

different type of aggregation. 



For example, if the Regular Aggregate property value of the query item "Quantity" is "sum", and 

the report author groups it by Product Name, the Quantity column in the report displays the total 

quantity of each product. 

During import, Framework Manager uses the "usage" value to determine the value of the 

Regular Aggregate property of each query item. 

Usage 

property 

identifier, 

count, 

attribute 

fact 

Regular Aggregate 

property value 

unsupported 

sum 

When you create a calculation (p. 75) that depends on other query items, Framework Manager 

sets the Regular Aggregate property to "automatic", to identify that the aggregation is an 

expression defined in the project. When you do this, the report uses the expression defined in 

the model. 

Semi Aggregate Property 

For relational metadata, the semi-aggregate property value is set to unsupported and is 

read-only. 

For SAP BW metadata, the semi-aggregate property displays the value that is set in the data 

source, and the property is read-only. If you change the regularAggregate property value of a 

query item, any semi-aggregate value other than "unsupported" is ignored. 

If the semi-aggregate value is set to "unsupported" in Framework Manager, the semi-aggregate 

behavior is ignored in the reporting application. 

Modify Usage and Aggregate Properties 

You can change existing usage and Regular Aggregate property values by: 

User Guide 73


❑ modifying the values in the Properties pane (p. 88), 

This lets you select additional aggregation values that are not available through import, such 

as average and maximum. You must understand what the data represents in order to know 

what aggregation rule is required. For example, if you aggregate a part number, the only 

aggregate values that apply are count, countDistinct, countNonZero, maximum, and 

minimum. 

The following aggregation values are supported for relational data sources: 

• unsupported 

• automatic 

• calculated 

• avg 

• count 

• min 

• max 

• sum 

The following aggregation values are supported for SAP BW: 

• COUNT 

• COUNT NOT ZERO 

• AVG 

• AVG NOT ZERO 

• CALCULATED 

• AUTOMATIC 

• MIN 

• MAX 

• MEDIAN 

• STDDEV 

• VAR 

• SUM 

Note that COUNT NOT ZERO and AVG NOT ZERO are supported only when the value is 

set during import. You cannot change an aggregate property from its imported value to 

COUNT NON ZERO or AVG NOT ZERO. 

❑ automatically regenerating the values of selected objects 

This lets you ensure that these values are appropriate for the type of data they represent. 

Note: If you change an aggregation value for SAP BW metadata the aggregation cannot 

perform time-based queries because the aggregation rules are not applied. 

Regenerate Usage and Aggregation Property Values 

Using Framework Manager to regenerate usage and aggregation property values ensures that 

they reflect the transformation rules. It is useful to regenerate these values before you publish a 

package to ensure that these properties reflect modifications to your model. 

When generating aggregation values, Framework Manager assigns a value that is based on the 

usage property value, and the type of model object it is. 

Usage property 

identifier, count, attribute 

fact 

Regular Aggregate property value 

unsupported 

sum 



Steps 

1. In the Project Viewer pane, select one or more query subjects. 

2. In the Properties pane, change the value of the 

• usage property to unknown 

• Regular Aggregate property to unsupported. 

3. Click Actions, Determine Usage. 

4. Click Actions, Determine Aggregation Rules. 

Adding Business Rules 

Create a Calculation 

You can add business rules to the query subjects in your model to refine the data retrieved and 

ensure that the right information is available for report authors. You can 

• add calculations so that report authors can include calculated data in their reports 

• create and apply filters so that you can limit the data that a query subject retrieves 

• add prompts so that users are prompted to filter data when they open a report 

• use session parameters and parameter maps to create dynamic queries 

You can create calculations to provide report authors with calculated values that they regularly 

use. Calculations can use query items, parameters, expressions, and expression components, 

such as functions. 

Framework Manager supports two types of calculations: stand-alone, and embedded. Create 

stand-alone calculations when you want to use reuse the expression by doing any of the 

following: 

• apply it to one or more query subjects to provide calculated data to a report 

• include it in a package to make it available to your report authors 

• move it, or a shortcut to it, into a folder to further organize your model objects 

If you want to use the calculation with only one query subject, you can create an embedded 

calculation while modifying the data source query subject (p. 55) or model query subject (p. 59). 

Tip: If you start with an embedded calculation, you can later convert it into a stand-alone 

expression that you can apply to other query subjects. To do this, right-click the calculation 

expression in the query subject editor and click Convert to Stand-Alone Calculation. 

At query time, Framework Manager returns a null value for any calculation that contains a 

divisor whose value is zero. Framework Manager cannot detect zero-division errors in functions 

such as AVG and MOD, because the division operator is not explicit. 

Steps 

1. Click the model folder and click Actions, Create, Calculation. 

The Calculation Definition dialog box appears. 

2. Define the expression. 

Goal 

Add model 

objects 

Add functions 

(p. 119) 

Add parameters 

(p. 81) 

Action 

On the Model tab, click a query item, filter, or 

calculation and click the arrow. 

On the Functions tab, select a component and 

click the arrow. 

On the Parameters tab, click a parameter and 

click the arrow. 

User Guide 75


Goal 

Limit test results 

Override 

session 

parameters 

(p. 80) 

Action 

Click the options button and change the 

number of rows that are returned on the 

Results tab. 

Click the options button, click the Set button, 

enter a value in the Override Value field, and 

click OK. 

Create a Filter 

3. Click OK. 

4. Modify the dataType property (p. 88) to identify the type of data the calculation returns. 

The reporting application uses this information to format the data that the calculation 

returns. 

A filter is an expression that specifies the conditions that rows or instances must meet to be 

retrieved for the query subject, calculation, or report to which the filter is applied. A filter returns 

a Boolean value, equivalent to the predicate in the Where clause in an SQL statement, so that 

you can limit the rows returned by a query subject. 

Framework Manager supports two types of filters: stand-alone, and embedded. Create 

stand-alone filters when you want to use reuse the expression by doing any of the following: 

• add it to one or more query subjects to limit the data that the query retrieves when the 

filtered query subject is used in a report 

• include it in a package to make it available to your report authors 

• move it, or a shortcut to it, into a folder to further organize your model objects 

If you want to use a filter with only one specific query subject, you can create an embedded filter 

while modifying either a data source query subject (p. 55) or model query subject (p. 59). 

Tip: If you start with an embedded filter, you can later convert it into a stand-alone expression 

that you can apply to other query subjects. To do this, right-click the filter expression in the query 

subject editor and click Convert to Stand-alone Filter. 

You can also restrict the data that the queries in a package retrieves by applying governors 

(p. 95). 

Steps 

1. Click the model folder and click Actions, Create, Filter. 

The Filter Definition dialog box appears. 

2. Define the expression. 

Goal 

Add query items 

and filters 

Add functions 

(p. 119) 

Add parameters 

(p. 81) 

Action 

In the Available Objects pane, click the Model 

tab and drag the objects to the Expression 

Definition box. 

In the Available Objects pane, click the 

Functions tab and drag the functions to the 

Expression Definition box. 

In the Available Objects pane, select the 

Parameters tab and drag the parameters to the 

Expression Definition field. 



Goal 

Action 

Limit test results Click the options button and change the number 

of rows to be returned on the Results tab. 

Override 

session 

parameters 

(p. 80) 

Click the options button, click Set, enter a value 

in the Override Value field, and click OK. 

3. Click OK 

Applying a Filter 

To apply a filter, you must modify the data source query subject (p. 55) or model query subject 

(p. 59). Note: The query subject must either contain the query item(s) that the filter references, 

or have a relationship path to the query subject(s) that contain the query item(s). 

When you apply a filter, you specify how it is used by selecting one of the following usage 

values. 

Usage 

Always 

Design Mode Only 

Description 

The filter is applied whenever the query subject 

is executed, regardless of whether the report 

contains the query item that is filtered. Always is 

the default usage value. 

Use this usage value to filter data that you want 

to ensure is filtered out of all reports. For 

example, your company may have obsolete 

information that it stores but does not want to 

report on. 

Limits the amount of data that the report authors 

and modelers retrieve while designing. By 

limiting data retrieval, design-time results are 

displayed much more quickly. You can have only 

one Design Mode filter for each query subject. 

This is the only value that you can assign to a 

filter that is applied to a multidimensional query 

subject. 

Example - Create and Apply a Filter 

You want to create a query that displays the currency name for a specific country. To do this, you 

create a filter that returns the data for a specific country code, and apply the filter to a model 

query subject that retrieves the currency name for each country. 

Note: The following example uses a relational data source. 

Steps 

1. Open the gosales_goretailers sample model. 

It is located in 

installation_location/crn/webcontent/samples/Models/gosales_goretailers/gosales_g 

oretailers.cpf. 

User Guide 77


Use a Prompt Value 

2. Create a filter to limit the retrieval of data to only those country codes in the conversion rate 

table whose value is "2". 

• Click the Filters folder, select Actions, Create, Filter, and name the new filter 

ConversionRateCountryCode. 

• From the Database view folder in the Model tab, open the GoSales folder. 

• Select Conversion rate.Country code, click the arrow to add it to the Expression 

definition pane, and type in the rest of the following expression: 

[gosales_goretailers].[Conversion rate].[Country code] = '2' 

• Click OK. 

3. Create a model query subject named ISO Code, and apply the 

ConversionRateCountryCode filter. 

• From Database view, drag Country.Country and Country.ISO 3-letter code into the 

Query Items and Calculations pane. 

• From the Filter folder, drag ConversionRateCountryCode to the Filters pane. 

4. Click Preview. 

The generated SQL contains the filter, even though it does not affect the result set. 

5. Change the usage of the ConversionRateCountryCode filter to As Needed. 

6. Click Preview. 

Because the query item in the filter and the query items in the select list are not from the 

same, the filter is not visible in the generated SQL. 

You can substitute a prompt for a value to enable users to filter data by typing a value when the 

report opens. 

In general, it is better to define type-in prompts in the reporting application to make use of the 

additional prompt features. However, there are some variables that report author cannot modify. 

For these, you can use Framework Manager to define type-in prompts. 

You can use prompts in: 

• parameter maps 

• session parameters 

• stored procedure arguments 

• expressions, including filters, calculations, and relationships 

The syntax for using a prompt as a value is: 

?? 

For example, if a stored procedure returns all rows with a specific part number, instead of using 

the part number as the argument for the stored procedure, you can use a prompt, such as 

?Part_Number?. 

When you test a model object that references a prompt, Framework Manager asks you to enter 

the prompt value. Framework Manager uses this value for either the duration of the session, or 

until you clear the prompt value. 

You can change the session value of prompt values through the Options dialog box. This dialog 

box is available when you modify a query subject (p. 59) or define a calculation (p. 75), filter 

(p. 76), or complex relationship (p. 68). This lets you change the prompt value at the time that 

you are testing the expression referencing that value. 

If you enable the always prompt for values check box in the Prompt dialog box, Framework 

Manager prompts you for a value every time you test the object. This check box only applies to 

testing, when updating the object or performing a count, Framework Manager uses the existing 

prompt value, if one exists. 

You can also set up prompt properties for query items. For more information, see "Define a 

Prompt Control" (p. 70). 



Create a Parameter Map 

Use parameters to create conditional query subjects that allow for substitutions at report run 

time. Parameter maps are similar to data source look-up tables. Each parameter map has two 

columns, one for the key and one for the value that the key represents. Keys and values can be 

manually entered, imported from a file, or based on existing query items in the model. 

Note: If you are using SAP BW metadata, you cannot use a query item to generate the keys and 

values of a parameter map. 

All parameter map keys must be unique so that Framework Manager can consistently retrieve 

the correct value. Do not place quotation marks around a parameter value. You can use 

quotation marks in the expression in which you use the parameter. 

The value of a parameter can be another parameter. However, you must enclose the entire 

value in number signs (#). You cannot have a nesting of parameters as values that exceeds five 

levels. 

For information about using parameters, see "Using a Macro" (p. 81). 

Steps to Manually Enter or Import Parameter Map Values 

1. Click the Parameter Maps folder, and click Actions, Create, Parameter Map. 

2. In the Name box, type a name for the new parameter map. 

3. Click Manually enter the parameter keys, and/or import them from a file and click Next. 

4. Do one of the following: 

• To manually enter values, click New Key, type a key, and press Tab to enter a value for 

that key. 

• To import keys and values, click Import File and identify the location of the appropriate 

.csv file. You can import from a .txt file only if the values are separated by tabs rather 

than commas. 

Note: If you are going to use a parameter in a data source query subject, the value must 

use English specific punctuation. This means that you must use a period (.) to represent a 

decimal and a comma (,) to separate lists of values. 

5. You can modify existing parameters by doing the following. 

Goal 

Assign a 

default value 

Remove a 

parameter 

Modify a 

parameter 

Clear all keys 

and values 

Action 

Type a value in the Default Value field. 

Framework Manager uses the default value if a 

key has an invalid value. 

Select a row and click Delete. 

Select the row you want to modify, click the Edit 

button, and type a value. 

Click Clear Map. 


Steps to Create a Parameter Map Based on Existing Query Items 

1. Click the Parameter Maps folder and click Actions, Create, Parameter Map. 

2. In the Name box, type a name for the new parameter map. 

3. Click Base the parameter map on existing Query Items and click Next. 

4. In the Select Query Items for Parameter Map box, select the key and value you want from 

the list of query items in the model, and click Next. 

Note: You must select the key and value from the same query subject. 

User Guide 79


5. Define the default values. 


Create a Session Parameter 

A session parameter is a variable that Framework Manager associates with a session. For 

example, user ID and preferred language are both session parameters. Because session 

parameters are key and value pairs, you can think of each session parameter as an entry in a 

parameter map called Session Parameters. You use a session parameter in the same way that 

you use a parameter map entry, although the syntax for session parameters is slightly different. 

There are two types of session parameters: environment and model. Environment session 

parameters are limited to 

• account.defaultName 

• account.personalInfo.userName (only applicable if a user has not logged on anonymously) 

• runLocale 

and are predefined and stored in Content Manager. If you need a session parameter that does 

not exist, you can create a model session parameter. Model session parameters are stored and 

set within the project, and can be published with a package. 

Model session parameters must have their values set within the scope of objects in the 

Framework Manger model. The scope can include the use of existing environment session 

parameters, as well as static values. 

In Framework Manager, you can define additional parameters using session parameters. For 

example, the parameter userName could be defined using the account.defaultName session 

parameter. The syntax would look like the following: 

userName = #$account.defaultName# 

For more information on syntax, see Using a Macro. 

Each session parameter must have a name and a default value. You can define an override 

value to test the results that value returns. The override value is valid only while you have the 

model open, and is not saved when you save the model. If no override value exists, Framework 

Manager uses the default value when it executes a query that contains a session parameter. 

For information about using stored procedures, see Modify a Stored Procedure Query Subject. 

Steps 

1. Click Project, Session Parameters. 

2. Click New Key and type a session parameter key and value. 

• To avoid having to set the override value every time you edit the project, set the session 

parameter as a value. 

• To avoid having to remove the project setting each time before you publish it, set the 

session parameter as a session override. 

3. You can modify existing parameters. 

Goal 

edit the 

parameter 

value 

Assign a 

default value 

Action 

Select the row you want to modify, click Edit, and 

type a value. 

Type a value in the Default Value box. 

Framework Manager uses the default value if a 

key has an invalid value. 



Goal 

Remove a 

parameter 

Clear an 

override value 

Action 

Click a row and click the Delete button. You 

cannot delete an environment session 

parameter. 

Click a row and click Clear Override. 

Using a Macro 


Macros are fragments of code that you can insert anywhere within the Select statement that 

defines a query subject. This code lets you include references to session parameters, 

parameter maps, and parameter map entries. Parameter values are populated when the query 

is executed. For example, you can use the "language" session parameter to display only the 

data that matches the language setting for the current user. 

Do not insert macros between existing quotation marks or square brackets because Framework 

Manager does not execute anything within these elements. 

For information about parameterized XML connection strings, see Parameterized XML 

Connection Strings. 

Use the following syntax to reference session parameter and parameter values. 

Object Syntax Example 

Session key $session_key #$my_account# 

Parameter map key $map{} #$map_one{’abc’}# 

Parameter map 

entry whose key is 

defined by a 

session parameter 

$map{$session_k 

ey} 

#$map_one{$my_account}# 

When you reference a parameter, you must 

• use a number sign (#) at the beginning and end of each set of one or more parameters. 

Everything between the number signs is treated as a macro expression, which is executed 

at run time. 

• precede each parameter map entry with a dollar sign ($) 

• use a name that starts with an alpha character (a..z, A..Z) 

User Guide 81


You can add the following elements to further define the macro expression. 

Symbol 

Single quotation 

marks 

Square brackets 

Curly brackets 

Purpose 

Delineates a literal string that has a single 

quotation mark as part of the string. 

• If the single quotation mark appears in a string, 

such as a query item, the string must be 

enclosed in a single quotation mark on both 

sides of the string and the single quotation 

mark must be doubled. For example, ab'c is 

written as 'ab''c' 

• If the single quotation mark appears in a 

macro, the string must be enclosed in square 

brackets. For example, ab'c is written as [ab’c] 

• If the single quotation mark appears in a 

prompt, there is no need to enclose the string. 

To escape a single quotation mark in an 

expression, use ' 

Used to enclose: 

• model objects, such as a namespace or query 

subject. 

• macro names that contain restricted 

characters, such as a number sign, hyphen, or 

space. 

Calls a function that is unknown to the parser, such 

as dateadd in DB2, and whose first argument is a 

keyword. 

Example: 

dateadd ({month},2,) 

+ operator Concatenates two strings, such as 'abc' + 'xyz’. 

Single quote 

function (sq) 

Surrounds the result of a string expression with 

single quotation marks. Existing single quotes are 

"double-escaped" so that they do not interfere with 

the quote structure. You can use this function to 

build clauses to test against literal 

parameter-driven values. 

For example, if a session parameter (my_sp) has 

the value ab’cc, the result of 

#sq($my_sp)# 

is 

’ab"cc’. 



Symbol 

Double quote 

function (dq) 

Square bracket 

function (sb) 

Purpose 

Surrounds the result of a string expression with 

double quotation marks. You can use this function 

to refer to table and column names with 

non-identifier characters, such as a blank space or 

a percent sign (%). 

For example, if runLocale=en-us, the result of 

#dq ( 'Column' + $runLocale )# 

is 

"Column en-us" 

Inserts a set of square brackets into the argument 

to build object references in a model query and 

model expressions, such as filters and calculations. 

For example, if runLocale=en-us, the result of 

#sb ( 'my item in ' + $runLocale )# 

is 

[my item in en-us] 

You can replace the following query subject elements with a parameter: 

Object 

Query items identified in the 

Select list 

Tables identified in the From 

clause 

Where clause 

Name of the data source, 

schema, or source property 

Example 

#’Product_name_’+ $languageCode# 

Product_#$language# 

#Product_lang = #sq($languageCode)# 

#$data_source#.#$schema#.Products 

Using Parameters with Relational Data Source Query Subjects 

Model objects do not reflect changes to the data source objects on which they are based. 

Therefore, when you add a parameter to a data source query subject, consider whether you 

want to create a model object that references the parameter. If so, you must assign an alias to 

the parameterized object in the data source query subject. This ensures that any model query 

subjects, filters, or calculations, that reference the object remain valid when the parameter value 

changes. 

Example 

The following SQL defines a data source query subject that contains a session parameter, 

runLocale. The runLocale parameter value determines which column the query retrieves. The 

alias behaves like a shortcut, so that when a model object references CountryNameAlias, 

Framework Manager retrieves the value to which the alias is assigned. 

Select 

#$ColumnMap{$runLocale}# as CountryNameAlias 

From 

[GoSales].Country 

Therefore, by using aliases, you can ensure that model objects that reference data source 

parameters return the correct results after the parameters are changed. 

User Guide 83


Using Security by Value 

You can use a parameter map as an argument in the Framework Manager CSVIdentityName 

function. This function retrieves account, group, and role information for the current user. It 

returns a string of comma-separated values in single quotation marks, such as ’clerks’, 

’technicians’, and ’typists’. 

The name in the defaultLocale of each piece of identity information is used as a key into the 

specified map. You can use this function to build partial in-clauses or to filter data based on the 

identity name of the current user. 

Syntax 

CSVIdentityName(%map) 

Example 

The result of 

regionColumn in ( #CSVIdentityName ( %region_for_identity )# ) 

can be 

regionColumn in ('North America' , 'Europe') 

Example - Using Parameters 

An international company stores its Product and Customer information in both French and 

English tables. The company stores its Order information only in an English table. By creating 

the following parameter maps, they can use parameters to ensure that the query retrieves data 

that matches the information the user requires. 

LanguageSensitiveStatusTables 

Key 

P 

O 

Value 

#$ProductStatusTables {$runLocale}# 

#$OrderStatusTables {$runLocale}# 

ProductStatusTables 

Key 

en 

fr 

 

Value 

EN_ProductStatus 

FR_ProductStatus 

EN_ProductStatus 

OrderStatusTables 

Key 

en 

fr 

 

Value 

English_OrderStatus 

Order_Status_FR 

English_OrderStatus 

The following query subject retrieves the code and description data that matches the defined 

parameter values: 

SELECT code, description 

FROM #$LanguageSensitiveStatusTables {’p’}# 



If the value of the runLocale parameter is fr, this expression is equivalent to 

SELECT code, description 

FROM FR_ProductStatus 

Multilingual Support 

You can view and modify model objects in different languages and publish packages for use by 

multiple-language audiences. To support multilingual metadata, use Framework Manager to 

• import metadata (p. 25) from multilingual data sources (p. 37) 

• define the languages the model supports 

• use a macro (p. 81) to dynamically substitute language values when the report is run 

• export multilingual properties in translation tables, which translators use to enter the correct 

text for each language 

• import a translation table that contains the translated property values 

• publish the metadata in the languages you specify (p. 103). 

For an example of how these features work together to enable multilingual modeling, see 

"Example - Create a Multilingual Project" (p. 87). 

Use a Macro to Model Multilingual Data 

Framework Manager lets you model multilingual data that is stored in multiple tables, columns, 

or rows, for each supported language. You can use parameters to create query subjects that 

retrieve data in the preferred language of the person viewing the report. 

The location of a parameter within the query subject definition depends on the location of 

multilingual data in the data source. 

Multilingual data 

exists in 

tables, such as 

Product_en, 

columns, such as 

ProductName_en 

rows whose 

language is 

identified by a 

special column, 

such as LANG 

Parameter 

location 

From clause 

Select list 

Filter 

Example 

SELECT ProductName 

FROM Product_#runLocale# 

SELECT 

ProductName_#runLocale# 

FROM Product 

SELECT ProductName 

FROM Product 

WHERE 

Product_lang=#runLocale# 

Define Languages 

When you add a language to a project, Framework Manager generates a new property value for 

every multilingual property of each object in the project. A multilingual property is any text 

property that appears in a report, such as Name, Description, and Screen Tip. 

Note: When using SAP BW metadata, Framework Manager displays each supported language 

but does not import the metadata for each language you define. This is because the metadata 

that SAP BW displays is automatically determined by the language in which the user logs on. 

The new values that Framework Manager assigns to these text properties are a combination of 

the original property value preceded by the language code. For example, if a query subject is 

named Country, and you add the Dutch language, Framework Manager inserts a Name whose 

value is "(nl)Country". 

User Guide 85


Each project contains two types of language definitions: 

• The Design Language is the language in which the model was originally created. This value 

is stored in the model and cannot be changed. It serves as the default language value. 

• The Active Language identifies the language in which model content is currently displayed. 

This value is not stored in the model and you can change it at any time. 

Steps 

1. From the menu, click Project, Languages, Define Languages. 

The Define Languages dialog box appears. 

2. In Available languages, select each language you want to add and use the arrow button to 

move it to Project languages. 

Tip: To remove a language, select it in Project languages and use the arrow button to 

move it to Available languages. 

3. To change the active language, click a language in Project languages and click Set as 

Active. 

4. Click OK. 

A dialog box appears and asks you to accept the changes you made to the project. 

5. Click OK. 

Tip: To display multilingual property values in the Properties pane, click the Languages option 

at the top of the pane 

Export a Translation Table 

When modeling relational metadata, you can generate and export a translation table to make 

the task of translating model objects easier. The translation table contains a list of all the text 

strings defined for multilingual properties, such as Name, Description, and Screen Tip. 

Translators can then use an external application, such as Microsoft Excel, to type the required 

information into the table. 

You can export a translation table as either a comma-separated value file (.csv) or Unicode text 

file (.txt). You must export the translation table as a Unicode text file if it either contains a 

non-Latin language or will be imported by a computer with a language setting that is different 

from your own computer. 

Note: Because SAP BW Variables behave as custom properties, their text strings are not 

automatically exported in the translation file. 

Steps 

1. If you want to export only selected objects, select those objects. 

2. Click Project, Languages, Export Translation File. 

3. In Project Languages, click the languages you want to export, and click the arrow button to 

move them into the Languages to be exported field. 

Note: Framework Manager exports the appropriate locale code for each language you 

select. If you do not select all of the languages to be translated, you must enter the 

language codes into the first row of each new language column in the translation table. 

4. In Model objects to be exported, select whether you want to export all model objects, or 

export only pre-selected objects and their children. 

5. Enter the location to which you want to export the translation table. 

6. Click OK. 

Import a Translation Table 

You can add text property values for each language defined in your model by importing 

translated data from a file. The imported file must be a translation table that was exported to 

translators who entered the required translated values. 

The translation file can contain a subset of the languages defined for the project. 



Note: Because SAP BW Variables behave as custom properties, text strings are not 

automatically imported from the translation file. 

Steps 

1. Click Project, Languages, Import Translation File. 

2. In Project Languages, click the languages in the translation table, and use the arrow 

buttons to move them to the Translate from and Translate into fields. 

3. Enter the location of the translation file. 

4. Click OK. 

Example - Create a Multilingual Project 

You want to create a model that can be used by English, French, and German report authors. 

You also want the reporting tool to automatically display metadata in the language required by 

the report author. 

Steps to Translate Metadata 

1. Open the goSales_goRetailers project. 

2. Ensure that English, French, and German are supported languages. 

• Click Project, Languages, Define Languages. 

• Verify that the Project languages pane contains English, French, and German. 

• In the Project Viewer pane, click a query item and, on the Properties pane, click 

Languages. 

Note that for the name, description, and tool tip text, you now see one entry per 

language. 

3. Export all of the languages and objects in the project to a .csv file called GOSales ML.csv. 

• Click Project, Languages, Export Translation File. 

• In the Project Languages pane, Ctrl+click English, French, and German, and click 

the top arrow to move them into the Languages to be exported pane. 

• Identify the file location into which you want to export language metadata. 

4. Open the GOSales ML.csv file in Microsoft Excel, and translate the strings. 

Note that each column represents a given language, and the file only contains the text 

strings that exist in the model. 

5. In Framework Manager, import the translated file. 

• Click Project, Languages, Import Translation File. 

• In the Project Languages pane, Ctrl+click English, French, and German, and click 

the top arrow to move them into the Translate into pane. 

• Identify the file location from which you want to import language metadata. 

Steps to Use Parameters to Create a Multilingual Project 

You can modify the query subjects in the goSales_goRetailers project to display multilingual 

content by using the Language_lookup parameter map and the runLocale session parameter. 

Note: Since SAP BW metadata is automatically displayed in the language of the current user, 

you do not need to use parameters to create a multilingual project for SAP BW metatdata. 

1. In the Project Viewer, double-click the Language_lookup parameter map. 

Note that the keys match the possible values for the runLocale session parameter, which 

identifies the language of the current user. These keys are mapped to the language values 

that are defined in the gosales_goretailers database. 

User Guide 87


2. Verify that the parameter map contains the following information. 

Key 

en 

fr 

de 

Value 

EN 

FR 

DE 

3. Select a query subject that contains multi-lingual columns, such as Order_Method, and click 

Actions, Edit Definition. 

4. Notice that the language identifier that was appended to the query item name is replaced 

with a parameter map and runLocale session parameter: 

Select 

ORDER_METHOD.ORDER_METHOD_CODE, 

ORDER_METHOD.ORDER_METHOD_# $LanguageMap{$runLocale} # as ORDER_METHOD 

from 

[_S_GOSALESML_SS_2000_OL].ORDER_METHOD 

5. Click the Test button to preview the results. 

6. Click Project, Session Parameters and change the runLocale session parameter value to 

fr. 

7. Test the Order_Method query subject again to view the results. 

Managing the Project 

Modify Properties 

In Framework Manager, you can organize the metadata in the project and ensure that the 

project is valid. You can 

• modify the properties of each object 

• organize objects by creating folders 

• organize query subjects by creating query item folders 

• check a project to verify that it contains valid metadata 

The property pane shows the properties of any object that is selected, such as query subjects, 

query items, and relationships. Object properties are set during import. After import, you can 

modify any property values that are not greyed-out. 

Steps 

1. In the Project Viewer pane, select one or more objects. 

If you selected multiple objects, Framework Manager shows only the properties that are 

common to all the objects. 

2. If you selected multiple objects, you can 

• sort property values alphabetically by double-clicking the property heading. An arrow 

appears to indicate the direction in which values are sorted. You can toggle between 

ascending and descending order. 

• filter property values by clicking the arrow to the right of the property heading. You can 

either click a value, or click Custom to define the criteria for the rows you want to 

display. 

3. In the Properties pane, click the cell and edit the value. 

Tip: To apply a property value to multiple objects, click the arrow next to the property and 

drag the highlighted area over the properties to which you want to apply that value. 



Create a Folder 

You can create folders to organize objects by subject or functional area. This makes it easier for 

you to locate metadata in projects that have many query subjects. You can nest folders by 

creating new folders in an existing folder. 

Tip: When viewing metadata in the Object Diagram, you can expand or collapse folders. From 

the Diagram menu, click Collapse All or Expand All. 

Using Shortcuts 

Model folders can contain either objects, or shortcuts to objects. Use shortcuts when there is an 

overlap between groupings and you want to include the metadata in more than one folder. For 

example, you create folders for Orders, Products, and Customers. If you want both Orders and 

Customers to contain the same query subject, you must create a shortcut to the query subject 

and add it to both folders. 

When you decide where to place shortcuts, consider how the scope of the shortcut impacts 

relationships: 

• Shortcuts in the same folder as the target query subject use the relationships of the target 


• Shortcuts in a different folder from the target query subject ignore the relationships of the 

target query subject and use those specified for the shortcut. 

When you create a shortcut, Framework Manager does not set the Screen Tip and Description 

properties. Unless you define these properties, the values displayed in Report Studio and Query 

Studio are the same as those defined in the object that the shortcut references. For information 

about defining properties, see "Modify Properties" (p. 88). 

Tip: To go to the object the shortcut references, right-click the shortcut and click Go to Target. 

Steps 

1. Click Actions, Create, Folder. 

The Create Model Folder wizard appears. 

Tip: To create a folder without using this wizard, select the query subjects before performing 

this step. 

2. In the Name box, type a name for the new folder. 


4. Choose whether to create shortcuts to the objects or actually move the objects: 

• To create shortcuts that reference selected objects, click Create a shortcut for the 

selected items, and select the relevant items. 

Do not select all of the objects in the namespace, to avoid creating a recursive structure 

in the reporting application. 

• To move selected objects to the folder, click Move the selected items to the new 

folder. 

When you move an object that participates in a relationship, the relationship may also 

move. For information about relationships, see "Relationships" (p. 65). 

5. Select the objects you want to add to the folder. 


Create a Query Item Folder 

You can create query item folders to organize query subjects that contain a large number of 

query items. A query item folder can contain only query items and query item folders. 

Steps 

1. In the Project Viewer, click a query subject. 

2. From the Action menu, click Create, Query Item Folder. 

A new query item folder appears in the Project Viewer, under the query items that belong to 

that query subject. 

User Guide 89


Check a Project 

3. Drag the query items that you want into the query item folder. 

You cannot add query items that do not exist in the parent query subject. 

At any point in the modeling process, you can verify the validity of your project. Framework 

Manager also provides an option to verify the package objects before you publish a package to 

ensure that there are no invalid objects that can break queries in the published package. 

When you verify a project, Framework Manager lists invalid objects and their status. Verifying a 

project detects various problems, which you can direct Framework Manager to repair. 

Invalid Relationships 

Framework Manager identifies query subjects whose relationships are invalid, so that you can 

delete them. Invalid relationships include 

• many-to-many relationships 

• orphaned query subjects (query subjects with no relationships) 

• multiple relationships (or relationship shortcuts) between query subjects (or query subject 

shortcuts) 

Invalid References 

Invalid references exist when an object references another object to which it does not have 

access. Invalid references occur when an object references another object that no longer exists 

in the project. 

Invalid Object Definition 

Framework Manager warns you when you change an object so that it cannot be executed. If you 

proceed, these are marked as invalid. When you verify a project, Framework Manager identifies 

any query subjects, shortcuts, filters, calculations, and relationships that were previously 

marked as invalid so that you can repair them. 

Invalid Aggregation Rules 

Framework Manager identifies any aggregate settings that are invalid for the data type of the 

query items to which they are applied. For example, if Product_Name has a character data type, 

its aggregate property cannot be set to either sum, count, or average. To repair the error, 

Framework Manager resets the aggregate property to unsupported. 

Steps 

1. Click Project, Verify. 

The Verify dialog box appears and displays lists of warnings and errors. A check box 

appears beside each repairable item. 

2. Click the errors you want to correct. 

Tip: To see the complete error message and the suggested solution double-click the error 

message. 

3. Click Repair. 

A dialog displays the number of objects repaired, and identifies the number of broken 

references that need to be retargeted. 

4. To fix broken references, click Yes. 

Note: When you repair a filter that contains an invalid reference, you must check its 

expression to ensure that the query items it now references do not contain invalid 

references. Any expression components that are invalid are underlined in red. 



5. Identify which references you want to display 

• To display every reference that exists for the selected object, click Show all references. 

Use this option to view valid relationships in which the object participates for more 

context about how that object is used. 

• To display only the references that are broken for this object, click Show only broken 

references. 

Use this option to reduce the number of references that are displayed to only those that 

need to be repaired. 

6. Click the Retarget/Delete Value column, and use the pull-down list to fix the broken 

reference. 

• To locate the object you want to reference, click Browse. 

• To delete the object that contains the broken reference, click Delete Object. 

• To clear an existing value, click None. 

• To use a reference that you have assigned to another object during this repair session, 

click the name of the reference. 

7. Click the Apply to column and identify where you want to apply the reference 

• To apply the change to this object only, click This Reference Only. 

• To apply the change to every object that references the same object, click Entire 

Project. 

8. click OK. 

Dimensional Metadata 

A dimension is a hierarchical structure that represents a major segment of your business 

information. For example, in a project for sales analysis, you might include these dimensions: 

• Dates of Sales (Time) 

• Locations of Sales (Region) 

• Product and Purchase Details (Products) 

• Customer Information (Customers) 

Each dimension consists of one or more paths that typically contain several levels. The time 

dimension may consist of the years, quarters, months, weeks, and days when sales were made. 

The Locations of Sales dimension may be grouped into regions, states, and cities. The Products 

dimension may organize your sale items by type, brand, model, color, and packaging. 

In Framework Manager you can define dimensional information for any query subject, whether 

or not it was imported from a dimensionally aware data source. 

To support dimensional model, Framework Manager lets you: 

• import hierarchy metadata from an SAP BW data source (p. 92) 

When you import SAP BW metadata, Framework Manager generates hierarchies to match 

the data source structure. 

• create a star schema grouping (p. 93) 

You can optimize your data warehouse metadata by grouping objects into star schemas. 

• specify dimensional information (p. 93) 

By organizing your data into hierarchies and levels, you can analyze results at various levels 

of detail in reports. 

Note that dimensions do not appear in the reporting application because they are only used for 

preparing the project for reporting. 

User Guide 91


SAP BW Hierarchies 

During import, Framework Manager generates a query subject for each hierarchy of an SAP BW 

characteristic as well as one query subject that represents the actual characteristic. Only one 

query subject of a given characteristic can be used in a report at a time. Therefore, it is best to 

group query subjects that represent the hierarchies of a single characteristic into a folder so that 

report authors know which query subjects are related to each characteristic. 

Framework Manager supports the following types hierarchies: 

• characteristic: lists all of the characteristic values 

• text nodes: contain only text and do not reference any other data source object 

• characteristic value: nodes of each level of a presentation hierarchy are values from another 

characteristic. 

• recursive: the nodes of the entire presentation hierarchy are from the characteristic itself 

Note: Framework Manager does not support hierarchies that contain two or more types of 

nodes. 

Versioned Hierarchies 

There are three types of versioned hierarchies that you can import from an SAP BW data 

source: 

• Version Dependent Hierarchy 

A hierarchy can have multiple versions. Each version of a hierarchy can have the same 

name but a different structure, such as Sales by Region and Sales by Manager. During 

import, Framework Manager creates a separate query subject for each version. 

• Entire Hierarchy Time Dependent 

Each version has an associated time period that does not overlap with any other versions of 

the same hierarchy. The structure of each version can be different. During import, 

Framework Manager creates a query subject for each version and includes the applicable 

time period as part of the query subject name. 

• Time Dependent Hierarchy Structure 

There is a single version of the hierarchy, but nodes within the hierarchy can be assigned 

applicable time periods. Over time, the structure of the hierarchy can change. For example, 

levels that represent different sales districts can be added or removed over time. During 

import, Framework Manager creates a query subject whose structure is based on the 

current date. 

You can apply a hierarchy to a characteristic and control which version of a hierarchy to use, or 

(if the hierarchy is time-dependent) which date to use to control the version. 

Framework Manager sets the query key date of time-dependent hierarchies to an arbitrary date, 

so that you can select specific versions of hierarchies. The hierarchy that you apply to a 

characteristic depends upon the type of query key date: 

• fixed date 

Include only the version that corresponds to the fixed date in the underlying InfoQuery. 

• current date 

Include only the version that encompasses a time span appropriate for "now" until some 

reasonable time in the future. 

• variable 

Set the date for the variable in the Framework Manager and include only the version of the 

hierarchy applicable to that date. 

In Framework Manager, if a versioned hierarchy is not time-dependent and has a fixed version, 

only include the version of the hierarchy associated with the selected version. Otherwise the 

report author is presented with a hierarchy that is inaccessible. 



Create a Star Schema Grouping 

Dimension tables can have duplicate data to support fact rows at different grains of aggregation. 

This means that each fact table can have multiple surrogate key relationships with different 

levels of the same dimension table. For example each level of the Time dimension contains the 

same surrogate key value for Month. 

Star-schema groups can contain the selected query subjects or shortcuts to the query subjects. 

The objects in a star-schema grouping cannot reference, or be referenced by, any object outside 

the group. Therefore, Framework Manager automatically creates a shortcut of any object that is 

referenced by an object outside of the group. 

When you create a grouping you can select one or more query subjects. Generally, you select a 

single query subject when the query subject is a Fact that has a relationship to every query 

subject that you want in the star-schema group. When you create a star schema group that is 

based on one query subject: 

• the query subject, rather than a shortcut, is moved to the group. 

• Framework Manager displays a list of query subjects with which it has a relationship so that 

you can quickly select the query subjects that you want in the group. 

• the name of the group is based on the name of the fact table 

• the new group is created under the same parent as the selected query subject. 

Selecting multiple query subjects is useful if you want to group query subjects that do not 

already have relationships defined. If you select multiple query subjects, the new group is 

placed under the nearest common parent of the query subjects. 

Steps 

1. Select one or more query subjects. 

2. Click Actions, Create Star Schema Grouping. 

3. To exclude a query subject from the group, in the Selected query subject list, clear the 

check box next to the query subject. 

4. Specify the criteria 

• To add shortcuts to the grouping, select Create a shortcut for all selected objects. 

• To move the objects to the grouping, select Create shortcuts only for objects that are 

used outside the star schema. 

5. To move the selected objects into a separate namespace: 

• ensure the Create a new namespace for this grouping check box is selected. 

• enter the name of the new namespace into the Namespace name field. 

6. Click OK. 

Specify Dimension Information 

It is common for dimension tables in data warehouses to be denormalized. The advantage is 

that there are fewer tables to process, which makes the queries much simpler and faster. For 

example, the normalized version of a Geography table uses three tables to organize geographic 

information. 

Table 

Country 

StateInfo 

CityInfo 

Columns 

CountryCode, CountryName, CountryHeadOfState, 

CountryPopulation, and CountrySize 

CountryCode*, StateCode, StateName, and 

StatePopulation 

CountryCode*, StateCode*, CityCode, CityName, 

CityPopulation 

* indicates that the column functions as a unique identifier. 

User Guide 93


The disadvantage of denormalization is that hierarchical information cannot be derived from 

table definitions. This information is particularly important when the structure is not intuitive. For 

example, product information can be organized as a product line that contains product types, 

which in turn contain products. However it can also be organized as product types containing 

product lines, which in turn contain products. 

Framework Manager lets you define this hierarchical information for relational metadata and use 

it to optimize SQL generation. You can add hierarchy and level properties to any query subject 

that references a relational data source. When you import SAP BW metadata, hierarchical 

metadata is automatically generated, and cannot be changed in Framework Manager. 

In Framework Manager, dimensional metadata is represented in the following way: 

• levels reference 0:n query items 

• hierarchies reference 0:n levels 

• query subjects can have 0:n hierarchies and 0:n levels 

Each query subject that is based on dimensional data contains one or more levels that 

represent the information hierarchies that may be explored in Framework Manager. Levels 

contain categories that are generated from, or matched to, column values in the source data. 

Each source level is associated with one or more columns in the source file. Facts are 

associated with levels to identify to the reporting application which numeric query items can be 

aggregated against 

After you define a level you can use it in a hierarchy to establish a relationship between the 

levels. The order of levels in a hierarchy determines the path that the user must follow to get to 

the level of granularity they require. For example Country contains State data, while the State 

level contains City data. You can reorder the levels in a hierarchy by using drag and drop. 

Each key is composed of one or more query item(s) that uniquely define the level. By default, 

the key is the query item that defines the level. You can use a single query item as a key if that 

item uniquely identifies the level. For example, Product_Number uniquely identifies each 

Product. Use composite keys when two or more query items are required to uniquely identify the 

level. For example, the combination of country and city are required to uniquely identify each 

city. 

Note that each level must be uniquely identified on its own, not by other levels within a hierarchy. 

Steps 

1. Select the query subject and click Actions, Specify Dimension Information. 

2. Create one or more levels 

• To create a level that is associated with a specific hierarchy, drag a query item from the 

Available Items list to the Hierarchies list. 

Framework Manager creates a hierarchy if one does not exist. 

• To create a level that you can use in multiple hierarchies, drag a query item from the 

Available Items list into the Levels list. 

Tip: To reuse an existing level, drag the level from the Levels list into the Hierarchies 

list 

3. Define a key for each level by dragging one or more query items in the Available Items list 

to the Key list. 

By default, Framework Manager add the names of any container levels to the key. 

4. To use the only specified key as a unique identifier, check the Unique Key box. 

Do this only if the key values are unique regardless of their context, such as postal code 

values. 

5. Identify query items that users need to report on by dragging query items from the 

Available Items list to the Attributes list. 

6. Click OK. 


Chapter 4: Publishing a Project 

Set Governors 

You must create a package in Framework Manager to contain all or part of your project. You then 

publish the package to the ReportNet server so that the report authors can use the metadata. 

Before you publish a package, you must create or open a project in Framework Manager (p. 20) 

and import metadata into the project (p. 25). You might also want to refine the project for 

reporting (p. 53) by creating and modifying the objects in the project. 

To publish a project: 

❑ Check the project to ensure that the contents are consistent and do not contain any errors 

(p. 104). 

❑ Set governors for reports (p. 95). 

❑ Create custom packages to suit different report authors’ requirements (p. 97). 

❑ Add security to the package (p. 98). 

❑ Analyze the effect of the published package on already published packages (p. 104). 

❑ Specify languages in the package (p. 103). 

❑ Publish the package to a location that report authors can access (p. 103). 

❑ Manage the packages in a project (p. 105) 

You can set limits to the data retrieved in a query subject test or the report design mode by 

setting governors. You use governors to reduce system resource requirements and improve 

performance. 

SQL is generated automatically on demand when you 

• run a report in Report Studio or Query Studio 

• test a query item or relationship in Framework Manager 

• create a new query subject by transforming relationships (p. 65) or merging objects (p. 64) 

Governors control SQL generation. As a result, when you set the outer join governor to deny 

you will not be allowed to automatically generate, in any of the actions listed above. 

This governor does not apply to SQL that is not generated on demand, but is obtained by other 

means. If you set the outer join governor to deny, it will not apply to the permanent SQL found in 

a data source query subject, whether the SQL was generated on import (p. 25), manually 

entered, or created by transforming relationships (p. 65) or merging objects (p. 64). 

User Guide 95


You set governors before you create packages to ensure the metadata in the package contains 

the specified limits. 

Limit 

Report table limits 

Data retrieval limits 

Query execution time limits 

Large text items limits 

Outer joins activities 

Cross-product joins 

activities 

Description 

Controls the number of tables that a 

user can retrieve in a query or report. 

Tables are counted as they are 

retrieved. An error message appears 

when the preset number of tables is 

reached. 

Controls the number of rows that a user 

can retrieve in a query or report. Rows 

are counted as they are retrieved. An 

error message appears when the 

preset number of rows is reached. 

Limits the time that a query can take. 

An error message appears when the 

preset number of seconds is reached. 

Controls the size of BLOBS (binary 

large objects) that a user can retrieve in 

a query or report. The BLOB size is 

truncated to the size you specify. An 

error message appears when the 

preset number of characters is 

reached. 

Controls whether outer joins can be 

used in your query or report. An outer 

join retrieves all rows in one table, even 

if there is no matching row in another 

table. This type of join can produce 

very large queries and reports. 

Note: For SAP BW metadata, setting 

this governor to "allow" lets you 

generate all relationships as 

outer-joins. This setting can be 

overridden in Report Studio. 

Note: If you set a governor to deny 

outer joins, you will be notified only if 

you create a relationship, in the Object 

Diagram View, that includes outer joins. 

You will not be notified if, you create a 

relationship, in a data source query 

subject or by transforming a 

relationship into a query subject, that 

includes outer joins. 

Controls whether cross-product joins 

can be used in your query or report. A 

cross-product join retrieves data from 

tables without joins. This type of join 

can take a long time to retrieve and can 

produce meaningless results. 

For information about troubleshooting governors, see Appendix A: "Troubleshooting" (p. 107). 



Steps 

1. From the Project menu, click Edit Governors. 

2. Specify the limits that you want to use when retrieving data. 

3. Click OK. 

Create or Modify a Package 

You create a package to make metadata available to report authors. A package is a subset of a 

project. It must contain all the information that a specific user or group of users needs to create 

reports. 

A package contains query subjects whose SQL defines the query items and relationships that 

the package retrieves. When you create a package, you select the objects that a user will want 

to report on. When you create or modify a package, you can also apply security to a package 

(p. 98). 

For example, if your data source contains information from different areas of a business, you 

might decide to create different package for Human Resources, and Finance. Ensure that your 

package meets a broad but related reporting need. Each report can contain information from a 

single package only. 

Once a package is published to the ReportNet server, it is available for use by report authors. 

Nested Packages 

When you create nested packages, you create a master package that is based on other existing 

packages. You use nested packages to reuse model information. Using nested packages saves 

you time, and they are easier to maintain. Another advantage of using a nested package is that 

you publish only the master package. 

For example, you create three separate packages named Canada, Mexico, and the United 

States. Each package contains the project objects and security appropriate for that package. 

You can create one master North America package and include the packages Canada, Mexico, 

and the United States. When you need to publish the package for report authors, you publish 

only the North America package. 

Select, Hide, Unselect 

When you create a package, you can choose whether objects in a project can be selected 

based on the requirements of reports authors. 

Option 

Select 

Hide 

Unselect 

Description 

The object can be used in reports and can be selected 

by report authors. 

The data within the object can be used in reports, but the 

object cannot be selected by report authors. 

For example, you include a model query subject in a 

package. Because model query subjects are dependent 

on data source query subjects (p. 53), you must add the 

data source query subject to your package. If you do not 

want report authors to see the data source query 

subject, you hide it. 

The object is not published and cannot be used for 

reports and cannot be selected by report authors. 

For example, package A has the query subject Country hidden and package B has the query 

subject Country selected. If package C includes package A and package B, then Country is 

included. However, if package C includes package A and package B, and you override the query 

subject Country in package C so that it is unselected, then Country is unselected. 

User Guide 97


Packaging SAP BW Metadata 

When you import SAP BW data, Framework Manager generates query items that represent 

surrogate keys to simplify join conditions in the star schema. These query items are 

automatically hidden in all packages, since they represent items that cannot be queried. 

If you select "Enhance the model for SAP BW organization of objects" during import, Framework 

Manager creates a query item folder in the Key Figures query subject called Surrogate Keys. 

While the query items in this folder are hidden, the folder, by default, is visible in all published 

packages. Therefore, you should hide the Surrogate Key query item folder, if it exists, when 

publishing models. 

Steps to Create a Package 

1. Click the Packages folder, and from the Actions menu, click Create, Package. 

2. Follow the instructions in the Create Package wizard. 

• Choose the location of the objects, either from the project or from existing packages. 

Tip: If you have created other packages, we suggest that you add package references when 

you create a package by clicking Using existing packages. 

• To accept the default package access security, click Finish. Otherwise, you can define 

access to your package by adding a user, group, or role. 

• Select the set of data source functions you want available in the package. 

For more information, see "Define Function Sets" (p. 48) 

3. Click Finish and choose whether to publish the package. 

Steps to Modify a Package 

1. Right-click the package you want to modify, and then click Edit Definition. 

2. Click the objects you want to add to or remove from the package. 

Tip: To toggle through the options for an object, click the object icon, or select an option 

from the list. For more information, see "Select, Hide, Unselect" (p. 97). 

3. Click OK. 

4. If you want to add or remove package references to the package you are modifying, click 

Edit. 

5. Click OK. 

Security in Framework Manager 

In Framework Manager, security is a way of restricting access to metadata and data across 

ReportNet products. There are three types of security in Framework Manager, each type uses 

users, groups, and roles to define access: 

• data security (p. 100) 

You create a security filter and apply it to a specific query subject. The filter controls the data 

that is shown to report authors when they set up their reports. 

• metadata security (p. 101) 

You apply security to a package and identify who has access to that package. 

• object-based security (p. 101) 

You secure an object directly by either making it visible or keeping it hidden. 

There are business reasons for restricting access to data. For example, you may have data that 

contains confidential data, and only specific users are allowed to see it. You may have a variety 

of data, and your users only need to retrieve data from specific tables or columns. Or, you may 

have a table that contains many records, and your users only need to retrieve a subset of 

records from that table. 

If you are using SAP BW metadata, there can be underlying SAP BW security that affects your 

users access to level members. Therefore, assigning a user access to a level does not 

guarantee that the user also has access to the members in that level. 



Before you add security in Framework Manager, ensure that security has been set up correctly 

in ReportNet. For more information, see the Administration and Security Guide. 

Add a User, Group, or Role 

Users and groups are created for authentication and authorization purposes. You can use users 

and groups created in third-party authentication providers, as well as create your own, in 

Cognos ReportNet. 

In Framework Manager, you add data security (p. 100) and metadata security (p. 101) using 

these users, groups, and Cognos groups. 

For more information about security, see the Administration and Security Guide. 

Users 

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

identify a human or a computer account. You can not create users in Cognos ReportNet. 

Information about users, such as first and last names, passwords, IDs, locales, and e-mail 

addresses, is stored in the providers. 

Users can become members of groups defined in third-party authentication providers and 

groups defined in ReportNet. A user can belong to one or more groups. If users are members of 

more than one group, their access permissions are merged. 

Groups and Roles 

Examples of groups are Employees, Developers, or Sales Personnel. Members of groups can 

be users and other groups. Group membership is part of the users’ basic identity. 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. 

A role is a special group. It represents a collection of users that have similar responsibilities and 

similar privileges in the organization. Members of roles can be users, groups, and other roles. 

Role membership is not part of the users’ basic identity. 

In ReportNet, you can use groups created by your organization in third-party authentication 

providers, or create new groups in the Cognos namespace. 

You create Cognos groups when 

• you can not create groups in your authentication provider 

• groups are required that span multiple namespaces 

• portable groups are required that can be deployed 

• you want to address specific needs of ReportNet administration 

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

ReportNet 

Steps to Create a New Group or Role 

1. Right-click the package you want, and click Edit Package Access. 

2. Click New. 

3. Follow the instructions in the New Group wizard. 

4. Click Finish, and then click OK. 

Steps to Remove a Group or Role 

1. Right-click the package you want, and click Edit Package Access. 

2. Click the user, group, or role you want to remove, and click Remove. 

3. Click OK. 

When you remove Cognos groups or roles, you do not delete them from the third-party 

authentication provider or Cognos ReportNet. 

User Guide 99


Add Data Security 

Steps to Add a Group or Role 

1. Right-click the package you want to modify, and click Edit Package Access. 

2. Click Add. 

Tip: To view all the users in a group, select the Show users in the list check box, and click 

the group you want. 

3. Specify the users or groups 

• To add entries by selecting the names from the list, on the Navigate tab, select the 

check box next to the appropriate user, group, or role, and then click Add. 

• To search for users, groups, or roles in a namespace you are currently using, on the 

Search tab, type the search criteria, and click Search. When the entry appears in the 

Search results box, select it and click Add. 

• To add entries by typing the names, on the Type tab, in the Type the names text box, 

type the names of users, groups, and roles, in the following format, and then click Add. 

namespace_name;namespace_name/group_name;namespace_name/user_name 

For example, you add a Report Authors group and a user named scarter by typing the 

following 

LDAP;Cognos/Report Authors;LDAP/scarter. 

Separate each entry using a semicolon (;). 

The entries that you add appear in the Entries to be added box. 

Tip: Select all or Deselect all applies to the current page, which may not represent all 

available entries. 

4. Click OK twice. 

You can restrict the data represented by query subjects in a project by creating a security filter. 

The security filter controls the data that is shown to the report authors when they set up their 

reports. 

For example, your Sales team consists of a Sales Director, and four Sales Managers. You create 

a security filter that includes the groups directors and sales managers, and apply the filter to the 

salary query subject. When the package is available for report authors, and a report is 

generated for the Sales Managers and the Sales Director, only the Sales Director can see the 

salary information for the sales managers. 

You can base the security filter on existing security filters. If you choose this option, the security 

filter inherits the filter, and all the filter properties. 

When you create a security filter, you can also use existing project filters, or create new filters 

using the expression editor. For more information, see "Create a Filter" (p. 76). 

For more information about groups, see "Add a User, Group, or Role" (p. 99). 

Steps 

1. Right-click the query subject you want, and click Specify Security Filters. 

2. Click Add Groups. 

3. To view all the users in a group, select the Show users in the list check box, and click the 

group you want. 







Search tab, specify the search criteria, and click Search. When the entry appears in the 






following 




• To remove a group in the security filter, click Delete Group. 



5. Click OK. 

6. If you want to base the group on an existing group, in the Based On column, click a group 

from the list. 

Tip: If you do not see the group you want in the list, you must add the group to the security 

filter. 

7. If you want to add a filter to a group, in the Filter column, click either Create/Edit 

Embedded Filter or Insert from Model. 

8. Click OK. 

Adding Metadata Security 

When you add metadata security in a package, you specify which users, groups, and roles have 

access to certain parts of the published model. 

You can define metadata security when you create and publish packages in Framework 

Manager. A package is a secured subset of a project. A package can be published and can be 

included in other packages. 

You can add entries created both in third-party authentication providers and in ReportNet as 

members of a Cognos group. You can also organize your security according to business rules 

by creating new groups or roles or by removing groups or roles. 

To add metadata security: 

❑ Decide whether the objects can be selected, unselected, or hidden in the package (p. 97). 

❑ Add users, groups, and roles to the package (p. 99). 

Add or Remove Object-Based Security 

Metadata security can be applied directly to objects in a project. When you add object-based 

security, you apply a specific user, group, or role (p. 99) directly to the object. You choose to 

make the object visible to selected users or groups. 

By default, every object in your project is hidden to everyone. You use object-based security to 

make that object visible to selected users, groups, or roles. You can make every object in a main 

project namespace visible to selected users or groups, except relationships. For example, in 

your project, you may have a Salary query subject. You can make the Salary query subject 

visible to the Managers group, and keep it hidden from everyone. 

When you secure an object, a package is automatically created in Framework Manager. The 

package name consists of an underscore (_) and the name of the secured object. These 

object-based packages are visible in the Object Explorer. You can use this package to see which 

objects in the project are included, hidden, or excluded from a specific user group. 

User Guide 101


Tip: To see a list of the object-based packages, double-click the Packages folder. The list 

appears in the Object Explorer View. To see which objects are secured against that specific 

object-based package, right-click the package, and click Explore Packages (p. 105). 

Every time you include that object in a package, and publish it for report authors, the same 

security rules apply for that object. When you publish a package that contains secured objects, 

the visible objects for ReportNet users are the intersection of the package definition and the 

object security settings. If object-based security is not used, security applied to a package 

remains unchanged. 

Steps to Set Object-Based Security 

1. Right-click the object you want to secure and click Give visibility rights. 













following 






3. Click Add. 

4. Click OK. 

A list of new and updated object-based packages appears. 

Steps to Remove Object-Based Security 

1. Right-click the secured object and click Remove visibility rights. 













following 






3. Click Add. 



4. Click OK. 

A list of packages that will be affected by these changes appears. 

Steps to Clear All Object-based Security 

1. Right-click the secured object and click Clear all visibility rights. 

A list of objects that will become unsecured appears. 

2. Click OK to accept changes. 

Specify Languages 

You can ensure that the package you publish contains the languages you want report authors to 

see on the ReportNet server. 

You must add languages to the project (p. 85) before you can specify languages report authors 

require in a package. 

Steps 

1. Right-click a package, and click Specify Languages. 

2. Click one or more languages and use the arrow buttons to move them from the Unselected 

Model Languages box to the Selected Languages box. 

Tip: To select more than one language, use Ctrl+click. 

3. Click OK. 

Publish a Package 

You can publish a package (p. 97) to a location that is convenient for report authors. When you 

publish a package, you can choose to save either to the ReportNet Server or to a network 

location. 

To avoid potential problems, before publishing a package, troubleshoot the package by using the 

verify check box in the Publish wizard to ensure that it is complete and does not contain any 

errors. When you check a package, Framework Manager suggests how to fix problems for 

• schema validation errors 

• invalid references 

• invalid association containership 

If the package you want to publish contains invalid references, Framework Manager includes the 

required object in the package but keeps it hidden. 

For information about using a published package, see the Report Studio User Guide. 

When you publish a package, you can set the number of model versions to retain on the 

ReportNet server. 

Tip: To see the number of model versions set for a package, select a package and, in the 

Property pane, find the maxVersions property. 

Reports and Model Versions 

When you publish a package for the first time, you create a corresponding package on the 

ReportNet server. The ReportNet package contains a model but no reports. 

When you publish a package, you can select how many versions of the model you want to retain 

on the Cognos ReportNet server. The next time you publish the same package, you update the 

version of the model, in the existing package on the ReportNet server. 

User Guide 103


New or modified reports will use the latest version of the model in the package. When a report is 

saved, the version of the model used is saved in the report specification. If the package is 

republished, a report author is notified that the report will use the newest version of the model in 

the package. The report author must save the report to complete the update. If you open a 

saved report after the package it is based on is republished, one of two things happens: 

• If the original version of the package still exists, the report runs against the original version. 

• If the original version of the package no longer exists, the report is updated to run against 

the most recent version. 

For information about reports, see the Report Studio User Guide. 

Steps 

1. Click the package you want to publish. 

2. From the Actions menu, click Publish Packages. 

3. Choose where to publish the package: 

• To publish the package to the Framework Manager repository, click Cognos ReportNet 

Server. 

• To publish the package to a network location, click Location on the network. 

4. To enable model versioning, select the Enable model versioning check box. 

5. In the Number of model versions to retain box, select the number of model versions of 

the package to retain. 

Tip: To delete all but the most recently published version on the Cognos ReportNet server, 

select the Delete all previous model versions check box. 

6. To troubleshoot the package for errors before publishing, select the Verify the package 

before publishing check box. 

7. Follow the instructions to complete the steps in the Publish wizard. 

8. Click Publish. 

Analyze the Effects of Changes to a Package 

After you create a package (p. 97) and publish a package (p. 103) in Framework Manager, you 

can analyze the effects of any changes you made to a package on the reports which were 

created based on that package. 

You can compare a selected package in Framework Manager with a published package of the 

same name in Content Manager to show changes between the packages that could affect any 

reports based on the package. You can see details on each change, and which reports are 

affected by a specific selected change. 

Steps 

1. Select the published package you want to analyze and click Actions, Analyze Publish 

Impact. 

Note: The package you select must be a published package. 

2. In the Analyze Publish Impact window, choose what you want to view. 

Goal 

To view the change details for 

an object. 

To view report dependencies. 

Action 

In the Changed Model Items 

box, click an item under 

Change. 

In the Changed Model Items 

box, select an object, and click 

Find Report Dependencies. 

Repeat for each object. 




Managing Packages 

You can use Framework Manager to manage your packages. You can view the security applied 

to a package, check which packages are secured by groups and users, explore packages in a 

project, and modify the administrative access of packages. 

Modify Package Access 

When you modify the package access, you see which users, groups, and roles are applied to 

that package. 

Steps 

1. Right-click the package you want and click Edit Package Access. 

2. Choose to either 

• add a user, group, or role to the package 

• remove a user, group, or role from the package 

• create a new group, user, or role and add it to the package 

For more information, see "Add a User, Group, or Role" (p. 99). 

3. Click OK. 

Modify Package Administrative Access 

When you apply administrative access to a package, you give access to the user(s) who are 

responsible for 

• republishing a package in Framework Manager to the ReportNet server. 

• ensuring that no reports are impacted when a Framework Manager package is republished 

to the ReportNet server. 

By default, when you publish a package, the user or group with the administrative role for 

reporting will be added in the Package Admin Access dialog. 

Steps 

Explore Packages 

1. Right-click the package you want and click Edit Package Admin Access. 

2. Choose to either 

• add a user, group, or role to the package 

• remove a user, group, or role from the package 

• create a new group, user, or role and add it to the package 

3. For more information, see "Add a User, Group, or Role" (p. 99). 

When you have a large number of projects and object-based security in a project, it can be 

difficult to keep everything organized. You can use explore packages to see the packages and 

roles in a project. 

In the Package Explorer, you see a list of all the packages (normal and object-based) in a 

project, as well as the objects that have been selected, unselected, or hidden for each package. 

In the Roles Explorer, you see a list of all the users, groups, and roles in a project, and in which 

package the object-based security is applied. You can also see whether the objects in the 

project are hidden or visible to that specific user, group, or role. 

User Guide 105


Steps 

1. Right-click the Packages folder and click Explore Packages. 

2. Choose one of the following 

• For package information, click the Package Explorer tab 

• For object-based security information, click the Roles Explorer tab 

3. To edit the package, in the Package Explorer tab, click Edit. 

For more information, see "Create or Modify a Package" (p. 97). 


View Package Inclusion 

When you view the package inclusion of an object, you see, by package, where that object 

exists and whether it is selected, unselected, or hidden in that package. 

If the object is secured, you will also see the object-based package in which the object exists. 

Steps 

1. Right-click on the object you want to see and click View Package Inclusion. 

2. To edit the package, click Edit Package. 

For more information, see "Create or Modify a Package" (p. 97). 

3. Click OK. 


Appendix A: Troubleshooting 

Unable to See Test Results 

You test a query subject and do not see the results of the query in the test window. This may 

occur because the data from your data source is greater than the stop at limit of any Runtime 

Limits governor. The query stops at the specified limit, but the test result window does not 

contain any data. 

You can set the governor stop at limits to zero to view your query results. 

Errors in Queries That Use Macros 

If a data source query subject contains a macro in the projection list, (SELECT clause) of the 

SQL statement, you may get an error when you run a query that uses that query subject. This 

error occurs when the macro evaluates to a column name that is different from the Column 

Name property of the corresponding query item. The result is that the system is unable to locate 

item in the projection list. 

To correct this, you should specify an alias in the SQL that matches the Column Name property 

of the query item. Assigning an alias ensures that the name of the item in the projection list 

remains constant, as the results of evaluating the macro change. 

For example, the following query contains a session parameter, runLocale, whose value 

specifies which column the query retrieves: 

Select 

#$ColumnMap{$runLocale}# as CountryNameAlias 

From 

[GoSales].Country 

Unable to View the Result Set of a Stored Procedure 

If the result set of a stored procedure contains a CLOB (character large object) or BLOB (binary 

large object), you must modify the stored procedure before executing it. 

Steps to Use CLOBS 

1. Insert a Cast or Substring function to calculate a string based on the CLOB. 

Steps to Use BLOBS 

1. Create a model query subject that references the stored procedure. 

2. Remove the BLOB from the Select statement of the query subject. 

You can add query items to the Select statement that perform a lookup on the table that 

contains the BLOB data. 

Error When Switching the Language in Reporting 

Application 

When changing the language to any language other than the language used to publish a model 

in Framework Manager, an Invalid Query Subject Error message appears in Report Studio and 

Query Studio. 

User Guide 107


This error originates in the model because queries that have parameters must use an alias in 

the SQL definition. 

Edit the definition of the query subject to ensure that any parameter in the projection list has an 

alias. 

You can also get an invalid query subject error if you use mismatched physical data sources in 

the same model. 

Required Currency Not Displayed 

If Framework Manager does not display the currency you require in the Currency dialog, you 

must ensure that you install the appropriate language packs to support the currency symbols 

you require. For example, to display the Indian currency symbol (rupee), you must run an 

operating system or install a language pack that can display this symbol. The Japanese 

operating system or Japanese language is one example that can display the Indian currency 

symbol (rupee). 

XML Validation Error During the Import of Third-party 

Metadata Sources 

In Framework Manager, when you import a third-party metadata source that does not match the 

type selected, the following XML validation error message appears. 

This file chosen is not a valid representation of the metadata type selected for import. 

For example, you try to import the XML file for an exported Architect model using the Cognos 

Impromptu XML option. Try the import again, specifying the correct metadata type. 

Expressions Imported from Business Objects Metadata 

Source Do Not Work 

The calculation, filter, and join expressions that are imported from a Business Objects metadata 

source do not work in Framework Manager. The reason is that Business Objects’ expression 

syntax is different from the syntax in Framework Manager. 

An example of a Business Objects expression 

@Select(Country\Country) LIKE 'C%' 

An example of the same filter in Framework Manager 

[gosales-oracle].[Country].[Country] LIKE 'C%' 

Similarly, embedded filters in the where clause of a query subject do not work. The syntax is 

imported as 

SALESTAFF.SALESTARGET>900000 

The same clause in Framework Manager might be: 

[gosales-oracle].SALESTAFF.SALESTARGET>900000 

In Framework Manager, after you have imported from Business Objects, you must edit these 

expressions manually to conform to the equivalent Framework Manager syntax. 

Extended Characters in Names of SQL Objects Imported 

from ERWin Metadata Source are Lost 

When you import from an ERWin metadata source, extended characters in object names in the 

SQL are converted to an underscore. For example, the table ¢Table is imported as _Table. 

In Framework Manager, you can edit the SQL definition manually, and restore the extended 

characters. 



If you do not have the necessary keyboard support installed, you can use ALT + numeric keys. 

For example, you can create these characters Ç , ü , and é , by entering these combinations, 

respectively ALT + 128, ALT + 129, and ALT + 130. For more information, see the Microsoft 

documentation. 

Unable to Execute Stored Procedures Imported from 

ERWin Metadata Source 

If you import a stored procedure from an ERWin metadata source, you are unable to execute it. 

In Framework Manager, after you have imported from the ERWin metadata source, you must 

re-import the stored procedures directly from the database. 

Script Error Occurs When Testing Query Subjects in 


When you test a query subject in Framework Manager, and you do not have the most recent 

version of Internet Explorer, you will get a script error. 

It is important to apply all required operating system patches and to use only the versions of 

third-party software that are supported. Otherwise, your product may not work properly. For an 

up-to-date list of environ 

ments supported by Cognos products, see the Cognos support site 


Here is the generated query that contains the information from all three tables: 

At first, this query looks like the wrong result. With a full outer join, you may have expected the 

following: 

If you separate the SQL from the presentation, you will see that the result is correct. What 

Framework Manager does is stitch together locally the two separate queries, one for the left side 

and one for the right side. 

Here is an example of the native SQL generated from the query: 

Select "SALES_STAFF"."FIRST_NAME" AS "C0", "SALES_STAFF"."LAST_NAME" AS "C1", 

"SALES_TARGET"."SALES_YEAR" AS "C2", sum("SALES_TARGET"."SALES_TARGET") AS "C3" 

from "GOSL"."dbo"."SALES_STAFF" "SALES_STAFF", "GOSL"."dbo"."SALES_TARGET" 

"SALES_TARGET" 

where "SALES_STAFF"."SALES_STAFF_CODE" "SALES_TARGET"."SALES_STAFF_CODE" 

group by "SALES_STAFF"."FIRST_NAME", "SALES_STAFF"."LAST_NAME", 

"SALES_TARGET"."SALES_YEAR" 

order by 1 asc , 2 asc , 3 asc 

Here is what the target query looks like: 

select "SALES_STAFF"."FIRST_NAME" AS "C0", "SALES_STAFF"."LAST_NAME" AS "C1", 

"ORDER_HEADER_DETAILS"."RETAILER_NAME" AS "C2", sum("ORDER_HEADER_DETAILS"."QUANTITY") 

AS "C3" 

from "GOSL"."dbo"."SALES_STAFF" "SALES_STAFF", 

(select "ORDER_HEADER"."RETAILER_NAME" AS "RETAILER_NAME", 

"ORDER_HEADER"."SALES_STAFF_CODE" AS "SALES_STAFF_CODE", "ORDER_DETAILS"."QUANTITY" AS 

"QUANTITY" 

from "GOSL"."dbo"."ORDER_HEADER" "ORDER_HEADER", 

"GOSL"."dbo"."ORDER_DETAILS" "ORDER_DETAILS" 

where "ORDER_HEADER"."ORDER_NUMBER" "ORDER_DETAILS"."ORDER_NUMBER") 

"ORDER_HEADER_DETAILS" 

where "SALES_STAFF"."SALES_STAFF_CODE" = "ORDER_HEADER_DETAILS". "SALES_STAFF_CODE" 

group by "SALES_STAFF"."FIRST_NAME", "SALES_STAFF"."LAST_NAME", 

"ORDER_HEADER_DETAILS"."RETAILER_NAME" 



Here is what the quantity query looks like: 

Here is an example of the Cognos SQL generated from the query: 

select 

coalesce(D2.FIRST_NAME,D3.FIRST_NAME) as FIRST_NAME, 

coalesce(D2.LAST_NAME,D3.LAST_NAME) as LAST_NAME, 

D2.SALES_YEAR as SALES_YEAR, 

D3.RETAILER_NAME as RETAILER_NAME, 

D2.SALES_TARGET as SALES_TARGET, 

D3.QUANTITY as QUANTITY 

from 

(select 

SALES_STAFF.FIRST_NAME as FIRST_NAME, 

SALES_STAFF.LAST_NAME as LAST_NAME, 

SALES_TARGET.SALES_YEAR as SALES_YEAR, 

XSUM(SALES_TARGET.SALES_TARGET for 

SALES_STAFF.FIRST_NAME,SALES_STAFF.LAST_NAME,SALES_TARGET.SALES_YEAR ) as 

SALES_TARGET, 

RSUM(1 at 

SALES_STAFF.FIRST_NAME,SALES_STAFF.LAST_NAME,SALES_TARGET.SALES_YEAR for 

SALES_STAFF.FIRST_NAME,SALES_STAFF.LAST_NAME order by SALES_STAFF.FIRST_NAME 

asc,SALES_STAFF.LAST_NAME asc,SALES_TARGET.SALES_YEAR asc local) as sc 

from 

where 

group by 

order by 

"GO Sales".GOSL.dbo.SALES_STAFF SALES_STAFF, 

"GO Sales".GOSL.dbo.SALES_TARGET SALES_TARGET 

(SALES_STAFF.SALES_STAFF_CODE = SALES_TARGET.SALES_STAFF_CODE) 

SALES_STAFF.FIRST_NAME, 

SALES_STAFF.LAST_NAME, 

SALES_TARGET.SALES_YEAR 

FIRST_NAME asc, 

LAST_NAME asc, 

SALES_YEAR asc 

) D2 

full outer join (select 

SALES_STAFF.FIRST_NAME as FIRST_NAME, 

SALES_STAFF.LAST_NAME as LAST_NAME, 

ORDER_HEADER_DETAILS.RETAILER_NAME as RETAILER_NAME, 

XSUM(ORDER_HEADER_DETAILS.QUANTITY for 

SALES_STAFF.FIRST_NAME,SALES_STAFF.LAST_NAME,ORDER_HEADER_DETAILS.RETAILER_NAME ) as 

QUANTITY, 

RSUM(1 at 

SALES_STAFF.FIRST_NAME,SALES_STAFF.LAST_NAME,ORDER_HEADER_DETAILS.RETAILER_NAME for 

SALES_STAFF.FIRST_NAME,SALES_STAFF.LAST_NAME order by SALES_STAFF.FIRST_NAME 

asc,SALES_STAFF.LAST_NAME asc,ORDER_HEADER_DETAILS.RETAILER_NAME asc local) as sc 

from 

User Guide 111


"GO Sales".GOSL.dbo.SALES_STAFF SALES_STAFF, 

(select ORDER_HEADER.RETAILER_NAME as 

RETAILER_NAME,ORDER_HEADER.SALES_STAFF_CODE as SALES_STAFF_CODE,ORDER_DETAILS.QUANTITY 

as QUANTITY from "GO Sales".GOSL.dbo.ORDER_HEADER ORDER_HEADER, "GO 

Sales".GOSL.dbo.ORDER_DETAILS ORDER_DETAILS where ORDER_HEADER.ORDER_NUMBER = 

ORDER_DETAILS.ORDER_NUMBER) ORDER_HEADER_DETAILS 

where 

(SALES_STAFF.SALES_STAFF_CODE = ORDER_HEADER_DETAILS.SALES_STAFF_CODE) 

group by 

SALES_STAFF.FIRST_NAME, 

SALES_STAFF.LAST_NAME, 

ORDER_HEADER_DETAILS.RETAILER_NAME 

order by 

FIRST_NAME asc, 

LAST_NAME asc, 

RETAILER_NAME asc 

) D3 

on (((D2.FIRST_NAME = D3.FIRST_NAME) and (D2.LAST_NAME = D3.LAST_NAME)) and 

(D2.sc = D3.sc)) 

Here is an example with the correct query results: 


Appendix B: Data Format Properties 

This chapter contains definitions of data formatting properties found in Framework Manager. 

The definition for each formatting property is also displayed when you select a property in the 

Data Format dialog in the Framework Manager. 

Note that for SAP BW metadata: 

• any unit of meaure information that exists in SAP BW is automatically appended to the data 

value 

• you cannot define a format for each currency in a multi-currency query subject. 

Data Formatting Properties 

Calendar Type 

Clock 

Currency 

Currency Display 

Currency Symbol 

The following is a list of properties available in the data formatting dialog. 

Specifies the type of calendar to be displayed. The date values will be mapped to the selected 

calendar before being formatted. The default value is inherited from the user's content 

language. Note that the Japanese Imperial setting is only applicable for Japanese languages. 

Any other languages will ignore this property if it is set to Japanese Imperial. 

Specifies whether to display the time in 12-hour or 24-hour format. The default value is inherited 

from the user's content language. 

Specifies the currency to be used. The default currency symbol will be displayed unless the 

values of the Currency Display and Currency Symbol properties are changed. The default value 

is inherited from the model. 

Specifies whether to display the international or local currency symbol. By default, the local 

currency symbol is displayed. 

Specifies a character or characters as a symbol to identify the local currency. This symbol will 

precede the number and any sign, even if it is a leading sign. A space between the symbol and 

the numeric value can be specified by entering it in this property, after the symbol. The default 

value is inherited from the user's content language. 

Currency Symbol Position 

Specifies where the currency symbol will appear. If End is selected, any spaces that follow the 

character or characters in the Currency Symbol or International Currency Symbol properties will 

be rendered between the number and the symbol. The default value is inherited from the user's 

content language. 

User Guide 113


Date Ordering 

Date Separator 

Date Style 

Decimal Separator 

Specifies the order in which to display the day, month, and year. The default value is inherited 


Specifies the character to be displayed between the year, month and day. The default value is 

inherited from the user's content language. 

Specifies the style of date to be used. The results that will be rendered are determined by the 

language. Typically, Short uses only numbers, Medium uses some abbreviated words, Long 

uses complete words, and Full includes all available details. 

Specifies the character that will separate non-decimal numbers from decimals. This property is 

ignored if no decimals are displayed. The default value is inherited from the user's content 

language. 

Display AM / PM Symbols 

Display As Exponent 

Display Days 

Display Eras 

Display Hours 

Display Milliseconds 

Specifies whether or not to display the AM or PM symbols. The default value is inherited from 

the user's content language. 

Specifies whether or not to render values in scientific notations, using exponents. If this property 

is set to No, no scientific notations will be used. If it is not specified, scientific notations will be 

used only when values exceed the maximum number of digits. The default value is inherited 


Specifies whether or not the day will be displayed. The format of the day can be controlled, by 

selecting one of the specific formats. Selecting Julian means that the 3 digit day of the year will 

be displayed. The default value is inherited from the user's content language. 

Specifies whether or not the era will be displayed. The default value is inherited from the user's 


Specifies whether or not to display the hours. The default value is inherited from the user's 


Specifies whether or not to display the milliseconds. The format of the milliseconds can be 

controlled, by selecting one of the specific formats. This property is ignored if seconds are not 

displayed. The default value is inherited from the user's content language. 


Display Minutes 

Display Months 

Display Seconds 

Display Time Zone 

Display Weekdays 

Display Years 

Exponent Symbol 

Group Size (digits) 


Specifies whether or not to display the minutes. The format of the minutes can be controlled, by 

selecting one of the specific formats. The default value is inherited from the user's content 

language. 

Specifies whether or not the month will be displayed. The format of the month can be controlled, 

by selecting one of the specific formats. The default value is inherited from the user's content 

language. 

Specifies whether or not to display the seconds. The format of the seconds can be controlled, by 

selecting one of the specific formats. The default value is inherited from the user's content 

language. 

Specifies whether or not to display the time zone. The default value is inherited from the user's 


Specifies whether or not the weekday will be displayed. The format of the weekday can be 

controlled, by selecting one of the specific formats. The default value is inherited from the user's 


Specifies whether or not the year will be displayed. The first two digits of the year (century) can 

be controlled, by selecting one of the associated property values. The default value is inherited 


Specifies the character to be displayed to identify exponents if the scientific notation is used. 

The symbol will be rendered after the number, separated by a space. The default value is 


Specifies the primary grouping size. This represents the number of digits left of the decimal 

point to be grouped together and separated by the thousands separator. The default value is 


International Currency Symbol 

Mantissa (digits) 

Specifies a character or characters as a symbol to identify the international currency. This 

symbol will take the position of the currency symbol. A space between the symbol and the 

numeric value can be specified by entering it in this property, after the symbol. The default value 

is inherited from the user's content language. 

Specifies the number of digits to be displayed following the exponent symbol if the scientific 

notation is used. 

User Guide 115


Maximum No. of Digits 

Specifies the maximum number of digits that can be displayed, including both sides of the 

decimal point. If the maximum number of digits is not sufficient to display the value, a scientific 

notation will be used. The default value is inherited from the user's content language. 

Minimum No. of Digits 

Specifies the minimum number of digits that can be displayed, including both sides of the 

decimal point. If the minimum number of digits is too high to display a value, the padding 

character will be used. The default value is inherited from the user's content language. 

Missing Value Characters 

Negative Pattern 

Specifies the character or characters to be displayed when the value is missing. If no value is 

entered for this property, an empty string will be displayed. 

Specifies a presentation format that is based on patterns, for negative numbers. Some 

restrictions exist for negative patterns. 

Negative Sign Position 

Specifies where the negative sign will appear. The default value is inherited from the user's 


Negative Sign Symbol 

Specifies how to display negative numbers. The default value is inherited from the user's content 

language. 

No. of Decimal Places 

Padding Character 

Specifies the number of digits to be displayed to the right of the decimal point. If this property is 

not set, the number of digits displayed will be as required. 

Specifies the character that will be used to pad values that have fewer digits than the minimum 

number of digits. The default value is inherited from the user's content language. 

Pattern 

Specifies a presentation format that is based on patterns. 

Percentage Symbol 

Specifies whether to display the values per hundred (percent) or per thousand. The symbol will 

be appended to the number and any trailing sign. A space between the numeric value and the 

symbol can be specified by entering it in this property, after the symbol. The default value is 


Percent Scale (integer) 

Specifies the scale to be applied to values before formatting. This property complements the 

Scale (integer) property. It is applied after the numeric scaling. If no value is entered, the percent 

scale will be derived from the specified or inherited percentage type. For example, if the 

Percentage type is set to per thousand, the percent scale will be set to -3. 


Scale (integer) 


Specifies how many digits to move the decimal delimiter for formatting purposes. For example, 

move the decimal three spaces to present values in thousands. The default value is inherited 

from the database field. 

Secondary Group Size (digits) 

Specifies the secondary grouping size. If a value is specified, it represents the number of digits 

left of the primary group that will be grouped together and separated by the thousands 

separator. If this property is left blank, the secondary grouping of digits is the same number as 

the primary group size, as specified by the Group Size (digits) property. The default value is 


Thousands Separator 

Time Separator 

Time Style 

Specifies how to delimit digit groups, such as thousands. This property is only used if the Use 

Thousands Separator property is set to Yes. The default value is inherited from the user's 


Specifies the character to be displayed between hour, minute and second. The default value is 


Specifies the style of time to be displayed. The exact results that will be rendered are 

determined by the language. Typically, Short means that the minimum details will be displayed, 

Long adds seconds, and Full means that all details are displayed, including the time zone. The 

default value is inherited from the user's content language. 

Time Unit 

Specifies the values' unit of measure. This property will be ignored if any day or time 

components are shown. The default value is inherited from the user's content language. 

Use Thousands Separator 

Specifies whether or not the grouping delimiter will be applied as defined by the Group Size 

property. The default value is inherited from the user's content language. 

Zero Value Characters 

Specifies the character or characters to be displayed when the value is zero (0). If no value is 

entered for this property, the Maximum No. of Digits property determines how many zero digits 

to display. 

User Guide 117



Appendix C: Using the Expression Editor 

An expression is any combination of operators, constants, functions, and other components that 

evaluates to a single value. You build expressions to create calculation and filter definitions. A 

calculation is an expression that you use to create a new value from existing values contained 

within a data item. A filter is an expression that you use to retrieve a specific subset of records. 

The Expression Editor UI displays the expression components that are supported by the data 

source in which the metadata is stored. For example, if you import metadata from an Oracle 

data source, the Expression Editor displays only the elements that are supported in Oracle. 

Note that SAP BW does not support any of the summary functions, constructs, and common 

functions, nor many of the operators and constants, that are listed in this appendix. 

Operators 

Operators specify what happens to the values on either side of the operator. Operators are 

similar to functions, in that they manipulate data items and return a result. 

- 

Performs arithmetic operations. 

Syntax 

- numeric_exp 

( 

Inserts an open parenthesis in your expression. 

Syntax 

(expression) 

) 

Inserts a closed parenthesis in your expression. 

Syntax 

(expression) 

* 


Syntax 

value1 * value2 

, 

Separates expression components. 

Syntax 

expression(param1, param2) 

User Guide 119


/ 


Syntax 

value1 / value2 

|| 

Concatenates strings. 

Syntax 

string1 || string2 

+ 


Syntax 

value1 + value2 

- 


Syntax 

value1 - value2 

< 

Compares values against a defined value and retrieves the values that are less than the defined 

value. 

Syntax 

value1 < value2 


Syntax 

value1 > value2 

--> 

Use with the Lookup operator to replace one value with another. 

Syntax 

Lookup (name) in (value1 --> value2) default (name) 

>= 

Compares values against a defined value and retrieves the values that are greater than or equal 

to the defined value. 

Syntax 

value1 >= value2 

and 

Returns true if the conditions on both sides of the expression are true. 

Syntax 

arg1 AND arg2 

auto 

Use with summary expressions to define the scope to be adjusted based on the grouping 

columns in the query. 

Syntax 

aggregate_function ( expression AUTO ) 

between 

Determines if a value falls in a given range. 

Syntax 

name BETWEEN value1 and value2 

case 

Use with When, Then, Else, and End. 

Syntax 

CASE expression { WHEN expression THEN expression } [ ELSE expression ] END 

contains 

Determines if a string contains another string. 

Syntax 

string1 CONTAINS string2 

default 

Inserts a default value when the conditions are not met. 

Syntax 

expression DEFAULT(value) 

distinct 

Includes only distinct occurrences within a data item in a calculation. 

User Guide 121


Syntax 

DISTINCT dataItem 

else 

Use with If or Case constructs. 

Syntax 

IF (condition) THEN .... ELSE (expression) , or CASE .... ELSE expression END 

end 

Use with Case When construct. 

Syntax 

CASE .... END 

for 

Use with summary expressions to define the scope of the aggregation in the query. 

Syntax 

aggregate_function ( expression FOR expression { , expression } ) 

for all 

Use with summary expressions to define the scope to be all the specified grouping columns in 

the query. See also FOR clause. 

Syntax 

aggregate_function ( expression FOR ALL expression { , expression } ) 

for any 

Use with summary expressions to define the scope to be adjusted based on a subset of the 

grouping columns in the query. Equivalent to FOR clause. 

Syntax 

aggregate_function ( expression FOR ANY expression { , expression } ) 

for report 

Use with summary expressions to define the scope to be the whole query. See also FOR 

clause. 

Syntax 

aggregate_function ( expression FOR REPORT ) 

if 

Use with Then and Else. 

Syntax 

IF (condition is true) THEN (action) ELSE (alternate action) 

in 

Determines if a value exists in a given list of values. 

Syntax 

exp1 IN (exp_list) 



in_range 

Determines if an item exists in a given list of constant values or ranges. 

Syntax 

expression IN_RANGE { constant : constant [ , constant : constant ] } 

is missing 

Determines if a value is undefined in the data. 

Syntax 

value IS MISSING 

is null 

Determines if a value is undefined in the data. 

Syntax 

value IS NULL 

is not missing 

Determines if a value is defined in the data. 

Syntax 

value IS NOT MISSING 

is not null 

Determines if a value is defined in the data. 

Syntax 

value IS NOT NULL 

like 

Determines if a string matches the pattern of another string. 

Syntax 

string1 LIKE string2 

lookup 

Finds and replaces data with a value you specify. 

Syntax 

LOOKUP (name) in (value1 --> value2) default (name) 

not 

Returns true if the condition is false, otherwise returns false. 

Syntax 

NOT arg 

or 

Returns true if either of the two conditions on both sides of the expression is true. 

Syntax 

arg1 OR arg2 

User Guide 123


prefilter 

Performs a summary calculation before applying the summary filter. 

Syntax 

summary ([expression] PREFILTER) 

rows 

Counts the number of rows output by the query. Use with Count(). 

Syntax 

count(ROWS) 

starts with 

Determines if a string starts with a given string. 

Syntax 

string1 STARTS WITH string2 

then 

Use with If or Case constructs. 

Syntax 

IF (condition) THEN ...., or CASE expression WHEN expression THEN .... END 

when 

Use with Case construct. 

Syntax 

Summaries 

CASE [expression] WHEN .... END 

A summary executes a predefined function and returns a summary value. 

average 

Returns the average value of selected data items. 

Syntax 

average ( [distinct] numeric_exp [for (expr) [, (expr)] | auto] ) 

Example 

average ( Sales ) 

Result: The average of all Sales values. 

count 

Returns the number of selected data items excluding NULL values. 

Syntax 

count ( [distinct] expr [for (expr) [, (expr)] | auto] ) 

Example 

count ( Sales ) 

Result: The total number of entries under Sales. 



maximum 

Returns the maximum value of selected data items. 

Syntax 

maximum ( [distinct] numeric_exp [for (expr) [, (expr)] | auto] ) 

Example 

maximum ( Sales ) 

Result: The maximum value of all Sales values. 

minimum 

Returns the minimum value of selected data items. 

moving-average 

Syntax 

minimum ( [distinct] numeric_exp [for (expr) [, (expr)] | auto] ) 

Example 

minimum ( Sales ) 

Result: The minimum value of all Sales values. 

Returns a moving average by row for a specified set of values of over a specified number of 

rows. 

Syntax 

moving-average ([distinct] numeric_exp, integer_const [for (expr) [, (expr)] | auto]) 

Example 

moving-average ( Qty, 3 ) 

Result: For each row, this displays the quantity and a moving average of the current row and the 

preceding two rows. 

moving-total 

Returns a moving total by row for a specified set of values over a specified number of rows. 

Syntax 

moving-total ( [distinct] numeric_exp, integer_const [for (expr) [, (expr)] | auto] ) 

Example 

moving-total ( Qty, 3 ) 

Result: For each row, this displays the quantity and a moving total of the current row and the 

preceding two rows. 

percentage 

Returns the percent of the total value for selected data items. 

Syntax 

percentage ( [distinct] numeric_exp [for (expr) [, (expr)] | auto] ) 

Example 

percentage ( sales 98 ) 

Result: Shows the percentage of the total sales for 1998 that is attributed to each sales 

representative. 

User Guide 125


percentile 

Returns a value, on a scale of one hundred, that indicates the percent of a distribution that is 

equal to or below the selected data items. 

Syntax 

percentile ( [distinct] numeric_exp [for (expr) [, (expr)] | auto] ) 

Example 

percentile ( Sales 98 ) 

Result: For each row, displays the percentage that the current sales value represents when 

compared to the highest sales value. 

quantile 

Returns the rank of a value in terms of a range that you specify. It returns integers to represent 

any range of ranks, such as 1 (highest) to 100 (lowest). 

Syntax 

quantile ( [distinct] numeric_exp, integer_const [for (expr) [, (expr)] | auto] ) 

Example 

Quantile ( Qty, 4 ) 

Result: The quantity, the rank of the quantity value, and the quantity values broken down into 4 

quantile groups (quartiles). 

quartile 

Returns the rank of a value, represented as integers from 1 (highest) to 4 (lowest), relative to a 

group of values. 

Syntax 

quartile ( [distinct] numeric_exp [for (expr) [, (expr)] | auto] ) 

Example 

quartile ( Qty ) 

Result: This displays the quantity and the quartile of the quantity value represented as integers 

from 1 (highest) to 4 (lowest). 

rank 

Returns the rank value of selected data items. 

Syntax 

rank ( [distinct] numeric_exp [for (expr) [, (expr)] | auto] ) 

Example 

rank ( Sales 98 ) 

Result: For each row, this displays the rank value of sales for 1998 that is attributed to each 

sales representative. 

running-average 

Returns the running average by row (including the current row) for a set of values. 

Syntax 

running-average ( [distinct] numeric_exp [for (expr) [, (expr)] | auto] ) 

Example 

running-average ( Qty ) 



Result: For each row, this displays the quantity and a running average of the current and the 

previous rows. 

running-count 

Returns the running count by row (including the current row) for a set of values. 

Syntax 

running-count ( [distinct] numeric_exp [for (expr) [, (expr)] | auto] ) 

Example 

running-count ( Qty ) 

Result: For each row, this displays the quantity and a running count of the position of current 

row. 

running-difference 

Returns a running difference by row, calculated as the difference between the value for the 

current row and the preceding row, (including the current row) for a set of values. 

Syntax 

running-difference ( [distinct] numeric_exp [for (expr) [, (expr)] | auto] ) 

Example 

running-difference ( Qty ) 

Result: For each row, this displays the quantity and a running difference between the value for 

the current row and the preceding row. 

running-maximum 

Returns the running maximum by row (including the current row) for a set of values. 

Syntax 

running-maximum ( [distinct] numeric_exp [for (expr) [, (expr)] | auto] ) 

Example 

running-maximum ( Qty ) 

Result: For each row, this displays the quantity and a running maximum of the current and 


running-minimum 

Returns the running minimum by row (including the current row) for a set of values. 

Syntax 

running-minimum ( [distinct] numeric_exp [for (expr) [, (expr)] | auto] ) 

Example 

running-minimum ( Qty ) 

Result: For each row, this displays the quantity and a running minimum of the current and 


running-total 

Returns a running total by row (including the current row) for a set of values. 

Syntax 

running-total ( [distinct] numeric_exp [for (expr) [, (expr)] | auto] ) 

Example 

running-total ( Qty ) 

User Guide 127


Result: For each row, this displays the quantity and a running total of the current and previous 

rows. 

standard-deviation 

Returns the standard deviation of selected data items. 

Syntax 

standard-deviation ( [distinct] numeric_exp [for (expr) [, (expr)] | auto] ) 

Example 

standard-deviation ( ProductCost ) 

Result: A value indicating the deviation between product costs and the average product cost. 

standard-deviation-pop 

Computes the population standard deviation and returns the square root of the population 

variance. 

Syntax 

standard-deviation-pop ( [distinct] numeric_exp [for (expr) [, (expr)] | auto] ) 

Example 

standard-deviation-pop ( ProductCost ) 

Result: A value of the square root of the population variance. 

tertile 

Returns the rank of a value as High, Middle, or Low relative to a group of values. 

Syntax 

tertile ( [distinct] numeric_exp [for (expr) [, (expr)] | auto] ) 

Example 

tertile ( Qty ) 

Result: Shows quantity, the quantile of the quantity value as broken down into tertiles, and the 

quantity values broken down into tertiles. 

total 

Returns the total value of selected data items. 

Syntax 

total ( [distinct] numeric_exp [for (expr) [, (expr)] | auto] ) 

Example 

total ( Sales ) 

Result: The total value of all Sales values. 

variance 

Returns the variance of selected data items. 

Syntax 

variance ( [distinct] numeric_exp [for (expr) [, (expr)] | auto] ) 

Example 

variance ( Product Cost ) 

Result: A value indicating how widely product costs vary from the average product cost. 



variance-pop 

Constants 

Returns the population variance of a set of numbers after discarding the nulls in this set. 

Syntax 

variance-pop ( [distinct] numeric_exp [for (expr) [, (expr)] | auto] ) 

Example 

variance-pop ( Qty) 

Result: For each row, this displays the population variance of a set of numbers after discarding 

the nulls in this set. 

A constant is a fixed value that you can use in an expression. 

date 

date-time 

Inserts the current system date. 

Inserts the current system date and time. 

Syntax 

date-time 

false 

interval 

Inserts false value. 

Inserts the current system interval. 

Syntax 

interval 

null 

number 

string 

time 

true 

Inserts a null value if the expression conditions are not met. 

Inserts the number 0, which you can replace with a new numeric value. 

Inserts two quotation marks and positions the cursor between them. 

Inserts the current system time. 

Inserts true value. 

User Guide 129


Constructs 

if then else 

Syntax 

example: IF ([Country] = 'Canada') THEN ([List Price] * 0.60) ELSE ([List 

Price]) 

in_range 

Specify one or more constants or ranges. A range can be open ended. 

Example 

[gosales].[CONVERSIONRATE].[COUNTRYCODE] IN_RANGE { :30 , 40, 50, 999: } 

search case 

Syntax 

example: CASE WHEN [Country] = 'Canada' THEN ([List Price] * 0.60) WHEN 

[CountryCode] > 100 THEN [List Price] * 0.80 ELSE [List Price] END 

simple case 

Syntax 

example: CASE [Country] WHEN 'Canada' THEN ([List Price] * 0.60) WHEN 

'Australia' THEN [List Price] * 0.80 ELSE [List Price] END 

Business Date/Time Functions 

_add_days 

Returns the date or datetime resulting from adding integer_exp days to date_exp. 

Syntax 

_add_days ( date_exp, integer_exp ) 

Example 

_add_days ( 2002-04-30 , 1 ) 

Result: 2002-05-01 

_add_months 

Returns the date or datetime resulting from adding integer_exp months to date_exp. 

Syntax 

_add_months ( date_exp, integer_exp ) 

Example 

_add_months ( 2002-04-30 , 1 ) 

Result: 2002-05-30 

_add_years 

Returns the date or datetime resulting from adding integer_exp years to date_exp. 

Syntax 

_add_years ( date_exp, integer_exp ) 



Example 

_add_years ( 2002-04-30 , 1 ) 

Result: 2003-05-30 

_age 

Returns a number that is obtained from subtracting date_exp from today’s date. This value has 

the form YYYYMMDD, where YYYY represents the number of years, MM represents the 

number of months, and DD represents the number of days. 

Syntax 

_age (date_exp ) 

Example 

Today's date=2003-02-05 _age ( 1990-04-30 ) 

Result: 120906 that is 12 years, 9 months and 6 days 

_day_of_week 

Returns the day of week ( between 1 and 7), where 1 is the first day of the week as indicated by 

the second parameter (between 1 and 7, 1 being Monday and 7 being Sunday). Note that in ISO 

8601 standard, a week begins with Monday being day 1. In North America where Sunday is the 

first day of the week being day 7. 

Syntax 

_day_of_week ( date_exp, integer ) 

Example 

_day_of_week ( 2003-01-01, 1 ) 

Result: 3 

_day_of_year 

Returns the ordinal for the day of the year in date_ exp (1 to 366). Also known as Julian day. 

Syntax 

_day_of_year ( date_exp ) 

Example 

_day_of_year ( 2003-03-01 ) 

Result: 61 

_days_between 

Returns a positive or negative number representing the number of days between the two date 

expressions. If date_exp1 < date_exp2 then the result will be a negative number. 

Syntax 

_days_between ( date_exp1, date_exp2 ) 

Example 

_days_between ( 2002-04-30 , 2002-06-21 ) 

Result: -52 

_days_to_end_of_month 

Returns a number representing the number of days remaining in the month represented by the 

date expression date_exp. 

User Guide 131


_first_of_month 

Syntax 

_days_to_end_of_month ( date_exp ) 

Example 

_days_to_end_of_month ( 2002-04-20 14:30:22.123 ) 

Result: 10 

Returns a date or datetime obtained from converting date_exp to a date with the same year and 

month but the day set to 1. 

Syntax 

_first_of_month ( date_exp ) 

Example 

_first_of_month ( 2002-04-20 ) 

Result: 2002-04-01 

_last_of_month 

Returns a date or datetime that is the last day of the month represented by date_exp. 

Syntax 

_last_of_month ( date_exp ) 

Example 

_last_of_month ( 2002-01-14 ) 

Result: 2002-01-31 

_make_timestamp 

Returns a timestamp constructed from integer_exp1 (the year), integer_exp2 (the month) and 

integer_exp3 (the day). 

Syntax 

_make_timestamp ( integer_exp1, integer_exp2, integer_exp3 ) 

Example 

_make_timestamp ( 2002 , 01 , 14 ) 

Result: 2002-01-14 00:00:00.000 

_months_between 

Returns a positive or negative integer number representing the number of months between 

date_exp1 to date_exp2. If date_exp1 < date_exp2, then a negative number is returned. 

Syntax 

_months_between ( date_exp1, date_exp2 ) 

Example 

_months_between ( 2002-01-30, 2002-04-03 ) 

Result: 2 

_round 

Returns the numeric expression rounded to the integer_exp places right of the decimal point. 

NOTE: integer_exp MUST be a non-negative integer. 



_week_of_year 

Syntax 

_round ( numeric, integer_exp ) 

Example 

_round ( 1220.42369, 2 ) 

Result: 1220.42 

Returns the number of the week of the year of the date_exp according to ISO 8601, in which 

week 1 of the year is the first week of the year to contain a Thursday, which is equivalent to the 

first week containing January 4th. 

Syntax 

_week_of_year ( date_exp ) 

Example 

_week_of_year ( 2003-01-01 ) 

Result: 1 

_years_between 

Returns a positive or negative integer number representing the number of years from date_exp1 

to date_exp2. If date_exp1 < date_exp2 then a negative value is returned. 

Syntax 

_years_between ( date_exp1, date_exp2 ) 

Example 

_years_between ( 2003-01-30, 2001-04-03 ) 

Result: 1 

_ymdint_between 

Returns a number representing the difference between the date expressions D1 and D2. This 

value has the form YYYYMMDD, where YYYY represents the number of years, MM represents 

the number of months, and DD represents the number of days. 

Syntax 

_ymdint_between ( date_exp1, date_exp2 ) 

Example 

_ymdint_between ( 1990-04-30 , 2003-02-05 ) 

Common Functions 

abs 

Returns the absolute value of numeric_exp. The sign of negative values is changed to positive. 

Syntax 

abs ( numeric_exp ) 

Example 1 

abs ( 15 ) 

Result: 15 

User Guide 133


Example 2 

abs ( -15 ) 

Result: 15 

cast 

Returns expression converted to datatype specified. 

Syntax 

cast ( expression, datatype_specification ) 

Example 

cast ( '123' , integer ) 

Result: 123 

ceiling 

Returns the smallest integer greater than or equal to numeric_exp. 

Syntax 

ceiling ( numeric_exp ) 

Example 1 

ceiling ( 4.22 ) 

Result: 5 

Example 2 

ceiling ( -1.23 ) 

Result: -1 

character_length 

Returns the number of characters in string_exp. 

Syntax 

character_length ( string_exp ) 

Example 

character_length ( 'Canada' ) 

Result: 6 

coalesce 

Returns the first non-null argument (or null if all arguments are null). The Coalesce function 

takes two or more arguments. 

Syntax 

coalesce ( exp_list ) 

current_date 

Returns a date value representing the current date of the computer that the database software 

runs on. 

Syntax 

current_date 

Example 

current_date 

Result: 2003-03-04 



current_time 

Returns a time value, representing the current time of the computer that runs the database 

software. 

Syntax 

current_time 

Example 

current_time 

Result: 16:33:11 

current_timestamp 

Returns a datetime value, representing the current timestamp of the computer that runs the 

database software. 

Syntax 


Example 


Result: 2003-03-03 16:40:15.535000 

exp 

Returns e raised to the power of numeric_exp. The constant e is the base of the natural 

logarithm. See also log. 

Syntax 

exp ( numeric_exp ) 

Example 

exp ( 2 ) 

Result: 7.389056 

extract 

Returns an integer representing the value of datepart (year, month, day, hour, minute, second) 

in datetime_exp. 

Syntax 

extract ( datepart , datetime_exp ) 

Example 1 

extract ( year , 2003-03-03 16:40:15.535 ) 

Result: 2003 

Example 2 

extract ( hour , 2003-03-03 16:40:15.535 ) 

Result: 16 

floor 

Returns the largest integer less than or equal to numeric_exp. 

Syntax 

floor ( numeric_exp ) 

User Guide 135


Example 1 

floor ( 3.22 ) 

Result: 3 

Example 2 

floor ( -1.23 ) 

Result: -2 

ln 

Returns the natural logarithm of the numeric_exp. 

Syntax 

ln ( numeric_exp ) 

Example 

ln ( 4 ) 

Result: 1.38629 

lower 

Returns string_exp with all uppercase characters shifted to lowercase. 

Syntax 

lower ( string_exp ) 

Example 

lower ( 'ABCDEF' ) 

Result: 'abcdef' 

mod 

Returns the remainder (modulus) of integer_exp1 divided by integer_exp2. The integer_exp2 

must not be zero or an exception condition is raised. 

Syntax 

mod ( integer_exp1, integer_exp2 ) 

Example 

mod ( 20 , 3 ) 

Result: 2 

octet_length 

Returns the number of bytes in string_exp. 

Syntax 

octet_length ( string_exp ) 

Example 1 

octet_length ( 'ABCDEF' ) 

Result: 6 

Example 2 

octet_length ( '' ) 

Result: 0 



position 

Returns integer value representing the position of the first string_exp in the second string_exp 

or 0 when the first string_exp is not found. 

Syntax 

position ( string_exp , string_exp ) 

Example 1 

position ( 'C' , 'ABCDEF' ) 

Result: 3 

Example 2 

position ( 'H' , 'ABCDEF' ) 

Result: 0 

power 

Returns numeric_exp1 raised to the power numeric_exp2. If numeric_exp1 is negative then 

numeric_exp2 must result in an integer value. 

Syntax 

power ( numeric_exp1, numeric_exp2 ) 

Example 

power ( 3 , 2 ) 

Result: 9 

sqrt 

Returns the square root of numeric_exp. numeric_exp must be non-negative. 

Syntax 

sqrt ( numeric_exp ) 

Example 

sqrt ( 9 ) 

Result: 3 

substring 

Returns the substring of string_exp that starts at position integer_exp1 for integer_exp2 

characters or to the end of string_exp if integer_exp2 is omitted. The first character in string_exp 

is at position 1. 

Syntax 

substring ( string_exp , integer_exp1 [ , integer_exp2 ] ) 

Example 

substring ( 'abdefg', 3, 2) 

Result: 'de' 

trim 

Returns a string_exp trimmed of leading and/or trailing blanks or trimmed of a certain character 

specified in match_character_exp. BOTH is implicit when first argument is not stated and blank 

is implicit when second argument is not stated. 

Syntax 

trim ( [ [ TRAILING | LEADING | BOTH ] [ match_character_exp ] , ] string_exp ) 

User Guide 137


Example 1 

trim ( TRAILING 'A' , 'ABCDEFA' ) 

Result: 'ABCDEF' 

Example 2 

trim ( BOTH ' ABCDEF ' ) 


upper 

Returns string_exp with all lowercase characters shifted to uppercase. 

Syntax 

upper ( string_exp ) 

Example 

upper ( 'abcdef' ) 


DB2 

ascii 

Returns the ASCII code value of the leftmost character of the argument as an integer. 

Syntax 

ascii ( string_exp ) 

ceiling 


Syntax 

ceiling ( numeric_exp ) 

char 

Returns a string representation of a date/time value or a decimal number. 

Syntax 

char ( exp ) 

chr 

Returns the character that has the ASCII code value specified by integer_exp. integer_exp 

should be between 0 and 255. 

Syntax 

chr ( integer_exp ) 

concat 

Returns a string that is the result of concatenating string_exp1 with string_exp2. 

Syntax 

concat ( string_exp1, string_exp2 ) 

date 

Returns a date from a single input value. exp can be a string or integer representation of a date. 



Syntax 

date ( exp ) 

day 

Returns the day of the month (1-31) from date_exp. date_exp can be a date value or a string 

representation of a date. 

Syntax 

day ( date_exp ) 

dayname 

Returns a character string containing the data source-specific name of the day (for example, 

Sunday through Saturday or Sun. through Sat. for a data source that uses English, or Sonntag 

through Samstag for a data source that uses German) for the day portion of date_exp. date_exp 

can be a date value or a string representation of a date. 

Syntax 

dayname ( date_exp ) 

dayofweek 

Returns the day of the week in date_exp as an integer in the range 1 to 7, where 1 represents 

Sunday. date_exp can be a date value or a string representation of a date. 

Syntax 

dayofweek ( date_exp ) 

dayofweek_iso 


Monday. date_exp can be a date value or a string representation of a date. 

Syntax 

dayofweek_iso ( date_exp ) 

dayofyear 

Returns the day of the year in date_exp as an integer in the range 1 to 366. date_exp can be a 

date value or a string representation of a date. 

Syntax 

dayofyear ( date_exp ) 

days 

Returns an integer representation of a date. exp can be a date value or a string representation 

of a date. 

Syntax 

days ( exp ) 

decimal 

Returns decimal representation of string_exp1 with precision numeric_exp1, scale 

numeric_exp2 and decimal character string_exp2. String_exp1 must be formatted as a SQL 

Integer or Decimal constant. 

Syntax 

decimal ( string_exp1 [ , numeric_exp1 [ , numeric_exp2 [ , string_exp2 ] ] ] ) 

User Guide 139


difference 

Returns an integer value representing the difference between the values returned by the data 

source-specific soundex function for string_exp1 and string_exp2. The value returned ranges 

from 0 to 4, with 4 indicating the best match. Note that 4 does not mean that the strings are 

equal. 

Syntax 

difference ( string_exp1, string_exp2 ) 

digits 

Returns the character string representation of a non-floating point number. 

Syntax 

digits ( numeric_exp ) 

double 

Returns the floating-point representation of an expression. 'exp' can be either a numeric or 

string expression. 

Syntax 

double ( exp ) 

event_mon_state 

Returns the operational state of a particular state monitor. 

Syntax 

event_mon_state ( string_exp ) 

float 

Returns the floating-point representation of a number. 

Syntax 

float ( numeric_exp ) 

hex 

Returns the hexadecimal representation of a value. 

Syntax 

hex ( exp ) 

hour 

Returns the hour (an integer from 0, which is midnight, to 23, which is 11:00 pm) from time_exp. 

time_exp can be a time value or a string representation of a time. 

Syntax 

hour ( time_exp ) 

insert 

Returns a string where length (integer_exp2) characters have been deleted from string_exp1 

beginning at start (integer_exp1) and where string_exp2 has been inserted into string_exp1 at 

start. The first character in a string is at position 1. 

Syntax 

insert ( string_exp1, integer_exp1, integer_exp2, string_exp2 ) 



integer 

Returns the integer representation of an expression. exp can be a numeric value or a string 

representation of a number. 

Syntax 

integer ( exp ) 

julian_day 

Returns an integer value representing the number of days from January 1, 4712 BC (the start of 

the Julian date calendar) to the date value specified in exp. exp can be a date value or a string 

representation of a date. 

Syntax 

julian_day ( exp ) 

lcase 


Syntax 

lcase ( string_exp ) 

left 

Returns the leftmost integer_exp characters of string_exp. 

Syntax 

left ( string_exp, integer_exp ) 

length 

Returns the length of the operand in bytes (except for double byte string types which return the 

length in characters). 

Syntax 

length ( exp ) 

locate 

Returns the starting position of the first occurrence of string_exp1 within string_exp2. The 

search starts at position start (integer_exp) of string_exp2. The first character in a string is at 

position 1. If string_exp1 is not found then zero is returned. 

long_varchar 

Syntax 

locate ( string_exp1, string_exp2 [ , integer_exp ] ) 

Returns a long string. 

Syntax 

long_varchar ( string_exp ) 

ltrim 

Returns string_exp with leading spaces removed. 

Syntax 

ltrim ( string_exp ) 

User Guide 141


microsecond 

Returns the microsecond (time-unit) part of a value. exp can be a timestamp or a string 

representation of a timestamp. 

Syntax 

microsecond ( exp ) 

midnight_seconds 

Returns an integer value in the range 0 to 86400 representing the number of seconds between 

midnight and time value specified in the argument. exp can be a time value, a timestamp or a 

string representation of a time. 

Syntax 

midnight_seconds ( exp ) 

minute 

Returns the minute (an integer from 0-59) from time_exp. time_exp can be a time value, a 

timestamp or a string representation of a time. 

Syntax 

minute ( time_exp ) 

month 

Returns the month (an integer from 1-12) from date_exp. 

Syntax 

month ( date_exp ) 

monthname 

Returns a character string containing the data source-specific name of the month (for example, 

January through December or Jan. through Dec. for a data source that uses English, or Januar 

through Dezember for a data source that uses German) for the month portion of date_exp. 

Syntax 

monthname ( date_exp ) 

quarter 

Returns the quarter in date_exp as a number in the range 1 to 4, where 1 represents January 1 

through March 31. 

Syntax 

quarter ( date_exp ) 

radians 

Returns the number of radians converted from numeric_exp degrees. 

Syntax 

radians ( numeric_exp ) 

repeat 

Returns a string consisting of string_exp repeated integer_exp times. 

Syntax 

repeat ( string_exp, integer_exp ) 



replace 

Replaces all occurrences of string_exp2 in string_exp1 with string_exp3. 

Syntax 

replace ( string_exp1, string_exp2, string_exp3 ) 

right 

Returns the rightmost integer_exp characters of string_exp. 

Syntax 

right ( string_exp, integer_exp ) 

round 

Returns numeric_exp rounded to the nearest value integer_exp places right of the decimal 

point. If integer_exp is negative, numeric_exp is rounded to the nearest value absolute 

(integer_exp) places to the left of the decimal point, e.g., round-near (125, -1) rounds to 130. 

Syntax 

round ( numeric_exp, integer_exp ) 

rtrim 

Returns string_exp with trailing spaces removed. 

Syntax 

rtrim ( string_exp ) 

second 

Returns the second (an integer from 0-59) from time_exp. 

Syntax 

second ( time_exp ) 

sign 

Returns an indicator of the sign of numeric_exp: +1 if numeric_exp is positive, 0 if zero or -1 if 

negative. 

Syntax 

sign ( numeric_exp ) 

smallint 

Returns the small integer representation of a number. 

Syntax 

smallint ( exp ) 

soundex 

Returns a 4 character string code obtained by systematically abbreviating words and names in 

string_exp according to phonetics. Can be used to determine if two strings sound the same, 

e.g., does sound-of ('SMITH') = sound-of ('SMYTH'). 

Syntax 

soundex ( string_exp ) 

space 

Returns a string consisting of integer_exp spaces. 

User Guide 143


Syntax 

space ( integer_exp ) 

substring 


characters. The first character in string_exp is at position 1. 

Syntax 

substring ( string_exp, integer_exp1 [ , integer_exp2 ] ) 

table_name 

Returns an unqualified name of a table or view based on the object name in string_exp1 and the 

schema name given in string_exp2. It is used to resolve aliases. 

Syntax 

table_name ( string_exp1 [ , string_exp2 ] ) 

table_schema 

Returns the schema name portion of the two part table or view name based on the object name 

in string_exp1 and the schema name in string_exp2. It is used to resolve aliases. 

Syntax 

table_schema ( string_exp1 [ , string_exp2 ] ) 

time 

Returns a time from a value. 

Syntax 

time ( exp ) 

timestamp 

Returns a timestamp from a value or a pair of values. exp1 must represent a date value, and 

exp2 must represent a time value. 

Syntax 

timestamp ( exp1 [ , exp2 ] ) 

timestamp_iso 

Returns a datetime in the ISO format (yyyy-mm-dd hh:mm:ss.nnnnnn) converted from the IBM 

format (yyyy-mm-dd-hh.mm.ss.nnnnnn). If the exp is a time, it inserts the value of the 

CURRENT DATE for the date elements and zero for the fractional time element. 

Syntax 

timestamp_iso ( exp ) 

timestampdiff 

Returns an estimated number of intervals of type exp1 based on the difference between two 

timestamps. Exp2 is the result of subtracting two timestamp types and converting the result to 

CHAR. Valid values of exp1 are: 1 Fractions of a second; 2 Seconds; 4 Minutes; 8 Hours; 16 

Days; 32 Weeks; 64 Months; 128 Quarters; 256 Years 

Syntax 

timestampdiff ( exp1, exp2 ) 



translate 

Returns string_exp1 in which characters from string_exp3 are translated to the equivalent 

characters in string_exp2. string_exp4 is a single character that is used to pad string_exp2 if it is 

shorter than string_exp3. If only string_exp1 is present, then this function translates it to 

uppercase characters. 

Syntax 

translate ( string_exp1 [ , string_exp2, string_exp3 [ , string_exp4 ] ] ) 

truncate 

Returns numeric_exp1 truncated to numeric_exp2 places RIGHT of the decimal point. If 

numeric_exp2 is negative, numeric_exp1 is truncated to the absolute value of numeric_exp2 

places to the LEFT of the decimal point. 

Syntax 

truncate ( numeric_exp1, numeric_exp2 ) 

ucase 


Syntax 

ucase ( string_exp ) 

value 

Returns the first non-null argument (or null if all arguments are null). The Value function takes 

two or more arguments. 

Syntax 

value ( exp_list ) 

varchar 

Returns a VARCHAR representation of exp, with length numeric_exp. 

Syntax 

varchar ( exp [ , numeric_exp ] ) 

week 

Returns the week of the year in date_exp as an integer value in the range 1 to 53. 

Syntax 

week ( date_exp ) 

year 

Returns the year from date_exp. 

Syntax 

year ( date_exp ) 

DB2 Cast 

cast_char 

Returns the first numeric_exp characters of the value of exp cast as a string. The whole string is 

returned when the second argument is not specified. 

User Guide 145


Syntax 

cast_char ( exp [ , numeric_exp ] ) 

cast_date 

Returns the value of the expression cast as a date. 

cast_decimal 

Syntax 

cast_date ( exp ) 

Returns the value of exp cast as a decimal with the precision of numeric_exp1 and scale of 

numeric_exp2. 

Syntax 

cast_decimal ( exp [ , numeric_exp1, numeric_exp2 ] ) 

cast_double 

Returns the value of the expression cast as a double. 

Syntax 

cast_double ( exp ) 

cast_double_precision 

Returns the value of the expression cast as a double. 

Syntax 

cast_double_precision ( exp ) 

cast_float 

Returns the value of the expression cast as a float. 

Syntax 

cast_float ( exp ) 

cast_integer 

Returns the value of the expression cast as a integer. 

Syntax 

cast_integer ( exp ) 

cast_longvarchar 

Returns the value of the expression cast as a longvarchar. 

Syntax 

cast_longvarchar ( string_exp ) 

cast_smallint 

Returns the value of the expression cast as a smallint. 

Syntax 

cast_smallint ( exp ) 

cast_time 

Returns the value of the expression cast as a time value 



Syntax 

cast_time ( string_exp ) 

cast_timestamp 

Returns the value of the expression cast as a datetime. 

Syntax 

cast_timestamp ( exp ) 

cast_varchar 

Returns the value of the expression cast as a varchar with length. 

Syntax 

cast_varchar ( exp, integer_exp ) 

DB2 Math 

log 

Returns the natural logarithm of numeric_exp. 

Syntax 

log ( numeric_exp ) 

log10 

Returns the base ten logarithm of numeric_exp. 

Syntax 

log10 ( numeric_exp ) 

rand 

Generates a random number using integer_exp as a seed value. 

Syntax 

rand ( integer_exp ) 

DB2 Trigonometry 

acos 

Returns the arccosine of numeric_exp in radians. The arccosine is the angle whose cosine is 

numeric_exp. 

Syntax 

acos ( numeric_exp ) 

asin 

Returns the arcsine of numeric_exp in radians. The arcsine is the angle whose sine is 

numeric_exp. 

Syntax 

asin ( numeric_exp ) 

atan 

Returns the arctangent of numeric_exp in radians. The arctangent is the angle whose tangent is 

numeric_exp. 

User Guide 147


Syntax 

atan ( numeric_exp ) 

atan2 

Returns the arctangent of the x and y coordinates specified by numeric_exp1 and 

numeric_exp2, respectively, in radians. The arctangent is the angle whose tangent is 

numeric_exp2 / numeric_exp1. 

Syntax 

atan2 ( numeric_exp1, numeric_exp2 ) 

cos 

Returns the cosine of numeric_exp where numeric_exp is an angle expressed in radians. 

Syntax 

cos ( numeric_exp ) 

cot 

Returns the cotangent of numeric_exp where numeric_exp is an angle expressed in radians. 

Syntax 

cot ( numeric_exp ) 

degrees 

Returns numeric_exp radians converted to degrees. 

Syntax 

degrees ( numeric_exp ) 

sin 

Returns the sine of numeric_exp where numeric_exp is an angle expressed in radians. 

Syntax 

sin ( numeric_exp ) 

tan 

Returns the tangent of numeric_exp where numeric_exp is an angle expressed in radians. 

Syntax 

MS Access 

tan ( numeric_exp ) 

ascii 

Returns a number representing the ascii code value of the leftmost character of string_exp. 

Syntax 

ascii(string_exp) 

ceiling 


Syntax 

ceiling(numeric_exp) 



char 



Syntax 

char(integer_exp) 

concat 

Returns a string that is the result of concatenating string_exp1 to string_exp2. 

Syntax 

concat(string_exp1, string_exp2) 

curdate 

Returns a date value representing the current date of the computer that the database software 

runs on. 

Syntax 

curdate() 

curtime 

Returns a time value representing the current time of the computer that the database software 

runs on. 

Syntax 

curtime() 

dayname 

Returns a character string containing the data source-specific name of the day (for example, 

Sunday through Saturday or Sun. through Sat. for a data source that uses English, or Sonntag 

through Samstag for a data source that uses German) for the day portion of date_exp. 

Syntax 

dayname(date_exp) 

dayofmonth 

Returns the day of the month (1-31) from date_exp. Returns the days field (a signed integer) 

from interval_exp. 

Syntax 

dayofmonth(date_exp|interval_exp) 

dayofweek 


Monday. 

Syntax 

dayofweek(date_exp) 

dayofyear 

Returns the day of the year in date_exp as an integer in the range 1 to 366. 

Syntax 

dayofyear(date_exp) 

User Guide 149


downshift 


Syntax 

downshift(string_exp) 

hour 

Returns the hour (an integer from 0, which is midnight, to 23, which is 11:00 pm) from time_exp. 

Syntax 

hour(time_exp) 

lcase 

Returns string_exp with all uppercase characters shifted to lowercase 

Syntax 

lcase(string_exp) 

left 

Returns the leftmost integer_exp characters of string_exp. 

Syntax 

left(string_exp, integer_exp) 

length 

Returns the number of characters in string_exp, excluding trailing blanks and the string 

termination character. 

Syntax 

length(string_exp) 

locate 

Returns the starting position of the first occurrence of string_exp1 within string_exp2. The 

search starts at position start (integer_exp) of string_exp2. The first character in a string is at 

position 1. If string_exp1 is not found then zero is returned. 

Syntax 

locate(string_exp1, string_exp2 [ , integer_exp ] ) 

ltrim 


Syntax 

ltrim(string_exp) 

minute 

Returns the minute (an integer from 0-59) from time_exp. 

Syntax 

minute(time_exp) 

month 

Returns the month (an integer from 1-12) from date_exp. 



Syntax 

month(date_exp) 

monthname 

Returns a character string containing the data source-specific name of the month (for example, 

January through December or Jan. through Dec. for a data source that uses English, or Januar 

through Dezember for a data source that uses German) for the month portion of date_exp. 

Syntax 

monthname(date_exp) 

now 

Returns a datetime value representing the current date and time of the computer that the 

database software runs on. 

Syntax 

now() 

position 

Returns the starting position of string_exp1 in string_exp2. The first character in a string is at 

position 1. 

Syntax 

position(string_exp1, string_exp2) 

quarter 

Returns the quarter in date_exp as a number in the range 1 to 4, where 1 represents January 1 

through March 31. 

Syntax 

quarter(date_exp) 

right 


Syntax 

right(string_exp, integer_exp) 

round 



(integer_exp) places to the left of the decimal point. 

Syntax 

round(numeric_exp, integer_exp) 

rtrim 


Syntax 

rtrim(string_exp) 

sign 


negative. 

User Guide 151


Syntax 

sign(numeric_exp) 

space 


Syntax 

space(integer_exp) 

substr 



Syntax 

substr(string_exp, integer_exp1, integer_exp2) 

substring 



Syntax 

substring(string_exp, integer_exp1, integer_exp2) 

truncate 


Syntax 

truncate(string_exp) 

ucase 


Syntax 

ucase(string_exp) 

upshift 


Syntax 

upshift(string_exp) 

week 

Returns the week of the year in date_exp as an integer value in the range 1 to 53. 

Syntax 

week(date_exp) 

year 

Returns the year from date_exp. 

Syntax 

year(date_exp) 



MS Access Cast 

cast_decimal 

Returns the value of the expression cast as a decimal. 

Syntax 

cast_decimal(exp) 

cast_float 


Syntax 

cast_float(exp) 

cast_integer 

Returns the value of the expression cast as a integer. 

Syntax 

cast_integer(exp) 

cast_numeric 

Returns the value of string_exp cast as a numeric value. 

Syntax 

cast_numeric(string_exp) 

cast_real 

Returns the value of the expression cast as a real. 

Syntax 

cast_real(exp) 

cast_smallint 

Returns the value of the expression cast as a smallint. 

Syntax 

cast_smallint(exp) 

cast_varchar 

Returns the value of the expression cast as a varchar. 

Syntax 

MS Access Math 

cast_varchar(exp) 

log 


Syntax 

log(numeric_exp) 

rand 


User Guide 153


Syntax 

rand(integer_exp) 

MS Access Trigonometry 

atan 


numeric_exp. 

Syntax 

atan(numeric_exp) 

cos 


Syntax 

cos(numeric_exp) 

sin 


Syntax 

sin(numeric_exp) 

tan 


Syntax 

tan(numeric_exp) 

Oracle 

add_months 

Returns the datetime resulting from adding integer_exp months to date_exp. 

Syntax 

add_months ( date_exp, integer_exp ) 

ascii 

Returns a number representing the ascii code value of the leftmost character of string_exp, e.g. 

ascii('A') is 65. 

Syntax 

ascii ( string_exp ) 

chr 



Syntax 

chr ( integer_exp ) 



concat 

Returns a string that is the result of concatenating string_exp1 to string_exp2. 

Syntax 

concat ( string_exp1, string_exp2 ) 

decode 

DECODE compares expr to each search value one by one. If expr is equal to a search, then 

returns the corresponding result. If no match is found, then returns default. If default is omitted, 

then returns null. 

Syntax 

decode ( expr , search , result [, search , result]... [, default] ) 

dump 

Returns internal representation of 'expr' with the format of numeric_exp1 starting from position 

numeric_exp2 for numeric_exp3. 

Syntax 

dump ( expr [ , numeric_exp1 [ , numeric_exp2 [ , numeric_exp3 ] ] ] ) 

greatest 

Returns the greatest value in a list of expressions. 

Syntax 

greatest ( exp_list ) 

initcap 

Returns string_exp, with the first letter of each word in uppercase, all other letters in lowercase. 

Words are delimited by white space or characters that are not alphanumeric. 

Syntax 

initcap ( string_exp ) 

instr 

Searches string_exp1 from the integer_exp1 position for the (integer_exp2)th occurrence of 

string_exp2. If integer_exp1 is negative then the search is backwards from the end of 

string_exp1. Returns an integer indicating the position of string_exp2. 

Syntax 

instr ( string_exp1, string_exp2 [ , integer_exp1 [ , integer_exp2 ] ] ) 

instrb 

Searches string_exp1 from the integer_exp1 position for the (integer_exp2)th occurrence of 

string_exp2. If integer_exp1 is negative then the search is backwards from the end of 

string_exp1. The result returned indicates the position (byte number) where search was found. 

Syntax 

instrb ( string_exp1, string_exp2 [ , integer_exp1 [ , integer_exp2 ] ] ) 

least 

Returns the least value in a list of expressions. 

Syntax 

least ( exp_list ) 

User Guide 155


length 

Returns the number of characters in string_exp. 

Syntax 

length ( string_exp ) 

lengthb 

Returns the number of bytes in string_exp. 

Syntax 

lengthb ( string_exp ) 

lpad 

Returns string_exp1 padded to length integer_exp with occurrences of string_exp2. If 

string_exp1 is longer than integer_exp then returns the appropriate portion of string_exp1. 

Syntax 

lpad ( string_exp1, integer_exp [ , string_exp2 ] ) 

ltrim 

Returns string_exp1, with leading characters removed up to the first character not in 

string_exp2, e.g. ltrim('xyxXxyAB', 'xy') returns 'XxyAB'. 

months_between 

Syntax 

ltrim ( string_exp1 [ , string_exp2 ] ) 

Returns the number of months from date_exp1 to date_exp2. If date_exp1 is later than 

date_exp2 then the result will be a positive number. The days and time portion of the difference 

are ignored, i.e. the months are not rounded, except if date_exp1 and date_exp2 are the last 

days of a month. 

Syntax 

months_between ( date_exp1, date_exp2 ) 

new_time 

Returns the Datetime in timezone 'new_tz' for 'datetime' in 'old_tz' timezone. 'Old_tz' and 

'new_tz' can be one of 'AST', 'ADT', 'BST', 'BDT', 'CST', 'CDT', 'EST', 'EDT', 'HST', 'HDT', 'MST', 

'MDT', 'NST', 'PST', 'PDT', 'YST' or 'YDT'. 

Syntax 

new_time ( datetime_exp, old_tz, new_tz ) 

next_day 

Returns the datetime of the first weekday named by string_exp that is later than datetime_exp. 

The return value has the same hours, minutes, and seconds as datetime_exp. 

Syntax 

next_day ( datetime_exp, string_exp ) 

nls_initcap 

Returns string_exp1 with the first letter of each word in uppercase, all other letters in lowercase. 

Words are delimited by white space or characters that are not alphanumeric. string_exp2 

specifies the sorting sequence. 



Syntax 

nls_initcap ( string_exp1 [ , string_exp2 ] ) 

nls_lower 

Returns string_exp1 with all letters in lowercase. string_exp2 specifies the sorting sequence. 

Syntax 

nls_lower ( string_exp1 [ , string_exp2 ] ) 

nls_upper 

Returns string_exp1 with all letters in uppercase. string_exp2 specifies the sorting sequence. 

Syntax 

nls_upper ( string_exp1 [ , string_exp2 ] ) 

nvl 

If exp is null (missing) returns constant. If exp is not null returns exp. Valid for numeric_exp, 

string_exp, date_exp, and time_exp. 

Syntax 

nvl ( exp, constant ) 

replace 

Replaces all occurrences of string_exp2 in string_exp1 with string_exp3. If string_exp3 is not 

specified then it replaces all occurrences with null (i.e.: removes all occurrences of string_exp2). 

Syntax 

replace ( string_exp1, string_exp2 [ , string_exp3 ] ) 

round 



(integer_exp) places to the left of the decimal point, e.g., round (125, -1) rounds to 130. 

Syntax 

round ( numeric_exp [ , integer_exp ] ) 

rpad 

Returns string_exp1 right-padded to length integer_exp with occurrences of string_exp2. If 

string_exp1 is longer than integer_exp then returns the appropriate portion of string_exp1. If 

string_exp2 is not specified then spaces are used. 

Syntax 

rpad ( string_exp1, integer_exp [ , string_exp2 ] ) 

rtrim 

Returns string_exp1, with final characters removed after the last character not in string_exp2, 

e.g. rtrim('ABxXxyx', 'xy') returns 'ABxX'. If string_exp2 is not specified it removes the final 

space characters. 

Syntax 

rtrim ( string_exp1 [ , string_exp2 ] ) 

sign 


negative. 

User Guide 157


Syntax 


soundex 

Returns a character string containing the phonetic representation of string_exp. 

Syntax 


substr 

Returns the substring of string_exp that starts at position integer_exp1. The first character in 

string_exp is at position 1. integer_exp2 can be used to select fewer characters, by default it 

selects character to the end of the string 

Syntax 

substr ( string_exp, integer_exp1 [ , integer_exp2 ] ) 

substrb 

Same as substr, except that the arguments are expressed in bytes (not characters). 

Syntax 

substrb ( string_exp, numeric_exp1 [ , numeric_exp2 ] ) 

{sysdate} 



Syntax 

{ sysdate } 

to_char 

Returns the string representation of exp with the format of string_exp. exp can either be a date 

value or a numeric value. 

Syntax 

to_char ( exp [ , string_exp ] ) 

to_date 

Converts string_exp1 to a datetime value as specified by the format string_exp2. string_exp3 

specifies format elements such as language. 

Syntax 

to_date ( string_exp1 [ , string_exp2 [ , string_exp3 ] ] ) 

to_number 

Converts string_exp1 to a numeric value as specified by the format string_exp2. string_exp3 

specifies format elements such as currency information. 

Syntax 

to_number ( string_exp1, string_exp2, string_exp3 ) 

translate 

Returns string_exp1, with all occurrences of each character in string_exp2 replaced by its 

corresponding character in string_exp3. 



Syntax 

translate ( string_exp1, string_exp2, string_exp3 ) 

trunc 

Truncates the date_exp using the format specified by string_exp. For example, if string_exp is 

'YEAR' then date_exp is truncated to the first day of the year. 

Syntax 

trunc ( date_exp, string_exp ) 

trunc 

Truncates digits from numeric_exp1 using numeric_exp2 as the precision. 

Syntax 

trunc ( numeric_exp1, numeric_exp2 ) 

{user} 

Returns the username of the current Oracle user. 

Syntax 

{ user } 

vsize 

Returns the number of bytes in the internal representation of 'exp'. 'exp' must be a string 

expression. 

Oracle Math 

Syntax 

vsize ( exp ) 

log 

Returns the logarithm of numeric_exp2 to the base numeric_exp1. 

Syntax 

Oracle Trigonometry 

log ( numeric_exp1, numeric_exp2 ) 

acos 


numeric_exp. 

Syntax 


asin 


numeric_exp. 

Syntax 


User Guide 159


atan 


numeric_exp. 

Syntax 


atan2 



numeric_exp2 / numeric_exp1. 

Syntax 

atan2 ( numeric_exp1 ,numeric_exp2 ) 

cos 


Syntax 


cosh 

Returns the hyperbolic cosine of numeric_exp where numeric_exp is an angle expressed in 

radians. 

Syntax 

cosh ( numeric_exp ) 

sin 


Syntax 


sinh 

Returns the hyperbolic sine of numeric_exp where numeric_exp is an angle expressed in 

radians. 

Syntax 

sinh ( numeric_exp ) 

tan 


Syntax 


tanh 

Returns the hyperbolic tangent of numeric_exp where numeric_exp is an angle expressed in 

radians. 

Syntax 

tanh ( numeric_exp ) 



Red Brick 

concat 

This function concatenates character strings and returns the concatenated string of characters. 

Syntax 

concat ( string_exp1 , string_exp2 ) 

current_user 

Returns the database username (authorization ID) of the current user. 

Syntax 

current_user 

date 

This function creates a date value from a character string or a timestamp expression and returns 

a date data type. The expression can be either characters or timestamp. 

Syntax 

date ( expression ) 

dateadd 

This function adds an interval to a datetime value and returns a result that is the same datetime 

data type as that of datetime_expression. The datepart refers to year, month, day, hour, minute, 

second. The interval must be an integer and datetime_exp can be date, time or timestamp. 

Syntax 

dateadd ( { datepart }, interval, datetime_exp ) 

datediff 

This function finds the difference between two datetime expressions and returns an integer 

result in datepart units. The datepart refers to year, month, day, hour, minute, second. The 

datetime_exp can be date, time or timestamp. 

Syntax 

datediff ( { datepart }, datetime_exp, datetime_exp ) 

datename 

This function extracts the specified datepart component and returns its value as a character 

string. The datepart refers to year, month, day, hour, minute, second. The datetime_exp can be 

date, time or timestamp 

Syntax 

datename ( { datepart }, datetime_exp ) 

dec 

This function converts a specified value to a decimal value and returns a value with the data 

type decimal (precision, scale). The default value of precision is 9. The default value of scale is 

0. 

Syntax 

dec ( expression, [precision, scale] ) 

User Guide 161


decode 

This function compares and converts an expression to another value. If the expression matches 

target, it is replaced by the corresponding replacement; otherwise the expression is replaced by 

default or by NULL if no default is specified. The expressions can be any data type and all 

expressions must be the same data type. 

Syntax 

decode ( expression, target, replacement [,default] ) 

float 

This function converts a specified value into a double-precision floating-point value. 

Syntax 

float ( numeric_exp ) 

ifnull 

This function tests an expression for missing values and replaces each one with a specified 

value. If expression is NULL, this function returns substitute; otherwise it returns the value of the 

expression. The expressions can be any data type and all expressions must be the same data 

type. 

Syntax 

ifnull ( expression , substitute ) 

int 

This function converts a specified numeric string into an integer value and returns an integer 

value. If the argument is null, this function returns NULL. 

Syntax 

int ( numeric_exp ) 

length 

If the argument is not null, this function returns an integer result specifying the number of 

characters in the string; otherwise the result is NULL. 

Syntax 

length ( string_exp ) 

lengthb 

If the argument is not null, this function returns an integer result specifying the number of bytes 

in the string. If the argument is null, the result is NULL. 

Syntax 

lengthb ( string_exp ) 

ltrim 

If the argument is not null, this function removes leading blanks from the character string; 

otherwise the result is NULL. 

Syntax 

ltrim ( string_exp ) 

nullif 

This function returns NULL if both expressions have the same value. If the expressions have 

different values, the value of the first expression is returned. The exp1 and exp2 can be any data 

type and must be the same data type. 



Syntax 

nullif ( exp1, exp2 ) 

positionb 

If the first string_exp is located, this function returns an integer that is relative to the beginning 

byte position of the first string_exp in the second string_exp. If the first string_exp is not located, 

the result is 0. If the first string_exp is of zero length, the result is 1. If the first string_exp is null, 

an error message is returned. If the second string_exp is null, the result is 0. 

Syntax 

positionb ( string-exp, string_exp ) 

real 

This function returns a real value. If the argument is null, this function returns NULL. 

Syntax 

real ( numeric_exp ) 

rtrim 

If the argument is not null, this function removes trailing blanks from the character string; 

otherwise the result is NULL. 

Syntax 

rtrim ( string_exp ) 

sign 

This function calculates the sign of the expression, and returns 1 for a positive value, –1 for a 

negative value, and 0 for zero. 

Syntax 


string 

This function converts numeric or datetime values to character strings. The expression can be 

numeric or datetime. 

Syntax 

string ( expression [, length [, scale]] ) 

substr 

If the first argument is not null, this function returns the substring that begins at position start 

and continues for length characters. If length is not specified, this function returns a substring 

from start to the end of string_exp. 

Syntax 

substr ( string_exp, start_integer, length_integer ) 

substrb 

If the first argument is not null, this function returns the substring that begins at position start 

and continues for length bytes. If length is not specified, this function returns a substring from 

start to the end of string_exp. 

Syntax 

substrb ( string_exp, start_integer, length_integer ) 

User Guide 163


time 

This function creates a time value from a character string or a time-stamp data type expression. 

Syntax 

time ( expression ) 

timestamp 

This function creates a time-stamp value from a character string. 

Syntax 

timestamp ( timestamp_exp ) 

timestamp 

This function creates a time-stamp value from time and date values. If there are two arguments, 

the first must be a date expression and the second must be a time expression, separated by a 

comma (,). If either the date expression or the time expression is null, the resulting time-stamp 

expression is also null. 

Syntax 

timestamp ( date_exp, time_exp ) 

to_char 

This function is a datetime scalar function that operates on a date, time, or timestamp data type 

and returns the character string specified by a given format. 

Syntax 

to_char ( source_date, format_str ) 

SAP BW 

SAP BW OLAP 

characteristicValue 

Creates the unique SAP BW identifier for a query item value that represents an SAP BW key 

value. Useful for identifying leaf-level query item values in unbalanced hierarchies. 

Syntax 

characteristicValue( [ query_subject, ] query_item_value) 

SAP BW Trigonometry 

arccos 


numeric_exp. 

Syntax 

arccos ( numeric_exp ) 

arcsin 


numeric_exp. 



Syntax 

arcsin ( numeric_exp ) 

arctan 


numeric_exp. 

Syntax 

arctan ( numeric_exp ) 

cos 


Syntax 


sin 


Syntax 


tan 


Syntax 


coshyp 

Returns the hyperbolic cosine of numeric_exp where numeric_exp is an angle expressed in 

radians. 

Syntax 

coshyp ( numeric_exp ) 

sinhyp 

Returns the hyperbolic sine of numeric_exp where numeric_exp is an angle expressed in 

radians. 

Syntax 

sinhyp ( numeric_exp ) 

tanhyp 

Returns the hyperbolic tangent of numeric_exp where numeric_exp is an angle expressed in 

radians. 

Syntax 

SAP BW Math 

tanhyp ( numeric_exp ) 

log10 


User Guide 165


Syntax 

log10 ( numeric_exp ) 

ln 

Returns the natural logarithm of the numeric_exp. 

Syntax 

ln ( numeric_exp ) 

exp 

Returns e raised to the power of numeric_exp. The constant e is the base of the natural 

logarithm. See also log. 

Syntax 

exp ( numeric_exp ) 

sqrt 

Returns the square root of numeric_exp. numeric_exp must be non-negative. 

Syntax 

SQL Server 

sqrt ( numeric_exp ) 

ascii 

Returns a number representing the ascii code value of the leftmost character of string_exp, e.g. 

ascii('A') is 65. 

Syntax 

ascii(string_exp) 

char 


should be between 0 and 255. For example, char(65) has the value 'A'. 

Syntax 

char(integer_exp) 

datalength 

Returns the length of the string. 

Syntax 

datalength(string_exp) 

dateadd 

Returns the date resulting from adding integer_exp units indicated by datepart(e.g. day, month, 

year) to date_exp. 

Syntax 

dateadd({datepart}, integer_exp, date_exp) 

datediff 

Returns the number of units indicated by datepart(e.g. day, month, year) between date_exp1 

and date_exp2. 



Syntax 

datediff({datepart}, date_exp1, date_exp2) 

day 

Returns the day portion of date_exp. Same as extract(day from date_exp). 

Syntax 

day(date_exp) 

difference 

Returns an integer value representing the difference between the values returned by the data 

source-specific soundex function for string_exp1 and string_exp2. The value returned ranges 

from 0 to 4, with 4 indicating the best match. Note that 4 does not mean that the strings are 

equal. 

Syntax 

difference(string_exp1, string_exp2) 

getdate 



Syntax 

getdate() 

ltrim 


Syntax 

ltrim(string_exp) 

month 

Returns the month portion of date_exp. Same as extract(month from date_exp). 

Syntax 

month(date_exp) 

replicate 

Returns a string consisting of string_exp repeated integer_exp times. 

Syntax 

replicate(string_exp, integer_exp) 

right 


Syntax 

right(string_exp, integer_exp) 

round 


point. 

Syntax 

round(numeric_exp,integer_exp) 

User Guide 167


sign 


negative. 

Syntax 

sign(numeric_exp) 

soundex 

Returns a four character string representing the sound of the words in string_exp. 

Syntax 

soundex(string_exp) 

space 


Syntax 

space(integer_exp) 

str 

Returns a string representation of numeric_exp. integer_exp1 is the length of the string 

returned. integer_exp2 is the number of decimal digits. 

Syntax 

str(numeric_exp [ , integer_exp1 [ , integer_exp2 ] ] ) 

stuff 

Returns a string where length (integer_exp2) characters have been deleted from string_exp1 

beginning at start (integer_exp1) and where string_exp2 has been inserted into string_exp1 at 

start. The first character in a string is at position 1. 

Syntax 

stuff(string_exp1, integer_exp1, integer_exp2, string_exp2) 

year 

Returns the year portion of date_exp. Same as extract(year from date_exp). 

Syntax 

year(date_exp) 

SQL Server Cast 

cast_char 

Returns the value of the expression cast as a char. 

Syntax 

cast_char(exp) 

cast_float 


Syntax 

cast_float(exp) 



cast_integer 

Returns the value of the expression cast as an integer. 

Syntax 

cast_integer(exp) 

cast_real 

Returns the value of the expression cast as a real. 

Syntax 

cast_real(exp) 

cast_smallint 

Returns the value of the expression cast as a small integer. 

Syntax 

cast_smallint(exp) 

cast_timestamp 

Returns the value of the expression cast as a datetime. 

Syntax 

cast_timestamp(exp) 

cast_varchar 

Returns the value of the expression cast as a varchar. 

Syntax 

cast_varchar(exp) 

SQL Server Math 

log 


Syntax 

log(numeric_exp) 

log10 


Syntax 

log10(numeric_exp) 

pi 

Returns the constant value of pi as a floating point value. 

Syntax 

pi() 

rand 


User Guide 169


Syntax 

rand(integer_exp) 

SQL Server Trigonometry 

acos 


numeric_exp. 

Syntax 

acos(numeric_exp) 

asin 


numeric_exp. 

Syntax 

asin(numeric_exp) 

atan 


numeric_exp. 

Syntax 

atan(numeric_exp) 

atn2 



numeric_exp1. 

Syntax 

atn2(numeric_exp1, numeric_exp2) 

cos 


Syntax 

cos(numeric_exp) 

cot 

Returns the cotangent of numeric_exp where numeric_exp is an angle expressed in radians. 

Syntax 

cot(numeric_exp) 

degrees 

Returns numeric_exp radians converted to degrees. 

Syntax 

degrees(numeric_exp) 

radians 

Returns the number of radians converted from numeric_exp degrees. 



Syntax 

radians(numeric_exp) 

sin 


Syntax 

sin(numeric_exp) 

tan 


Teradata 

Syntax 

tan(numeric_exp) 

account 

This function returns the account string for the current user. 

Syntax 

account 

bytes 

This function returns the number of bytes contained in the specified byte string. The byte_exp 

are restricted to BYTE or VARBYTE. 

Syntax 

bytes ( byte_exp ) 

case_n 

This function evaluates a list of conditions and returns the position of the first condition that 

evaluates to TRUE, provided that no prior condition in the list evaluates to UNKNOWN. The NO 

CASE is an optional condition that evaluates to TRUE if every conditional_expression in the list 

evaluates to FALSE. The NO CASE OR UNKNOWN condition evaluates to TRUE if every 

conditional_expression in the list evaluates to FALSE, or if a conditional_expression evaluates to 

UNKNOWN and all prior conditions in the list evaluate to FALSE. The UNKNOWN is an optional 

condition that evaluates to TRUE if a conditional_expression evaluates to UNKNOWN and all 

prior conditions in the list evaluate to FALSE. 

Syntax 

case_n ( condition_exp_list [, NO CASE | UNKNOWN | NO CASE OR UNKNOWN [, UNKNOWN ]] ) 

char2hexint 

This function returns the hexadecimal representation for a character string. 

Syntax 

char2hexint ( string_exp ) 

characters 

This function returns an integer value representing the number of logical characters or bytes 

contained in the specified operand string. 

Syntax 

characters ( string_exp ) 

User Guide 171


database 

This function returns the name of the default database for the current user. 

Syntax 

database 

date 

This function returns the current date. 

Syntax 

date 

format 

This function returns the declared format for the named expression. The data type returned by a 

FORMAT phrase is a variable character string of up to 30 characters. 

Syntax 

format ( expression ) 

index 

This function returns the position in string_exp1 where string_exp2 starts. 

Syntax 

index ( string_exp1, string_exp2 ) 

log 

Computes the base 10 logarithm of an argument. The numeric_exp is a non-zero, positive 

numeric expression. 

Syntax 

log ( numeric_exp ) 

nullif 

This function returns NULL if scalar_exp1 and scalar_exp2 are equal. Otherwise, it returns its 

first argument, scalar_exp1. The scalar_exp1 and scalar_exp2 can be any data type. 

Syntax 

nullif ( scalar_exp1, scalar_exp2 ) 

nullifzero 

This function converts data from zero to null to avoid problems with division by zero. 

Syntax 

nullifzero ( numeric_exp ) 

profile 

This function returns the current profile for the session or NULL if none. 

Syntax 

PROFILE 



random 

This function returns a random integer number for each row of the results table. The 

lower_bound and upper_bound are integer constants. The limits for lower_bound, upper_bound 

range from -2147483648 to 2147483647, inclusive. The upper_bound must be greater than or 

equal to lower_bound. 

Syntax 

random ( lower_bound, upper_bound ) 

range_n 

This function evaluates a test_exp and maps the result into a list of specified ranges and returns 

the position of the range in the list. start_exp and end_exp are constants or constant 

expressions and must be the same data type as test_exp. Use an asterisk ( * ) for the starting 

boundary of the first range to indicate the lowest possible value. Use an asterisk ( * ) for the 

ending boundary of the last range to indicate the highest possible value. An asterisk is 

compatible with any data type. The range_size is a constant or constant expression. A range 

that specifies an EACH phrase is equivalent to a series of ranges. The value of range_size must 

be greater than zero. NO RANGE is an optional range to handle a test_exp that does not map 

into any of the specified ranges. The NO RANGE OR UNKNOWN option handles a test_exp 

that does not map into any of the specified ranges, or a test_exp that evaluates to NULL when 

RANGE_N does not specify the range BETWEEN * AND *. UNKNOWN is an option to handle a 

test_expression that evaluates to NULL when RANGE_N does not specify the range BETWEEN 

* AND *. 

Syntax 

range_n ( test_exp BETWEEN start_exp | start_exp_list | * AND end_exp | * [ EACH 

range_size [, NO RANGE [ OR UNKNOWN | , UNKNOWN ] | UNKNOWN ] ]) 

role 

This function returns the current role for the session or NULL if none. 

Syntax 

role 

session 

This function returns the number of the session for the current user. 

Syntax 

session 

soundex 

This function returns a character string that represents the Soundex code for string_exp. 

Syntax 


time 

This function returns the current time based on a 24-hour day. 

Syntax 

time 

type 

This function returns the data type defined for an expression. 

Syntax 

type ( expression ) 

User Guide 173


user 

This function returns the user name of the current user. 

Syntax 

user 

vargraphic 

This function Returns a character string that represents the vargraphic code for string_exp. 

Syntax 

vargraphic ( string_exp ) 

zeroifnull 

This function converts data from null to 0 to avoid cases where a null result creates an error. If 

the numeric_exp is not null, it returns the value of the numeric_exp, if numeric_exp is a 

character string, it is converted to a numeric value of FLOAT data type. If the numeric_exp is null 

or zero, it returns zero. 

Syntax 

zeroifnull ( numeric_exp ) 

Teradata Trigonometry 

acos 


numeric_exp.The values of numeric_exp must be between -1 and 1, inclusive. 

Syntax 


acosh 

Returns the inverse hyperbolic cosine of an argument. The numeric_exp can be any real 

number equal to or greater than 1. 

Syntax 

acosh ( numeric_exp ) 

asin 


numeric_exp. The values of numeric_exp must be between -1 and 1, inclusive. 

Syntax 


asinh 

Returns the inverse hyperbolic sine of an argument. The numeric_exp can be any real number. 

Syntax 

asinh ( numeric_exp ) 

atan 


numeric_exp. 



Syntax 


atan2 


numeric_exp2, respectively, in radians. ATAN2(x,y) equals ATAN(y/x), except that x can be 0 in 

ATAN2(x,y).The returned angle is between - and π radians, excluding π. 

Syntax 

atan2 ( numeric_exp1, numeric_exp2 ) 

atanh 

Returns the inverse hyperbolic tangent of an argument. The numeric_exp can be any real 

number between 1 and -1, excluding 1 and -1. 

Syntax 

atanh (numeric_exp ) 

cos 


Syntax 


sin 


Syntax 


sinh 

Returns the hyperbolic sine of an argument. The numeric_exp can be any real number. 

Syntax 

sinh ( numeric_exp ) 

tan 


Syntax 


tanh 

Returns the hyperbolic tangent of an argument. The numeric_exp can be any real number. 

Syntax 

tanh ( numeric_exp ) 

User Guide 175


OLAP 

OLAP Member 

ancestor 

Returns the value of query_item that represents the ancestor of query_item_value. If 

query_item_value has multiple ancestors, the provider elects which parent to return. 

Syntax 

ancestor(query_item_value, query_item) 

closingPeriod 

Returns the last value of query_item that is a descendant of query_item_value. Typically applied 

to query subjects associated with time. 

Syntax 

closingPeriod(query_item, query_item_value ) 

openingPeriod 

Returns the first value of query_item that is a descendant of query_item_value. Typically applied 

to query subjects associated with time. 

Syntax 

openingPeriod(query_item, query_item_value ) 

parallelPeriod 

Obtains the value of query_item that represents the ancestor of query_item_value. Then 

identifies the sibling of that value that lags by index positions, then returns the equivalent of 

query_item_value for that sibling. Typically applied to query subjects associated with time. 

OLAP Set 

Syntax 

parallelPeriod(query_item, index, query_item_value) 

bottomCount 

Sorts the query item values contained in set_exp on numeric_value_exp and returns the bottom 

index_exp values. 

Syntax 

bottomCount(set_exp, index_exp, numeric_value_exp) 

bottomPercent 

Sorts the query item values contained in set_exp on numeric_value_exp and returns the 

bottommost values with a cumulative total of at least index_exp. 

Syntax 

bottomPercent(set_exp, index_exp, numeric_value_exp) 

bottomSum 


bottommost values such that their sum is at least index_exp. 



Syntax 

bottomSum(set_exp, index_exp, numeric_value_exp) 

descendants 

Returns all values of query_item that represent descendants of query_item_value. 

Syntax 

descendants(query_item_value,query_item) 

distinct 

Removes all duplicates from the specified set. The remaining items remain in their original 

order. 

Syntax 

distinct(set_expr) 

except 

Returns the difference between the query item values contained in set_exp1 and set_exp2. 

The result removes duplicates. 

Syntax 

except(set_exp1, set_exp2) 

exceptAll 

Returns the difference between the query item values contained in set_exp1 and set_exp2. The 

result retains duplicates. 

Syntax 

exceptAll(set_exp1, set_exp2) 

filter 

Filters the query item values contained in set_exp based on search_condition_exp. 

Syntax 

filter(set_exp, search_condition_exp) 

intersect 

Returns the intersection of the query item values contained in set_exp1 and set_exp2. The 

result removes duplicates. 

Syntax 

intersect(set_exp1, set_exp2) 

intersectAll 

Returns the intersection of the query item values contained in set_exp1 and set_exp2. The 

result retains duplicates. 

Syntax 

intersectAll(set_exp1, set_exp2) 

lastPeriods 

Returns the set of index_exp query item values ending with query_item_value and starting with 

the query item value lagging index_exp - 1 from query_item_value. Typically applied to query 

subjects associated with time. 

User Guide 177


periodsToDate 

Syntax 

lastPeriods(index_exp, query_item_value) 

Within the scope of query_item, returns the set of values of the query item associated with 

query_item_value, starting with the first query item value of the query item associated with 

query_item_value. Typically applied to query subjects associated with time, such as obtaining 

the set of days within the quarter in which a particular day occurs. 

Syntax 

periodsToDate(query_item, query_item_value) 

topCount 

Sorts the query item values contained in set_exp on numeric_value_exp and returns the top 

index_exp values. 

Syntax 

topCount(set_exp, index_exp, numeric_value_exp) 

topPercent 


topmost values with a cumulative total of at least index_exp. 

Syntax 

topPercent(set_exp, index_exp, numeric_value_exp) 

topSum 


topmost values such that their sum is at least index_exp. 

Syntax 

topSum(set_exp, index_exp, numeric_value_exp) 

union 

Returns the union of the query item values of set_exp1 and set_exp2. The result removes 

duplicates. 

Syntax 

union(set_exp1, set_exp1) 

unionAll 

Returns the union of the query item values of set_exp1 and set_exp2. The result retains 

duplicates. 

Syntax 

OLAP Numeric 

unionAll(set_exp1, set_exp) 

avg 

Computes the average of the query item values in set_exp based on numeric_value_exp. 

Syntax 

avg(set_exp, numeric_value_exp) 



countSet 

Counts all of the query item values contained in set_exp, excluding empty values. 

Syntax 

countSet(set_exp) 

countSetAll 

Counts all of the query item values in set_exp, including empty values. 

Syntax 

countSetAll(set_exp) 

max 

Computes the maximum of the tuples in set_exp based on numeric_value_exp. 

Syntax 

max(set_exp, numeric_value_exp) 

median 

Computes the median of the tuples in set_exp based on numeric_value_exp. 

Syntax 

median(set_exp, numeric_value_exp) 

min 

Computes the minimum of the tuples in set_exp based on numeric_value_exp. 

Syntax 

min(set_exp, numeric_value_exp) 

stddev 

Computes the standard deviation of the tuples in set_exp based on numeric_value_exp. 

Syntax 

stddev(set_exp, numeric_value_exp) 

sum 

Computes the sum of the tuples in set_exp based on numeric_value_exp. 

Syntax 

sum(set_exp, numeric_value_exp) 

var 

Computes the variance of the tuples in set_exp based on numeric_value_exp. 

Syntax 

var(set_exp, numeric_value_exp) 

User Guide 179



Appendix D: Formatting Data With Patterns 

You can format data so that it matches any pattern of text and numbers when default formats are 

not appropriate. For example, you can format dates to use full text including the era, or you can 

format them to only use numbers and display the last two digits of years to save space. 

Using symbols and patterns can provide similar results as basic data formatting tasks. For 

example, you can set how many digits are displayed after the decimal point. You can achieve 

these types of results with a pattern, or you can set the No. of Decimal Places property. Patterns 

allow flexibility for more complex requirements. 

Each supported content language code requires a specific set of symbols to be used in 

patterns. For each language code, there are two tables; one for date and time symbols, and one 

for decimal symbols. The language codes are listed in alphabetical order. 

To define patterns, open the Data Format dialog box, and edit the Pattern property for each 

format type. Use the symbols that are defined in the language code tables, and follow these 

guidelines. 

Pattern Guidelines 

When you define a pattern, the number of symbols you use affects how the data will be shown. 

There are different rules for text, numbers, and values that can take the form of text or numbers. 

Text 

You can specify whether text is produced in full or abbreviated form. 

Number of 

symbols Meaning Example 

4 or more Full text form EEEE produces Monday 

Less than 4 Abbreviated form EEE produces Mon 

Numbers 

The number of symbols you use in a pattern sets the minimum number of digits that are 

produced in a report. Numbers that have fewer digits than specified are zero-padded. For 

example, if you specify mm for minutes, and the database value is 6, the report will display 06. 

Note: The year value is handled differently. If you specify two symbols for year, the last two digits 

of the year value is produced. For example, yyyy produces 1997, and yy produces 97. 

Text and Numbers 

For values that can produce text or numbers, such as months, you can specify whether text or 

numbers are produced, and whether words are abbreviated. 

Number of 

symbols Meaning Example 

3 or more Text MMMM produces January 

MMM produces Jan 

Less than 3 Numbers MM produces 01 

M produces 1 

User Guide 181


Language Code: cs 

Locale ID: cs 

Date and Time Symbols 

Symbol Meaning Presentation Example 

G Era Text AD 

u Year Number 1996 

M Month in year Text and 

number 

July and 07 

t Day in month Number 10 

k Hour in a.m. or p.m. (1 

to 12) 

Number 12 

H Hour in day (0 to 23) Number 0 

m Minute in hour Number 30 

s Second in minute Number 55 

S Millisecond Number 978 

E Day in week Text Tuesday 

D Day in year Number 189 

F Day of week in month Number 2 (2nd Wed in 

July) 

w Week in year Number 27 

W Week in month Number 2 

a a.m. or p.m. marker Text pm 

h Hour in day (1 to 24) Number 24 

K Hour in a.m. or p.m. (0 

to 11) 

Number 0 

z Time zone Text Pacific Standard 

Time 

U Escape used in text n/a n/a 

e Single quote n/a ’ 



Decimal Format Symbols 

Symbol 

Meaning 

, A digit that is shown even if the value is zero. 

\u00A0 

A digit that is suppressed if the value is zero. 

; A placeholder for decimal separator. 

% A placeholder for thousands grouping separator. 

0 Separates mantissa and exponent for exponential 

formats. 

# Separates formats for positive numbers and formats for 

negative numbers. 

- The default negative prefix. 

E 

Multiplied by 100, as percentage. 

\u2030 Multiplied by 1000, as per mille. 

\u221E 

\uFFFD 

X 

The currency symbol. If this symbol is present in a 

pattern, the monetary decimal separator is used instead 

of the decimal separator. 

The international currency sign. It will be replaced by an 

international currency symbol. If it is present in a 



Other characters that can be used in the prefix or suffix. 

’ Used to quote special characters in a prefix or suffix. 

Locale ID: cs_CZ 



G Era Text AD 



number 

July and 07 



to 12) 

Number 12 




User Guide 183







July) 






to 11) 

Number 0 


Time 




Symbol 

Meaning 


\u00A0 





formats. 




E 



\u221E 

\uFFFD 










Symbol 

X 

Meaning 



Language Code: da 

Locale ID: da 



G Era Text AD 



number 

July and 07 



to 12) 

Number 12 








July) 






to 11) 

Number 0 


Time 



User Guide 185



Symbol 

Meaning 


. A digit that is suppressed if the value is zero. 




formats. 




E 



\u221E 

\uFFFD 

X 










Locale ID: da_DK 



G Era Text AD 



number 

July and 07 


k 

Hour in a.m. or p.m. (1 to 

12) 

Number 12 











July) 





K 

Hour in a.m. or p.m. (0 to 

11) 

Number 0 


Time 




Symbol 

Meaning 






formats. 




E 



\u221E 

\uFFFD 








User Guide 187


Symbol 

X 

Meaning 



Language Code: de 

Locale ID: de 



G Era Text AD 

j Year Number 1996 


number 

July and 07 



to 12) 

Number 12 








July) 






to 11) 

Number 0 


Time 

J Escape used in text n/a n/a 





Symbol 

Meaning 






formats. 




E 



\u221E 

\uFFFD 

X 


pattern, the monetary decimal separator is used 

instead of the decimal separator. 







Locale ID: de_CH 



G Era Text AD 



number 

July and 07 



to 12) 

Number 12 




User Guide 189







July) 






to 11) 

Number 0 


Time 




Symbol 

Meaning 






formats. 




E 



\u221E 

\uFFFD 










Symbol 

X 

Meaning 



Locale ID: de_DE, de_LU, de_AT 



G Era Text AD 



number 

July and 07 



to 12) 

Number 12 








July) 






to 11) 

Number 0 


Time 



User Guide 191



Symbol 

Meaning 






formats. 




E 



\u221E 

\uFFFD 

X 










Language Code: el 

Locale ID: el 



G Era Text AD 

a Year Number 1996 

n Month in year Text and 

number 

July and 07 

j Day in month Number 10 


to 12) 

Number 12 











July) 



x a.m. or p.m. marker Text pm 



to 11) 

Number 0 


Time 

A Escape used in text n/a n/a 



Symbol 

Meaning 






formats. 




E 



\u221E 




User Guide 193


Symbol 

\uFFFD 

X 

Meaning 







Locale ID: el_GR 



G Era Text AD 

y Year Number 1996 


number 

July and 07 

d Day in month Number 10 

h Hour in a.m. or p.m. (1 

to 12) 

Number 12 








July) 




k Hour in day (1 to 24) Number 24 


to 11) 

Number 0 

Z Time zone Text Pacific Standard 

Time 

’ Escape used in text n/a n/a 

" Single quote n/a ’ 




Symbol 

Meaning 






formats. 




E 



\u221E 

\uFFFD 

X 










Language Code: en 

Locale ID: en, en_AU, en_CA, en_GB, en_IE, en_NZ, en_SG, en_US, en_ZA, 

en_ZW 



G Era Text AD 



number 

July and 07 



to 12) 

Number 12 

User Guide 195










July) 






to 11) 

Number 0 


Time 




Symbol Meaning 

0 A digit that is shown even if the value is zero. 

# A digit that is suppressed if the value is zero. 

. A placeholder for decimal separator. 

, A placeholder for thousands grouping separator. 

E 

Separates mantissa and exponent for exponential 

formats. 

; Separates formats for positive numbers and formats for 



% Multiplied by 100, as percentage. 

‰ Multiplied by 1000, as per mille. 

¤ The currency symbol. If this symbol is present in a 





Symbol 

Meaning 

¤¤ The international currency sign. It will be replaced by an 




X 



Locale ID: en_BE 



G Era Text AD 



number 

July and 07 



to 12) 

Number 12 








July) 






to 11) 

Number 0 


Time 



User Guide 197



Symbol 

Meaning 






formats. 




E 



\u221E 

\uFFFD 

X 










Locale ID: en_HK, en_IN, en_PH, en_BW 

These symbols are valid for the following locales: en_HK, en_IN, en_PH, en_BW. 



G Era Text AD 



number 

July and 07 



to 12) 

Number 12 











July) 






to 11) 

Number 0 


Time 




Symbol 

Meaning 

. A digit that is shown even if the value is zero. 

, A digit that is suppressed if the value is zero. 




formats. 




E 



\u221E 




User Guide 199


Symbol 

\uFFFD 

X 

Meaning 







Language Code: es 

Locale ID: es, es_AR, es_CL, es_ES, es_PE, es_PY, es_UY, es_VE 



G Era Text AD 



number 

July and 07 



to 12) 

Number 12 








July) 






to 11) 

Number 0 


Time 







Symbol 

Meaning 






formats. 




E 



\u221E 

\uFFFD 

X 










Locale ID: es_BO, es_CO, es_CR, es_DO, es_EC, es_GT, es_HN, es_MX, 

es_NI, es_PA, es_PR, es_SV, es_US 



G Era Text AD 



number 

July and 07 


User Guide 201




to 12) 

Number 12 








July) 






to 11) 

Number 0 


Time 




Symbol 

Meaning 






formats. 




E 





Symbol 

\u221E 

\uFFFD 

X 

Meaning 










Language Code: fi 

Locale ID: fi, fi_FI 



G Era Text AD 



number 

July and 07 



to 12) 

Number 12 








July) 





User Guide 203




to 11) 

Number 0 


Time 




Symbol 

Meaning 


\u00A0 





formats. 




E 



\u221E 

\uFFFD 

X 












Language Code: fr 

Locale ID: fr, fr_CA, fr_FR, fr_LU 



G Era Text AD 



number 

July and 07 



to 12) 

Number 12 








July) 






to 11) 

Number 0 


Time 



User Guide 205








E 


formats. 













X 



Locale ID: fr_BE 



G Era Text AD 



number 

July and 07 



to 12) 

Number 12 











July) 






to 11) 

Number 0 


Time 




Symbol 

Meaning 






formats. 




E 



\u221E 

\uFFFD 








User Guide 207


Symbol 

X 

Meaning 



Locale ID: fr_CH 



G Era Text AD 



number 

July and 07 



to 12) 

Number 12 








July) 






to 11) 

Number 0 


Time 






Symbol 

Meaning 


’ A digit that is suppressed if the value is zero. 




formats. 




E 



\u221E 

\uFFFD 

X 










Language Code: hi 

Locale ID: hi 



G Era Text AD 



number 

July and 07 



to 12) 

Number 12 


User Guide 209









July) 






to 11) 

Number 0 


Time 




Symbol 

Meaning 





\u0966 Separates mantissa and exponent for exponential 

formats. 




E 



\u221e 






Symbol 

\ufffd 

X 

Meaning 







Locale ID: hi_IN 



G Era Text AD 



number 

July and 07 



to 12) 

Number 12 








July) 






to 11) 

Number 0 


Time 



User Guide 211



Symbol 

Meaning 





\u0966 Separates mantissa and exponent for exponential 

formats. 




E 



\u221e 

\ufffd 

X 










Language Code: hu 

Locale ID: hu 



G Era Text AD 



number 

July and 07 



to 12) 

Number 12 











July) 






to 11) 

Number 0 


Time 




Symbol 

Meaning 


\u00A0 





formats. 




E 



\u221E 




User Guide 213


Symbol 

\uFFFD 

X 

Meaning 







Locale ID: hu_HU 



G Era Text AD 



number 

July and 07 



to 12) 

Number 12 








July) 






to 11) 

Number 0 


Time 






Symbol 

Meaning 


\u00A0 





formats. 




E 



\u221E 

\uFFFD 

X 










Language Code: it 

Locale ID: it 



G Era Text AD 



number 

July and 07 



to 12) 

Number 12 


User Guide 215









July) 






to 11) 

Number 0 


Time 




Symbol 

Meaning 






formats. 




E 



\u221E 






Symbol 

\uFFFD 

X 

Meaning 







Locale ID: it_IT 

These symbols are valid for the following locales: it_IT 



G Era Text AD 



number 

July and 07 



to 12) 

Number 12 








July) 






to 11) 

Number 0 


Time 

User Guide 217






Symbol 

Meaning 






formats. 




E 



\u221E 

\uFFFD 

X 










Locale ID: it_CH 



G Era Text AD 



number 

July and 07 



to 12) 

Number 12 











July) 






to 11) 

Number 0 


Time 




Symbol 

Meaning 


’ A digit that is suppressed if the value is zero. 




formats. 




E 



\u221E 




User Guide 219


Symbol 

\uFFFD 

X 

Meaning 







Language Code: ja 

Locale ID: ja 



G Era Text AD 



number 

July and 07 



to 12) 

Number 12 








July) 






to 11) 

Number 0 


Time 







Symbol 

Meaning 






formats. 




E 



\u221E 

\uFFFD 

X 










Locale ID: ja_JP 



G Era Text AD 



number 

July and 07 



to 12) 

Number 12 

User Guide 221










July) 






to 11) 

Number 0 


Time 




Symbol 

Meaning 






formats. 




E 



\u221E 






Symbol 

\uFFFD 

X 

Meaning 







Language Code: ko 

Locale ID: ko, ko_KR 



G Era Text AD 



number 

July and 07 



to 12) 

Number 12 








July) 






to 11) 

Number 0 


Time 

User Guide 223











E 


formats. 













X 



Language Code: nl 

Locale ID: nl, nl_BE, nl_NL 



G Era Text AD 



number 

July and 07 






to 12) 

Number 12 








July) 






to 11) 

Number 0 


Time 




Symbol 

Meaning 






formats. 




E 


User Guide 225


Symbol 

Meaning 


\u221E 

\uFFFD 

X 










Language Code: no 

Locale ID: no, no_NO 



G Era Text AD 



number 

July and 07 



to 12) 

Number 12 








July) 









to 11) 

Number 0 


Time 




Symbol 

Meaning 


\u00A0 





formats. 




E 



\u221E 

\uFFFD 

X 










User Guide 227


Language Code: pl 

Locale ID: pl, pl_PL 



G Era Text AD 



number 

July and 07 



to 12) 

Number 12 








July) 






to 11) 

Number 0 


Time 






Symbol 

Meaning 


\u00A0 





formats. 




E 



\u221E 

\uFFFD 

X 










Language Code: pt 

Locale ID: pt, pt_BR, pt_PT 



G Era Text AD 



number 

July and 07 



to 12) 

Number 12 


User Guide 229









July) 






to 11) 

Number 0 


Time 




Symbol 

Meaning 






formats. 




E 



\u221E 






Symbol 

\uFFFD 

X 

Meaning 







Language Code: ro 

Locale ID: ro, ro_RO 



G Era Text AD 



number 

July and 07 



to 12) 

Number 12 








July) 






to 11) 

Number 0 


Time 

User Guide 231






Symbol 

Meaning 






formats. 




E 



\u221E 

\uFFFD 

X 










Language Code: ru 

Locale ID: ru, ru_UA, ru_RU 



G Era Text AD 



number 

July and 07 






to 12) 

Number 12 








July) 






to 11) 

Number 0 


Time 




Symbol 

Meaning 


\u00A0 





formats. 




E 


User Guide 233


Symbol 

Meaning 


\u221E 

\uFFFD 

X 










Language Code: sk 

Locale ID: sk, sk_SK 



G Era Text AD 



number 

July and 07 



to 12) 

Number 12 








July) 









to 11) 

Number 0 


Time 




Symbol 

Meaning 


\u00A0 





formats. 




E 



\u221E 

\uFFFD 

X 










User Guide 235


Language Code: sv 

Locale ID: sv, sv_FI, sv_SE 



G Era Text AD 



number 

July and 07 



to 12) 

Number 12 








July) 






to 11) 

Number 0 


Time 






Symbol 

Meaning 


\u00A0 





formats. 




E 



\u221E 

\uFFFD 

X 










Language Code: tr 

Locale ID: tr, tr_TR 



G Era Text AD 



number 

July and 07 



to 12) 

Number 12 


User Guide 237









July) 






to 11) 

Number 0 


Time 




Symbol 

Meaning 






formats. 




E 



\u221E 






Symbol 

\uFFFD 

X 

Meaning 







Language Code: zh 

Locale ID: zh, zh_CN, zh_HK, zh_MO, zh_SG, zh_TW 



G Era Text AD 



number 

July and 07 



to 12) 

Number 12 








July) 






to 11) 

Number 0 


Time 

User Guide 239











E 


formats. 













X 




Glossary 

access permissions 

A definition of which resources the members of a group or a user can read, change, or 

otherwise use. Examples of resources are reports and folders. 

Administrator Workbench 

In SAP BW, the Administrator Workbench is the tool you use to control how data gets from the 

sources systems into the InfoCubes of the Business Information Warehouse. The parts of the 

Administrator Workbench that you use to request and manage the data include: Source system, 

InfoSource, InfoCube, InfoObject, Scheduler and Monitor. 

In SAP BW, the Administrator Workbench is the tool you use to control how data gets from the 

sources systems into the InfoCubes of the Business Information Warehouse. The parts of the 

Administrator Workbench that you use to request and manage the data include: Source system, 

InfoSource, InfoCube, InfoObject, Scheduler and Monitor. 

alias 

In modeling and database terminology, a secondary name for a database table. Aliases are 

used to create a distinct reference to the table in the model, so that self-joins can be created or 

ambiguous query paths can be resolved. 

Business Explorer (BEx) 

The SAP Business Information Warehouse Reporting Tool. 

The SAP Business Information Warehouse Reporting Tool. 

cardinality 

A property of a relationship that is used to ensure that queries return the correct results. 

Cardinality describes the association between two query subjects and is set at each end of the 

relationship. 

Cardinality is expressed by using the following notation: 

• 0..1 (zero or one match) 

• 1..1 (only one match required) 

• 0..n (zero or more matches) 

• 1..n (one or more matches required) 

The first part of the notation specifies the minimum required matches that must exist between 

tables: 0 indicates that finding a match is optional, and 1 indicates that at least one row must 

match. The second part defines the maximum required matches (1=1, n=many). 

For example, A and B have an association with one another. The cardinality of 1...1 for table A 

means that for each row in table B, there is only one row in table A. The cardinality of 0...n for 

table B means that for each row in table A, there are zero or many rows in table B. 

characteristics 

In SAP BW, a criterion according to which data can be selected, such as Company Code, 

Product, Material, or Region.Each characteristic is associated with one or more values that 

contain discrete names. For example, the characteristic Region can have the values "North", 

"Central" and "South". 

Characteristics are also referred to as "dimensions". 

User Guide 241

Glossary 

In SAP BW, a criterion according to which data can be selected, such as Company Code, 

Product, Material, or Region.Each characteristic is associated with one or more values that 

contain discrete names. For example, the characteristic Region can have the values "North", 

"Central" and "South". 

Characteristics are also referred to as "dimensions". 

constraint 

A restriction on the possible values that users can enter in a field. 

A security specification that denies one or more users the ability to access a model component 

or to perform a modeling or authoring task. 

Content Manager 

The ReportNet service that manages the storage of reporting applications, including 

application-specific security, configuration data, models, reports, and report output. Content 

Manager is needed to publish models, retrieve or store report specifications, manage 

scheduling information, and manage the Cognos namespace. 

content store 

The database that contains all data that ReportNet needs to operate, such as 

• report specifications, published models, and the packages that contain them 

• connection information for data sources 

• information about the external namespace, and the Cognos namespace itself 

• information about scheduling and bursting reports 

Design models and log files are not stored in the content store. 

The ReportNet service that uses the content store is named Content Manager. 

data source 

A named set of connections to physical databases. Framework Manager uses the name of the 

data source for models. The ReportNet server uses the data source connections to access the 

physical databases. 

data source connection 

The named information that defines the type of the data source, its physical location, and any 

signon requirements. A data source can have more than one connection. 

dimension 

A representation of the data components that reflect specific business structures. Typically, a 

dimension is a nested representation of a business concept. 

For example, a geographical dimension such as Continent-Country-State-City represents the 

location of branch offices of an organization in multiple levels, using direct parent-child 

relationships between each level and its preceding level. The resultant structure is sometimes 

referred to as a hierarchy or a dimension. Each level may also have a number of attributes, 

which can be used to provide additional descriptive data, like Country Long Name and Country 

Population as attributes of the Country Level. 

In Framework Manager, dimensions may be represented by folders, or may be types of query 

subjects. Both the levels and the attributes are represented as query items, with a special usage 

property which describes their role in the hierarchy or dimension. 

Levels in hierarchies provide useful default behavior for grouping, filtering, prompting, and so on 

to Query Studio and Report Studio users. 

foreign key 

See key. 

free characteristics 

In SAP BW, a characteristic that is used in a query. It can be used freely for navigation. 


Glossary 

In SAP BW, a characteristic that is used in a query. It can be used freely for navigation. 

governor 

A set of rules to stop the execution of reports that will take too long, or take too many resources. 

group 

In security, a list of users or other groups that you use as a single object for setting access 

permissions. Groups are usually created in the authentication provider but may be created 

within the administration portal. 

Users are authenticated as members of the groups they belong to, unless the groups have also 

been defined as roles. Users can choose one or more roles when they log on, to change what 

data they have authorization for. 

In reporting, grouping is the action of organizing common values of a column or query item 

together. Grouped items are automatically sorted. Headers and footers often appear after each 

instance of a common value in a grouped column. 

hierarchy 

A description of the order of levels in a dimension. 

In Framework Manager, you define hierarchies in the query subject. 

See also level. 

identifier 

In modeling, a query item that is a primary key in the database. Query items that are identifiers 

are used for building relationships in the model and for sorting, filtering, and grouping in the 

report. 

In report specifications, any grouped item may be considered an identifier. 

InfoCatalog 

In SAP BW, a tree-like structure in the Administrator Workbench that displays Business 

Information Warehouse workbooks and queries. The structure of the sub-trees can be defined 

by the administrator. A user accesses their queries of the InfoCatalog using BEx. 

In SAP BW, a tree-like structure in the Administrator Workbench that displays Business 

Information Warehouse workbooks and queries. The structure of the sub-trees can be defined 

by the administrator. A user accesses their queries of the InfoCatalog using BEx. 

InfoCube 

In SAP BW, a central data container for queries and evaluations. InfoCubes contain key figures 

and characteristics. 

An InfoCube is constructed by combining one or more characteristics with transactional 

information based on values from those characteristics and one or more key figures. 



An InfoCube is constructed by combining one or more characteristics with transactional 

information based on values from those characteristics and one or more key figures. 

InfoObject 

A generic term in SAP BW for characteristics and key figures. InfoObjects are used in the 

InfoCubes and the three structures relevant for the data requests (extract, transfer and 

communication structures). 

Within the characteristic a distinction is made between time and unit characteristics. Examples 

for characteristics would be evaluation groups such as cost center or product group. Key figures 

are currency, quantity or number fields such as sales revenue, revenue or number of employees. 

A generic term in SAP BW for characteristics and key figures. InfoObjects are used in the 

InfoCubes and the three structures relevant for the data requests (extract, transfer and 

communication structures). 

User Guide 243

Glossary 

Within the characteristic a distinction is made between time and unit characteristics. Examples 

for characteristics would be evaluation groups such as cost center or product group. Key figures 

are currency, quantity or number fields such as sales revenue, revenue or number of employees. 

InfoSet 

In SAP BW, describes a specific kind of InfoProvider. InfoSet describes data sources that are 

defined as joins of characteristics with master data. If one of the InfoObjects contained in the 

join is a time-dependent characteristic, the join is a time-dependent or temporal join. 

An InfoSet is a semantic view of data sources and is not a physical data target in itself. Unlike 

the classic InfoSet, an InfoSet is a BW-specific view of data. 

For the report author to access the ODS, you must define an InfoSet and create a BEx 

InfoQuery based on that InfoSet. 

In SAP BW, describes a specific kind of InfoProvider. InfoSet describes data sources that are 

defined as joins of characteristics with master data. If one of the InfoObjects contained in the 

join is a time-dependent characteristic, the join is a time-dependent or temporal join. 

An InfoSet is a semantic view of data sources and is not a physical data target in itself. Unlike 

the classic InfoSet, an InfoSet is a BW-specific view of data. 

For the report author to access the ODS, you must define an InfoSet and create a BEx 

InfoQuery based on that InfoSet. 

InfoSource 

In SAP BW, an InfoSource is a quantity of information for a unit. This information has been 

logically grouped together from a business point of view. InfoSources can either contain 

transaction data or master data (attributes, texts and hierarchies). An InfoSource is always a 

quantity of InfoObjects 

In SAP BW, an InfoSource is a quantity of information for a unit. This information has been 

logically grouped together from a business point of view. InfoSources can either contain 

transaction data or master data (attributes, texts and hierarchies). An InfoSource is always a 

quantity of InfoObjects 

InfoQuery 



An InfoQuery is created in BEx and can contain variables. 



An InfoQuery is created in BEx and can contain variables. 

join 

In modeling, a query item that is a primary key in the database. Query items that are identifiers 

are used for building relationships in the model and for sorting, filtering, and grouping in the 

report. 

In report specifications, any grouped item may be considered an identifier. 

See also relationship and cardinality. 

key 

A unique identifier for a row in a table. A table can have more than one key. Keys are also used 

to create relationships. 

For example, the CUST-ID column is the primary key for the CUSTOMERS table because there 

can be only one customer ID for each customer. 

Foreign keys are columns that establish relationships between tables. For example, the 

CUST-ID column in the ORDERS table is the foreign key that joins the ORDERS table to the 

CUSTOMERS table. Each order in the ORDERS table can be associated to only one customer. 


Glossary 

key figure 

In SAP BW, values or quantities such as sales revenue, fixed costs, sales quantity or number of 

employees. 

In addition to the key figures saved on the database, you can define derived (calculated) key 

figures in the query definition in BEx. Examples of derived key figures are: sales revenue by 

employee, variance as a percentage, and contribution margin. 

In SAP BW, values or quantities such as sales revenue, fixed costs, sales quantity or number of 

employees. 

In addition to the key figures saved on the database, you can define derived (calculated) key 

figures in the query definition in BEx. Examples of derived key figures are: sales revenue by 

employee, variance as a percentage, and contribution margin. 

level 

A group of query items that must contain a key query item, so that each member within the 

group is unique. Levels may contain other non-key query items. Levels are parts of dimensions. 

For example, a geographical dimension might contain levels for country, region, and city. 

locale 

A code that is used to set 

• the language or dialect used for browsers, report text, and so on 

• the regional preferences, such as formats for time, date, money, money expressions, and 

time of day 

In ReportNet, you can specify a locale for the product interface (product locale) and for the data 

in the report (content locale). A locale is also stored to record what locale an author used to 

create a report specification or a Framework Manager project. 

many-to-many relationship 

See cardinality. 

measure 

A query item that contains values that can be aggregated to produce meaningful results. For 

example, product costs can be treated as a measure because average and total costs have 

some meaning, but product codes, though numbers, are not usually treated the same way. 

Measures are quantitative performance indicators. Measures give the numbers that usually 

appear in the cells of crosstab reports or in the numbers of a chart. 

model 

A business presentation of the structure of the data from one or more databases. A model 

describes data objects, structure, and grouping, as well as relationships and security. 

A model, called a design model, is created and maintained in Framework Manager. The design 

model or a subset of the design model must be published to the ReportNet server as a package 

for users to create and run reports. 

model segment 

A part of a Framework Manager project that is a shortcut to a second project. Segments can be 

parameter maps, data sources, namespaces, or folders. You must make any changes in the 

source project, not in the segment. 

You use segments to simplify model maintenance or to facilitate multi-user modeling. How you 

use segments does not affect the packages that you publish to ReportNet. 

MultiCube 

In SAP BW, a MulitCube is a virtual cube that displays data from BasicCubes and 

RemoteCubes. A MultiCube does not actually contain data. 

In SAP BW, a MulitCube is a virtual cube that displays data from BasicCubes and 

RemoteCubes. A MultiCube does not actually contain data. 

User Guide 245

Glossary 

namespace 

In security, a collection of user accounts and user groups from an authentication provider. 

In XML, namespaces uniquely identify element types and attributes. An XML namespace is 

defined by a URI (Uniform Resource Identifier) whose purpose is to name the namespace, not 

necessarily to identify a location from which to obtain information. 

In Framework Manager, namespaces uniquely identify query items, query subjects and so on. 

You import different databases into separate namespaces to avoid duplicate names. 

normalization 

In programming, the process of standardizing the format of information, such as locale codes. 

one-to-many relationship 


one-to-one relationship 


package 

A container for models, reports, and so on. Modelers create packages in Framework Manager to 

publish models to the ReportNet server. 

See also query subject, and query item. 

portal 

A Web site or page that provides a single presentation and a single starting point for a set of 

information. Also, the Cognos component that runs the Cognos portal site. 

Cognos Web products may use a Cognos portal or may be integrated with other portals. 

primary key 

See key. 

project 

A set of models, packages, and related information for administration, and for sharing model 

information. You create projects in Framework Manager. 

query item 

A representation of a column of data in a data source. It contains a reference to a database 

column, a reference to another query item, or a calculation. Query items may appear in a model 

or in a report. 

query locale 

The ISO standard code associated with a query the specifies the language and formatting of 

the report results. 

query subject 

One of the types of objects inside a model. A query subject can be 

• defined as a collection of references to items of other query subjects 

• expressed as an SQL expression that represents selected query items, which will be 

retrieved from objects such as tables, synonyms, views, and so on 

Query subjects contain query items. Query subjects may be part of folders in the model. The 

query subject is the basis of a query in Report Studio and in report specifications. 

relationship 

A connection that explains how the data in one table relates to the data in another. When you 

create a relationship, you define the cardinality of each end of the relationship. 


Glossary 

For example, a one-to-many relationship between table A and table B means that for each row 

in table A, there can be 1 or more row matches in table B. Therefore, table B has a many-to-one 

relationship with table A. 

See also join, and cardinality. 

RemoteCube 

In SAP BW, a RemoteCube is an InfoCube whose data is managed outside of SAP BW and only 

its structure is defined in SAP BW. For example, an InfoCube whose data comes from SAP R3. 

RemoteCubes may perform more slowly than InfoCubes that are managed within SAP BW. 

In SAP BW, a RemoteCube is an InfoCube whose data is managed outside of SAP BW and only 

its structure is defined in SAP BW. For example, an InfoCube whose data comes from SAP R3. 

RemoteCubes may perform more slowly than InfoCubes that are managed within SAP BW. 

report specification 

An XML representation of the queries, prompts, layouts, and styles in a report. You create report 

specifications by using Report Studio or Query Studio, or by writing your own report 

specifications in XML. 

role 

A special group that users can choose when they log on to change what groups they are 

authenticated as members of, so that they change what data they have authorization for. 

User Guide 247

Glossary 


Index 

A 

access permissions 

definition, 241 

accessing 

data source connections, 31 

action logging, 50 

adding 

business rules, 75 

data source functions, 48 

function sets, 48 

groups, 99 

metadata security, 101 

object-based security, 101 

roles, 99 

users, 99 

adding security 

packages, 105 

administrative access 

packages, 105 

aggregation 

rules, 72 

aliases, 241 


using with parameters, 79 

ambiguous 

joins, 67 

API 


applying 

filters, 77 

Architect metadata 

troubleshooting, 108 

Architect XML files 

importing, 29 

B 

binary large objects 

using in stored procedures, 107 

Business Date/Time Functions, 130 

Business Objects expressions 


business rules 

adding, 75 

C 

calculations 

creating in Framework Manager, 75 


Calendar Type, 113 

cardinality, 66 


chasm traps, 109 

checking in 

projects, 45 

checking out 

projects, 45 

choosing 

query processing, 48 

clearing 


Clock, 113 

Common Functions, 133 

Common Warehouse Metamodel, 42 

complex 

expressions, 66 

configuring 

CVS repository connections, 44 

Conform, 57 

conformed dimensions, 28 

conforming 

query subjects, 57 

connections 

data sources, 34 

repositories, 43 

Constants, 129 

constraints 


Constructs, 130 

Content Manager 


content store 


converting 

model query subjects to data source, 59 

copyright, 2 

creating, 42 

calculations, 75 

CVS repository connections, 44 


database connections, 34 

filters, 76 

folders, 89 

links, 47 

namespaces, 25 

outer joins, 109 

packages, 97 

parameters, 79 

projects, 20 

query item folders, 89 


relationship shortcuts, 68 

relationships, 67 

repositories, 43 

segments, 46 

Visual SourceSafe database, 44 

Visual SourceSafe repository connections, 44 

CSVIdentityName function, 84 

Currency, 113 

currency 

format type, 70 

unable to see, 108 

Currency Display, 113 

Currency Symbol, 113 

Currency Symbol Position, 113 

User Guide 249

Index 

custom properties 

SAP BW Variables (dataSource), 37 

CVS repository connections 

configuring, 44 

creating, 44 

CWM, See Common Warehouse Metamodel 

D 

data 

formatting, 70 

data formatting patterns by locale ID 

cs, 182 

cs_CZ, 183 

da_DK, 186 

de, 188 

de_AT, 191 

de_CH, 189 

de_DE, 191 

de_LU, 191 

el, 192 

el_GR, 194 

en, 195 

en_AU, 195 

en_BW, 198 

en_CA, 195 

en_GB, 195 

en_HK, 198 

en_IE, 195 

en_IN, 198 

en_NZ, 195 

en_PH, 198 

en_SG, 195 

en_US, 195 

en_ZA, 195 

en_ZW, 195 

es, 200 

es_AR, 200 

es_BO, 201 

es_CL, 200 

es_CO, 201 

es_CR, 201 

es_DO, 201 

es_EC, 201 

es_ES, 200 

es_GT, 201 

es_HN, 201 

es_MX, 201 

es_NI, 201 

es_PA, 201 

es_PE, 200 

es_PR, 201 

es_PY, 200 

es_SV, 201 

es_US, 201 

es_UY, 200 

es_VE, 200 

fi, 203 

fi_FI, 203 

fr, 205 

fr_CA, 205 

fr_FR, 205 

fr_LU, 205 

hi, 209 

hi_IN, 211 

hu, 212 

hu_HU, 214 

it, 215 

data formatting patterns by locale ID (cont'd) 

it_CH, 218 

it_IT, 217 

ja, 220 

ja_JP, 221 

ko, 223 

ko_KR, 223 

nl, 224 

nl_BE, 224 

nl_NL, 224 

no, 226 

no_NO, 226 

pl, 228 

pl_PL, 228 

pt, 229 

pt_BR, 229 

pt_PT, 229 

ro, 231 

ro_RO, 231 

ru, 232 

ru_RU, 232 

ru_UA, 232 

sk, 234 

sk_SK, 234 

sv, 236 

sv_FI, 236 

sv_SE, 236 

tr, 237 

tr_TR, 237 

zh, 239 

zh_CN, 239 

zh_HK, 239 

zh_MO, 239 

zh_SG, 239 

zh_TW, 239 

data sets 

defining, 35 

multiple, 35 

data source 

connections, 34 


properties, 37 


accessing, 31 

creating, 31 


isolation levels, 31 

testing, 34 

data source functions 

adding, 48 

data source query subjects, 53 

using parameters, 83 

data sources 

connection levels, 31 

creating connections, 33 

multilingual, 37 


SAP BW, 27 

database connection strings, 33 

database connections, See data source connections 

database only, 48 

databases 

creating connections, 34 

importing, 26 

supported, 33 

date 


Date Ordering, 114 


Index 

Date Separator, 114 

Date Style, 114 

DB2, 138 

DB2 Cast, 145 

DB2 Math, 147 

DB2 Trigonometry, 147 

Decimal Separator, 114 

deconforming 

dimensions, 60 

defining 

function sets, 48 

languages, 85 

prompt controls, 70 

defining multiple data sets, 35 

detecting 


diagrams, 21 

viewing, 23 

dimension information 

specifying, 93 

dimensions 

conforming, 28 

deconforming, 60 


Display AM / PM Symbols, 114 

Display As Exponent, 114 

Display Days, 114 

Display Eras, 114 

Display Hours, 114 

Display Milliseconds, 114 

Display Minutes, 115 

Display Months, 115 

Display Seconds, 115 

Display Time Zone, 115 

Display Weekdays, 115 

Display Years, 115 

document 

version, 2 

E 

embedded strings, 81 

embedding 

parameters in XML connection strings, 35 

ERWin extended characters 


ERWin stored procedures 


escape symbol, 81 

examples 

multilingual modeling, 87 

exploring 


packages, 105 

roles, 105 

Exponent Symbol, 115 

exporting 

metadata into CWM, 42 

translation tables, 86 

expressions 

complex, 66 

using prompts, 78 

F 

filters 

applying to a query subject, 77 

creating, 76 

filters (cont'd) 

determining usage, 77 

modifying, 76 

folders 

creating, 89 

using shortcuts, 89 

foreign keys, 242 


format types 

currency, 70 

date, 70 

text, 70 

formatting 

data, 70 


project, 19 

function sets 

adding, 48 

defining, 48 

functions 

project, 48 

G 

generating 


getting latest 

versions, 45 

governors 


setting run-time limits, 107 

Group Size (digits), 115 

groups 

adding, 99 


H 

hierarchies 


SAP BW, 92 

history 

viewing, 46 

HTTP URL connection strings 


I 

IBM DB2 

creating connection strings, 33 

identifiers 


importing 

Architect XML files, 29 

databases, 26 

Impromptu XML files, 29 

metadata into Framework Manager, 25 

ReportNet models, 28 

SAP BW, 92 

SAP BW metadata, 27 

third-party data sources, 29 

translation tables, 86 

XML files, 30 

Impromptu XML files 

importing, 29 

Impromtpu metadata 


User Guide 251

Index 

Informix 


installing 

language packs, 108 

International Currency Symbol, 115 

invalid query results, 107 

invalid query subject error 

when switching language in reporting application, 107 

isolation levels, 31 

J 

join, 244 


joins 

, 66 

ambiguous, 67 

refining, 66 

self, 66 

K 

keys, 244 


L 

language 

error when switching in reporting application, 107 

language packs 

installing, 108 

languages 

defining, 85 

levels, 245 


limited local, 48 

links 

creating, 47 

literal strings, 81 

locale 


locale, See languages 

M 

macros 


using, 81, 107 

managing 

packages, 105 

projects, 43, 50 

Mantissa (digits), 115 

many-to-many relationships, 109, 245 


mapping parameter values, 79 

Maximum No. of Digits, 116 

measures 


merging 

metadata, 64 

metadata 

exporting, 42 

importing, 25 

merging, 64 

publishing, 95 

structuring, 13 

metadata security 

adding, 101 

Microsoft SQL Server 


Minimum No. of Digits, 116 

Missing Value Characters, 116 

model objects, 21, 246 



viewing, 21 

model objects with parameters, 107 

model query subjects, 54 

converting to data source, 59 

model segments 


model versions 

updating, 103 

modeling 



multiuser, 49 

models 


preparing, 53 

versioning, 103 

modifying 

data source query subjects, 55 

filters, 76 

model query subjects, 59 

package access, 105 

package administrative access, 105 

packages, 97 



session parameters, 80 

stored procedure query subjects, 60 

MS Access, 148 

MS Access Cast, 153 

MS Access Math, 153 

MS Access Trigonometry, 154 

multi-fact relationships, 109 

multilingual 

data sources, 37, 85 

multilingual modeling 

example, 87 


multiple data sets, 35 

defining, 35 

multiple data source connections 

using, 31 

multiple users 

modeling, 49 

multiuser modeling, 49 

N 

namespaces, 246 

creating, 25 


naming conventions 

objects, 24 

native SQL, 62 

Negative Pattern, 116 

Negative Sign Position, 116 

Negative Sign Symbol, 116 

No. of Decimal Places, 116 

non-redundant 


normalization, 246 



Index 

notations, 66 

O 

Object Diagram View, 23 

Object Explorer View, 23 

object-based security 

adding, 101 

clearing, 101 

exploring, 105 

removing, 101 

objects 

naming conventions, 24 

searching, 24 

unique identifiers, 24 

ODBC 

creating data sources, 34 

OLAP, 176 

OLAP Member, 176 

OLAP Numeric, 178 

OLAP Set, 176 

one-to-many relationships, 246 


one-to-one relationships, 246 


opening 

projects, 20 

Operators, 119 

operators, 66 

Oracle, 154 

Oracle databases 


Oracle Math, 159 

Oracle Trigonometry, 159 

outer joins 

in SQL, 109 

P 

package access 

modifying, 105 

package administrative access 

modifying, 105 

package inclusion 

viewing, 106 

packages, 246 

adding security, 105 

administrative access, 105 

creating, 97 



managing, 105 

modifying, 97 


packaging 

SAP BW metadata, 98 

Padding Character, 116 

parameter maps, 79 

using as lookup tables, 85 

parameterizing 

XML connection strings, 35 


creating, 79 

embedded in XML connection strings, 35 

in model objects, 79 

in XML connection strings, 35 

multilingual modeling, 85 

session, 80 

parameters (cont'd) 

using, 81 

using aliases, 79 

using in data source query subjects, 83 

pass-through SQL, 63 

Pattern, 116 

Percent Scale (integer), 116 

Percentage Symbol, 116 

portals 


primary keys, 246 


product 

version, 2 

project 

Framework Manager, 19 

functions, 48 

project files, 19 

project objects 

naming conventions, 24 

Project Viewer, 21 

projects 

checking in, 45 

checking out, 45 

creating, 20 


managing, 43, 50 

opening, 20 


structuring, 14 

synchronizing, 50 

using multiple data sets, 35 

verifying, 90 

prompt controls 

defining, 70 

prompt type 


promptInfo 

property, 70 

prompts 

cascade on reference, 71 

display on reference, 71 

filter on reference, 72 

in expressions, 78 

properties 

aggregation rules, 72 

cascade on reference, 71 


display on reference, 71 

filter on reference, 72 

modifying, 88 

prompt type, 70, 71 

promptInfo, 70 

regularAggregate, 72 


SAP BW data source, 37 

SAP BW Variables, 37 

semiAggregate, 72 

usage, 72 

viewing, 23 

publishing 

metadata, 95 

packages, 103 

projects, 95 

User Guide 253

Index 

Q 

query item folders 

creating, 89 

query items 


query locales 


query paths 

refining, 66 

query processing, 48 

choosing, 48 

query subjects 

creating, 54 

data source, 53 


model, 54 

modifying a model query subject, 59 

modifying a stored procedure query subject, 60 

modifying data source query subjects, 55 

SQL, 53 

stored procedure, 54 

testing, 60 

viewing properties, 88 

quotation marks, 81 

R 

recursive relationships, 66 

Red Brick, 161 

redundant 


refining 

query paths, 66 

regularAggregate 

property, 72 


ambiguous, 67 

cardinality, 66 

creating, 67 

creating shortcuts, 68 


generating, 69 

many-to-many, 109 

modifying, 68 

multi-fact, 109 

non-redundant, 66 


recursive, 66 

redundant, 66 

refining, 66 

removing 


Report functions, 179 

report specifications 


reporting application 

error when switching language, 107 

ReportNet models 

importing, 28 

repositories 

connections, 43 

creating, 43 

repository control, 43 

roles 

adding, 99 



rules 

business, 75 

run-time limits 

governors, 107 

S 

SAP BW, 164 

comforming dimension, 57 

hierarchies, 92 

importing, 27 

packaging metadata, 98 

variables, 37 

SAP BW Math, 165 

SAP BW OLAP, 164 

SAP BW Trigonometry, 164 

SAP BW Variables, 37 

Scale (integer), 117 

searching 

objects, 24 

Secondary Group Size (digits), 117 

security 

CSVIdentityName function, 84 

segments 

creating, 46 

self joins, 66 

semiAggregate 

property, 72 

sending 

information through XML connection strings, 35 

session parameters 

creating, 80 

modifying, 80 

shortcuts 

using, 89 

single quotation marks, 81 

specifying 

dimension information, 93 

SQL 

Cognos, 61 

generation types, 64 

native, 61, 62 

outer joins, 109 

pass-through, 63 


stand-alone native, 61 

SQL Server, 166 

SQL Server Cast, 168 

SQL Server Math, 169 

SQL Server Trigonometry, 170 

statistics 

viewing, 23 

stored procedure query subjects, 54 

modifying query subjects, 60 

stored procedures 

using binary large objects, 107 

structuring 

metadata, 13 

projects, 14 

Summaries, 124 

summaries 

viewing, 23 

supported environments 


supporting 

multiple users, 49 




Index 

synchronizing 

projects, 50 

T 

tasks 

viewing, 23 

Teradata, 171 

Teradata Trigonometry, 174 

test results 

unable to view, 107 

testing 



text 


third-party data sources 

importing, 29 

third-party metadata 


Thousands Separator, 117 

Time Separator, 117 

Time Style, 117 

Time Unit, 117 

translation tables 

exporting, 86 

importing, 86 

traps 

chasm, 109 


Architect metadata, 108 

Business Objects expressions, 108 

ERWin extended characters, 108 

ERWin stored procedures, 109 

Impromptu metadata, 108 

macros, 107 

third-party metadata, 108 

XML validation, 108 

U 

unable to see 

currency, 108 

unable to view 

test results, 107 

unique identifiers 

objects, 24 

UNIX 

creating ODBC data sources, 34 

updating 

model versions, 103 

usage property, 72 

Use Thousands Separator, 117 

users 

adding, 99 

using 

macros, 107 

multiple data source connections, 31 

parameters in XML connection strings, 35 

using embedded strings 


in macros, 81 

using literal strings 


in macros, 81 

using parameters 

in data source query subjects, 83 

using quotation marks 


in macros, 81 

V 

version 

product, 2 

versioning 

models, 103 

versions 

getting latest, 45 

viewing 

diagrams, 23 

history, 46 

model objects, 21 

package inclusion, 106 


statistics, 23 

summaries, 23 

tasks, 23 

Visual SourceSafe database 

creating, 44 

Visual SourceSafe repository connections 

creating, 44 

X 

XML 


XML connection strings 

parameterizing, 35 

sending information, 35 


with parameters, 35 

XML files 

importing, 30 

XML validation 


Z 

Zero Value Characters, 117 

User Guide 255

Index

ug_fm

Create successful ePaper yourself

Delete template?

Save as template?