IBM Cognos Transformer Version 10.2.1: Developer Guide

267 Pages·2013·1.62 MB·English

IBM Cognos Transformer
Version 10.2.1
Developer Guide
Note
Before using this information and the product it supports, read the information in “Notices” on page 241.
Product Information
This document applies to IBM Cognos Business Intelligence Version 10.2.1 and may also apply to subsequent
releases.
Licensed Materials - Property of IBM
© Copyright IBM Corporation 2007, 2013.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule Contract
with IBM Corp.
Contents
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xiii
Chapter 1. What's New . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
New features in version 10.2.1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
New features in version 10.2.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
New option for defining hierarchies in a time dimension . . . . . . . . . . . . . . . . . . . 1
Chapter 2. Model Definition Language (MDL) . . . . . . . . . . . . . . . . . . . . 3
.py? and .mdl formats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
User interface and MDL representations of a model object . . . . . . . . . . . . . . . . . . . . 4
MDL usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Example - Changing a model object using MDL . . . . . . . . . . . . . . . . . . . . . . 6
Cognos Transformer and verb MDL . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Chapter 3. Cognos Transformer objects . . . . . . . . . . . . . . . . . . . . . . 9
Object identifiers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Object names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Uniqueness of object names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Category names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Column names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
View names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Locating objects uniquely. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Uniquely locate existing objects. . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Uniquely locate new objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Setting global preferences. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Specify a preferred category sorting option . . . . . . . . . . . . . . . . . . . . . . . . 14
Chapter 4. Creating a complete MDL model . . . . . . . . . . . . . . . . . . . . 15
Example - MDL model using IBM Cognos data sources in verb MDL . . . . . . . . . . . . . . . . 15
Create the data sources in Cognos Transformer . . . . . . . . . . . . . . . . . . . . . . 15
Example - MDL model using an IQD data source in verb MDL . . . . . . . . . . . . . . . . . . 16
Step 1: Create the data sources in Cognos Transformer . . . . . . . . . . . . . . . . . . . . 16
Step 2: Create the time dimension . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Step 3: Create the products dimension . . . . . . . . . . . . . . . . . . . . . . . . . 18
Step 4: Create key product measures . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Step 5: Create allocations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Step 6: Create the signon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Step 7: Populate the model and create the PowerCube . . . . . . . . . . . . . . . . . . . . 20
Step 8: Create the model by combining the scripts . . . . . . . . . . . . . . . . . . . . . 20
Checking the model generated by Cognos Transformer . . . . . . . . . . . . . . . . . . . . 21
Example - MDL model using an IBM Cognos data source in structured MDL . . . . . . . . . . . . . 34
Example - MDL model using an IBM Cognos data source in verb MDL . . . . . . . . . . . . . . . 45
Sample scripts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
Change data source types sample . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
Change data source sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
Update selected cubes sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
Update all cubes sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
Description samples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
Add several descriptions sample . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
Change a cube output location sample . . . . . . . . . . . . . . . . . . . . . . . . . 58
Change several cube output locations sample . . . . . . . . . . . . . . . . . . . . . . . 58
Change the PowerCube output type sample . . . . . . . . . . . . . . . . . . . . . . . 58
Change optimization setting sample . . . . . . . . . . . . . . . . . . . . . . . . . . 58
Automate CleanHouse sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
© Copyright IBM Corp. 2007, 2013 iii
Convert model file formats sample . . . . . . . . . . . . . . . . . . . . . . . . . . 58
Create cubes based on dimension views sample . . . . . . . . . . . . . . . . . . . . . . 59
Update conversion rates sample . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
Disable incremental update sample . . . . . . . . . . . . . . . . . . . . . . . . . . 59
Chapter 5. Syntax conventions . . . . . . . . . . . . . . . . . . . . . . . . . 61
Data type conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
Syntax example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
Syntax requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
Chapter 6. MDL verbs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
Verb types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
AllocationAdd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
ApexCat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
AssociationAdd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
AssociationDelete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
AssociationMake . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
AssociationUpdate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
AutoDesign . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
CatAdd. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
CatDelete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
CatJoin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
CatMake . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
CatMorph . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
CatMoveVertical . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
CatUpdate. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
CatUpdateAll. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
CleanHouse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
CognosPackageAdd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
CognosPackageDelete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
CognosPackageMake . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
CognosPackageUpdate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
CognosPackageDatasourceConnectionAdd . . . . . . . . . . . . . . . . . . . . . . . . . 79
CognosPackageDatasourceConnectionDelete . . . . . . . . . . . . . . . . . . . . . . . . 80
CognosPackageDatasourceConnectionMake. . . . . . . . . . . . . . . . . . . . . . . . . 80
CognosPackageDatasourceConnectionUpdate . . . . . . . . . . . . . . . . . . . . . . . . 82
CognosPackageFilterAdd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
CognosPackageFilterDelete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
CognosPackageFilterMake . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
CognosPackageFilterUpdate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
ColumnAdd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
ColumnDelete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
ColumnListUpdate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
ColumnMake . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
ColumnUpdate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
CreateColumns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
CreateFiles. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
CreateFromCubes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
CreateFromQueries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
CubeAdd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
CubeDelete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
CubeGroupAdd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
CubeGroupCubeAdd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
CubeGroupCubeDelete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
CubeGroupCubeListUpdate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
CubeGroupCubeMake . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
CubeGroupCubeUpdate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
CubeGroupDelete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
CubeGroupMake . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
CubeGroupUpdate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
iv IBM Cognos Transformer Version 10.2.1: Developer Guide
CubeMake. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
CubeUpdate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
CurrencyAdd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
CurrencyDelete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
CurrencyMake . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
CurrencyTableAdd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
CurrencyTableDelete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
CurrencyTableMake . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
CurrencyTableUpdate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
CurrencyUpdate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
CustomViewAdd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
CustomViewChildListUpdate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110
CustomViewDelete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110
CustomViewMake . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110
CustomViewUpdate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
DataSourceAdd. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
DataSourceDelete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
DataSourceMake . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114
DataSourceUpdate. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
DeletionListUpdate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
DimAdd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116
DimCalcDefAdd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116
DimCalcDefDelete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
DimCalcDefMake . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
DimCalcDefUpdate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119
DimDelete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121
DimensionListUpdate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121
DimMake . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121
DimUpdate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122
DrillCatMake . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
EventEnd. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124
EventStart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124
FilterCat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124
LevelAdd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
LevelDelete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126
LevelMake . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
LevelMoveAfter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
LevelMoveBefore . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
LevelNewDrill . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129
LevelUpdate. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
MDCClear . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
MeasureAdd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131
MeasureDelete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132
MeasureListUpdate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132
MeasureMake . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132
MeasureUpdate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134
ModelEnsureCompleteness . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134
NewModel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134
OpenDef . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135
OpenMDL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135
OpenPY . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136
PopulateFromQueries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137
PopulateModel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137
PowerCubeCustomViewListUpdate . . . . . . . . . . . . . . . . . . . . . . . . . . . 137
PowerCubeDelete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138
PowerCubeListUpdate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138
PromptAdd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139
PromptDelete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139
PromptMake . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139
PromptUpdate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140
ReportPartitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140
Contents v
RootCatMake . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141
RootCatUpdate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141
SaveMDL. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142
SavePY . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142
SecurityNamespaceAdd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143
SecurityNamespaceDelete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143
SecurityNamespaceMake . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144
SecurityNamespaceUpdate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144
SecurityObjectAdd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145
SecurityObjectDelete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146
SecurityObjectMake . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146
SecurityObjectUpdate. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147
SignonAdd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147
SignonDelete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148
SignonMake . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149
SignonUpdate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149
SourceListUpdate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150
SpecialCatAdd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150
SpecialCatDelete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151
SpecialCatMake . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152
SpecialCatUpdate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153
SubDimRootMake . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153
SubDimRootUpdate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154
SummarizeCat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155
SummarizeLevel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156
UpdateForwardReference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156
UpdatePowerCubes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157
ViewAdd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157
ViewDelete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158
ViewListUpdate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158
ViewMake . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159
ViewUpdate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160
Chapter 7. MDL options . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
appqueryopts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
AppInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
CharacterSet. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
CognosSource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162
Columns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162
DataRange . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162
DecimalSep . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162
ImrName. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163
Isolation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163
ModelStamp. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163
ModelNonRollupHierarchies . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164
PackageReportSource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164
PackageTimeStamp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164
PreSummarized . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165
SegmenterPrompt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165
SegmenterPromptEnabled . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165
Separator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165
SetCurrent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165
Source . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166
SourceInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166
SourcePath . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166
SourceSignonList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166
SourceType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166
Speed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167
SQL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167
Stamp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168
StreamExtractSize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168
vi IBM Cognos Transformer Version 10.2.1: Developer Guide
SuppressNull . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168
ThousandSep . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169
Timing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169
UpdateCycle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169
Version . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169
assocopts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170
AssociationContext . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170
AssociationReferenced . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170
AssociationRole . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170
AssociationType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170
catopts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171
Blanks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171
Calc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171
CalcDef . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172
CatInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173
ContextLevel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173
ContextOffset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173
Current . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173
Date . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174
DateDrill . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174
ExtraWeek . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174
Filtered . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174
Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174
Inclusion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175
IsKeyOrphanage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175
IsTruncated . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175
Label . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176
LastUse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176
NewPartition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176
HideValue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176
Orphanage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177
PartialWeek . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177
Primary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177
PrimaryDrill . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177
Rollup. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178
RunningPeriods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178
Share . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178
ShortName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178
Sign . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179
SourceValue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179
SplitWeek . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179
Suppressed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179
TargetLevel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180
TargetOffset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180
TimeAggregate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180
ToDateLevel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180
WeekBegins . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181
YearBegins . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181
cognospackageopts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181
PackageTimeStamp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181
SourcePath . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182
SourceType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182
colopts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182
Calc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182
Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186
ColSrcType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186
Column . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186
ColumnInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187
Dateconstant . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187
DateLevel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187
Contents vii
Decimals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188
Detail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188
Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188
InputScale . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188
Offset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189
Origin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189
Scale . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189
Size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189
Storage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190
TimeArray . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190
TimeArrayCol . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190
TimeArrayMonth . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190
currencyrecordopts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190
BaseCurrency . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191
CountryCode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191
CurrencyCountryLabel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191
CurrencyDecimals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191
CurrencyFormatOverride . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192
CurrencyIsEMU . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192
CurrencySymbol . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192
EmuEntryDate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192
EuroBaseCurrency . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192
currencytableopts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193
CurrencyCountryCodeColumn . . . . . . . . . . . . . . . . . . . . . . . . . . . 193
CurrencyDateColumn . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193
CurrencyLabelColumn . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193
CurrencyRateColumn. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194
CurrencyTableType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194
deletionopts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194
CalcDef . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194
Column . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194
Cube . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195
DataSource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195
Dimension . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195
Levels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195
Measure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195
Signon. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196
View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196
dimopts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196
Association . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196
DaysInWeek . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196
DimDefaultCategory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197
DimInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197
DimType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197
EarliestDate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198
ExcludeAutoPartitioning . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198
LatestDate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198
ManualPeriods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198
NewCatsLock . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199
filteropts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199
CognosPackageFilterRef . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199
DATASOURCE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199
CognosPackageFilterDelete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199
CognosPackageFilterUpdate . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199
ExpMark . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200
FilterDescription . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200
levelopts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200
Association . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200
Blanks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200
CategoryCode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201
CatLabFormat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201
viii IBM Cognos Transformer Version 10.2.1: Developer Guide
DateFunction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201
Filtered . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202
Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202
Generate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202
Inclusion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202
LevelInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203
Label . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203
NewCatsLock . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203
OrderBy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203
SortOrder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204
SortAs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204
Partition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204
RefreshLabel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205
RefreshDescription . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205
RefreshShortName. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205
Share . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205
ShortName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205
Source . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206
Suppressed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206
TimeRank . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206
UniqueCategories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206
UniqueMove . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207
meaopts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207
ActivityMeasure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207
Allocation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207
Association . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208
Calc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208
Decimals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209
Dimension . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210
DrillThrough . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210
DuplicateRollup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210
DuplicateWeight . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211
Exclude . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211
Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211
IgnoreMissingValue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212
IsCurrency . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212
IsFolder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213
Label . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213
MeasureInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213
Missing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213
Rollup. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213
Parent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214
Scale . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214
ShortName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214
Sign . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214
Storage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215
TimeStateRollup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215
TimeStateWeight . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215
Timing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216
Weight . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216
WeightID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216
powercubeopts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216
BlockParentTotals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217
Caching . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217
Compress . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217
Consolidate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217
ConsolidatedRecords . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218
CubeCreation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218
CubeCycle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218
CubeStamp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218
Contents ix
CubeUpdateLock . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218
Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219
DatabaseInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219
DataSource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219
DeployLocations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220
DeployType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220
DetailLevel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220
DrillThrough . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220
Exclude . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221
IncrementalUpdate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221
Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221
MDCFile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222
MeasureName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222
Optimize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222
PartitionSize. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222
PassesNumber . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223
Password. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223
PublishAllowAccessToSuppressionOptions . . . . . . . . . . . . . . . . . . . . . . . 223
PublishAllowMultiEdgeSuppression . . . . . . . . . . . . . . . . . . . . . . . . . . 223
PublishAllowNullSuppression . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223
SegmenterDimension . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224
SegmenterLevel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224
ServerCube . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224
Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224
SummaryLevel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225
UseAlternateFilename . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225
TimeBasedPartitionedCube . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225
promptopts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225
PromptType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225
PromptValue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226
signonopts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226
PromptForPassword . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226
UserId. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226
password. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226
AutoLogon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227
SignonNamespace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227
SignonType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227
SignonInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227
viewopts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227
Apex . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228
Cloak . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228
Filter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228
LevelCloak . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228
LevelFilter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229
LevelSummary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229
LevelSuppressed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229
Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230
NotCloak. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230
NotFilter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230
NotSummary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230
NotSuppressed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231
Summary. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231
Suppressed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231
Chapter 8. Structured MDL . . . . . . . . . . . . . . . . . . . . . . . . . . 233
History of MDL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233
Comparison of structured and verb keywords . . . . . . . . . . . . . . . . . . . . . . . 233
Using structured MDL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235
Notices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241
x IBM Cognos Transformer Version 10.2.1: Developer Guide