transformer automation guide...目次 第 1 章 概要 . 1 オブジェクトの作成の概要 . 1...

558
IBM Cognos Analytics バージョン 11.0 Transformer オートメーショ ン・ガイド IBM

Upload: others

Post on 26-Dec-2019

2 views

Category:

Documents


0 download

TRANSCRIPT

IBM Cognos Analyticsバージョン 11.0

Transformer オートメーション・ガイド

IBM

©

この資料は IBM Cognos Analytics バージョン 11.0.0 を対象として作成されています。また、その後のリリースも対象となる場合があります。

お客様の環境によっては、資料中の円記号がバックスラッシュと表示されたり、バックスラッシュが円記号と表示されたりする場合があります。

 

原典: IBM Cognos AnalyticsVersion 11.0Transformer Automation Guide

発行: 日本アイ・ビー・エム株式会社

担当: トランスレーション・サービス・センター

著作権

Licensed Materials - Property of IBM

© Copyright IBM Corp. 2007, 2017.

IBM、IBM ロゴおよび ibm.com は、世界の多くの国で登録された International Business Machines Corporationの商標です。他の製品名およびサービス名等は、それぞれ IBM または各社の商標である場合があります。現時点での IBM の商標リストについては、www.ibm.com/legal/copytrade.shtml をご覧ください。

他の会社名、製品名およびサービス名等はそれぞれ各社の商標です。

v Linux は、Linus Torvalds の米国およびその他の国における商標です。

v UNIX は The Open Group の米国およびその他の国における登録商標です。

目次

第 1 章 概要 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1オブジェクトの作成の概要 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1Visual Basic 用のタイプ・ライブラリーの概要 . . . . . . . . . . . . . . . . . . . . . . . . 2Visual C++ および Visual Studio 2009 C# 用のタイプ・ライブラリーの概要 . . . . . . . . . . . . . 3Transformer 用のタイプ・ライブラリーの概要 . . . . . . . . . . . . . . . . . . . . . . . . 4メソッドの概要 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5値リストと定数の概要 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5Transformer オブジェクトの階層マップ . . . . . . . . . . . . . . . . . . . . . . . . . . 6Transformer オブジェクトの階層マップ A . . . . . . . . . . . . . . . . . . . . . . . . . 8Transformer オブジェクトの階層マップ B . . . . . . . . . . . . . . . . . . . . . . . . . 8Transformer オブジェクトの階層マップ C . . . . . . . . . . . . . . . . . . . . . . . . . 9Transformer オブジェクトの階層マップ D . . . . . . . . . . . . . . . . . . . . . . . . . 10Transformer オブジェクトの階層マップ E . . . . . . . . . . . . . . . . . . . . . . . . . 10ソフトウェア開発キット設定の設定 . . . . . . . . . . . . . . . . . . . . . . . . . . . 10IBM Cognos Series 7 モデル . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

第 2 章 コレクション. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11Associations コレクション . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12CalculationDefinitions コレクション . . . . . . . . . . . . . . . . . . . . . . . . . . . 13Categories コレクション . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14CategorySets コレクション . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15ChildCubes コレクション . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16Columns コレクション . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16CubeCustomViews コレクション . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17Cubes コレクション . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18CurrencyRates コレクション . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19CurrencyRecords コレクション. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19CurrencyTables コレクション . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20CustomViews コレクション . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22DataSources コレクション . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22DimensionLevels コレクション. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23Dimensions コレクション . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24DrillDowns コレクション . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25DrillThroughTargets コレクション . . . . . . . . . . . . . . . . . . . . . . . . . . . 26Filters コレクション . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27LevelCategories コレクション . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28LevelDrillDowns コレクション . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28Levels コレクション . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29Measures コレクション . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30Names コレクション . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31Namespaces コレクション . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32PackageDatasourceConnections コレクション . . . . . . . . . . . . . . . . . . . . . . . . 33Packages コレクション . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34Prompts コレクション . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35Queries コレクション . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36Reports コレクション . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37SecurityObjects コレクション . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38Signons コレクション . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39SuspendedModels コレクション . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40Views コレクション . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

iii

第 3 章 オブジェクト. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43Application オブジェクト . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45Association オブジェクト . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48CalculationDefinition オブジェクト . . . . . . . . . . . . . . . . . . . . . . . . . . . 49Category オブジェクト . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51CategorySet オブジェクト . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54ChildCube オブジェクト . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55Column オブジェクト . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57CrossTabDataSource オブジェクト . . . . . . . . . . . . . . . . . . . . . . . . . . . 59Cube オブジェクト. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61CubeGroup オブジェクト . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65CurrencyRate オブジェクト . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68CurrencyRecord オブジェクト . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70CurrencyTable オブジェクト . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71CustomView オブジェクト . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73DataSource オブジェクト . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75DateDimension オブジェクト . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77DateDrillDown オブジェクト . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80DateLevel オブジェクト . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82DateWizard オブジェクト . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86DbDataSource オブジェクト. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87Dimension オブジェクト . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90DrillDown オブジェクト . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92DrillThroughTarget オブジェクト . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94Filter オブジェクト . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95FlatFileDataSource オブジェクト . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96IqdDataSource オブジェクト . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98Level オブジェクト . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100Measure オブジェクト . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103モデル・オブジェクト . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107Name オブジェクト . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110Namespace オブジェクト . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110Package オブジェクト . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112PackageDatasourceConnection オブジェクト . . . . . . . . . . . . . . . . . . . . . . . . 113Prompt オブジェクト . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114Query オブジェクト . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115Report オブジェクト . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117SecurityObject オブジェクト . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118Signon オブジェクト . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119SpecialCategory オブジェクト. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121SuspendedModel オブジェクト . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124View オブジェクト . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125

第 4 章 メソッド . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129Add メソッド () . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133Add メソッド (Categories). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134Add メソッド (CustomViews) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135Add メソッド (DrillThroughTargets) . . . . . . . . . . . . . . . . . . . . . . . . . . 136Add メソッド (オブジェクト). . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137AddDeployLocation メソッド . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138AddToCustomView メソッド . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138AddToFolder メソッド . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139AssociateWith メソッド . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140CheckLocalPowerCubes メソッド . . . . . . . . . . . . . . . . . . . . . . . . . . . 141CheckModel メソッド . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142CleanHouse メソッド . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142

iv IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

ClearDeployLocations メソッド . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143Close メソッド . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144ConnectWithCategory メソッド . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144CreateAlternateDrillDown メソッド . . . . . . . . . . . . . . . . . . . . . . . . . . . 145CreateDateDimension メソッド . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146CreateMDCFile メソッド . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147CreateMDCFiles メソッド . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147Delete メソッド . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148DeleteAllCustomViews メソッド . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150DeleteAllSecurityObjects メソッド . . . . . . . . . . . . . . . . . . . . . . . . . . . 150DeployCube メソッド . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151DeployCubes メソッド . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151DimensionAssociateWith メソッド . . . . . . . . . . . . . . . . . . . . . . . . . . . 152DoAutoDesign メソッド . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153FindCategoryByCatCode メソッド . . . . . . . . . . . . . . . . . . . . . . . . . . . 153GenerateCategories メソッド . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154GenerateDateCategories メソッド . . . . . . . . . . . . . . . . . . . . . . . . . . . 155GetDefaultCategory メソッド . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156GetViewStatus メソッド . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156IsExcludeDateDimension メソッド . . . . . . . . . . . . . . . . . . . . . . . . . . . 157IsExcludeDateLevel メソッド . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158IsExcludeDimension メソッド . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158IsExcludeLevel メソッド . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159Item メソッド . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160Item メソッド () . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161Item メソッド () . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163LoadCurrencyTable メソッド . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164Logoff メソッド . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164Logon メソッド . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165Move メソッド. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165MoveToCategory メソッド . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167MoveToLevel メソッド . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168NewModel メソッド . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168OpenModel メソッド . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169OpenSuspendedModel メソッド . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170PublishDatasource メソッド . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171PublishPackage メソッド . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171Remove メソッド . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172RemoveCubeCustomView メソッド . . . . . . . . . . . . . . . . . . . . . . . . . . . 174RemoveFromFolder メソッド . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175RemoveSuspendedModel メソッド . . . . . . . . . . . . . . . . . . . . . . . . . . . 175ResetPartitions メソッド . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176Save メソッド . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176SaveAs メソッド . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177SetAllocation メソッド . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178SetDefaultCategory メソッド . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179SetDeployType メソッド . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180SetExcludeDateDimension メソッド . . . . . . . . . . . . . . . . . . . . . . . . . . . 181SetExcludeDateLevel メソッド . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182SetExcludeDimension メソッド . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183SetExcludeLevel メソッド . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183SetViewStatus メソッド . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184TestBuild メソッド . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185Update メソッド . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186Verify メソッド . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188

目次 v

第 5 章 プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189ActivityMeasure プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207Aggregate プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208AllocationMeasure プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209AllocationType プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210AllowCurrencyConversion プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . 211AllowDrillThrough プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . 212AlternateQueryPath プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . 212AltMDCFile プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213AlwaysUseTransformerSignon プロパティー . . . . . . . . . . . . . . . . . . . . . . . . 214Apex プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215Application プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215AssociationRole プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218Associations プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219AssociationType プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220AutoLogon プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221AutoSummary プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221BlankSubstitute プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222BlockParentTotals プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223CacheCrossTabs プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223CalculationDefinitions プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . 224CAMID プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225CanAllocate プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225CanAllocateByMeasure プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . 226CanAllocateMeasure プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . 228Categories プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229Category プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230CategoryCount プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230CategoryCountLevel プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . 231CategorySets プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232CharacterType プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233ChildCategories プロパティー. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233ChildCubes プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234ChildCustomViews プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . 235ChildMeasures プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235Code プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236Columns プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237ColumnsLoaded プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238CompressMDC プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238Connection プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239Consolidate プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240Context プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241ContextLevel プロパティー. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242ContextOffset プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242ConvergenceLevel プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243Count プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244CountryCode プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246CubeCodePage プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246CubeCreation プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 248CubeCustomViews プロパティー. . . . . . . . . . . . . . . . . . . . . . . . . . . . 249Cubes プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250CubeStamp プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250CurrencyCountryLabel プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . 251CurrencyDecimals プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251CurrencyFormatOverride プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . 252CurrencyIsEMU プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253

vi IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

CurrencyIsEuro プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254CurrencyRates プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254CurrencyRecord プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . 255CurrencyRecords プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256CurrencySymbol プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256CurrencyTable プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257CurrencyTables プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258CurrencyTableType プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . 258CurrentModel プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259CurrentValueIndex プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . 260CustomView プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260CustomViews プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261DataCharacterSet プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262DataClass プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262DataRange プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 263DataSource プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264DataSourcePath プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264DataSources プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265DataSourceWindowsLocation プロパティー . . . . . . . . . . . . . . . . . . . . . . . . 265DataTemporaryFilesPath プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . 266DateDegreeofDetail プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . 267DateDegreeofDetailLevelName プロパティー. . . . . . . . . . . . . . . . . . . . . . . . 268DateFormat プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 268DateFunction プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 269DateInputFormat プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . 270DateLevel プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 271DateWizard プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 271DecimalPoint プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 272Decimals プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 273DefaultCategoryOrderBy プロパティー. . . . . . . . . . . . . . . . . . . . . . . . . . 273DefaultDateFormat プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . 274Description プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 274DesiredPartitionSize プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . 276DetachDataSource プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . 277DetailLevel プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 277Dimension プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 278DimensionInclude プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . 279DimensionLevels プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . 280DimensionName プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281Dimensions プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281DimensionView プロパティー. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 282DimensionViewType プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . 283DisplayName プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284DrillCode プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 285DrillDowns プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 285DrillInclusion プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 286DrillThroughTargets プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . 287DuplicateRollup プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . 288DuplicateWeight プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . 289EarliestDate プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 289EMUEntryDate プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 290EnableMessageLogging プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . 291EnableTimePeriod プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . 292EstimatedRows プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 292ExcludeAutoPartition プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . 293ExpressionText プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 294

目次 vii

External プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 295FieldSeparator プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 296FileName プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297Filters プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 298FindCategoryByCatCode プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . 298Format プロパティー. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 299FormatDecimals プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . 301FullName プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 301GenerateCategories プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . 302GenerateDateCategories プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . 303GenerateDates プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 303GeneratePowerCube プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . 304GenerateTimePeriod プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . 305Group プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 306GroupDimension プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . 306GroupLevel プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 307HasSubdimension プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . 308HideValue プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 309ID プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 309IgnoreMissingValue プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . 310Inclusion プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 311IncrementalUpdate プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . 311InputScale プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 312IsAnyColumnMismatched プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . 313IsBad プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 314IsExpressionValid プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . 315IsFolder プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 316IsManual プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 316IsMDCInUse プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 317IsolationLevel プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 318IsPrimary プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 319IsTimeBasedPartitionedCube プロパティー . . . . . . . . . . . . . . . . . . . . . . . . 320KeyName プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 321Label プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 321LastUseDate プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 322LatestDate プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 323Level プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 324LevelCategories プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 324LevelDrillDowns プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . 325Levels プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 325LocalPath プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 326LogErrorLevel プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 327LogFileAppend プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 328LogFileName プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 328LogFilesPath プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 329Lunar プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 330ManualCurrentPeriod プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . 330MaximizeSpeed プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 331MaxNumPartLevels プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . 332MaxTransactionNumber プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . 333MDCFile プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 334MeasureInclude プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 334MeasureName プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 335Measures プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 336MeasureType プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 336MissingValue プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 337

viii IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

ModelName プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 338ModelsPath プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 338ModelTemporaryFilesPath プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . 339ModelType プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 340MonthType プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 340Name プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 341Namespaces プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 343NewCatsLocked プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . 344ObjectCAMID プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 344ObjectName プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 345Optimize プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 346OrderByDescending プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . 346OrderByStorageType プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . 347Origin プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 348OriginalName プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 349Orphanage プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 350OutputScale プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 351Packages プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 351PackagesDatasourceConnections プロパティー . . . . . . . . . . . . . . . . . . . . . . . 352Parent プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 353ParentCategories プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . 356Partition プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 356Password プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 358PatFile プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 359Path プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 359PopulateByDataSource プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . 360Position プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 361PowerCubesPath プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . 361PowerPlayPath プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 362Precision プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 363PromptForPassword プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . 363Prompts プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 364PromptValueType プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . 365QualifiedName プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 365QuarterType プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 366Queries プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 366QyPath プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 367Rate プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 368RefName プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 369RefreshDescription プロパティー. . . . . . . . . . . . . . . . . . . . . . . . . . . . 369RefreshLabel プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 370RefreshShortName プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . 371RegularRollup プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 372RegularWeight プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 373Reports プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 373ReverseSign プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 374Rollup プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 375RollupTiming プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 375RowsAsSample プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 376RowsChecked プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 377RunningPeriods プロパティー. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 378SecurityObjects プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 379Server プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 379ServerModelPath プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . 380ServerPath プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 380ServerQuery プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 381

目次 ix

ServicesBuildNumber プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . 382ServicesVersionText プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . 382SetsCurrentPeriod プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . 383ShortName プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 384Signon プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 385SignOnNamespace プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . 386Signons プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 386SignonType プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 387Size プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 387SortComparisonRule プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . 388SourceType プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 389SpecialCategoryCount プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . 390SQLExpression プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 390Status プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 391StorageType プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 392StreamExtractAllowed プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . 392StreamExtractSize プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . 393SummaryLevel プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 393SuppressNull プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 394SuspendedModels プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . 395TargetLevel プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 395TargetOffset プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 396ThousandPoint プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 397Time プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 398TimeArrayColumn プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . 398TimeArrayStartMonth プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . 399TimeArrayType プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 400TimeRank プロパティー. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 400TimeStamp プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 401TimeStateRollup プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . 402TimeStateWeight プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . 403ToDateLevel プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 403TransdaPath プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 404TransformerSignon プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . 405Type プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 405Unique プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 407UniqueMove プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 409UseAltMDCFile プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 409User プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 410UserCAMID プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 411UserID プロパティー. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 411Value プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 412ValuesCount プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 412Version プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 413Views プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 414ViewType プロパティー. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 414WeekAdd プロパティー. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 415WeekSpan プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 416WeekStart プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 417WeekStartDay プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 418WorkingDay プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 418WorkingDays プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 419YearStartDay プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 421YearType プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 422

x IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

第 6 章 定数 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 423xtrAllocationType 値リスト . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 423xtrAssociationRole 値リスト . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 424xtrAssociationType 値リスト . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 425xtrCharacterType 値リスト . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 425xtrCubeConsolidate 値リスト . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 426xtrCubeCreation 値リスト . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 426xtrCubeOptimize 値リスト . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 427xtrCubeStatus 値リスト . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 428xtrCurrencyTableType 値リスト . . . . . . . . . . . . . . . . . . . . . . . . . . . . 429xtrDataClass 値リスト . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 429xtrDateCategoriesGeneration 値リスト . . . . . . . . . . . . . . . . . . . . . . . . . . 430xtrDateFormat 値リスト. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 430xtrDateLevel 値リスト . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 431xtrDeployType 値リスト . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 432xtrDuplicateRollup 値リスト . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 432xtrGenerateOptions 値リスト . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 433xtrInclusion 値リスト . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 434xtrMeasureType 値リスト . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 435xtrMissingValue 値リスト . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 435xtrObjectType 値リスト . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 436xtrOrigin 値リスト . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 438xtrPowerCubeGeneration 値リスト . . . . . . . . . . . . . . . . . . . . . . . . . . . 438xtrPreferences 値リスト . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 440xtrPromptValueType 値リスト . . . . . . . . . . . . . . . . . . . . . . . . . . . . 441xtrRollup 値リスト . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 441xtrRollupTiming 値リスト . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 442xtrSecurityType 値リスト . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 443xtrSourceType 値リスト . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 444xtrSpecialFunction 値リスト . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 446xtrStorage 値リスト . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 447xtrTimeAggregate 値リスト . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 448xtrTimeArrayType 値リスト . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 448xtrTimeRollup 値リスト . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 449xtrTimeType 値リスト . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 451xtrViewStatus 値リスト . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 451xtrViewType 値リスト . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 452xtrWeekAdd 値リスト . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 453xtrWeekDay 値リスト . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 453xtrWeekSpan 値リスト . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 454

第 7 章 UI との対応 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 457コレクション . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 457オブジェクト . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 459メソッド . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 461プロパティー . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 463値リストと定数 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 490

第 8 章 サンプルと例 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 495モデルを開き、関連付けによる並べ替えを指定する例 . . . . . . . . . . . . . . . . . . . . . 495モデルを開き、計算を追加する例 . . . . . . . . . . . . . . . . . . . . . . . . . . . . 496相対時間カテゴリーを作成する例 . . . . . . . . . . . . . . . . . . . . . . . . . . . . 497キューブ・グループを追加する例 . . . . . . . . . . . . . . . . . . . . . . . . . . . . 498追加のデータ・ソースをモデルに追加する例 . . . . . . . . . . . . . . . . . . . . . . . . 499モデルを開き、キューブのプロパティーを変更する例 . . . . . . . . . . . . . . . . . . . . . 500カスタム・ビューを作成する例 . . . . . . . . . . . . . . . . . . . . . . . . . . . . 501

目次 xi

モデルを開き、通貨レコードを追加する例 . . . . . . . . . . . . . . . . . . . . . . . . . 502DoAutoDesign メソッドと TestBuild メソッドを使用してキューブを作成する例 . . . . . . . . . . . 503ディメンションを選択、変更、更新する例 . . . . . . . . . . . . . . . . . . . . . . . . . 504Level コレクションから 1 つのレベルを削除する例 . . . . . . . . . . . . . . . . . . . . . 505Measure オブジェクトを移動し、Revenue 数値データの集計を変更する例. . . . . . . . . . . . . . 505パーティションを作成し、モデルをチェックする例 . . . . . . . . . . . . . . . . . . . . . . 506モデルを開き、PowerCube にドリルスルーする例 . . . . . . . . . . . . . . . . . . . . . . 507作成者の役割をカスタム・ビューに追加する例 . . . . . . . . . . . . . . . . . . . . . . . 507中断モデルをチェックする例 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 509モデルを開き、ディメンション・ビューを作成する例 . . . . . . . . . . . . . . . . . . . . . 509キューブ・グループをモデルに追加する例 . . . . . . . . . . . . . . . . . . . . . . . . . 510モデルを作成し、日付ディメンションのプロパティーを更新する例 . . . . . . . . . . . . . . . . 511代替ドリルダウン・パスを作成する例 . . . . . . . . . . . . . . . . . . . . . . . . . . 512DateWizard を使用して時間ディメンションを作成する例 . . . . . . . . . . . . . . . . . . . 514カテゴリー・カウントの数値データを作成し、モデルに追加する例 . . . . . . . . . . . . . . . . 515ディメンション・ビューをモデルに追加する例 . . . . . . . . . . . . . . . . . . . . . . . 516子カテゴリーを別の親に移動する例 . . . . . . . . . . . . . . . . . . . . . . . . . . . 516ファイルにテーブルを追加し、データをロードする例 . . . . . . . . . . . . . . . . . . . . . 517月暦年に基づいて時間ディメンションを生成する例 . . . . . . . . . . . . . . . . . . . . . . 519子カテゴリーを別の親カテゴリーに移動する例 . . . . . . . . . . . . . . . . . . . . . . . 520アプリケーションに属性を設定する例 . . . . . . . . . . . . . . . . . . . . . . . . . . 521パッケージを追加および削除する例 . . . . . . . . . . . . . . . . . . . . . . . . . . . 522レポートを追加および削除する例 . . . . . . . . . . . . . . . . . . . . . . . . . . . . 523クエリーを作成する例 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 524モデルのフィルターを作成および削除する例 . . . . . . . . . . . . . . . . . . . . . . . . 525単一値のプロンプトを作成する例 . . . . . . . . . . . . . . . . . . . . . . . . . . . . 526複数値プロンプトを作成する例 . . . . . . . . . . . . . . . . . . . . . . . . . . . . 528新しいモデルを開き、PowerCube を発行する例. . . . . . . . . . . . . . . . . . . . . . . 529PowerCube をコピーし、有効化する例. . . . . . . . . . . . . . . . . . . . . . . . . . 530サインオンと IQD データ・ソースを使用してモデルを作成する例 . . . . . . . . . . . . . . . . 531サインオンとパッケージ・データ・ソースを使用してモデルを作成する例 . . . . . . . . . . . . . . 532

はじめに . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 535

特記事項 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 537

索引 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 541

xii IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

第 1 章 概要

Transformer OLE オートメーションは、プログラム言語インターフェースを使用して Transformer ユーザー・インターフェースに代わる機能を提供します。このドキュメントでは、作業を開始するときに役立つように、一部の Transformer OLE メソッドおよびプロパティーについて対応する UI を説明しています。

OLE オートメーションでは、プロパティーで属性を変更し、メソッドで動作を制御するコレクションとオブジェクトのセットとして、Transformer モデルを表します。オートメーションは、ディメンション、レベル、データ・ソース、数値データ、カテゴリー、ドリルダウン・パスなどのモデル・オブジェクトを作成して管理し、PowerCube を作成するために使用します。

OLE でモデルを作成するときは、オブジェクトを階層の順に作成して値を割り当てる必要があります。例えば、レベルを作成するには、そのレベルが属するディメンションをあらかじめ作成しておく必要があります。

オブジェクト作成の順序は、階層マップ 6 ページの『Transformer オブジェクトの階層マップ』を使用して決定できます。

Transformer マクロ作成の一般情報については、次の概要トピックを参照してください。

v 『オブジェクトの作成の概要』

v 2 ページの『Visual Basic 用のタイプ・ライブラリーの概要』

v 3 ページの『Visual C++ および Visual Studio 2009 C# 用のタイプ・ライブラリーの概要』

v 4 ページの『Transformer 用のタイプ・ライブラリーの概要』

v 5 ページの『メソッドの概要』

v 5 ページの『値リストと定数の概要』

オブジェクトの作成の概要Transformer OLE のオブジェクトを作成する方法は、使用するエディターや言語、作業の目的に応じて異なります。

Transformer OLE ドキュメントでは、ほぼすべての例で、次の一般形式のオブジェクトを作成します。

Dim objTransApp As Object

Dim objModel As Object

Dim objDataSource As Object

Dim objDimension As Object

この一般形式で作成したオブジェクトは、VB.NET と互換性があります。

1

上記の方法の制約は、Transformer タイプ・ライブラリーの機能を利用できないことです。タイプ・ライブラリーにアクセスするには、Microsoft Visual Basic または VB 互換エディターで次のようにオブジェクトを作成します。

Dim objTransApp As Application

Dim objModel As Model

Dim objDataSource As DataSource

Dim objDimension As Dimension

Visual Basic 用のタイプ・ライブラリーの概要タイプ・ライブラリーは、OLE オートメーション・サーバーにより認識されるクラス・インターフェースと値リスト (列挙子) が含まれたバイナリー・ファイルです。タイプ・ライブラリーは、Microsoft Visual Basic、Visual C#、Visual C++ などの開発ツールによりサポートされます。開発環境と統合化されているタイプ・ライブラリーでは、アプリケーションのコンパイルおよび実行時に、オートメーション情報を検索できます。

Transformer タイプ・ライブラリーには、オブジェクトおよびコレクションと、それぞれのプロパティーおよびメソッドの情報が含まれています。また、次の機能もあります。

v コンパイル時のエラー・チェック (実行時のエラー・チェックではない)

v 実行速度が向上するメソッドとプロパティーのアーリー・バインディング (レイト・バインディングではない)

v スクリプト作成時の高度なヘルプ機能

Transformer タイプ・ライブラリーの情報は、VB.NET や C# でマクロ・スクリプトをビルドしたり、Visual C++ でヘッダー・ファイルやインプリメンテーション・ファイルを作成するために使用します。タイプ・ライブラリーは、Word またはExcel に付属している Visual Basic Editor でも表示できます。

タイプ・ライブラリーと OLE オートメーションは、Windows 環境でのみ動作し、他の環境 (UNIX など) では動作しません。

次に示す手順では、Microsoft Visual Studio を統合開発環境 (IntegratedDevelopment Environment:IDE) として使用します。

手順1. プロジェクトを開きます。

2. 「プロジェクト」メニューの「参照の追加」をクリックします。

3. 「追加」をクリックし、「参照の追加」ダイアログ・ボックスで「IBM CognosTransformer Application Control」を選択します。

注:エントリーがリストにない場合は、「参照」をクリックし、Transformer のインストール場所の"bin"フォルダーにある"TransformerSDK.dll"を選択します。"TransformerSDK.dll"は、Transformer とともにインストールされます。

4. 「表示」メニューの「オブジェクト・ブラウザー」をクリックします。

5. ライブラリーのリスト (左上) の「Interop.TransformerSDKLib」をクリックします。

2 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

6. 目的のオブジェクトまたはコレクションを検索し、対応するメソッドとプロパティーを選択します。

7. これらのメソッドとプロパティーをマクロに使用します。

Visual C++ および Visual Studio 2009 C# 用のタイプ・ライブラリーの概要

タイプ・ライブラリーは、OLE オートメーション・サーバーにより認識されるクラス・インターフェースと値リスト (列挙子) が含まれたバイナリー・ファイルです。タイプ・ライブラリーは、Microsoft Visual Basic、Visual C#、Visual C++ などの開発ツールによりサポートされます。開発環境と統合化されているタイプ・ライブラリーでは、アプリケーションのコンパイルおよび実行時に、オートメーション情報を検索できます。

Transformer タイプ・ライブラリーには、オブジェクトおよびコレクションと、それぞれのプロパティーおよびメソッドの情報が含まれています。また、次の機能もあります。

v コンパイル時のエラー・チェック (実行時のエラー・チェックではない)

v 実行速度が向上するメソッドとプロパティーのアーリー・バインディング (レイト・バインディングではない)

v スクリプト作成時の高度なヘルプ機能

Transformer タイプ・ライブラリーの情報は、VB.NET や C# でマクロ・スクリプトをビルドしたり、Visual C++ でヘッダー・ファイルやインプリメンテーション・ファイルを作成するために使用します。タイプ・ライブラリーは、Word またはExcel に付属している Visual Basic Editor でも表示できます。

タイプ・ライブラリーと OLE オートメーションは、Windows 環境でのみ動作し、他の環境 (UNIX など) では動作しません。

次に示す手順では、Microsoft Visual Studio を統合開発環境 (IntegratedDevelopment Environment:IDE) として使用します。

手順1. Visual Studio を開きます。

2. プロジェクトを開きます。

プロジェクトで、タイプ・ライブラリーの生成が許可されている必要があります。

3. 「ソリューション・エクスプローラー」から、「参照」をクリックし、右クリックして「参照の追加」をクリックします。

ヒント:別の方法として、「プロジェクト」メニューの「参照の追加」をクリックすることもできます。

4. 「参照の追加」ダイアログ・ボックスで、「参照」をクリックし、Transformerソフトウェア開発キットをインストールした"bin"フォルダーにある"TransformerSDK.dll"ファイルを選択します。"TransformerSDK.dll"は、Transformer の一部としてインストールされています。

第 1 章 概要 3

追加した参照を表示するには、「ツール」メニューの「OLE/COM オブジェクト・ビューアー」をクリックします。「コントロール」の下に表示される「IBM Cognos Transformer Application Control」を参照します。

詳細を表示するには、右クリックして、ショートカット・メニューで「ViewType Information」をクリックします。

Transformer 用のタイプ・ライブラリーの概要タイプ・ライブラリーは、OLE オートメーション・サーバーにより認識されるクラス・インターフェースと値リスト (列挙子) が含まれたバイナリー・ファイルです。タイプ・ライブラリーは、Microsoft Visual Basic、Visual C#、Visual C++ などの開発ツールによりサポートされます。開発環境と統合化されているタイプ・ライブラリーでは、アプリケーションのコンパイルおよび実行時に、オートメーション情報を検索できます。

Transformer タイプ・ライブラリーには、オブジェクトおよびコレクションと、それぞれのプロパティーおよびメソッドの情報が含まれています。また、次の機能もあります。

v コンパイル時のエラー・チェック (実行時のエラー・チェックではない)

v 実行速度が向上するメソッドとプロパティーのアーリー・バインディング (レイト・バインディングではない)

v スクリプト作成時の高度なヘルプ機能

Transformer タイプ・ライブラリーの情報は、VB.NET や C# でマクロ・スクリプトをビルドしたり、Visual C++ でヘッダー・ファイルやインプリメンテーション・ファイルを作成するために使用します。タイプ・ライブラリーは、Word またはExcel に付属している Visual Basic Editor でも表示できます。

タイプ・ライブラリーと OLE オートメーションは、Windows 環境でのみ動作し、他の環境 (UNIX など) では動作しません。

次に示す手順では、Microsoft Visual Studio を統合開発環境 (IntegratedDevelopment Environment:IDE) として使用します。

手順1. Visual Studio を開きます。

2. プロジェクトを開きます。

プロジェクトで、タイプ・ライブラリーの生成が許可されている必要があります。

3. 「プロジェクト」メニューの「クラスの追加」をクリックし、「クラスの追加」ダイアログ・ボックスの「テンプレート」リストで MFC カテゴリーの「ActiveX コントロールの MFC クラス」を選択します。

そして、「ActiveX コントロールからのクラスの追加 (Add Class fromActiveX Control)」ウィザードで、「ActiveX コントロールの MFC カテゴリー/MFC クラス (MFC Categories/MFC Class From ActiveX Control)」をクリックします。

4 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

4. 「使用できる ActiveX コントロール」ボックスで、「IBM CognosTransformer Application Control<version#>」を選択します。ここで、version# は、Transformer ソフトウェア開発キットのバージョン番号です。

「クラスの追加元」に「レジストリー」が選択されている場合は、"TransformerSDK.dll"ファイルが指定されている必要があります。

5. 必要なインターフェースを選択し、「完了」をクリックします。

6. 選択したクラスとそのオブジェクトをワークスペースに表示するには「クラス・ビュー」をクリックします。

7. 別のラッパー・クラスのオブジェクト定義表示するには、「ファイルの表示」をクリックします。

メソッドの概要OLE オートメーションでは、オブジェクトを作成、変更、または削除するためにメソッドを使用します。

Transformer のメソッドには、サブルーチンとして動作するタイプと関数として動作するタイプがあります。メソッドのタイプは、次のいずれかの方法で決定できます。

v Visual Studio 開発ツールを使用している場合、オブジェクト・ブラウザーでメソッドを検索します。

v Oleview ツールを使用します。Oleview にアクセスするには、「スタート」メニューで「ファイル名を指定して実行」をクリックし、「oleview」と入力します。「OK」をクリックします。「コントロール」の下に表示される「IBMCognos Transformer Application Control」を参照します。タイプ情報を表示するには、右クリックして、ショートカット・メニューで「View TypeInformation」をクリックします。

TransformerSDK のタイプ情報では、サブルーチンと関数メソッドの両方でパラメーターの周囲に括弧が表示されますが、常に必要なわけではありません。サブルーチンを定義するメソッドは、括弧を使用する必要がなく、値を返しません。関数は、括弧を使用する必要があり、値を返します。これは実装言語や、一般オブジェクトの使用の有無によっても異なります。

値リストと定数の概要Transformer OLE の多くのプロパティーとメソッドでは、列挙型データ型のセットまたは値リストを使用します。値リストには、適用されるプロパティーまたはメソッドの動作を定義する定数が含まれます。

値リストの名前にはプレフィックス「xtr」が付きます。定数自体にはプレフィックス「tr」が付きます。例えば、xtrCubeCreation 値リストは、次のキューブ作成オプションを設定するために使用します。

v trCubeCreationDefault

v trCubeCreationON

v trCubeCreationOFF

第 1 章 概要 5

値リストの定数は、値の設定と取得の両方に使用できます。次の例は、xtrObjectType 値リストの定数を返します。

If objDimension1.ObjectType = xtrObjectType.trDateDimensionThen

.

.

End If

次の例は、xtrObjectType 値リストの定数を使用し、コレクションにDateDimension オブジェクトを追加します。

objDimCollection.Add(xtrObjectType.trDateDimension)

これまで IBM® CognosScript Editor を使用して Transformer OLE マクロを作成していた場合、Cognos® TransformerSDK を使用できるように TranConst.inc ファイルが更新されています。ただし、このエディター・アプリケーションはサポート対象外となっています。このファイルは、VB.NET、C#、C++ では使用できません。

"TranConst.inc"のコピーは、Transformer のインストール場所の インストール場所¥templates¥cogtr¥TransformerSDK フォルダーにあります。

"TranConst.inc"ファイルを参照する Include 文の例を次に示します。

$Include "TranConst.inc"

定数にはすべて対応する等価の数値がありますが、TransformerSDK をアップグレードするときの問題を回避するため、定数は名前で参照することを推奨します。.NET テクノロジーを使用する場合は、"type.enumeration"列挙アイテム表記法を使用する必要があります。

Transformer オブジェクトの階層マップモデルを構築するときは、コレクションとオブジェクトを階層の順に作成して値を割り当てる必要があります。

次のマップは、全コレクションおよびオブジェクトと階層内の順序を示します。

6 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

v オブジェクト

v コレクション

v コレクションとオブジェクト

アスタリスク (*) が付いた項目は、オブジェクトに適用され、コレクションには適用されません。

図 1. 全オブジェクト

第 1 章 概要 7

Transformer オブジェクトの階層マップ ADataSources 階層のマップを次に示します。

v オブジェクト

v コレクション

v コレクションとオブジェクト

Transformer オブジェクトの階層マップ BDimension 階層のマップを次に示します。

図 2. DataSources 階層

図 3. Dimension 階層

8 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

v オブジェクト

v コレクション

v コレクションとオブジェクト

アスタリスク (*) が付いた項目は、オブジェクトに適用され、コレクションには適用されません。

Transformer オブジェクトの階層マップ CDateDimension 階層のマップを次に示します。

v オブジェクト

v コレクション

v コレクションとオブジェクト

アスタリスク (*) が付いた項目は、オブジェクトに適用され、コレクションには適用されません。

図 4. DateDimension 階層

第 1 章 概要 9

Transformer オブジェクトの階層マップ DQuery 階層のマップを次に示します。

v オブジェクト

v コレクション

v コレクションとオブジェクト

Transformer オブジェクトの階層マップ EReport 階層のマップを次に示します。

v オブジェクト

v コレクション

v コレクションとオブジェクト

ソフトウェア開発キット設定の設定すべてのアプリケーションが一貫して動作するように、ソフトウェア開発キット設定を設定する必要があります。設定を設定するには、Application オブジェクトのプロパティーを使用します。

IBM Cognos Series 7 モデルこのバージョンの OLE オートメーションで IBM Cognos Series 7 モデルを使用するには、モデルをアップグレードする必要があります。

IBM Cognos Series 7 モデルのアップグレードについては、「Transformer ユーザー・ガイド」を参照してください。

図 5. Query 階層

図 6. Report 階層

10 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

第 2 章 コレクション

次の表は、Transformer OLE オートメーション・コレクションのリストです。

オブジェクト 説明

Associations コレクション 特定のオブジェクトの Association オブジェクトをすべて含みます。

CalculationDefinitions コレクション 特定のディメンションのCalculationDefinition オブジェクトをすべて含みます。

Categories コレクション Category オブジェクトまたはSpecialCategory オブジェクトをグループ化します。

CategorySets コレクション CalculationDefinition オブジェクトで値の計算に使用する CategorySet オブジェクトをすべて含みます。

ChildCubes コレクション ChildCube オブジェクトをグループ化します。

Columns コレクション データ・ソースの Column オブジェクトをグループ化します。

CubeCustomViews コレクション 特定の Cube オブジェクト、CubeGroup オブジェクト、または ChildCube オブジェクトにアクセスできる CustomView オブジェクトを含みます。

Cubes コレクション モデルの Cube オブジェクトと CubeGroupオブジェクトをすべてグループ化します。

CurrencyRates コレクション CurrencyRate オブジェクトをグループ化します。

CurrencyRecords コレクション モデルの CurrencyRecord オブジェクトをすべて含みます。

CurrencyTables コレクション モデルの CurrencyTable オブジェクトをすべて含みます。

CustomViews コレクション モデル内の CustomView オブジェクトのコレクションです。

DataSources コレクション モデルのデータ・ソースをすべて含みます。

DimensionLevels コレクション 関連するディメンションに属する一意のレベルの読み取り専用のリストを含みます。

Dimensions コレクション モデルの Dimension オブジェクトとDateDimension オブジェクトをすべて含みます。

DrillDowns コレクション DrillDown オブジェクトまたはDateDrillDown オブジェクトのどちらか一方を含みます。

11

オブジェクト 説明

DrillThroughTargets コレクション 関連する DrillThroughTarget オブジェクトをグループ化します。

Filters コレクション クエリーの Filter オブジェクトをすべて含みます。

LevelCategories コレクション 特定レベルのカテゴリーのコレクションを含みます。

LevelDrillDowns コレクション ドリルダウン・パスを表すオブジェクトの読み取り専用コレクションを表します。

Levels コレクション Level オブジェクトまたは DateLevel オブジェクトのどちらか一方をグループ化します。

Measures コレクション モデルの Measure オブジェクトをすべて含みます。

Names コレクション Name オブジェクトの読み取り専用グループを含みます。

Namespaces コレクション モデルの Namespace オブジェクトをすべて含みます。

PackageDatasourceConnections コレクション

PackageDatasourceConnection オブジェクトをすべて含みます。

Packages コレクション モデルの Package オブジェクトをすべて含みます。

Prompts コレクション クエリーの Prompt オブジェクトをすべて含みます。

Queries コレクション パッケージまたはレポートの Query オブジェクトをすべて含みます。

Reports コレクション 関連する Report オブジェクトをグループ化します。

SecurityObjects コレクション モデルの SecurityObject オブジェクトをすべて含みます。

Signons コレクション 関連する Signon オブジェクトをグループ化します。

SuspendedModels コレクション アプリケーションで使用できるSuspendedModel オブジェクトをすべて含みます。

Views コレクション View オブジェクトをグループ化します。

Associations コレクションAssociations コレクションには、特定のオブジェクトの Association オブジェクトがすべて含まれます。

解説

このコレクションは、Association オブジェクトの追加、選択、または削除に使用します。

12 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

レベルやディメンションなど、モデルのオブジェクトの多くは 1 つ以上のAssociation オブジェクトを通じて外部データとの関連を管理します。関連は、ラベル、説明、ソート、名前などを表すプロパティーやソース・データの値を供給します。

このコレクションを返すには、Associations プロパティーを使用します。

次の表は、関連するメソッドとプロパティーを示します。

メソッド 説明

Add メソッド (オブジェクト) コレクションに Association オブジェクトを追加します。

Item メソッド コレクションの特定の Association オブジェクトを選択します。

Remove メソッド コレクションから特定の Association オブジェクトを削除します。

プロパティー 説明

Application プロパティー Transformer Application オブジェクトを返します。

Count プロパティー コレクションに含まれる Association オブジェクトの個数を返します。

Parent プロパティー 親オブジェクトを返します。

例objAssociation = objDrill.ConvergenceLevel.Associations.Add()

CalculationDefinitions コレクションCalculationDefinitions コレクションには、特定のディメンションのCalculationDefinition オブジェクトがすべて含まれます。

解説

このコレクションは、CalculationDefinition オブジェクトの追加、選択、または削除に使用します。

CalculationDefinition オブジェクトは、計算に 1 つ以上のカテゴリーの値を使用する複雑な数式からなります。

このコレクションを返すには、CalculationDefinitions プロパティーを使用します。

次の表は、関連するメソッドとプロパティーを示します。

メソッド 説明

Add メソッド (オブジェクト) コレクションに CalculationDefinition オブジェクトを追加します。

Item メソッド コレクションの特定の CalculationDefinitionオブジェクトを選択します。

第 2 章 コレクション 13

メソッド 説明

Remove メソッド コレクションから特定のCalculationDefinition オブジェクトを削除します。

プロパティー 説明

Application プロパティー Transformer Application オブジェクトを返します。

Count プロパティー コレクションに含まれるCalculationDefinition オブジェクトの個数を返します。

Parent プロパティー 親オブジェクトを返します。

例calcDef = dimension.CalculationDefinitions.Add()

Categories コレクションCategories コレクションは、Category オブジェクトまたは SpecialCategory オブジェクトをグループ化します。

解説

標準カテゴリーのコレクションを返すには、DrillDown オブジェクトの Categoriesプロパティーを使用します。

子孫カテゴリーのコレクションを返すには、Category オブジェクトのChildCategories プロパティーを使用します。

特殊カテゴリーのコレクションを返すには、Dimension オブジェクトまたはDateDimension オブジェクトの Categories プロパティーを使用します。

算出カテゴリーは、通常カテゴリーまたは特殊カテゴリーと関連付けられ、どちらのコレクションにも含まれます。

全ディメンションのカテゴリーを生成するには、GenerateCategories メソッドを使用します。このコレクションは、手動で変更できます。例えば、Add メソッドを使用してコレクションに SpecialCategory オブジェクトを追加したり、Inclusion プロパティーを設定して特定の Category オブジェクトを除外できます。

Categories コレクションは、手動レベルを作成するときに手動で作成できます。これは、生成されるコレクションの Category オブジェクトが多すぎて PowerPlay®

の表示が見にくくなる場合に便利です。

CalculationDefinition オブジェクトは、数式を作成するときに CategorySet のCategories コレクションを使用します。CategorySet にカテゴリーを追加するたびに、Categories コレクションの Add メソッドを使用します。

次の表は、関連するメソッドとプロパティーを示します。

14 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

メソッド 説明

Add メソッド (Categories) コレクションに Category またはSpecialCategory オブジェクトを追加します。

Item メソッド コレクションの特定の Category またはSpecialCategory オブジェクトを選択します。

Remove メソッド コレクションから特定の Category またはSpecialCategory オブジェクトを削除します。

プロパティー 説明

Application プロパティー Transformer Application オブジェクトを返します。

Count プロパティー コレクションに含まれる Category またはSpecialCategory オブジェクトの個数を返します。

Parent プロパティー 親オブジェクトを返します。

例objSpecCategory = _

objModel.Dimensions("Time").Categories.Add(xtrObjectType.trSpecialCategory)

CategorySets コレクションCategorySets コレクションには、CalculationDefinition オブジェクトで値の計算に使用する CategorySet オブジェクトがすべて含まれます。

解説

このコレクションは、CategorySet オブジェクトの追加、選択、または削除に使用します。各 CategorySet オブジェクトには、Categories コレクションが含まれます。

このコレクションを返すには、CategorySets プロパティーを使用します。

次の表は、関連するメソッドとプロパティーを示します。

メソッド 説明

Add メソッド (オブジェクト) コレクションに CategorySet オブジェクトを追加します。

Item メソッド コレクションの特定の CategorySet オブジェクトを選択します。

第 2 章 コレクション 15

メソッド 説明

Remove メソッド コレクションから特定の CategorySet オブジェクトを削除します。

プロパティー 説明

Application プロパティー Transformer Application オブジェクトを返します。

Count プロパティー コレクションに含まれる CategorySet オブジェクトの個数を返します。

Parent プロパティー 親オブジェクトを返します。

例catSet = calcDef.CategorySets.Add()

ChildCubes コレクションChildCubes コレクションは、ChildCube オブジェクトをグループ化します。

解説

このコレクションは、ChildCube オブジェクトの選択に使用します。このコレクションの各キューブは、CubeGroup オブジェクトに含まれ、CubeGroup に関連付けられたレベルの 1 つのカテゴリーを表します。

このコレクションを返すには、ChildCubes プロパティーを使用します。

次の表は、関連するメソッドとプロパティーを示します。

メソッド 説明

Item メソッド コレクションの特定の ChildCube オブジェクトを選択します。

プロパティー 説明

Application プロパティー Transformer Application オブジェクトを返します。

Count プロパティー コレクションに含まれる ChildCube オブジェクトの個数を返します。

Parent プロパティー 親オブジェクトを返します。

例objCubesByRegion = objModel.Cubes.Add(xtrObjectType.trCubeGroup)objChildCube = objCubesByRegion.ChildCubes("Central Europe")

Columns コレクションColumns コレクションは、データ・ソースに含まれる Column オブジェクトをグループ化します。

16 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

解説

このコレクションは、Column オブジェクトの追加、選択、または削除に使用します。Transformer のデータ・ソースのデータは、各レベルの値のソース・データとして機能する列に編成されています。

このコレクションを返すには、データ・ソース・オブジェクトの Columns プロパティーを使用します。

次の表は、関連するメソッドとプロパティーを示します。

メソッド 説明

Add メソッド (オブジェクト) コレクションに Column オブジェクトを追加します。

Item メソッド コレクションに含まれる特定の Column オブジェクトを選択します。

Remove メソッド コレクションから特定の Column オブジェクトを削除します。

プロパティー 説明

Application プロパティー Transformer Application オブジェクトを返します。

Count プロパティー コレクションに含まれる Column オブジェクトの数を返します。

Parent プロパティー 親オブジェクトを返します。

例objDataSource = objModel.DataSources.Add(xtrObjectType.trFlatFileDataSource)objColumn = objDataSource.Columns(1)

CubeCustomViews コレクションCubeCustomViews コレクションには、特定の Cube オブジェクト、CubeGroupオブジェクト、または ChildCube オブジェクトに関連付けられているCustomView オブジェクトが含まれます。

解説

このコレクションは、CustomView オブジェクトの追加、選択、または削除に使用します。各 Cube オブジェクトまたは ChildCube オブジェクトは、CubeCustomView コレクションを定義します。このコレクションを返すには、CubeCustomViews プロパティーを使用します。

次の表は、関連するメソッドとプロパティーを示します。

メソッド 説明

Add メソッド (CubeCustomViewsCollection)

コレクションに CustomView オブジェクトを追加します。

第 2 章 コレクション 17

メソッド 説明

Item メソッド コレクションに含まれる特定の CustomViewオブジェクトを選択します。

Remove メソッド コレクションから特定の CustomView オブジェクトを削除します。

プロパティー 説明

Application プロパティー Transformer Application オブジェクトを返します。

Count プロパティー コレクションに含まれる CustomView オブジェクトの数を返します。

Parent プロパティー 親オブジェクトを返します。

例cube = model.Cubes.Item("Sales and Marketing")cube.CubeCustomViews.Add(custom_view)

Cubes コレクションCubes コレクションは、モデルの Cube オブジェクトと CubeGroup オブジェクトをすべてグループ化します。

解説

このコレクションは、Cube または CubeGroup オブジェクトの追加、選択、または削除に使用します。Cube オブジェクトには、関連する Reports コレクションとCubeCustomViews コレクションが含まれます。CubeGroup オブジェクトには、関連する ChildCubes コレクション、DrillThroughTargets コレクション、CubeCustomViews コレクションが含まれます。

このコレクションを返すには、Cubes プロパティーを使用します。

次の表は、関連するメソッドとプロパティーを示します。

メソッド 説明

Add メソッド (オブジェクト) コレクションに Cube または CubeGroupオブジェクトを追加します。

Item メソッド コレクションの特定の Cube またはCubeGroup オブジェクトを選択します。

Remove メソッド コレクションから特定の Cube またはCubeGroup オブジェクトを削除します。

プロパティー 説明

Application プロパティー Transformer Application オブジェクトを返します。

18 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

プロパティー 説明

Count プロパティー コレクションに含まれる Cube とCubeGroup オブジェクトの個数を返します。

Parent プロパティー 親オブジェクトを返します。

CurrencyRates コレクションCurrency コレクションは、Collection オブジェクトと CurrencyRate オブジェクトをグループ化します。

解説

このコレクションは、CurrencyRate オブジェクトの選択に使用します。各オブジェクトは、通貨変換に使用する変換レートを表します。

通貨を変換するには、CurrencyRates、CurrencyRecords、CurrencyTables の全コレクションが必要です。このコレクションを返すには、CurrencyRates プロパティーを使用します。

次の表は、関連するメソッドとプロパティーを示します。

メソッド 説明

Item メソッド コレクションの特定の CurrencyRate オブジェクトを選択します。

Remove メソッド コレクションから特定の CurrencyRate オブジェクトを削除します。

プロパティー 説明

Application プロパティー Transformer Application オブジェクトを返します。

Count プロパティー コレクションに含まれる CurrencyRate オブジェクトの個数を返します。

Parent プロパティー 親オブジェクトを返します。

例objCurrencyRecord = objModel.CurrencyRecords.Add()objCurrencyRate = objCurrencyRecord.CurrencyRates(intX)

CurrencyRecords コレクションCurrencyRecords コレクションには、モデルに含まれる CurrencyRecord オブジェクトがすべて含まれます。

第 2 章 コレクション 19

解説

このコレクションは、CurrencyRecord オブジェクトの追加、選択、または削除に使用します。コレクションの各オブジェクトは、PowerPlay で通貨の書式設定と表示に使用する 1 行の通貨情報を表します。

通貨を変換するには、CurrencyRates、CurrencyRecords、CurrencyTables の全コレクションが必要です。

このコレクションを返すには、CurrencyRecords プロパティーを使用します。

次の表は、関連するメソッドとプロパティーを示します。

メソッド 説明

Add メソッド () コレクションに CurrencyRecord オブジェクトを追加します。

Item メソッド コレクションの特定の CurrencyRecord オブジェクトを選択します。

Remove メソッド コレクションから特定の CurrencyRecord オブジェクトを削除します。

プロパティー 説明

Application プロパティー Transformer Application オブジェクトを返します。

Count プロパティー コレクションに含まれる CurrencyRecord オブジェクトの個数を返します。

Parent プロパティー 親オブジェクトを返します。

例objCurrencyRecord = objModel.CurrencyRecords.Add()

CurrencyTables コレクションCurrencyTables コレクションには、モデルに含まれる CurrencyTable オブジェクトがすべて含まれます。

解説

このプロパティーは、CurrencyTable オブジェクトの追加、選択、または削除に使用します。

通貨表には、外部データ・ソースを使用してデータを取り込むことも、通貨レコードと通貨レートを作成して挿入することもできます。どちらの方法を使用する場合も、次の情報を設定するデータが必要です。

20 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

v 変換日付

v ISO 国または地域コード

v 変換レート

v 通貨ラベル (オプション)

Transformer では、ユーザーが PowerPlay でキューブを表示するときに正しく変換を実行するために通貨表の情報が使用されます。通貨変換には、モデルに少なくとも 1 つの時間ディメンションが必要です。Transformer では、時間ディメンションの表示と同じ詳細度 (デフォルトでは月) で通貨情報が保存されます。必要な場合は、より高い詳細度に調整できます。

EMU 通貨変換では、2 つのテーブルが必要です。一方のテーブルのCurrencyTableType プロパティーを trCurrencyTableBase に、もう一方のテーブルの CurrencyTableType プロパティーを trCurrencyTableEuro に設定します。CurrencyTables コレクションには、各タイプのテーブルを 1 つだけ含めることができます。

通貨を変換するには、CurrencyRates、CurrencyRecords、CurrencyTables の全コレクションが必要です。このコレクションを返すには、CurrencyTables プロパティーを使用します。

次の表は、関連するメソッドとプロパティーを示します。

メソッド 説明

Add メソッド () コレクションに CurrencyTable オブジェクトを追加します。

Item メソッド コレクションの特定の CurrencyTable オブジェクトを選択します。

Remove メソッド コレクションから特定の CurrencyTable オブジェクトを削除します。

プロパティー 説明

Application プロパティー Transformer Application オブジェクトを返します。

Count プロパティー コレクションに含まれる CurrencyTable オブジェクトの個数を返します。

Parent プロパティー 親オブジェクトを返します。

例objBaseTable = objModel.CurrencyTables.Add()

第 2 章 コレクション 21

CustomViews コレクションCustomViews コレクションは、モデル内の CustomView オブジェクトのコレクションです。

解説

このコレクションは、CustomView オブジェクトの追加、選択、または削除に使用します。CustomView オブジェクトには、関連する SecurityObjects コレクションと Views コレクションが含まれます。

このコレクションを返すには、CustomViews プロパティーまたはChildCustomViews プロパティーを使用します。

次の表は、関連するメソッドとプロパティーを示します。

メソッド 説明

Add メソッド () コレクションに CustomView オブジェクトを追加します。

Item メソッド コレクションに含まれる特定の CustomViewオブジェクトを選択します。

Remove メソッド コレクションから特定の CustomView オブジェクトを削除します。

プロパティー 説明

Application プロパティー Transformer Application オブジェクトを返します。

Count プロパティー コレクションに含まれる CustomView オブジェクトの数を返します。

Parent プロパティー 親オブジェクトを返します。

例custom_view = model.CustomViews.Add()custom_view = model.CustomViews.Add()

DataSources コレクションDataSources コレクションには、モデルに含まれるデータ・ソースがすべて含まれます。

解説

このコレクションは、データ・ソースの追加、選択、または削除に使用します。このコレクションには、次のオブジェクトを含めることができます。

v CrossTabDataSource

v DataSource

v DbDataSource。

v FlatFileDataSource

22 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

v IqdDataSource

このコレクションを返すには、DataSources プロパティーを使用します。

次の表は、関連するメソッドとプロパティーを示します。

メソッド 説明

Add メソッド () 複数のタイプのオブジェクトを含むコレクションに、オブジェクトを追加します。

Item メソッド コレクションの特定のデータ・ソースを選択します。

Remove メソッド コレクションから特定のデータ・ソースを削除します。

プロパティー 説明

Application プロパティー Transformer Application オブジェクトを返します。

Count プロパティー コレクションに含まれる DataSource オブジェクトの個数を返します。

Parent プロパティー 親オブジェクトを返します。

例objDataSource = objModel.DataSources.Add(xtrObjectType.trFlatFileDataSource)

DimensionLevels コレクションDimensionLevels コレクションには、関連するディメンションに属する一意のレベルの読み取り専用のリストが含まれます。

解説

このコレクションは、ディメンションから Level オブジェクトを選択するために使用します。

ディメンションに代替ドリルダウン・パスがある場合、ディメンションに 1 つのレベルが重複して表示されることがあります。ただし、このコレクションに含まれるこのレベルの参照は、ディメンション内の重複回数にかかわらず 1 つだけです。

このコレクションを返すには、DimensionLevels プロパティーを使用します。

次の表は、関連するメソッドとプロパティーを示します。

メソッド 説明

Item メソッド コレクションに含まれる特定のオブジェクトを選択します。

第 2 章 コレクション 23

プロパティー 説明

Application プロパティー Transformer Application オブジェクトを返します。

Count プロパティー コレクションに含まれるオブジェクトの個数を返します。

Parent プロパティー 親オブジェクトを返します。

例objLevel = objModel.Dimensions("Products").DimensionLevels(1)

Dimensions コレクションDimensions コレクションには、モデルの Dimension オブジェクトとDateDimension オブジェクトがすべて含まれます。

解説

このコレクションは、Dimension オブジェクトまたは DateDimension オブジェクトの追加、選択、または削除に使用します。

DoAutoDesign メソッドを使用してディメンションを作成すると、Transformer では自動的にデータ・ソースの関係に基づいて、このコレクションにディメンションが追加されます。DateWizard オブジェクトは、このコレクションにDateDimension オブジェクトを追加します。

このコレクションを返すには、Dimensions プロパティーを使用します。

次の表は、関連するメソッドとプロパティーを示します。

メソッド 説明

Add メソッド () コレクションに Dimension オブジェクトまたは DateDimension オブジェクトを追加します。

Item メソッド コレクションの特定の Dimension オブジェクトまたは DateDimension オブジェクトを選択します。

Remove メソッド コレクションから特定の Dimension オブジェクトまたは DateDimension オブジェクトを削除します。

プロパティー 説明

Application プロパティー Transformer Application オブジェクトを返します。

Count プロパティー コレクションに含まれる Dimension オブジェクトと DateDimension オブジェクトの個数を返します。

Parent プロパティー 親オブジェクトを返します。

24 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

例objDimensions = objModel.Dimensions

DrillDowns コレクションDrillDowns コレクションには、DrillDown オブジェクトまたは DateDrillDownオブジェクトのどちらか一方が含まれます。

解説

このコレクションは、DrillDown オブジェクトまたは DateDrillDown オブジェクトの選択または削除に使用します。

親ディメンションを作成すると、Transformer では自動的に各 DrillDowns コレクションに 1 つの DrillDown または DateDrillDown オブジェクトが追加されます。このオブジェクトは、主ドリルダウン・パスを表し、ユーザーはこのオブジェクトを削除できません。コレクションの他の DrillDown オブジェクトまたはDateDrillDown オブジェクトは、すべて代替ドリルダウン・パスを表します。

コレクションに DrillDown オブジェクトまたは DateDrillDown オブジェクトを追加するには、Level オブジェクトの CreateAlternateDrillDown メソッドを使用します。

このコレクションを返すには、DrillDowns プロパティーを使用します。

メソッド 説明

Item メソッド コレクションの特定の DrillDown オブジェクトまたは DateDrillDown オブジェクトを選択します。

Remove メソッド コレクションから特定の DrillDown オブジェクトまたは DateDrillDown オブジェクトを削除します。コレクションの最初のオブジェクトには適用されません。最初のオブジェクトに適用すると、例外が返されます。

プロパティー 説明

Application プロパティー Transformer Application オブジェクトを返します。

Count プロパティー コレクションに含まれる DrillDown オブジェクトまたは DateDrillDown オブジェクトの個数を返します。

Parent プロパティー 親オブジェクトを返します。

例objDrill = objModel.Dimensions("Retailers").DrillDowns(2)

第 2 章 コレクション 25

DrillThroughTargets コレクションDrillThroughTargets コレクションは、関連する DrillThroughTarget オブジェクトをグループ化します。

解説

このコレクションは、DrillThroughTarget オブジェクトの追加、選択、または削除に使用します。

以前のバージョンのドキュメントでは、DrillThroughTarget オブジェクトは、Impromptu レポート (.imr)、Impromptu クエリー定義ファイル(.iqd)、PowerPlay レポート (.ppr)、PowerCube (.mdc)、マクロ・スクリプト・ファイル (.mac) などのドリルスルー・オブジェクトを表すと記載されていました。しかし、カウントやドリルスルー・ターゲット・オブジェクトに関するその他の情報の取得などの一部の操作では、MDL スクリプトを使用する必要があります。

Measure オブジェクト、Cube オブジェクト、または CubeGroup オブジェクトのDrillThroughTargets コレクションを返すには、DrillThroughTargets プロパティーを使用します。Measure の DrillThroughTargets コレクションにDrillThroughTarget オブジェクトを追加すると、ドリルスルー機能がその数値データのみに制限されます。Cube または CubeGroup オブジェクトのDrillThroughTargets コレクションに DrillThroughTarget オブジェクトを追加すると、キューブまたは子キューブの任意の位置でドリルスルー機能を使用できます。

データ・ソースとして Impromptu クエリー定義 (.iqd) を使用するモデルに関しては、対応する Impromptu レポート (.imr) が、Transformer によって各数値データの DrillThroughTargets コレクションに自動的に追加されます。

ドリルスルー機能を使用可能にするには、AllowDrillThrough プロパティーを Trueに設定する必要があります。

メソッド 説明

Add メソッド (DrillThroughTargets) コレクションに DrillThroughTarget オブジェクトを追加します。

Item メソッド コレクションに含まれる特定のDrillThroughTarget オブジェクトを選択します。

Remove メソッド コレクションから特定の DrillThroughTargetオブジェクトを削除します。

プロパティー 説明

Application プロパティー Transformer Application オブジェクトを返します。

26 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

プロパティー 説明

Count プロパティー コレクションに含まれる Report オブジェクトの個数を返します。

Parent プロパティー 親オブジェクトを返します。

例objReport = objMeasure.DrillThroughTargets.Add(strReportPath,"Default Report")

Filters コレクションFilters コレクションには、クエリーに含まれる Filter オブジェクトがすべて含まれます。

解説

このコレクションは、Filter オブジェクトの選択または削除に使用します。

このコレクションは IBM Cognos オブジェクトです。モデルの各 Query オブジェクトと Report オブジェクトには、Filters コレクションが含まれる場合があります。フィルターは、データ・ソースからデータを取得する際に満たす必要がある条件を表します。このコレクションを返すには、Filters プロパティーを使用します。

新しい Filter オブジェクトをコレクションに追加するには、Add メソッドを使用します。Filter オブジェクトを削除するには、Remove メソッドを使用します。

次の表は、関連するメソッドとプロパティーを示します。

メソッド 説明

Add メソッド () コレクションに Filter オブジェクトを追加します。

Item メソッド コレクションに含まれる特定の Filter オブジェクトを選択します。

Remove メソッド コレクションから特定の Filter オブジェクトを削除します。

プロパティー 説明

Application プロパティー Transformer Application オブジェクトを返します。

Count プロパティー コレクションに含まれる Filter オブジェクトの数を返します。

第 2 章 コレクション 27

プロパティー 説明

Parent プロパティー 親オブジェクトを返します。

例new_package = model.Packages.Add()new_query = new_package.Queries.Add()new_filter = new_query.Filters.Add()

LevelCategories コレクションLevelCategories コレクションは、特定レベルのカテゴリーのコレクションを表します。

解説

このコレクションは、各レベルに関連付けられたカテゴリーを選択するために使用します。

次の表は、関連するメソッドとプロパティーを示します。

メソッド 説明

Item メソッド コレクションの特定の Category オブジェクトを選択します。

プロパティー 説明

Application プロパティー Transformer Application オブジェクトを返します。

Count プロパティー コレクションに含まれる Category オブジェクトの個数を返します。

Parent プロパティー 親オブジェクトを返します。

LevelDrillDowns コレクションLevelDrillDowns コレクションは、ドリルダウン・パスを表すオブジェクトの読み取り専用コレクションを表します。

解説

このコレクションは、ディメンションの DrillDown オブジェクトまたはDateDrillDown オブジェクトの選択に使用します。

ほとんどのレベルでは、ドリルダウン・パスは 1 つであるため、このコレクションには DrillDown オブジェクトまたは DateDrillDown オブジェクトが 1 つのみ含まれます。複数のドリルダウン・パスがある収束レベルの場合、コレクションには同数のエントリーが含まれます。

28 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

LevelDrillDowns コレクションには、DrillDown オブジェクトまたはDateDrillDown オブジェクトのどちらか一方が含まれます。

このコレクションを返すには、LevelDrillDowns プロパティーを使用します。

次の表は、関連するメソッドとプロパティーを示します。

メソッド 説明

Item メソッド コレクションの特定の DrillDown オブジェクトまたは DateDrillDown オブジェクトを選択します。

プロパティー 説明

Application プロパティー Transformer Application オブジェクトを返します。

Count プロパティー コレクションに含まれる DrillDown オブジェクトまたは DateDrillDown オブジェクトの個数を返します。

Parent プロパティー 親オブジェクトを返します。

例objLevel = objDateDrillDown.Levels("Year")Select Case objLevel.LevelDrillDowns(1).Categories(intX).KeyName

Levels コレクションLevels コレクションは、Level オブジェクトまたは DateLevel オブジェクトのどちらか一方をグループ化します。

解説

このコレクションは、Level オブジェクトまたは DateLevel オブジェクトの追加、選択、または削除に使用します。

モデルの各 Dimension オブジェクトと DateDimension オブジェクトには、PowerPlay で情報の検索に使用するドリルダウン・パスの手順を表す Levels コレクションが含まれます。DoAutoDesign メソッドを使用すると、Transformer では自動的に Levels コレクションが作成されます。

このコレクションを返すには、Level プロパティーを使用します。

次の表は、関連するメソッドとプロパティーを示します。

メソッド 説明

Add メソッド () コレクションに Level オブジェクトまたはDateLevel オブジェクトを追加します。

第 2 章 コレクション 29

メソッド 説明

Item メソッド コレクションの特定の Level オブジェクトまたは DateLevel オブジェクトを選択します。

Remove メソッド コレクションから特定の Level オブジェクトまたは DateLevel オブジェクトを削除します。

プロパティー 説明

Application プロパティー Transformer Application オブジェクトを返します。

Count プロパティー コレクションに含まれる Level オブジェクトまたは DateLevel オブジェクトの個数を返します。

例objTimeDimension = objModel.Dimensions.Item("Time)objLevel=objTimeDimension.DrillDowns.Item(1).Levels.Item("Month")

Measures コレクションMeasures コレクションには、モデルに含まれる Measure オブジェクトがすべて含まれます。

解説

このコレクションは、Measure オブジェクトの追加、選択、または削除に使用します。

コレクションの各 Measure オブジェクトは、PowerPlay で業績の指標として使用される数値を表します。数値データは、常に数量化が可能です。例えば、有効な数値データには販売金額、販売金額/従業員、利益率 % などがあります。DoAutoDesign メソッドを使用すると、Transformer では自動的にコレクションが作成されます。

Measures コレクションには、標準数値データ、算出数値データ、またはカテゴリー・カウント数値データが含まれます。このコレクションを返すには、Measures プロパティーを使用します。

次の表は、関連するメソッドとプロパティーを示します。

30 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

メソッド 説明

Add メソッド () コレクションに Measure オブジェクトを追加します。

Item メソッド コレクションの特定の Measure オブジェクトを選択します。

Remove メソッド コレクションから特定の Measure オブジェクトを削除します。

プロパティー 説明

Application プロパティー Transformer Application オブジェクトを返します。

Count プロパティー コレクションに含まれる Measure オブジェクトの個数を返します。

Parent プロパティー 親オブジェクトを返します。

例objMeasures = objModel.Measures

Names コレクションNames コレクションには、Name オブジェクトの読み取り専用グループが含まれます。

解説

このコレクションは、名前またはメッセージを表す文字列のグループを参照するために使用します。Names コレクションは、CheckModel メソッド (モデル・オブジェクト) によって返されます。

このコレクションの各 Name オブジェクトには、完全なメッセージ文字列が含まれます。Name プロパティーの戻り値を使用して CheckModel プロシージャーの結果を読み取ることができます。

次の表は、関連するメソッドとプロパティーを示します。

メソッド 説明

Item メソッド コレクションに含まれる Name オブジェクトを選択します。

プロパティー 説明

Application プロパティー Transformer Application オブジェクトを返します。

第 2 章 コレクション 31

プロパティー 説明

Count プロパティー コレクションに含まれる Name オブジェクトの個数を返します。

Parent プロパティー 親オブジェクトを返します。

例MsgBox(objModel.CheckModel(intX).Name)

Namespaces コレクションNamespaces コレクションには、モデルに含まれる Namespaces オブジェクトがすべて含まれます。

解説

このコレクションは、Namespace オブジェクトの選択または削除に使用します。

この IBM Cognos オブジェクトは、認証とアクセス制御を許可する認証プロバイダーのインスタンスを表します。このコレクションを返すには、Namespaces プロパティーを使用します。モデルで Namespaces を使用しない場合のコレクション数は0 です。このオブジェクトを使用するには、IBM Cognos サーバーを使用する必要があります。このオブジェクトを使用すると、SecurityObjects オブジェクトのメンバーであるユーザーとグループの情報にアクセスできます。

新しい Namespace オブジェクトをコレクションに追加するには、Add メソッドを使用します。Namespace オブジェクトを削除するには、Remove メソッドを使用します。

次の表は、関連するメソッドとプロパティーを示します。

メソッド 説明

Add メソッド () コレクションに Namespace オブジェクトを追加します。

Item メソッド コレクションに含まれる特定の Namespaceオブジェクトを選択します。

Remove メソッド コレクションから特定の Namespace オブジェクトを削除します。

プロパティー 説明

Application プロパティー Transformer Application オブジェクトを返します。

Count プロパティー コレクションに含まれる Namespace オブジェクトの数を返します。

32 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

プロパティー 説明

Parent プロパティー 親オブジェクトを返します。

例new_namespace = model.Namespaces.Add()

PackageDatasourceConnections コレクションPackageDatasourceConnections コレクションには、PackageDatasourceConnectionオブジェクトがすべて含まれます。

解説

このコレクションは、PackageDatasourceConnection オブジェクトの追加、選択、または削除に使用します。

この IBM Cognos オブジェクトを使用するには、IBM Cognos サーバーがインストールされていて、動作している必要があります。PackageDatasourceConnectionオブジェクトは、IBM Cognos Connection を使用して作成されます。モデルでPackages を使用しない場合のコレクション数は 0 です。

このコレクションを返すには、PackageDatasourceConnections プロパティーを使用します。

新しい PackageDatasourceConnection オブジェクトをコレクションに追加するには、Add メソッドを使用します。PackageDatasourceConnection オブジェクトを削除するには、Remove メソッドを使用します。

次の表は、関連するメソッドとプロパティーを示します。

メソッド 説明

Add メソッド () コレクションにPackageDatasourceConnection オブジェクトを追加します。

Item メソッド コレクションに含まれる特定のPackageDatasourceConnection オブジェクトを選択します。

Remove メソッド コレクションから特定のPackageDatasourceConnection オブジェクトを削除します。

第 2 章 コレクション 33

プロパティー 説明

Application プロパティー Transformer Application オブジェクトを返します。

Count プロパティー コレクションに含まれるPackageDatasourceConnection オブジェクトの個数を返します。

Parent プロパティー 親オブジェクトを返します。

例package = model.Packages.Add()connection = package.PackageDatasourceConnections.Add()

Packages コレクションPackages コレクションには、モデルに含まれる Package オブジェクトがすべて含まれます。

解説

このコレクションは、Package オブジェクトの選択または削除に使用します。

このIBM Cognos を使用するには、IBM Cognos サーバーがインストールされていて、動作している必要があります。定義からわかるとおり、パッケージとしては、IBM Cognos サーバーで使用可能となっている、Transformer モデルのサブセットを使用できます。モデルで Packages を使用しない場合のコレクション数は 0 です。

このコレクションを返すには、Packages プロパティーを使用します。

新しい Package オブジェクトをコレクションに追加するには、Add メソッドを使用します。Package オブジェクトを削除するには、Remove メソッドを使用します。

次の表は、関連するメソッドとプロパティーを示します。

メソッド 説明

Add メソッド () コレクションに Package オブジェクトを追加します。

Item メソッド コレクションに含まれる特定の Package オブジェクトを選択します。

Remove メソッド コレクションから特定の Package オブジェクトを削除します。

34 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

プロパティー 説明

Application プロパティー Transformer Application オブジェクトを返します。

Count プロパティー コレクションに含まれる Package オブジェクトの個数を返します。

Parent プロパティー 親オブジェクトを返します。

例packages = model.Packages

Prompts コレクションPrompts コレクションには、クエリーに含まれる Prompt オブジェクトがすべて含まれます。

解説

このコレクションは、Prompt オブジェクトの選択または削除に使用します。

このIBM Cognos を使用するには、IBM Cognos サーバーがインストールされていて、動作している必要があります。Prompts はクエリーに関連付けられます。このコレクションを返すには、Query オブジェクトの Prompts プロパティーを使用します。

新しい Prompt オブジェクトをコレクションに追加するには、Add メソッドを使用します。Prompt オブジェクトを削除するには、Remove メソッドを使用します。

次の表は、関連するメソッドとプロパティーを示します。

メソッド 説明

Add メソッド () コレクションに Prompt オブジェクトを追加します。

Item メソッド コレクションに含まれる特定の Prompt オブジェクトを選択します。

Remove メソッド コレクションから特定の Prompt オブジェクトを削除します。

プロパティー 説明

Application プロパティー Transformer Application オブジェクトを返します。

第 2 章 コレクション 35

プロパティー 説明

Count プロパティー コレクションに含まれる Prompt オブジェクトの数を返します。

Parent プロパティー 親オブジェクトを返します。

例new_report = model.Reports.Add()new_query = new_report.Queries.Add()new_prompt = new_query.Prompts.Add()

Queries コレクションQueries コレクションには、パッケージまたはレポートの Query オブジェクトがすべて含まれます。

解説

Queries コレクションは、Query オブジェクトの選択または削除に使用します。

このIBM Cognos を使用するには、IBM Cognos サーバーがインストールされていて、動作している必要があります。Query オブジェクトは、データ・ソースから取得されるデータ・セットの仕様を表します。Transformer モデルには、データ・ソースとして複数のクエリーが含まれる場合があります。

このコレクションを返すには、Queries プロパティーを使用します。

新しい Query オブジェクトをコレクションに追加するには、Add メソッドを使用します。Query オブジェクトを削除するには、Remove メソッドを使用します。

次の表は、関連するメソッドとプロパティーを示します。

メソッド 説明

Add メソッド () コレクションに Query オブジェクトを追加します。

Item メソッド コレクションに含まれる特定の Query オブジェクトを選択します。

Remove メソッド コレクションから特定の Query オブジェクト削除します。

プロパティー 説明

Application プロパティー Transformer Application オブジェクトを返します。

36 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

プロパティー 説明

Count プロパティー コレクションに含まれる Query オブジェクトの数を返します。

Parent プロパティー 親オブジェクトを返します。

例new_package = model.Packages.Add()new_query = new_package.Queries.Add()

Reports コレクションReports コレクションは、関連する Report オブジェクトをグループ化します。

解説

このコレクションは、Report オブジェクトの追加、選択、または削除に使用します。

レポートは、コンテナー・データ・ソースとして機能する IBM Cognos レポートです。複数のデータ・ソース・クエリーをレポートに関連付けることができます。レポートは、リレーショナル・パッケージや DMR パッケージを使用して、QueryStudio や Reporting などの IBM Cognos アプリケーションによって作成されます。レポートは IBM Cognos Connection で保存されるため、データ・ソース接続を確立するには IBM Cognos サーバーが必要です。レポートには、1 つ以上のクエリーを含めることができます。モデルでレポートを使用しない場合のコレクション数は 0 です。

このコレクションを返すには、Reports プロパティーを使用します。

新しい Report オブジェクトをコレクションに追加するには、Add メソッドを使用します。Report オブジェクトを削除するには、Remove メソッドを使用します。

メソッド 説明

Add メソッド () コレクションに Report オブジェクトを追加します。

Item メソッド コレクションの特定の Report オブジェクトを選択します。

Remove メソッド コレクションから特定の Report オブジェクトを削除します。

第 2 章 コレクション 37

プロパティー 説明

Application プロパティー Transformer Application オブジェクトを返します。

Count プロパティー コレクションに含まれる Report オブジェクトの個数を返します。

Parent プロパティー 親オブジェクトを返します。

例reports = model.Reports

SecurityObjects コレクションSecurityObjects コレクションには、モデルに含まれる SecurityObject オブジェクトがすべて含まれます。

解説

このコレクションは、SecurityObject オブジェクトの選択または削除に使用します。

このコレクションを取得するには、CustomView または Namespace オブジェクトの SecurityObjects プロパティーを使用します。

新しい SecurityObject オブジェクトをコレクションに追加するには、Add メソッドを使用します。SecurityObject オブジェクトを削除するには、Remove メソッドを使用します。

次の表は、関連するメソッドとプロパティーを示します。

メソッド 説明

Add メソッド () コレクションに Report オブジェクトを追加します。

Item メソッド コレクションの特定の Report オブジェクトを選択します。

Remove メソッド コレクションから特定の Report オブジェクトを削除します。

プロパティー 説明

Application プロパティー Transformer Application オブジェクトを返します。

Count プロパティー コレクションに含まれる Report オブジェクトの個数を返します。

Parent プロパティー 親オブジェクトを返します。

38 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

例new_namespace = model.Namespaces.Add()securityObject = new_namespace.SecurityObjects.Add()

Signons コレクションSignons コレクションは、関連する Signon オブジェクトをグループ化します。

解説

このコレクションは、Signon オブジェクトの追加、変更、または削除に使用します。

このコレクションの各オブジェクトは、IqdDataSource オブジェクトのデータへのアクセスを規制します。このコレクションを返すには、Signons プロパティーを使用します。

Impromptu クエリー定義 (.iqd) ファイルをモデル・クエリーのデータ・ソースとして使用する場合、Transformer では、.iqd ファイルの情報を使用して、モデルに新規の Signon オブジェクトを自動作成します。Impromptu クエリー定義 (.iqd)ファイルに指定されている論理データベース名が、新規 Signon オブジェクトに割り当てられます。

次の表は、関連するメソッドとプロパティーを示します。

メソッド 説明

Add メソッド () コレクションに Signon オブジェクトを追加します。

Item メソッド コレクションの特定の Signon オブジェクトを選択します。

Remove メソッド コレクションから特定の Signon オブジェクトを削除します。

プロパティー 説明

Application プロパティー Transformer Application オブジェクトを返します。

Count プロパティー コレクションに含まれる Signon オブジェクトの個数を返します。

Parent プロパティー 親オブジェクトを返します。

例signon = model.Signons.Add()

第 2 章 コレクション 39

SuspendedModels コレクションSuspendedModels コレクションには、アプリケーションで使用できるSuspendedModel オブジェクトが含まれます。

解説

このコレクションは、SuspendedModel オブジェクトの選択または削除に使用します。

システム障害などのためにモデルが正常に閉じなかった場合、Transformer ではモデルの SuspendedModel オブジェクトが SuspendedModels コレクションに追加されます。

このコレクションを返すには、SuspendedModels プロパティーを使用します。

次の表は、関連するメソッドとプロパティーを示します。

メソッド 説明

Item メソッド コレクションの特定の SuspendedModel オブジェクトを選択します。

RemoveSuspendedModel メソッド コレクションから特定の SuspendedModelを削除します。

プロパティー 説明

Application プロパティー Transformer Application オブジェクトを返します。

Count プロパティー コレクションに含まれる SuspendedModelオブジェクトの個数を返します。

Parent プロパティー 親オブジェクトを返します。

例If objTransApp.SuspendedModels.Count = 0 Then

Views コレクションViews コレクションは、View オブジェクトをグループ化します。

解説

このコレクションは、View オブジェクトの追加、選択、または削除に使用します。

多くの組織では、モデルの全データを全ユーザーに表示する必要はありません。データを制限する 1 つの方法は、ビュー (ディメンションのレベルとカテゴリーのサブセット) を作成することです。ディメンションに関連付けられた複数のビューをViews コレクションにグループ化できます。

このコレクションを返すには、Views プロパティーを使用します。

40 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

次の表は、関連するメソッドとプロパティーを示します。

メソッド 説明

Add メソッド () コレクションに View オブジェクトを追加します。

Item メソッド コレクションの特定の View オブジェクトを選択します。

Remove メソッド コレクションから特定の View オブジェクトを削除します。

プロパティー 説明

Application プロパティー Transformer Application オブジェクトを返します。

Count プロパティー コレクションに含まれる View オブジェクトの個数を返します。

Parent プロパティー 親オブジェクトを返します。

例objDimension = objModel.Dimensions("Retailers")objView = objDimension.Views.Add()

第 2 章 コレクション 41

42 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

第 3 章 オブジェクト

次の表は、Transformer OLE オートメーション・オブジェクトのリストです。

オブジェクト 説明

Application オブジェクト Transformer アプリケーションのインスタンスを表します。

Association オブジェクト モデル・オブジェクトと基になるデータ・ソース間の関係を定義します。

CalculationDefinition オブジェクト 算出カテゴリーを定義するテンプレートとして機能します。

Category オブジェクト モデルに使用するカテゴリーを定義します。

CategorySet オブジェクト 計算の定義で使用するカテゴリーをグループ化します。

ChildCube オブジェクト キューブ・グループのメンバーとしてキューブを定義します。

Column オブジェクト データ・ソースの 1 つのデータ項目を表します。

CrossTabDataSource オブジェクト クロス集計形式の外部ファイルを表します。

Cube オブジェクト キューブを定義します。

CubeGroup オブジェクト 関連する子キューブのセットを定義します。

CurrencyRate オブジェクト 通貨変換の交換レートを定義します。

CurrencyRecord オブジェクト 通貨情報の表示を定義します。

CurrencyTable オブジェクト 通貨変換に使用する通貨表を定義します。

CustomView オブジェクト カスタム・ビューを表します。

DataSource オブジェクト 一般的なデータ・ソースを定義します。

DateDimension オブジェクト 日付データを論理グループに編成します。

DateDrillDown オブジェクト 日付や時刻の主ドリルダウン・パスと代替ドリルダウン・パスを定義します。

DateLevel オブジェクト モデルの日付レベルを定義します。

43

オブジェクト 説明

DateWizard オブジェクト DateDimension オブジェクトを作成します。

DbDataSource オブジェクト データベース形式の外部ファイルを表します。

Dimension オブジェクト 日付以外のデータを論理グループに編成します。

DrillDown オブジェクト キューブをナビゲートするために使用する主ドリルダウン・パスと代替ドリルダウン・パスを定義します。

DrillThroughTarget オブジェクト 外部レポートまたは PowerCube へのドリルスルー・リンクを表します。

Filter オブジェクト Transformer モデルに含まれるフィルターを表します。

FlatFileDataSource オブジェクト ASCII 形式の外部ファイルを表します。

IqdDataSource オブジェクト Impromptu クエリー定義ファイル (.iqd) を表します。

Level オブジェクト ディメンションのレベルを定義します。

Measure オブジェクト キューブの数量的な値を表します。

Model オブジェクト Transformer モデルを定義します。

Name オブジェクト 名前またはメッセージのテキスト文字列を表します。

Namespace オブジェクト Transformer モデルに含まれるネームスペースを表します。

Package オブジェクト Transformer モデルに含まれるパッケージ・データ・ソースを表します。

PackageDatasourceConnection オブジェクト Transformer モデルに含まれるパッケージ・データ・ソース接続を表します。

Prompt オブジェクト Transformer モデルに含まれるプロンプトを表します。

Query オブジェクト レポートまたはパッケージの一部であるクエリーを表します。

Report オブジェクト Transformer モデルに含まれるレポート・データ・ソースを表します。

44 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

オブジェクト 説明

SecurityObject オブジェクト Transformer モデルに含まれるセキュリティー・オブジェクトを表します。

Signon オブジェクト データベース・サインオンを定義します。

SpecialCategory オブジェクト データ・ソースの値を直接使用しないカテゴリーを定義します。

SuspendedModel オブジェクト 存在する不完全なモデルを表す。

View オブジェクト ディメンションの表示を定義します。

Application オブジェクトApplication オブジェクトは、Transformer アプリケーションのインスタンスを表します。

解説

このオブジェクトは、モデルの作成、または変更に使用します。

Application オブジェクトのほとんどのプロパティーは、実行時の設定を決定するものです。一度設定した設定のプロパティーは、変更するまで有効になります。つまり、Application オブジェクトを作成するたびに設定を行う必要はありません。

このオブジェクトを作成するには、CreateObject 関数を使用します。

このオブジェクトのプロパティーへの変更を保存するには、Update メソッドを使用します。

関連トピック

次の表は、関連するコレクション、メソッド、プロパティーを示します。

メソッド 説明

NewModel メソッド 空のモデルを作成します。

OpenModel メソッド 既存のモデルを開きます。

OpenSuspendedModel メソッド 中断モデルを開きます。

RemoveSuspendedModel メソッド コレクションから中断モデルを削除します。

第 3 章 オブジェクト 45

プロパティー 説明

PatFile プロパティー 自動デザインを使用するときに、関連するユーザー・インターフェースのロケールに対するパターン・ファイル"cogtr_<ロケール>.pat" ("cogtr_en.pat"など) の場所を設定するか、または設定状態を返します。

CurrentModel プロパティー 現在開いているモデル・オブジェクトを返します。

DataCharacterSet プロパティー アプリケーションで使用するデフォルトの文字セットを設定する、または設定状態を返します。

DataSourcePath プロパティー Transformer でデータ・ソース・ファイルを検索する場所を設定する、または設定状態を返します。

DataTemporaryFilesPath プロパティー Transformer でキューブを生成するときに、一時作業ファイルを作成するディレクトリーの名前を設定する、または設定状態を返します。

DefaultDateFormat プロパティー DateInputFormat プロパティーのデフォルト設定を設定する、または設定状態を返します。

DetachDataSource プロパティー データ・ソースとの接続を維持するかどうかを設定する、または設定状態を返します。

EnableMessageLogging プロパティー Transformer でメッセージをログ・ファイルに追加するか、前のログ・メッセージを上書きするかを設定する、または設定状態を返します。

LogErrorLevel プロパティー 記録するエラー・メッセージの重大度を設定する、または設定状態を返します。

LogFileAppend プロパティー Transformer でメッセージをログ・ファイルに付加するか、前のログ・メッセージに上書きするかを設定する、または設定状態を返します。

LogFileName プロパティー ログ・ファイルの名前を設定する、または設定状態を返します。

LogFilesPath プロパティー Transformer でログ・ファイルを保存する場所を設定する、または設定状態を返します。

46 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

プロパティー 説明

MaxTransactionNumber プロパティー Transformer で変更をキューブにコミットする前に処理する最大レコード数を設定する、または設定状態を返します。

ModelsPath プロパティー Transformer でモデル・ファイルを開いたり保存する場所を設定する、または設定状態を返します。

ModelTemporaryFilesPath プロパティー Transformer でテンポラリー・モデル・ファイル (.qy?) を作成する場所を設定する、または設定状態を返します。

Name プロパティー アプリケーションの名前を返します。

PatFile プロパティー 自動デザインを使用するときに、関連するユーザー・インターフェースのロケールに対するパターン・ファイル"cogtr_<ロケール>.pat" ("cogtr_en.pat"など) の場所を設定するか、または設定状態を返します。

PowerCubesPath プロパティー Transformer で PowerCube ファイル(.mdc) を作成する場所を設定する、または設定状態を返します。

PowerPlayPath プロパティー "PowerPlay.exe" の場所を設定する、または設定状態を返します。

RowsAsSample プロパティー DoAutoDesign メソッドでモデルを作成するときにサンプリングする行数を設定する、または設定状態を返します。

RowsChecked プロパティー DoAutoDesign メソッドでデータ・ソースから読み取る最大行数を設定する、または設定状態を返します。

ServicesBuildNumber プロパティー Transformer で使用するデータ・アクセス・サービスのビルド番号を返します。

ServicesVersionText プロパティー Transformer で使用するデータ・アクセス・サービスのバージョン番号を返します。

SortComparisonRule プロパティー Transformer でデータをソートするときに使用する比較法を設定する、または設定状態を返します。

SuspendedModels プロパティー 中断モデル・オブジェクトのコレクションを返します。

第 3 章 オブジェクト 47

プロパティー 説明

TransdaPath プロパティー "Transda.exe"のインストール場所を設定する、または設定状態を返します。

Type プロパティー オブジェクトのタイプを返します。

Version プロパティー Transformer のバージョン番号を返します。

例objTransApp = CreateObject("IBMCognosTransformer.ApplicationCtrl.1")

Association オブジェクトAssociation オブジェクトは、モデル・オブジェクトと基礎になるデータ・ソース間の関係を定義します。

解説

このオブジェクトは、モデルのオブジェクトとその基礎になるデータ・ソース間のリンクを管理するために使用します。

コレクションの Association オブジェクトにはそれぞれ役割があります。例えば、ソース値の参照、短縮名の表示、ソートの定義を実行する Association などです。Association の役割を指定するには、AssociationRole プロパティーを使用します。

各 Association オブジェクトは、データ・ソースの列を参照します。Associationオブジェクトで列がどのように使用されるかは、Association に割り当てられた役割によって異なります。列を指定するには、Label プロパティーを参照オブジェクトの名前に設定します。

Association オブジェクトを作成するには、Associations コレクションの Add メソッドを使用するか、適用されるオブジェクトの AssociateWith メソッドまたはDimensionAssociateWith メソッドを使用します。

デフォルトでは、カテゴリーはデータ・ソースと同じ順序でレベル (最終的にはキューブ) に表示されます。オブジェクトをソートするには、Association オブジェクトを使用して AssociationRole プロパティーを trAssociationOrderBy に設定します。

Transformer では、レベルをソートするときに Label プロパティーに指定した列に基づいてソートされます。例えば、Product レベルを product_name やproduct_number でソートすることができます。

ソートを適用するドリルダウン・パスに名前を付けるには、Context プロパティーを使用します。レベルが複数のドリルダウン・パスの収束レベルになっている場合は、それぞれ異なるソートの順序を適用できます。

48 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

ソートの順序を指定するには、OrderByDescending プロパティーを使用します。数値データの列を使用してソートを定義する場合は、OrderByStorageType を使用してデータ型のサイズを指定します。

このオブジェクトのプロパティーへの変更を保存するには、Update メソッドを使用します。

関連トピック

次の表は、関連するコレクション、メソッド、プロパティーを示します。

メソッド 説明

Delete メソッド Association オブジェクトを削除します。

Update メソッド Association オブジェクトを更新します。

プロパティー 説明

Application プロパティー Transformer Application オブジェクトを返します。

AssociationRole プロパティー Association オブジェクトで実行される役割を設定する、または設定状態を返します。

AssociationType プロパティー Association オブジェクトに関連付けられているデータ・ソースのタイプを設定する、または設定状態を返します。

Context プロパティー レベルのカテゴリーを並べ替えるために使用するドリルダウン・パスを設定する、または設定状態を返します。

Label プロパティー 参照オブジェクトの名前を設定するか、設定状態を返します。

Parent プロパティー 親オブジェクトを返します。

RefreshDescription プロパティー Association オブジェクトのデータ・ソース列を設定します。

Type プロパティー オブジェクトのタイプを返します。

例objAssociation = objDrill.ConvergenceLevel.Associations.Add()

CalculationDefinition オブジェクトCalculationDefinition オブジェクトは、算出カテゴリーを定義するためのテンプレートとして機能します。

解説

CalculationDefinition オブジェクトは、計算の一部に 1 つ以上のカテゴリーの値を使用する複雑な数式を追加するために使用します。

CalculationDefinition オブジェクトを作成するには、CalculationDefinitions コレクションの Add メソッドを使用します。

第 3 章 オブジェクト 49

CalculationDefinition オブジェクトの値は、式と、その式を適用するカテゴリーまたはカテゴリー・セットに基づきます。式は、関数と演算子を使用した数式として構成し、ExpressionText プロパティーに割り当てます。数式では複数のカテゴリー・セットを参照できます。

数式に記述したカテゴリーは、Update メソッドを実行したときに生成されます。数式の有効性もチェックされます。重複カテゴリーなどのエラーがある場合、Updateは失敗し、Transformer からエラー・メッセージが発行されます。

Description プロパティーは、プロパティーとして使用できますが、何の機能も持ちません。Description プロパティーに加えた変更は保持されません。

関連トピック

次の表は、関連するコレクション、メソッド、プロパティーを示します。

メソッド 説明

Delete メソッド CalculationDefinition オブジェクトを削除します。

Update メソッド CalculationDefinition オブジェクトを更新します。

プロパティー 説明

Application プロパティー Transformer Application オブジェクトを返します。

CategorySets プロパティー CalculationDefinition オブジェクトが使用する CategorySets コレクションを返します。

ExpressionText プロパティー CalculationDefinition オブジェクトの値を定義する数式の内容を設定する、または設定状態を返します。

Group プロパティー CalculationDefinition をカテゴリー・セットのカテゴリーとグループ化するかどうかを設定する、または設定状態を返します。

IsExpressionValid プロパティー 数式が有効かどうかを返します。

Name プロパティー オブジェクトの名前を設定する、または設定状態を返します。

Parent プロパティー 親オブジェクトを返します。

Type プロパティー オブジェクトのタイプを返します。

50 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

例calcDef = dimension.CalculationDefinitions.Add()

Category オブジェクトCategory オブジェクトは、モデルで使用されるカテゴリーを定義します。

解説

このオブジェクトは、モデルの Category オブジェクトのプロパティーを変更するために使用します。カテゴリーは、GenerateCategories メソッドを使用したときにデータ・ソースから生成されます。また、キューブを作成したときにも生成されます。

標準カテゴリーには、組織の詳細 (製品ラインや販売店) を記述または分類する構造データが含まれています。カテゴリーは、一般にディメンション・レベルと対応します。モデルを作成すると、トランザクション・データ・ソースから数値データ値の値がカテゴリーに取り込まれます。

算出カテゴリーでは、数式とカテゴリーの値を使用して値が算出されます。算出カテゴリーを作成するには、Categories コレクションの Add メソッドを使用し、ExpressionText プロパティーを使用して値を割り当てます。また、CalculationDefinition オブジェクトと CategorySet オブジェクトを使用して、算出カテゴリーを作成することもできます。

ディメンションの最上位にある標準カテゴリーのコレクションを返すには、DrillDown オブジェクトの Categories プロパティーを使用します。子カテゴリーのコレクションを返すには、Category オブジェクトの ChildCategories プロパティーを使用します。特殊カテゴリーのコレクションを返すには、親ディメンションのCategories プロパティーを使用します。

このオブジェクトのプロパティーへの変更を保存するには、Update メソッドを使用します。

関連トピック

次の表は、関連するコレクション、メソッド、プロパティーを示します。

メソッド 説明

ConnectWithCategory メソッド 子カテゴリーを同じレベルの新しい親カテゴリーに移動します。

Delete メソッド Category オブジェクトを削除します。

MoveToCategory メソッド 子カテゴリーを別の親カテゴリーに移動します。

MoveToLevel メソッド 子カテゴリーを現在の親カテゴリーの下にある新しいレベルに移動します。

第 3 章 オブジェクト 51

メソッド 説明

SetAllocation メソッド オブジェクトで使用する数値データの割り当てタイプを変更します。

Update メソッド Category オブジェクトを更新します。

プロパティー 説明

AllocationMeasure プロパティー 加重係数として使用する Measure オブジェクトを返します。

AllocationType プロパティー オブジェクトで数値データを割り当てる方法を返します。

Application プロパティー Transformer Application オブジェクトを返します。

CanAllocate プロパティー 数値データ値の値を子孫のレベルとカテゴリーに割り当てることができるかどうかを返します。

CanAllocateByMeasure プロパティー 数値データで割り当てるときに、指定した数値データを加重係数として使用できるかどうかを返します。

CanAllocateMeasure プロパティー 指定した数値データを子孫のレベルとカテゴリーに割り当てることができるかどうかを返します。

ChildCategories プロパティー Categories コレクションを返します。

Code プロパティー ディメンションのカテゴリーについて一意の識別コードを設定する、または設定状態を返します。

Description プロパティー Category オブジェクトの説明を設定する、または設定状態を返します。

Dimension プロパティー Category オブジェクトのディメンションを返します。

ExpressionText プロパティー Category オブジェクトの値を定義する数式の内容を設定する、または設定状態を返します。

Format プロパティー 数値を表示する書式を設定する、または設定状態を返します。

52 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

プロパティー 説明

FormatDecimals プロパティー PowerPlay で表示する数値データの小数桁数を設定する、または設定状態を返します。

HideValue プロパティー カテゴリー・オブジェクトの値を非表示にするかどうかを指定します。デフォルト:False

Inclusion プロパティー キューブにカテゴリーが含まれるかどうかを設定する、または設定状態を返します。

IsExpressionValid プロパティー 数式が有効かどうかを返します。

IsPrimary プロパティー Category オブジェクトが主ドリル・カテゴリーであるか代替ドリル・カテゴリーであるかを返します。

KeyName プロパティー データ・ソースの関連した列に表示される値を設定する、または設定状態を返します。

Label プロパティー オブジェクトの名前を設定する、または設定状態を返します。Transformer のユーザー・インターフェースでは、ラベルは「ソース値」ですが、デフォルト値は "" です。

LastUseDate プロパティー Category オブジェクトを最後に変更または使用した日付を返します。

Level プロパティー Category オブジェクトのレベルを返します。

Name プロパティー オブジェクトの名前を設定する、または設定状態を返します。

Orphanage プロパティー カテゴリーが孤児かどうかを設定する、または設定状態を返します。

Parent プロパティー 親オブジェクトを返します。

ParentCategories プロパティー ParentCategories コレクションを返します。

Partition プロパティー 手動パーティション番号を設定する、または設定状態を返します。

ReverseSign プロパティー PowerPlay で数値データの符号を反転するかどうかを設定する、または設定状態を返します。

ShortName プロパティー Category オブジェクトの短縮名を設定する、または設定状態を返します。

Type プロパティー オブジェクトのタイプを返します。

第 3 章 オブジェクト 53

例parentCategory = drillDown.Categories.Item(1)'select"Camping Equipment"

CategorySet オブジェクトCategorySet オブジェクトは、計算の定義で使用されるカテゴリーをグループ化します。

解説

CalculationDefinition オブジェクトでは、CategorySet オブジェクトをパラメーターとする数式を使用できます。カテゴリー・セットには、数式の値の供給元として、適用されるディメンションの 1 つ以上のカテゴリーを設定します。

カテゴリー・セットは、数式で参照する前に作成しておく必要があります。

カテゴリー・セットは、式に全レベルを含めない場合、カテゴリーをグループ化する便利な方法です。カテゴリー・セットには、ディメンションの他のレベルのカテゴリーも含めることができます。

最初に CalculationDefinition オブジェクトを作成し、Add メソッドを使用してCategorySets コレクションに CategorySet を追加します。次に、Add メソッドを使用してカテゴリー・セットの Categories コレクションにカテゴリーを追加します。最後に、Label プロパティーを使用してカテゴリー・セットに名前を付けます。

数式の参照には CategorySet オブジェクトの Label プロパティーを使用します。各カテゴリー・コードの文字列とラベルは、追加の引用符で囲みます。

このオブジェクトのプロパティーへの変更を保存するには、Update メソッドを使用します。

関連トピック

次の表は、関連するコレクション、メソッド、プロパティーを示します。

メソッド 説明

Delete メソッド CategorySet オブジェクトを削除します。

Update メソッド CategorySet オブジェクトを更新します。

プロパティー 説明

Application プロパティー Transformer Application オブジェクトを返します。

54 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

プロパティー 説明

Categories プロパティー CategorySet オブジェクトに含まれるカテゴリーのコレクションを返します。

Description プロパティー CategorySet オブジェクトの説明を設定する、または設定状態を返します。

Label プロパティー PowerPlay に表示される説明的な名前を設定する、または設定状態を返します。

Name プロパティー オブジェクトの名前を設定する、または設定状態を返します。

Parent プロパティー 親オブジェクトを返します。

Type プロパティー オブジェクトのタイプを返します。

例catSet = calcDef.CategorySets.Add()

ChildCube オブジェクトChildCube オブジェクトは、キューブ・グループのメンバーとしてキューブを定義します。

解説

キューブ・グループは、ディメンション内の 1 つのレベルを表します。グループの各 ChildCube オブジェクトは、そのレベルの 1 つのカテゴリーを反映します。

このオブジェクトは、ChildCube オブジェクトのプロパティーを変更するために使用します。コレクションの ChildCube オブジェクトを返すには、CubeGroup オブジェクトの ChildCubes プロパティーを使用します。

このオブジェクトのプロパティーへの変更を保存するには、Update メソッドを使用します。

関連トピック

次の表は、関連するコレクション、メソッド、プロパティーを示します。

メソッド 説明

RemoveCubeCustomView メソッド カスタム・ビューを削除します。

Update メソッド ChildCube オブジェクトを更新します。

第 3 章 オブジェクト 55

プロパティー 説明

AllowDrillThrough プロパティー キューブまたは数値データを、キューブまたはレポートへドリルスルーできるかどうかを設定する、または設定状態を返します。

AltMDCFile プロパティー 子キューブの代替ファイル名を設定する、または設定状態を返します。

Application プロパティー Transformer Application オブジェクトを返します。

Consolidate プロパティー キューブを集約する方法を設定する、または設定状態を返します。

CubeCreation プロパティー キューブを作成するかどうかを設定する、または設定状態を返します。

CubeCustomViews プロパティー CustomView オブジェクトのコレクションを返します。

Description プロパティー ChildCube オブジェクトの説明を設定する、または設定状態を返します。

DrillThroughTargets プロパティー ChildCube オブジェクトに関連付けられているすべての DrillThroughTargets オブジェクトのコレクションを返します。

IsMDCInUse プロパティー 子キューブが使用中または再構築中であるかを返します。

MDCFile プロパティー PowerCube ファイル (.mdc) の名前を設定する、または設定状態を返します。

MeasureName プロパティー PowerPlay ディメンション・ラインの数値データを識別する説明的なタイトルを設定する、または設定状態を返します。

Name プロパティー オブジェクトの名前を設定する、または設定状態を返します。

Optimize プロパティー 現在のキューブの最適化オプションを設定する、または設定状態を返します。

Parent プロパティー 親オブジェクトを返します。

Password プロパティー キューブのパスワードを設定します (大文字と小文字を区別)。

Status プロパティー キューブを最後に作成したときに関連付けられた問題のステータスを返します。

56 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

プロパティー 説明

Type プロパティー オブジェクトのタイプを返します。

UseAltMDCFile プロパティー 一時ファイル名を使用できるかどうかを設定する、または設定状態を返します。

例objCubesByRegion = objModel.Cubes.Add(xtrObjectType.trCubeGroup)objChildCube =objCubesByRegion.ChildCubes("Central Europe")

Column オブジェクトColumn オブジェクトは、データ・ソースの 1 つのデータ・アイテムを表します。

解説

モデルの Column オブジェクトは、関連付けられたデータ・ソースの列とリンクされ、カテゴリー生成後にレベルおよび数値データの値のソースとして機能します。

Transformer では、列を使用してモデルのディメンションと数値データが構築されます。列には、モデルのカテゴリーになるテキスト値、または数値データ値になる数値が含まれています。列には、カテゴリーのラベル、短縮名、または説明として使用される値も含まれています。

Transformer では、ほとんどのサポートされているデータ・ソース・タイプについて、データ・ソースの列が自動的に識別され、デフォルトの列名とプロパティーが割り当てられます。この割り当ては、あとで変更できます。列を手動で作成する場合 (固定長フィールドのテキスト・ファイルを使用するときなど) は、モデルに使用するデータ列のみを識別する必要があります。

複数のデータ・ソースに同じ列名がある場合、Transformer では、これらの列が 1つのレベルまたは数値データと関連付けられます。また、一致する列を使用したソース・ファイルの結合が行われるのではなく、各ソース・ファイルを使用してモデルにカテゴリーが生成されます。

モデルに時間ディメンションを設定するには、モデルの少なくとも 1 つのデータ・ソースに日付値を表す列が必要です。

モデルに必要な構造または数値情報がデータ・ソースにない場合は、ExpressionText プロパティーを使用して算出列を定義できます。算出列は、他の列、関数、および定数を使用してモデルに新しいデータを作成します。算出列は、他の列、関数、および定数を使用してモデルに新しいデータを持たせます。

Column オブジェクトを作成するには、Columns コレクションの Add メソッドを使用します。

このオブジェクトのプロパティーへの変更を保存するには、Update メソッドを使用します。

第 3 章 オブジェクト 57

関連トピック

次の表は、関連するコレクション、メソッド、プロパティーを示します。

メソッド 説明

Delete メソッド Column オブジェクトを削除します。

Update メソッド Column オブジェクトを更新します。

プロパティー 説明

Application プロパティー Transformer Application オブジェクトを返します。

DataClass プロパティー ソース列のデータ型を設定する、または設定状態を返します。

DateDegreeofDetail プロパティー レポートを作成する日付レベルを設定する、または設定状態を返します。

DateDegreeofDetailLevelName プロパティー

外部的に集計する数値データに適用する日付レベルを設定する、または設定状態を返します。

DateInputFormat プロパティー 日付を表示する書式を設定する、または設定状態を返します。

Decimals プロパティー ソース・データに定義されている場合、小数桁数を返します。

Description プロパティー Column オブジェクトの説明を設定する、または設定状態を返します。

ExpressionText プロパティー 算出列の値を定義する数式の内容を設定する、または設定状態を返します。

InputScale プロパティー 列の値を小数から整数に変換するために使用するスケール値を設定する、または設定状態を返します。

IsExpressionValid プロパティー 数式が有効かどうかを返します。

Name プロパティー オブジェクトの名前を設定する、または設定状態を返します。

Origin プロパティー Column オブジェクトのソースを設定する、または設定状態を返します。

OriginalName プロパティー データ・ソースの列名を設定する、または設定状態を返します。

58 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

プロパティー 説明

OutputScale プロパティー PowerPlay の値を整数から小数に変換するために使用するスケール値を設定する、または設定状態を返します。

Parent プロパティー 親オブジェクトを返します。

Position プロパティー データ・ソースの列の開始位置を設定する、または設定状態を返します。

Size プロパティー 一部のデータ・ソースについて列のサイズを指定します。

StorageType プロパティー オブジェクトの数値保管タイプを設定する、または設定状態を返す (適用される場合)。

TimeArrayColumn プロパティー オブジェクトが日付配列を表すときに配列の1 列目の名前を設定する、または設定状態を返します。

TimeArrayStartMonth プロパティー オブジェクトに日付配列が含まれているときに会計年度の開始月を設定する、または設定状態を返します。

TimeArrayType プロパティー 日付値に使用する配列のタイプを設定する、または設定状態を返します。

Type プロパティー オブジェクトのタイプを返します。

例objDataSource= objModel.DataSources.Add(xtrObjectType.trFlatFileDataSource)objColumn= objDataSource.Columns("EXPECTED_VOLUME")

CrossTabDataSource オブジェクトCross TabDataSource オブジェクトは、外部ファイルをクロス集計形式で表します。

解説

CrossTabDataSource は、Lotus® 1-2-3 またはMicrosoft Excel のスプレッドシートを参照します。クロス集計データ・ソースを作成するには、スプレッドシートの各列に範囲名を割り当てます。

CrossTabDataSource オブジェクトを作成するには、DataSources コレクションのAdd メソッドを使用します。xtrObjectType 値リストからパラメーターtrCrossTabDataSource を指定します。

第 3 章 オブジェクト 59

SourceType プロパティーを trExcelCrossTab または trLotus123CrossTab に設定します。

Transformer では、クロス集計データ・ソースを開くとき、モデルに列のコレクションが作成されます。名前を付けた各範囲に 1 つの列が対応します。Transformerでは、各範囲のセル値がサンプリングされて各列のデータ・クラス (テキスト、数値、または日付) が決定されます。

このオブジェクトのプロパティーへの変更を保存するには、Update メソッドを使用します。

関連トピック

次の表は、関連するコレクション、メソッド、プロパティーを示します。

メソッド 説明

Delete メソッド CrossTabDataSource オブジェクトを削除します。

Move メソッド CrossTabDataSource オブジェクトをDataSources コレクションの別の位置に移動します。

Update メソッド CrossTabDataSource オブジェクトを更新します。

プロパティー 説明

Application プロパティー Transformer Application オブジェクトを返します。

Columns プロパティー Columns コレクションを返します。

ColumnsLoaded プロパティー モデルの構築にデータ・ソースの列を使用したかどうかを返します。

Description プロパティー CrossTabDataSource オブジェクトの説明を設定する、または設定状態を返します。

DecimalPoint プロパティー 小数点に使用する区切り文字を設定する、または設定状態を返します。

External プロパティー データ・ソースにあらかじめ集計した値が含まれているかどうかを設定する、または設定状態を返します。

GenerateCategories プロパティー データ・ソースのカテゴリーを生成するかどうかを設定する、または設定状態を返します。

60 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

プロパティー 説明

GeneratePowerCube プロパティー モデルでデータ・ソースを参照するかどうかを設定する、または設定状態を返します。

IsAnyColumnMismatched プロパティー データ・ソースの列が基礎になるデータと一致するかどうかを返します。

LocalPath プロパティー ローカル・データ・ソースの場所を設定する、または設定状態を返します。

MaximizeSpeed プロパティー カテゴリーの生成速度を最適化するかどうかを設定する、または設定状態を返します。

Name プロパティー データ・ソースの一意の名前を設定する、または設定状態を返します。

Parent プロパティー 親オブジェクトを返します。

ServerQuery プロパティー Transformer でデータ・ソースから現在期間の日付を検索するかどうかを設定する、または設定状態を返します。

SetsCurrentPeriod プロパティー データ・ソースで使用するデータ・ファイルのタイプを設定する、または設定状態を返します。

ThousandPoint プロパティー 1000 の区切りに使用する文字を設定する、または設定状態を返します。

SourceType プロパティー オブジェクトのタイプを返します。

Cube オブジェクトCube オブジェクトは、キューブを定義します。

解説

このオブジェクトは、キューブのプロパティーを変更するために使用します。モデルに定義された各キューブは、PowerPlay を通じて基礎になるデータの多次元ビューをユーザーに表示します。Cube オブジェクトを作成するには、Cubes コレクションの Add メソッドを使用します。

PowerCube ファイル (.mdc) を作成するには、CreateMDCFile メソッドを使用します。モデルの .mdc ファイルをすべて作成するには、モデル・オブジェクトのCreateMDCFiles メソッドを使用します。

ユーザーは、各セッションで 1 回ログオンすれば、自分のカスタム・ビューに割り当てられたキューブやレポートをいくつでも表示できます。

第 3 章 オブジェクト 61

このオブジェクトのプロパティーへの変更を保存するには、Update メソッドを使用します。

ユーザーは、PublishDatasource メソッドまたは PublishPackage メソッドを使用して、データ・ソースまたはパッケージを発行できます。パッケージを発行する場合は、デフォルトでデータ・ソースも発行されます。ユーザーは、発行時にデータ・ソースまたはパッケージを上書きするかどうかを選択できます。また、カスタム・ビューを各キューブに割り当てることができます。カスタム・ビューには、セキュリティー情報が含まれます。

関連トピック

次の表は、関連するコレクション、メソッド、プロパティーを示します。

メソッド 説明

AddDeployLocation メソッド Copy および Activate の新しい配布場所を追加します。

ClearDeployLocations メソッド すべての配布場所を削除します。

CreateMDCFile メソッド キューブの定義に基づいて PowerCube ファイル (.mdc) を作成します。

Delete メソッド Cube オブジェクトを削除します。

DeployCubes メソッド すべての配布場所に PowerCube を配布します。

PublishDatasource メソッド IBM Cognos Analytics サーバーにPowerCube 用のデータ・ソース接続を発行します。

PublishPackage メソッド IBM Cognos Analytics サーバーにPowerCube 用のパッケージを発行します。

RemoveCubeCustomView メソッド キューブからカスタム・ビューを削除します。

SetDeployType メソッド Copy および Activate の配布タイプを設定します。

Update メソッド Cube オブジェクトを更新します。

プロパティー 説明

AllowDrillThrough プロパティー キューブまたは数値データを、キューブまたはレポートへドリルスルーできるかどうかを設定する、または設定状態を返します。

62 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

プロパティー 説明

AlternateQueryPath プロパティー キューブで使用する代替データ・ソース・パスを設定する、または設定状態を返します。

AlternateQueryPath プロパティーを使用する場合、データ・ソースの名前およびデータ・ソースへのパスを指定する必要があります。

AltMDCFile プロパティー キューブの代替ファイル名を設定する、または設定状態を返します。

Application プロパティー Transformer Application オブジェクトを返します。

BlockParentTotals プロパティー 除外されている子の親の拒否された値を返します。

CacheCrossTabs プロパティー キューブの最初の PowerPlay クロス集計のために集計をキャッシュするかどうかを設定する、または設定状態を返します。

CompressMDC プロパティー キューブをコンパクトに保存するために圧縮するかどうかを設定する、または設定状態を返します。

Consolidate プロパティー キューブを集約する方法を設定する、または設定状態を返します。

CubeCreation プロパティー キューブを作成するかどうかを設定する、または設定状態を返します。

CubeCustomViews プロパティー CubeCustomViews プロパティーの説明です。

CubeStamp プロパティー キューブ作成のタイム・スタンプを返します。

DataSourceWindowsLocation プロパティー IBM Cognos Analytics サーバーにおける、Windows 上の PowerCube の場所を設定する、または設定状態を返します。

Description プロパティー Cube オブジェクトの説明を設定する、または設定状態を返します。

DesiredPartitionSize プロパティー 自動パーティションが有効な場合に、必要なパーティション・サイズを設定するか、または返します。

第 3 章 オブジェクト 63

プロパティー 説明

DimensionView プロパティー キューブまたはカスタム・ビューに関連付けられている View オブジェクトを設定するか、設定状態を返します。

DimensionViewType プロパティー キューブに属するディメンションと表示を設定する、または設定状態を返します。

DrillThroughTargets プロパティー Cube オブジェクトに関連付けられているDrillThroughTarget オブジェクトのコレクションを返します。

EstimatedRows プロパティー 自動パーティションの前にキューブに含まれるレコード数の推定値を設定する、または設定状態を返します。

IncrementalUpdate プロパティー キューブをデータ・ソースからインクリメンタルに更新するかどうかを設定する、または設定状態を返します。

IsMDCInUse プロパティー 子キューブが使用中または再構築中であるかを返します。

MaxNumPartLevels プロパティー Transformer でキューブをパーティション化するときに、データ・ソースを読み取る最大回数を設定する、または設定状態を返します。

MDCFile プロパティー PowerCube ファイル (.mdc) の名前を設定する、または設定状態を返します。

MeasureInclude プロパティー Cube オブジェクトに含まれる数値データの名前を設定する、または設定状態を返します。

MeasureName プロパティー PowerPlay ディメンション・ラインの数値データを識別する説明的なタイトルを設定する、または設定状態を返します。

Name プロパティー オブジェクトの名前を設定する、または設定状態を返します。

Optimize プロパティー 現在のキューブの最適化オプションを設定する、または設定状態を返します。

Parent プロパティー 親オブジェクトを返します。

Password プロパティー キューブのパスワードを設定します (大文字と小文字を区別)。

64 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

プロパティー 説明

Server プロパティー キューブをローカルで処理するか、サーバーで処理するかを設定する、または設定状態を返します。

Signon プロパティー キューブが使用する Signon オブジェクトを設定する、または設定状態を返します。

Status プロパティー キューブを最後に作成したときに関連付けられた問題のステータスを返します。

Type プロパティー オブジェクトのタイプを返します。

UseAltMDCFile プロパティー 一時ファイル名を使用できるかどうかを設定する、または設定状態を返します。

例objCube = objModel.Cubes.Item(1)

CubeGroup オブジェクトCubeGroup オブジェクトは、関連する子キューブのセットを定義します。

解説

このオブジェクトは、キューブ・グループの内容を定義するために使用します。キューブ・グループは、ディメンション内の 1 つのレベルを表します。グループの各ChildCube オブジェクトは、そのレベルの 1 つのカテゴリーを反映します。

CubeGroup オブジェクトを作成するには、Cubes コレクションの Add メソッドを使用し、Type パラメーターを trCubeGroup に設定します。

キューブ・グループの内容を決定するには、GroupDimension プロパティーおよびGroupLevel プロパティーを使用します。実際の PowerCube ファイル (.mdc)は、CreateMDCFile メソッドで作成します。

このオブジェクトのプロパティーへの変更を保存するには、Update メソッドを使用します。

関連トピック

次の表は、関連するコレクション、メソッド、プロパティーを示します。

メソッド 説明

CreateMDCFile メソッド キューブ・グループの定義に基づいてPowerCube ファイル (.mdc) を作成します。

第 3 章 オブジェクト 65

メソッド 説明

Delete メソッド CubeGroup オブジェクトと子キューブすべてを削除します。

Update メソッド CubeGroup オブジェクトを更新します。

プロパティー 説明

AllowDrillThrough プロパティー キューブまたは数値データを、キューブまたはレポートへドリルスルーできるかどうかを設定する、または設定状態を返します。

AlternateQueryPath プロパティー グループ内のキューブが使用する代替データ・ソースを設定する、または設定状態を返します。

AltMDCFile プロパティー キューブの代替ファイル名を設定する、または設定状態を返します。

Application プロパティー Transformer Application オブジェクトを返します。

CacheCrossTabs プロパティー キューブ・グループの最初の PowerPlay クロス集計のために集計をキャッシュするかどうかを設定する、または設定状態を返します。

ChildCubes プロパティー キューブ・グループから ChildCube オブジェクトのコレクションを返します。

CompressMDC プロパティー キューブをコンパクトに保存するために圧縮するかどうかを設定する、または設定状態を返します。

Consolidate プロパティー キューブを集約する方法を設定する、または設定状態を返します。

CubeCreation プロパティー キューブを作成するかどうかを設定する、または設定状態を返します。

CubeCustomViews プロパティー CubeCustomViews プロパティーの説明です。

CubeStamp プロパティー キューブ作成のタイム・スタンプを返します。

Description プロパティー CubeGroup オブジェクトの説明を設定する、または設定状態を返します。

66 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

プロパティー 説明

DesiredPartitionSize プロパティー 自動パーティションが有効な場合に、必要なパーティション・サイズを設定するか、または返します。

DetailLevel プロパティー CubeGroup オブジェクトのキューブについて最下位の詳細レベルを設定する、または設定状態を返します。

DimensionView プロパティー キューブまたはカスタム・ビューに関連付けられている View オブジェクトを設定するか、設定状態を返します。

DimensionViewType プロパティー キューブ・グループに属するディメンションとビューを設定する、または設定状態を返します。

DrillThroughTargets プロパティー CubeGroup オブジェクトに関連付けられている DrillThroughTarget オブジェクトのコレクションを返します。

EstimatedRows プロパティー 自動パーティションの前にキューブに含まれるレコード数の推定値を設定する、または設定状態を返します。

GroupDimension プロパティー キューブ・グループを構築するために使用するディメンションを設定する、または設定状態を返します。

GroupLevel プロパティー キューブ・グループに属するカテゴリーが、個々のキューブになるレベルを設定する、または設定状態を返します。

IncrementalUpdate プロパティー キューブ・グループをデータ・ソースからインクリメンタルに更新するかどうかを設定する、または設定状態を返します。

IsMDCInUse プロパティー 子キューブが使用中または再構築中であるかを返します。

IsTimeBasedPartitionedCube プロパティー キューブが時系列にパーティション化されたキューブとして指定されているかどうかを設定するか、設定状態を返します。

MaxNumPartLevels プロパティー Transformer でキューブをパーティション化するときに、データ・ソースを読み取る最大回数を設定する、または設定状態を返します。

第 3 章 オブジェクト 67

プロパティー 説明

MDCFile プロパティー PowerCube ファイル (.mdc) の名前を設定する、または設定状態を返します。

MeasureInclude プロパティー キューブ・グループに含める数値データの名前を設定する、または設定状態を返します。

MeasureName プロパティー PowerPlay ディメンション・ラインの数値データを識別する説明的なタイトルを設定する、または設定状態を返します。

Name プロパティー オブジェクトの名前を設定する、または設定状態を返します。

Optimize プロパティー 現在のキューブの最適化オプションを設定する、または設定状態を返します。

Parent プロパティー 親オブジェクトを返します。

Password プロパティー キューブ・グループのパスワードを設定します (大文字と小文字を区別)。

Server プロパティー キューブをローカルで処理するか、サーバーで処理するかを設定する、または設定状態を返します。

Signon プロパティー キューブ・グループが使用する Signon オブジェクトを設定する、または設定状態を返します。

Status プロパティー キューブを最後に作成したときに関連付けられた問題のステータスを返します。

SummaryLevel プロパティー キューブ・グループの外部カテゴリーを集計するために使用するレベルを設定する、または設定状態を返します。

Type プロパティー オブジェクトのタイプを返します。

UseAltMDCFile プロパティー 一時ファイル名を使用できるかどうかを設定する、または設定状態を返します。

例objCubesByRegion = objModel.Cubes.Add(xtrObjectType.trCubeGroup)

CurrencyRate オブジェクトCurrencyRate オブジェクトは、通貨変換用の換算レートを定義します。

68 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

解説

CurrencyRate オブジェクトは、手動で管理するか、またはデータ・ソースから取り込みます。各通貨レートには、レートの適用期間を設定する日付カテゴリーが関連付けられます。

CurrencyRate オブジェクトは、自動的に CurrencyRecord オブジェクトに追加されます。CurrencyRecord オブジェクトに関連付けられる CurrencyRate オブジェクトの数は、DateLevel プロパティーに指定した日付レベルと時間ディメンションに定義した日付範囲に対応します。例えば、詳細レベルを月に、日付範囲を 2 年に設定した場合、通貨レコードの通貨レートの数は 24 になります。

通貨変換が正しく機能するには、CurrencyRate、CurrencyRecord、CurrencyTable、DateDimension のすべてのオブジェクトが必要です。

このオブジェクトのプロパティーへの変更を保存するには、Update メソッドを使用します。

関連トピック

次の表は、関連するコレクション、メソッド、プロパティーを示します。

メソッド 説明

Delete メソッド CurrencyRate オブジェクトを削除します。

Update メソッド CurrencyRate オブジェクトを更新します。

プロパティー 説明

Application プロパティー Transformer Application オブジェクトを返します。

Category プロパティー 通貨レートが有効な期間を決定する日付カテゴリーを返します。

CurrencyRecord プロパティー CurrencyRate オブジェクトが適用されるCurrencyRecord オブジェクトを返します。

CurrencyTable プロパティー 関連付けられた CurrencyTable オブジェクトを返します。

Parent プロパティー 親オブジェクトを返します。

PopulateByDataSource プロパティー 通貨レートをデータ・ソースから取り込むか、Transformer で設定するかを設定する、または設定状態を返します。

Rate プロパティー 通貨交換レートを設定する、または設定状態を返します。

Type プロパティー オブジェクトのタイプを返します。

例objCurrencyRecord = objModel.CurrencyRecords.Add()objCurrencyRate= objCurrencyRecord.CurrencyRates(intX)

第 3 章 オブジェクト 69

CurrencyRecord オブジェクトCurrency Record オブジェクトは、通貨情報の表示方法を定義します。

解説

このオブジェクトは次の場合に使用します。

v 通貨レートの日付レベルを指定します。

v PowerPlay で通貨を表示するために必要な情報を定義します。

この情報には、通貨名、通貨コード、通貨記号、小数桁数が含まれます。CurrencyDecimals プロパティーおよび CurrencySymbol プロパティーは、CurrencyFormatOverride プロパティーを True に設定しなければ変更できません。

データ・ソースを使用して通貨表にデータを取り込む場合は、自動的にCurrencyRecord オブジェクトがモデルに追加されます。各レコードには通貨レートが関連付けられます。

CurrencyRecord オブジェクトを明示的に作成するには、CurrencyRecords コレクションの Add メソッドを使用します。この場合は、自動的に CurrencyRate オブジェクトが生成されますが、レートを手動で管理する必要があります。

通貨変換が正しく機能するには、CurrencyRate、CurrencyRecord、CurrencyTable、DateDimension のすべてのオブジェクトが必要です。

このオブジェクトのプロパティーへの変更を保存するには、Update メソッドを使用します。

関連トピック

次の表は、関連するコレクション、メソッド、プロパティーを示します。

メソッド 説明

Delete メソッド CurrencyRecord オブジェクトを削除します。

Update メソッド CurrencyRecord オブジェクトを更新します。

プロパティー 説明

Application プロパティー Transformer Application オブジェクトを返します。

CountryCode プロパティー 通貨レコードを適用する国または地域の ISOコードを設定する、または設定状態を返します。

70 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

プロパティー 説明

CurrencyCountryLabel プロパティー 通貨の国または地域のラベルを設定するか、設定状態を返します。

CurrencyDecimals プロパティー 通貨に使用する小数桁数を設定する、または設定状態を返します。

CurrencyFormatOverride プロパティー 通貨の標準書式をオーバーライドできるかどうかを設定する、または設定状態を返します。

CurrencyIsEMU プロパティー レコードが EMU の通貨レコードかどうかを設定する、または設定状態を返します。

CurrencyIsEuro プロパティー 通貨レコードが基準ユーロ通貨かどうかを設定する、または設定状態を返します。

CurrencyRates プロパティー CurrencyRates コレクションを返します。

CurrencySymbol プロパティー 通貨に関連付けられた通貨記号を設定する、または設定状態を返します。

DateLevel プロパティー 通貨レートが適用される時間ディメンションのレベルを設定する、または設定状態を返します。

EMUEntryDate プロパティー 通貨のユーロ Triangulation (3 通貨変換) の計算を開始する日付を設定する、または設定状態を返します。

Label プロパティー PowerPlay に表示される説明的な名前を設定する、または設定状態を返します。

Parent プロパティー 親オブジェクトを返します。

Type プロパティー オブジェクトのタイプを返します。

例objCurrencyRecord = objModel.CurrencyRecords.Add()

CurrencyTable オブジェクトCurrencyTable オブジェクトは、通貨変換で使用される通貨表を定義します。

解説

このオブジェクトは、通貨レコードおよびレートの設定に使用します。

CurrencyTable オブジェクトを作成するには、CurrencyTables コレクションのAdd メソッドを使用します。データ・ソースを使用して通貨表にデータを取り込む

第 3 章 オブジェクト 71

場合は、自動的に CurrencyRecord オブジェクトがモデルに追加されます。各レコードには通貨レートが関連付けられます。

通貨表に通貨レコードを手動で追加することもできます。この場合は、新規の各CurrencyRecord オブジェクトに自動的に CurrencyRate オブジェクトが生成されますが、レートを手動で管理する必要があります。

通貨変換が正しく機能するには、CurrencyRate、CurrencyRecord、CurrencyTable、DateDimension のすべてのオブジェクトが必要です。

欧州通貨統合 (EMU) に加盟していない通貨変換または 1999 年より前の EMU 通貨変換では、CurrencyTableType プロパティーを trCurrencyTableBase に設定した1 つのテーブルのみが必要です。基準テーブルには、最初にデフォルトの通貨 (米国ドルなど) が表示されます。これは、オペレーティング・システムの地域の設定に基づいています。この設定は、他の任意の通貨 (ユーロを含む) に変更できます。

1999 年以降の EMU 通貨変換では、2 つのテーブルが必要です。一方のテーブルの CurrencyTableType プロパティーを trCurrencyTableBase に、もう一方のテーブルの CurrencyTableType プロパティーを trCurrencyTableEuro に設定します。ユーロ表には、ユーロと基準通貨を変換の中間値として使用することにより EMUの各国または地域の通貨の値を換算するための固定変換レートが設定されます。このプロセスをユーロ Triangulation と呼びます。ユーロ Triangulation が正しく機能するように、日付レベルを昇順にソートし、各日付レベルの Unique プロパティーを True に設定します。EMU 加盟国の 1999 年 1 月 1 日以降のレコードについては、日付フィールドに 0 を指定します。

必要な乗算、除算、切り上げ、切り捨てなどの演算は、すべて PowerPlay で実行されます。

基準テーブルの通貨データは、複数のデータ・ソースから取り込むことができます。ただし、情報が正しく結合されるように、列名はすべて一致しなければなりません。ユーロ表にも同じ必要条件が適用されますが、ユーロ表と関連付ける列には別の名前を割り当てる必要があります。

データ・ソースを使用してテーブルにデータを取り込む場合は、GeneratePowerCube プロパティーを trGenerationNoCreatePowerCubes に、GenerateCategories プロパティーを False に設定します。この操作により、CurrencyTable オブジェクトを更新しても、モデルの他のカテゴリー生成に影響しなくなります。データ・ソースの日付列の名前が基準通貨とユーロ通貨で異なり、時間ディメンションの列名とも異なる場合は、これらのプロパティーを使用可能にしておくことができます。同名の場合、Transformer ではそれらを区別できません。

このオブジェクトのプロパティーへの変更を保存するには、Update メソッドを使用します。

72 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

関連トピック

次の表は、関連するコレクション、メソッド、プロパティーを示します。

メソッド 説明

AssociateWith メソッド CurrencyTable オブジェクトに作成元オブジェクトを関連付けます。

Delete メソッド CurrencyTable オブジェクトを削除します。

Update メソッド CurrencyTable オブジェクトを更新します。

プロパティー 説明

Application プロパティー Transformer Application オブジェクトを返します。

Associations プロパティー Associations コレクションを返します。

CurrencyTableType プロパティー 通貨表のタイプを設定する、または設定状態を返します。

Name プロパティー オブジェクトの名前を設定する、または設定状態を返します。

Parent プロパティー 親オブジェクトを返します。

Type プロパティー オブジェクトのタイプを返します。

例objBaseTable = objModel.CurrencyTables.Add()

CustomView オブジェクトCustomView オブジェクトは、カスタム・ビューを表します。

解説

このオブジェクトは、モデルから生成されるキューブに基本セキュリティーを設定するために使用します。各カスタム・ビューは、類似の職務を担当するため、類似の情報を必要とするユーザー、グループ、役割などのセキュリティー・オブジェクトからなります。

各 CustomView オブジェクトには、各ディメンションに 1 つずつ View オブジェクトからなるコレクションが自動的に設定されます。コレクションの各オブジェクトのデフォルト・ビューは、"All Categories"です。このビューは、DimensionInclude プロパティーを使用して全カテゴリーを省略したりカスタム・ビューを作成することにより変更できます。

第 3 章 オブジェクト 73

カスタム・ビューは、PowerPlay ユーザーにキューブ情報の特定のサブセットを表示します。例えば、レベル全体またはレベル内の各カテゴリーを要約できます。カスタム・ビュー (trViewTypeCustom) を指定する場合は、DimensionView プロパティーを使用して Dimension に関連付けられている View オブジェクトを返す必要があります。次に、Apex プロパティーを使用して新規のルート・カテゴリーを作成したり、SetViewStatus メソッドを使用して選択したレベルまたはカテゴリーに View オブジェクトを関連付けることができます。

カスタム・ビューを使用してビューを完了するには、カスタム・ビューをキューブに関連付ける必要があります。Add メソッドを使用して、キューブのCubeCustomViews コレクションに CustomView オブジェクトを追加します。

CustomView オブジェクトは、モデルで定義され、CustomViews プロパティーにより返されます。DimensionInclude などの Transformer CustomView オブジェクトのプロパティーは、Transformer 内のカスタム・ビューの有効範囲を指定するように変更できます。

キューブの全部または一部のアクセスを制御するには、ネームスペースでユーザーのグループを定義してから Transformer モデルでカスタム・ビューをキューブに関連付けます。

例えば、全体の業績データが製品系列、販売店、地域別に分類されているモデルを開きます。各キューブが特定の地域については詳細な業績データを表示し、他の地域については要約されたデータを表示するようなキューブ・グループを作成します。各販売チームが自分の地域の詳細な情報にアクセスできるように、カスタム・ビューを定義して適用します。

このオブジェクトのプロパティーへの変更を保存するには、Update メソッドを使用します。

関連トピック

次の表は、関連するコレクション、メソッド、プロパティーを示します。

メソッド 説明

Delete メソッド CustomView オブジェクトを削除します。

Update メソッド CustomView オブジェクトを更新します。

プロパティー 説明

Application プロパティー Transformer Application オブジェクトを返します。

ChildCustomViews プロパティー CustomView オブジェクトのコレクションを返します。

Description プロパティー CustomView オブジェクトの説明を返します。

74 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

プロパティー 説明

DimensionInclude プロパティー カスタム・ビューのビューのタイプを設定するか、設定状態を返します。

DimensionView プロパティー カスタム・ビューに関連付けられているView オブジェクトを返します。

MeasureInclude プロパティー 数値データを CustomView オブジェクトに適用するかどうかを決定する Boolean 値を設定するか、設定状態を返します。

Name プロパティー オブジェクトの名前を設定する、または設定状態を返します。

Parent プロパティー 親オブジェクトを返します。

SecurityObjects プロパティー カスタム・ビューに関連付けられているSecurityObjects のコレクションを返します。

Type プロパティー オブジェクトのタイプを返します。

Views プロパティー Views コレクションを返します。

例custom_view = model.CustomViews.Add()

DataSource オブジェクトDataSource オブジェクトは、一般的なデータ・ソースを定義します。

解説

このオブジェクトは、DataSources コレクションのオブジェクト参照に使用します。DataSource オブジェクトは一般的なデータ・ソースを表すため、基礎になるデータ・ソースを反映するようにプロパティーが変更されます。

DataSource オブジェクトの xtrObjectType 値リストには Type 定数がありません。Type プロパティーの値は、オブジェクトが現在表しているデータ・ソースから取得します。このため (また、その他の相違から)、DataSource オブジェクトは、IqdDataSource のような特殊なデータ・ソース・オブジェクトほど効率的ではありません。

DataSource オブジェクトの全機能を活用するには、Visual Basic または VB 互換エディターで次の文を使用します。

Dim objDataSource As CognosTransformer.DataSource

このオブジェクトのプロパティーへの変更を保存するには、Update メソッドを使用します。

第 3 章 オブジェクト 75

関連トピック

次の表は、関連するコレクション、メソッド、プロパティーを示します。

メソッド 説明

Delete メソッド DataSource オブジェクトを削除します。

Move メソッド DataSource オブジェクトを DataSources コレクションの別の位置へ移動します。

Update メソッド DataSource オブジェクトを更新します。

プロパティー 説明

Application プロパティー Transformer Application オブジェクトを返します。

Description プロパティー DataSource オブジェクトの説明を設定する、または設定状態を返します。

GenerateCategories プロパティー データ・ソースのカテゴリーを生成するかどうかを設定する、または設定状態を返します。

GeneratePowerCube プロパティー モデルでデータ・ソースを参照するかどうかを設定する、または設定状態を返します。

IsAnyColumnMismatched プロパティー データ・ソースの列が基礎になるデータと一致するかどうかを返します。

MaximizeSpeed プロパティー カテゴリーの生成速度を最適化するかどうかを設定する、または設定状態を返します。

Name プロパティー データ・ソースの一意の名前を設定する、または設定状態を返します。

Parent プロパティー 親オブジェクトを返します。

ServerQuery プロパティー データをローカルで処理するか、サーバーで処理するかを設定する、または設定状態を返します。

SetsCurrentPeriod プロパティー Transformer でデータ・ソースから現在期間の日付を検索するかどうかを設定する、または設定状態を返します。

SourceType プロパティー データ・ソースで使用するデータ・ファイルのタイプを設定する、または設定状態を返します。

76 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

プロパティー 説明

Type プロパティー DataSource オブジェクトが現在参照している基礎のデータ・ソースのタイプを返します。

例objDataSource = objModel.DataSources.Add(xtrObjectType.trFlatFileDataSource)

DateDimension オブジェクトDateDimension オブジェクトは、日付データを論理グループに編成します。

解説

時間ディメンションは、ビジネスの主要な側面の 1 つとして時間ベースの情報を表す階層的構造です。時間ディメンションは、DrillDowns コレクションと 1 つ以上の DateDrillDown オブジェクト (ドリルダウン・パスを表す) からなります。

DateDimension オブジェクトは、モデルに時間のコンテキストを追加するために使用します。少なくとも 1 つの DateDimension オブジェクトを追加しない限り、キューブの有用性の大部分 (利益や費用の追跡など) は失われてしまいます。また、通貨変換も時間ディメンションがないと使用できません。

DoAutoDesign メソッドを使用すると、Transformer は自動的にデータ・ソースの日付定義に基づいて時間ディメンションを作成します。

DateDimension オブジェクトは、次の 2 とおりの方法により手動で作成することもできます。

v DateWizard オブジェクトの、適用されるすべてのプロパティーを設定し、DimensionAssociateWith メソッドを使用してデータ・ソースを割り当てます。次に、CreateDateDimension メソッドを使用します。このプロセスでは、ディメンションとともにドリルダウン・パスと日付レベルも作成されます。年間累計などの相対時間カテゴリーも生成されます。

v Dimensions コレクションの Add メソッドを使用し、Type パラメーターをtrDateDimension に設定します。オブジェクトの Name プロパティーを設定する必要があります。次に、AssociateWith メソッドを使用してデータ・ソースを割り当てます。この手順では、ドリルダウン・パスが作成され、後から日付レベルと相対時間カテゴリーを追加できます。

このオブジェクトのプロパティーへの変更を保存するには、Update メソッドを使用します。

第 3 章 オブジェクト 77

関連トピック

次の表は、関連するコレクション、メソッド、プロパティーを示します。

メソッド 説明

AssociateWith メソッド DateDimension オブジェクトに作成元オブジェクトを関連付けます。

CleanHouse メソッド 時間ディメンションから非アクティブなカテゴリーを削除します。

Delete メソッド DateDimension オブジェクトを削除します。

GenerateDateCategories メソッド モデルに StartDate と EndDate に指定した日付カテゴリーを生成します。

Move メソッド 時間ディメンションを Dimensions コレクションの別の位置に移動します。

SetAllocation メソッド オブジェクトで使用する数値データの割り当てタイプを変更します。

Update メソッド DateDimension オブジェクトを更新します。

プロパティー 説明

AllocationMeasure プロパティー 加重係数として使用する Measure オブジェクトを返します。

AllocationType プロパティー オブジェクトで数値データを割り当てる方法を返します。

Application プロパティー Transformer Application オブジェクトを返します。

Associations プロパティー Associations コレクションを返します。

CalculationDefinitions プロパティー CalculationDefinition オブジェクトのコレクションを返します。

CanAllocate プロパティー 数値データ値の値を子孫のレベルとカテゴリーに割り当てることができるかどうかを返します。

CanAllocateByMeasure プロパティー 数値データで割り当てるときに、指定した数値データを加重係数として使用できるかどうかを返します。

78 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

プロパティー 説明

CanAllocateMeasure プロパティー 指定した数値データを子孫のレベルとカテゴリーに割り当てることができるかどうかを返します。

Categories プロパティー DateDimension オブジェクトに含まれるカテゴリーのコレクションを返します。

CategoryCount プロパティー DateDimension オブジェクトに含まれる標準カテゴリー数を返します。

Description プロパティー DateDimension オブジェクトの説明を設定する、または設定状態を返します。

DimensionLevels プロパティー DimensionLevels コレクションを返します。

DrillDowns プロパティー DrillDowns コレクションを返します。

EarliestDate プロパティー 日付カテゴリーの範囲の開始日付を設定する、または設定状態を返します。

ExcludeAutoPartition プロパティー 時間ディメンションを自動パーティション・プロセスから除外するかどうかを設定する、または設定状態を返します。

GenerateTimePeriod プロパティー 時間ディメンションのカテゴリー生成オプションを設定する、または設定状態を返します。

GetDefaultCategory メソッド ディメンションに属するデフォルトのカテゴリーを返します。

LatestDate プロパティー 日付カテゴリーの範囲の最終日付を設定する、または設定状態を返します。

ManualCurrentPeriod プロパティー 現在の期間を手動で設定するか Transformerで設定するかを設定する、または設定状態を返します。

Name プロパティー DateDimension オブジェクトの名前を設定する、または設定状態を返します。

NewCatsLocked プロパティー 新規のカテゴリーを DateDimension オブジェクトに追加できるかどうかを設定する、または設定状態を返します。

Parent プロパティー 親オブジェクトを返します。

SetDefaultCategory メソッド シナリオ・カテゴリー・グループのルートまたは親以外の、ディメンションの新規デフォルト・カテゴリーを指定します。

第 3 章 オブジェクト 79

プロパティー 説明

SpecialCategoryCount プロパティー ディメンションのドリル、ルート、および特殊カテゴリーの数を返します。

Type プロパティー オブジェクトのタイプを返します。

Views プロパティー Views コレクションを返します。

WorkingDay プロパティー 週日かどうかを設定する、または設定状態を返します。

WorkingDays プロパティー 週日を設定する、または設定状態を返します。

例objDateDim = objModel.Dimensions("Date")

DateDrillDown オブジェクトDateDrillDown オブジェクトは、日付や時刻の主ドリルダウン・パスと代替ドリルダウン・パスを定義します。

解説

このオブジェクトは、主 DateDrillDown オブジェクトのプロパティーを変更、または代替 DateDrillDown オブジェクトを定義するために使用します。

時間ディメンションには DrillDowns コレクションがあります。時間ディメンションを構築すると、このコレクションに主 DateDrillDown オブジェクトがTransformer によって自動的に追加されます。コレクションの主ドリルダウン・パスは 1 つのみで、ユーザーは削除できません。コレクションの他のDateDrillDown オブジェクトは、すべてユーザーが作成する代替 DateDrillDownオブジェクトです。代替ドリルダウン・パスは、PowerPlay のデータについて別の視点を定義します。

代替ドリルダウン・パスは、IsPrimary プロパティーを使用して主ドリルダウン・パスに変更できます。

コレクションに DateDrillDown オブジェクトを追加するには、新規のドリルダウン・パスで最下位の詳細レベルにする DateLevel オブジェクトを返します。次に、指定した DateLevel オブジェクトの CreateAlternateDrillDown メソッドを使用して新規のドリルダウン・パスを作成します。このレベルは、既存のドリルダウン・パスと新規のドリルダウン・パスに共通なため、収束レベルと呼びます。

代替ドリルダウン・パスに日付レベルを追加するには、新規に作成したDateDrillDown オブジェクトの Add メソッドを使用します。次に、必要なドリルダウンの階層を反映するようにコレクションの順序を変更する必要があります。順序を変更して追加レベルを収束レベルより上位にシフトするには、Move メソッドを使用します。例えば、収束レベルを Weeks に設定し、Levels コレクションに

80 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

Years レベルを追加した場合、Move メソッドを使用して Years Level オブジェクトをコレクションの最上位に移動します。

代替ドリルダウン・パスは、必ずルート・カテゴリーから開始し、選択した収束レベルへと続きます。複数の親カテゴリーを同じ収束カテゴリーに正しく接続するには、収束レベルの各カテゴリーが一意であり、あいまいでないことが必要です。カテゴリーの一意性を指定するには、収束レベルの Unique プロパティーを True に設定します。

収束レベルとその下位レベルのカテゴリー値はすべてのドリルダウン・パスによって共有されるため、収束レベルまたはその下位レベルにある 1 つのパスのカテゴリーを削除または変更すると、他のすべてのドリルダウン・パスの同じカテゴリーが直接影響を受けます。

複数のドリルダウン・パスに属するカテゴリーには、複数の親カテゴリーがあります。親カテゴリーのコレクションを返すには、ParentCategories プロパティーを使用します。

時間ディメンションの代替ドリルダウン・パスについては、Transformer オンライン・ヘルプを参照してください。

このオブジェクトのプロパティーへの変更を保存するには、Update メソッドを使用します。

関連トピック

次の表は、関連するコレクション、メソッド、プロパティーを示します。

メソッド 説明

Delete メソッド DateDrillDown オブジェクトを削除します。

Update メソッド DateDrillDown オブジェクトを更新します。

プロパティー 説明

Application プロパティー Transformer Application オブジェクトを返します。

Categories プロパティー DateDrillDown オブジェクトに含まれるカテゴリーのコレクションを返します。

ConvergenceLevel プロパティー 代替ドリルダウン・パスの収束レベルを返します。

DrillCode プロパティー ディメンション全体で、ドリルダウン・カテゴリーを一意に識別するコードを設定する、または設定状態を返します。

第 3 章 オブジェクト 81

プロパティー 説明

DrillInclusion プロパティー DateDrillDown オブジェクトがキューブに含まれるかどうかを設定する、または設定状態を返します。

IsPrimary プロパティー ドリルダウン・パスが主ドリルダウン・パスかどうかを設定する、または設定状態を返します。

Levels プロパティー Levels コレクションを返します。

Lunar プロパティー オブジェクトが月暦年に基づくかどうかを設定する、または設定状態を返します。

Name プロパティー オブジェクトの名前を設定する、または設定状態を返します。

Parent プロパティー 親オブジェクトを返します。

ShortName プロパティー ドリルダウン・パスの短縮名を設定する、または設定状態を返します。

Type プロパティー オブジェクトのタイプを返します。

WeekAdd プロパティー 月暦年に追加する日数を設定する、または設定状態を返します。

WeekSpan プロパティー 2 つの年にまたがる週を扱う方法を設定する、または設定状態を返します。

WeekStart プロパティー 週の開始日を設定する、または設定状態を返します。

YearStartDay プロパティー 年の開始日を設定する、または設定状態を返します。

例objLocationsDim = objModel.Dimensions("Salesregions")objLevel = objLocationsDim.DrillDowns(1).Levels("Employee")objAltDrill= objLevel.CreateAlternateDrillDown

DateLevel オブジェクトDateLevel オブジェクトは、モデルに含まれる日付レベルを定義します。

解説

DateLevel オブジェクトは、PowerCube のデータに日付のコンテキスト (年、四半期、月など) を設定するために使用します。

82 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

モデルの各 DateDimension オブジェクトに、DateLevel オブジェクトが含まれるLevels コレクションがあります。レベルには次の 2 つのタイプがあります。

v データ・ソースから生成されるカテゴリーが含まれるソース・レベル。各ソース・レベルは、Association オブジェクトを通じてデータ・ソースの列とリンクされます。

v ソース列に関連付けない手動レベル。例えば、孤児カテゴリーが含まれる手動レベルを作成できます。

新規の DateLevel オブジェクトを作成するには、Levels コレクションの Add メソッドを使用します。

日付レベルを代替ドリルダウン・パスの収束レベルにするには、CreateAlternateDrillDown メソッドを使用します。

このオブジェクトのプロパティーへの変更を保存するには、Update メソッドを使用します。

関連トピック

次の表は、関連するコレクション、メソッド、プロパティーを示します。

コレクション 説明

LevelCategories コレクション レベルに含まれるカテゴリーのコレクションを返します。

メソッド 説明

AssociateWith メソッド DateLevel オブジェクトに作成元オブジェクトを関連付けます。

CreateAlternateDrillDown メソッド ディメンションに代替ドリルダウン・パスを作成し、レベルを収束レベルにします。

Delete メソッド DateLevel オブジェクトを削除します。

Move メソッド DateLevel オブジェクトを Levels コレクションの別の位置に移動します。

SetAllocation メソッド オブジェクトで使用する数値データの割り当てタイプを変更します。

Update メソッド DateLevel オブジェクトを更新します。

プロパティー 説明

AllocationMeasure プロパティー 加重係数として使用する Measure オブジェクトを返します。

第 3 章 オブジェクト 83

プロパティー 説明

AllocationType プロパティー オブジェクトで数値データを割り当てる方法を返します。

Application プロパティー Transformer Application オブジェクトを返します。

Associations プロパティー Associations コレクションを返します。

BlankSubstitute プロパティー 日付レベルに生成された空白カテゴリーに割り当てるデフォルトのラベルを設定する、または設定状態を返します。

CanAllocate プロパティー 数値データ値の値を子孫の日付レベルとカテゴリーに割り当てることができるかどうかを返します。

CanAllocateByMeasure プロパティー 数値データで割り当てるときに、指定した数値データを加重係数として使用できるかどうかを返します。

CanAllocateMeasure プロパティー 指定した数値データを子孫の日付レベルとカテゴリーに割り当てることができるかどうかを返します。

CategoryCount プロパティー DateLevel オブジェクトに含まれる標準カテゴリー数を返します。

DateFormat プロパティー 日付を表示する書式を設定する、または設定状態を返します。

DateFunction プロパティー レベルに生成される日付カテゴリーを設定する、または設定状態を返します。

Description プロパティー DateLevel オブジェクトの説明を設定する、または設定状態を返します。

GenerateDateCategories プロパティー 日付レベルが日付カテゴリーを生成するかどうかを設定する、または設定状態を返します。

HasSubdimension プロパティー Level オブジェクトにサブディメンションが含まれるかどうかを返します。

Inclusion プロパティー キューブにカテゴリーが含まれるかどうかを設定する、または設定状態を返します。

IsManual プロパティー 日付レベルが手動で作成されたか、または生成されたかどうかを返します。

LevelDrillDowns プロパティー LevelDrillDowns コレクションを返します。

84 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

プロパティー 説明

Name プロパティー オブジェクトの名前を設定する、または設定状態を返します。

NewCatsLocked プロパティー DateLevel オブジェクトに新規カテゴリーを追加できるかどうかを設定する、または設定状態を返します。

OrderByDescending プロパティー 値を降順に表示するかどうかを設定する、または設定状態を返します。

OrderByStorageType プロパティー 列の保管タイプに基づいてカテゴリーをソートする方法を設定する、または設定状態を返します。

Parent プロパティー 親オブジェクトを返します。

Partition プロパティー 手動パーティション番号を設定する、または設定状態を返します。

QualifiedName プロパティー 日付レベルの絶対パス名を返します。

RefreshDescription プロパティー 説明を更新するかどうかを設定する、または設定状態を返します。

RefreshLabel プロパティー ラベルを更新するかどうかを設定する、または設定状態を返します。

RefreshShortName プロパティー 短縮名を更新するかどうかを設定する、または設定状態を返します。

TimeRank プロパティー 時間ディメンションに含まれる日付レベルの相対ランクを設定する、または設定状態を返します。

Type プロパティー オブジェクトのタイプを返します。

Unique プロパティー Transformer で日付レベルの各カテゴリーを一意のソース値で識別できるかどうかを設定する、または設定状態を返します。

UniqueMove プロパティー 関連付けられているカテゴリーを移動したときに一意の DateLevel オブジェクトを扱う方法を設定する、または設定状態を返します。

例objDateDim = objModel.Dimensions("Date")objDateLevel= objDateDim.DimensionLevels("Month")

第 3 章 オブジェクト 85

DateWizard オブジェクトDateWizard オブジェクトは、DateDimension オブジェクトを作成します。

解説

時間ディメンションは、ビジネスの時間ベースの情報を表す階層構造です。DateWizard オブジェクトを使用すると、DateDimension オブジェクトおよびDateLevel オブジェクトを簡単に構築できます。

最初に、モデル・オブジェクトの DateWizard プロパティーを使用してDateWizard オブジェクトを返します。次に、DateWizard オブジェクトの、適用されるすべてのプロパティーを設定し、DimensionAssociateWith メソッドを使用してデータ・ソースを割り当てます。最後に、CreateDateDimension メソッドを使用して新規の DateDimension オブジェクトを作成します。月暦階層を有効にするには、MonthType、QuarterType、YearType の各プロパティーを月暦の値に設定します。

関連トピック

次の表は、関連するコレクション、メソッド、プロパティーを示します。

メソッド 説明

CreateDateDimension メソッド DateWizard オブジェクトのプロパティーに基づいて DateDimension オブジェクトを作成します。

DimensionAssociateWith メソッド 新規の DateDimension オブジェクトにソース・オブジェクトを関連付けます。

プロパティー 説明

Application プロパティー Transformer Application オブジェクトを返します。

DimensionName プロパティー 新規 DateDimension オブジェクトの名前を設定します。

EarliestDate プロパティー 日付カテゴリーの範囲の開始日付を設定します。

EnableTimePeriod プロパティー 時間ディメンションの詳細レベルを設定します。

GeneratePowerCube プロパティー DateWizard オブジェクトが日付カテゴリーを生成するかどうかを設定します。

LatestDate プロパティー 日付カテゴリーの範囲の最終日付を設定します。

86 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

プロパティー 説明

MonthType プロパティー 時間ディメンションの月レベルを計算する方法を設定します。

Parent プロパティー 親オブジェクトを返します。

QuarterType プロパティー 時間ディメンションの四半期レベルを計算する方法を設定します。

Type プロパティー オブジェクトのタイプを返します。

WeekAdd プロパティー 月暦年に追加する日数を設定します。

WeekSpan プロパティー 2 つの年にまたがる週を扱う方法を設定します。

WeekStartDay プロパティー 週の開始日を設定します。

WorkingDay プロパティー 週日かどうかを設定します。

WorkingDays プロパティー 週日を設定します。

YearStartDay プロパティー 年の開始日を設定します。

YearType プロパティー 時間ディメンションの年レベルを計算する方法を設定します。

例objDateWizard = objModel.DateWizard

DbDataSource オブジェクトDbDataSource オブジェクトは、外部ファイルをデータベース形式で表します。

解説

このオブジェクトは、データベース形式の外部ファイルと接続するために使用します。

DbDataSource オブジェクトを作成するには、DataSources コレクションの Addメソッドを使用します。Type パラメーターは trDbDataSource 定数に設定します。SourceType プロパティーは、開くデータベース・ファイルのタイプに設定します。データ・ファイルの場所を指定するには、適用される LocalPath またはServerPath プロパティーを使用します。

DbDataSource オブジェクトには、Columns コレクションがあります。列は、ディメンションに含まれるレベルのソースになります。

Transformer では、次のデータベース情報を使用できます。

第 3 章 オブジェクト 87

v dBase

v Excel

v Access

v Paradox

v FoxPro

v Clipper

このプロパティーを使用して、例えば Access データベース (.mdb) のテーブルを指定できます。

ODBC データ・ソースを参照する Access クエリーを使用すると、サーバー・ベースのデータを Transformer に取り込むことができます。Access クエリーをソースとして使用する場合、Columns コレクションは、データベースを参照する SQL クエリーから生成されます。

Paradox のテーブルを Jet engine for Paradox のデフォルトの設定である ASCII以外のソート・キーで使用する場合は、主インデックス・ファイル (.px) をParadox と同じ場所に保存する必要があります。Windows のレジストリー・キーも、データベース・ファイル (.db) のテーブルをインポートする前に、テーブル作成時に使用するソート・キーの値に変更する必要があります。有効な値は次のとおりです。

v ASCII

v インターナショナル

v Norwegian-Danish

v 日本語

v Swedish-Finnish

このオブジェクトのプロパティーへの変更を保存するには、Update メソッドを使用します。

関連トピック

次の表は、関連するコレクション、メソッド、プロパティーを示します。

メソッド 説明

Delete メソッド DbDataSource オブジェクトを削除します。

Move メソッド DbDataSource オブジェクトを DataSourcesコレクションの別の位置に移動します。

Update メソッド DbDataSource オブジェクトを更新します。

プロパティー 説明

Application プロパティー Transformer Application オブジェクトを返します。

88 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

プロパティー 説明

Columns プロパティー Columns コレクションを返します。

ColumnsLoaded プロパティー モデルの構築にデータ・ソースの列を使用したかどうかを返します。

DataRange プロパティー データ・ソースのデータベース範囲の名前を設定する、または設定状態を返します。

DecimalPoint プロパティー 小数点に使用する区切り文字を設定する、または設定状態を返します。

Description プロパティー DbDataSource オブジェクトの説明を設定する、または設定状態を返します。

External プロパティー モデルでデータ・ソースの値を使用するときに集計または自動集計として扱うかどうかを設定する、または設定状態を返します。

GenerateCategories プロパティー データ・ソースのカテゴリーを生成するかどうかを設定する、または設定状態を返します。

GeneratePowerCube プロパティー モデルでデータ・ソースを参照するかどうかを設定する、または設定状態を返します。

IsAnyColumnMismatched プロパティー データ・ソースの列が基礎になるデータと一致するかどうかを返します。

LocalPath プロパティー ローカル・データ・ソースの場所を設定する、または設定状態を返します。

MaximizeSpeed プロパティー カテゴリーの生成速度を最適化するかどうかを設定する、または設定状態を返します。

Name プロパティー データ・ソースの一意の名前を設定する、または設定状態を返します。

Parent プロパティー 親オブジェクトを返します。

ServerPath プロパティー データ・ソース・ファイルの名前と場所を設定する、または設定状態を返します。

ServerQuery プロパティー データをローカルで処理するか、サーバーで処理するかを返します。

SetsCurrentPeriod プロパティー Transformer でデータ・ソースから現在期間の日付を検索するかどうかを設定する、または設定状態を返します。

第 3 章 オブジェクト 89

プロパティー 説明

SourceType プロパティー データ・ソースで使用するデータ・ファイルのタイプを設定する、または設定状態を返します。

ThousandPoint プロパティー 1000 の区切りに使用する文字を設定する、または設定状態を返します。

Type プロパティー オブジェクトのタイプを返します。返されるオブジェクト・タイプは trDbQuery ですが、DataSources コレクションからのアイテムの追加または取得にはxtrObjectType.trDbDataSource タイプを使用する必要があります。

Dimension オブジェクトDimension オブジェクトは、日付以外のデータを論理グループに編成します。

解説

Dimension オブジェクトは、数値データやテキスト・データを表す Level オブジェクトおよび DrillDown オブジェクトをグループ化するために使用します。ディメンションは、ビジネスの主要な各側面の情報を表す階層的構造です。

DoAutoDesign メソッドを使用すると、Transformer では自動的にデータ・ソースのパターンと関係に基づいてディメンションとその Level オブジェクトおよびDrillDown オブジェクトが作成されます。

Dimension オブジェクトを手動で作成することもできます。最初に Dimensions コレクションの Add メソッドを使用します。次に、ディメンション内の適用されるコレクションに Level オブジェクトを追加します。

日付または時刻のデータには、代わりに DateDimension オブジェクトを使用します。

このオブジェクトのプロパティーへの変更を保存するには、Update メソッドを使用します。

関連トピック

次の表は、関連するコレクション、メソッド、プロパティーを示します。

メソッド 説明

AssociateWith メソッド Dimension オブジェクトに作成元オブジェクトを関連付けます。

CleanHouse メソッド ディメンションから非アクティブなカテゴリーを削除します。

Delete メソッド Dimension オブジェクトを削除します。

90 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

メソッド 説明

FindCategoryByCatCode メソッド 指定したカテゴリー・コードの文字列を含む、カテゴリー・オブジェクトを返します。

GetDefaultCategory メソッド ディメンションに属するデフォルトのカテゴリーを返します。

Move メソッド ディメンションを Dimensions コレクションの別の位置に移動します。

SetAllocation メソッド オブジェクトで使用する数値データの割り当てタイプを変更します。

SetDefaultCategory メソッド シナリオ・カテゴリー・グループのルートまたは親以外の、ディメンションの新規デフォルト・カテゴリーを指定します。

Update メソッド Dimension オブジェクトを更新します。

プロパティー 説明

AllocationMeasure プロパティー 加重係数として使用する Measure オブジェクトを返します。

AllocationType プロパティー オブジェクトで数値データを割り当てる方法を返します。

Application プロパティー Transformer Application オブジェクトを返します。

Associations プロパティー Associations コレクションを返します。

CalculationDefinitions プロパティー CalculationDefinition オブジェクトのコレクションを返します。

CanAllocate プロパティー 数値データ値の値を子孫のレベルとカテゴリーに割り当てることができるかどうかを返します。

CanAllocateByMeasure プロパティー 数値データで割り当てるときに、指定した数値データを加重係数として使用できるかどうかを返します。

CanAllocateMeasure プロパティー 指定した数値データを子孫のレベルとカテゴリーに割り当てることができるかどうかを返します。

Categories プロパティー Dimension オブジェクトに含まれる特殊カテゴリーのコレクションを返します。

CategoryCount プロパティー Dimension オブジェクトの標準カテゴリー数を返します。

Description プロパティー Dimension オブジェクトの説明を設定する、または設定状態を返します。

DimensionLevels プロパティー DimensionLevels コレクションを返します。

DrillDowns プロパティー DrillDowns コレクションを返します。

ExcludeAutoPartition プロパティー ディメンションを自動パーティション・プロセスから除外するかどうかを設定する、または設定状態を返します。

Name プロパティー オブジェクトの名前を設定する、または設定状態を返します。

第 3 章 オブジェクト 91

プロパティー 説明

NewCatsLocked プロパティー 新規のカテゴリーを Dimension オブジェクトに追加できるかどうかを設定する、または設定状態を返します。

Parent プロパティー 親オブジェクトを返します。

SpecialCategoryCount プロパティー ディメンションのドリル、ルート、および特殊カテゴリーの数を返します。

Type プロパティー オブジェクトのタイプを返します。

Views プロパティー Views コレクションを返します。

例objDimensions = objModel.DimensionsobjLocationsDim= objDimensions.Item(3)

DrillDown オブジェクトDrillDown オブジェクトは、キューブをナビゲートするために使用する主ドリルダウン・パスと代替ドリルダウン・パスを定義します。

解説

DrillDowns コレクションには、1 つの主ドリルダウン・パスが含まれます。DrillDowns コレクションの他のドリルダウン・パスは、すべてユーザーが作成する代替ドリルダウン・パスです。代替ドリルダウン・パスは、PowerPlay のデータについて別の視点を定義します。

このオブジェクトは、主ドリルダウン・パスのプロパティーを変更するため、または代替ドリルダウン・パスを定義するために使用します。Transformer で作成したデフォルトの主ドリルダウン・パスは削除できません。

新規の代替 DrillDown オブジェクトを DrillDowns コレクションに追加するには、代替ドリルダウン・パスの収束レベルにする Level オブジェクトにCreateAlternateDrillDown メソッドを適用します。選択したレベルは、新規のDrillDown オブジェクトの Levels コレクションの最初のレベルになります。次に、Add メソッドを使用して、この Levels コレクションにレベルを追加します。Add メソッドは常に新しいレベルをコレクションの最後に追加するため、Move メソッドを使用して追加レベルを収束レベルの上位にシフトします。

代替ドリルダウン・パスは、必ずルート・カテゴリーから開始し、選択した収束レベルへと続きます。複数の親カテゴリーを同じ収束カテゴリーに正しく接続するには、収束レベルの各カテゴリーが一意であり、あいまいでないことが必要です。つまり、レベル内の 2 つのカテゴリーが同じ値を持つことはできません。Transformer で代替ドリルダウン・パスを受容するには、収束レベルの Unique プロパティーを True に設定する必要があります。

収束レベルとその下位レベルのカテゴリー値はすべてのドリルダウン・パスによって共有されるため、収束レベルまたはその下位レベルにある 1 つのパスのカテゴリーを削除または変更すると、他のすべてのドリルダウン・パスの同じカテゴリーが直接影響を受けます。

92 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

複数のドリルダウン・パスに属するカテゴリーには、複数の親カテゴリーがあります。親カテゴリーのコレクションを返すには、ParentCategories プロパティーを使用します。

このオブジェクトのプロパティーへの変更を保存するには、Update メソッドを使用します。

関連トピック

次の表は、関連するコレクション、メソッド、プロパティーを示します。

メソッド 説明

Delete メソッド DrillDown オブジェクトを削除します。

Update メソッド DrillDown オブジェクトを更新します。

プロパティー 説明

Application プロパティー Transformer Application オブジェクトを返します。

Categories プロパティー DrillDown オブジェクトに含まれるカテゴリーのコレクションを返します。

ConvergenceLevel プロパティー 代替ドリルダウン・パスの収束レベルを返します。

DrillCode プロパティー ディメンション全体で、ドリルダウン・カテゴリーを一意に識別するコードを設定する、または設定状態を返します。

DrillInclusion プロパティー DrillDown オブジェクトがキューブに含まれるかどうかを設定する、または設定状態を返します。

IsPrimary プロパティー ドリルダウン・パスが主ドリルダウン・パスかどうかを設定する、または設定状態を返します。

Levels プロパティー Levels コレクションを返します。

Name プロパティー オブジェクトの名前を設定する、または設定状態を返します。

Parent プロパティー 親オブジェクトを返します。

ShortName プロパティー ドリルダウン・パスの短縮名を設定する、または設定状態を返します。

Type プロパティー オブジェクトのタイプを返します。

第 3 章 オブジェクト 93

例objDrill = objModel.Dimensions("Retailers").DrillDowns(2)

DrillThroughTarget オブジェクトDrillThroughTarget オブジェクトは、外部レポートまたは PowerCube へのドリルスルー・リンクを表します。

解説

ドリルスルー・ターゲットには、Impromptu レポート (.imr)、Impromptu クエリー定義ファイル (.iqd)、PowerPlay レポート (.ppr)、PowerCube (.mdc)、またはマクロ・スクリプト・ファイル (.mac) を使用できます。OLE オートメーションによって、関連付けられたアプリケーションが PowerPlay から直接開かれ、レポートを指定した部分から表示します。

DrillThroughTarget オブジェクトを作成するには、DrillThroughTargets コレクションの Add メソッドを使用します。Measure オブジェクトのDrillThroughTargets コレクションに DrillThroughTarget オブジェクトを追加すると、ドリルスルー機能がその数値データのみに制限されます。Cube オブジェクトまたは CubeGroup オブジェクトの DrillThroughTargets コレクションにDrillThroughTarget オブジェクトを追加すると、キューブまたはキューブ・グループの任意の位置でドリルスルー・リンクを使用できます。

ドリルスルー機能を使用可能にするには、AllowDrillThrough プロパティーを Trueに設定する必要があります。

関連トピック

次の表は、関連するコレクション、メソッド、プロパティーを示します。

メソッド 説明

Delete メソッド DrillThroughTarget オブジェクトを削除します。

isExcludeDimension メソッド 特定のディメンションが除外されるかどうかを返します。

isExcludeLevel メソッド 特定のレベルが除外されるかどうかを返します。

SetExcludeDimension メソッド 特定のディメンションを isRestricted の値に設定します。

SetExcludeLevel メソッド 特定のレベルを isRestricted の値に設定します。

94 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

メソッド 説明

Update メソッド DrillThroughTarget オブジェクトを更新します。

プロパティー 説明

Application プロパティー Transformer Application オブジェクトを返します。

Description プロパティー DrillThroughTarget オブジェクトの説明を設定する、または設定状態を返します。

Name プロパティー オブジェクトの名前を設定する、または設定状態を返します。レポートの場合は、完全修飾ファイル名を指定する必要があります。

Parent プロパティー 親オブジェクトを返します。

Type プロパティー オブジェクトのタイプを返します。

例objReport = objMeasure.DrillThroughTargets.Add(strReportPath,"Default Report")

Filter オブジェクトFilter オブジェクトは、Transformer モデルに含まれるフィルターを表します。

解説

Filters プロパティーは Filters コレクションを返します (Query オブジェクト)。コレクションに含まれる各 Filter オブジェクトは、Transformer モデルに含まれるフィルターを参照します。

関連トピック

次の表は、関連するコレクション、メソッド、プロパティーを示します。

メソッド 説明

Delete メソッド Filter オブジェクトを削除します。

Update メソッド Filter オブジェクトを更新します。

プロパティー 説明

Application プロパティー Transformer Application オブジェクトを返します。

Name プロパティー オブジェクトの名前を設定する、または設定状態を返します。

第 3 章 オブジェクト 95

プロパティー 説明

Parent プロパティー 親オブジェクトを返します。

RefName プロパティー データ・ソースのフィルター名を設定する、または設定状態を返します。

例new_package = model.Packages.Add()new_query= new_package.Queries.Add()new_filter = new_query.Filters.Add()

FlatFileDataSource オブジェクトFlatFileDataSource オブジェクトは、外部ファイルを ASCII 形式で表します。

解説

FlatFileDataSource オブジェクトは、各列がフィールド・セパレーターで区切られている ASCII 形式のデータに使用します。

FlatFileDataSource オブジェクトを作成するには、DataSources コレクションのAdd メソッドを使用します。Type パラメーターは trFlatFileDataSource 定数に設定します。SourceType プロパティーは、開くフラット・ファイルのタイプに設定します。データの書式や構造を記述するには、FieldSeparator、DecimalPoint、ThousandPoint などのプロパティーを使用します。データ・ファイルの場所を指定するには、LocalPath プロパティーまたはServerPath プロパティーを使用します。

FlatFileDataSource オブジェクトには、Columns コレクションがあります。列は、ディメンションに含まれるレベルのソースになります。

このオブジェクトのプロパティーへの変更を保存するには、Update メソッドを使用します。

関連トピック

次の表は、関連するコレクション、メソッド、プロパティーを示します。

メソッド 説明

Delete メソッド FlatFileDataSource オブジェクトを削除します。

Move メソッド FlatFileDataSource オブジェクトをDataSources コレクションの別の位置に移動します。

Update メソッド FlatFileDataSource オブジェクトを更新します。

96 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

プロパティー 説明

Application プロパティー Transformer Application オブジェクトを返します。

CharacterType プロパティー データ・ソースで使用する文字セットのタイプを設定する、または設定状態を返します。

Columns プロパティー Columns コレクションを返します。

ColumnsLoaded プロパティー モデルの構築にデータ・ソースの列を使用したかどうかを返します。

DecimalPoint プロパティー フラット・ファイルの小数点に使用する文字を設定する、または設定状態を返します。

Description プロパティー FlatFileDataSource オブジェクトの説明を設定する、または設定状態を返します。

External プロパティー データ・ソースにあらかじめ集計した値が含まれているかどうかを設定する、または設定状態を返します。

FieldSeparator プロパティー フラット・ファイルのフィールドの区切りに使用する文字を返します。

GenerateCategories プロパティー データ・ソースのカテゴリーを生成するかどうかを設定する、または設定状態を返します。

GeneratePowerCube プロパティー モデルでデータ・ソースを参照するかどうかを設定する、または設定状態を返します。

IsAnyColumnMismatched プロパティー データ・ソースの列が基礎になるデータと一致するかどうかを返します。

LocalPath プロパティー ローカル・データ・ソースの場所を設定する、または設定状態を返します。

MaximizeSpeed プロパティー カテゴリーの生成速度を最適化するかどうかを設定する、または設定状態を返します。

Name プロパティー データ・ソースの一意の名前を設定する、または設定状態を返します。

Parent プロパティー 親オブジェクトを返します。

ServerPath プロパティー データ・ソース・ファイルの名前と場所を設定する、または設定状態を返します。

第 3 章 オブジェクト 97

プロパティー 説明

ServerQuery プロパティー データをローカルで処理するか、サーバーで処理するかを設定する、または設定状態を返します。

SetsCurrentPeriod プロパティー Transformer でデータ・ソースから現在期間の日付を検索するかどうかを設定する、または設定状態を返します。

SourceType プロパティー データ・ソースで使用するデータ・ファイルのタイプを設定する、または設定状態を返します。

ThousandPoint プロパティー 1000 の区切りに使用する文字を設定する、または設定状態を返します。

Type プロパティー オブジェクトのタイプを返します。trFlatFileQuery タイプが返されますが、DataSources コレクションからのデータ・ソースを取得または追加にはtrFlatFileDataSource を使用する必要があります。

例objDataSource = objModel.DataSources.Add(xtrObjectType.trFlatFileDataSource)

IqdDataSource オブジェクトIqdDataSource オブジェクトは、Impromptu クエリー定義ファイル (.iqd) を表します。

解説

このオブジェクトは、Impromptu 形式の外部ファイルへのアクセスを設定するために使用します。

IqdDataSource オブジェクトを作成するには、DataSources コレクションの Addメソッドを使用します。Type パラメーターは trIqdDataSource 定数に設定します。

IqdDataSource の SourceType プロパティーを定数 trQuery に設定します。Impromptu クエリー定義ファイルの場所を指定するには、適用される LocalPathプロパティーまたは ServerPath プロパティーを使用します。

IqdDataSource オブジェクトには、Columns コレクションがあります。列は、ディメンションに含まれるレベルのソースになります。

このオブジェクトのプロパティーへの変更を保存するには、Update メソッドを使用します。

98 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

関連トピック

次の表は、関連するコレクション、メソッド、プロパティーを示します。

メソッド 説明

Delete メソッド IqdDataSource オブジェクトを削除します。

Move メソッド IqdDataSource オブジェクトを DataSourcesコレクションの別の位置に移動します。

Update メソッド IqdDataSource オブジェクトを更新します。

プロパティー 説明

Application プロパティー Transformer Application オブジェクトを返します。

Columns プロパティー Columns コレクションを返します。

ColumnsLoaded プロパティー モデルの構築にデータ・ソースの列を使用したかどうかを返します。

DecimalPoint プロパティー Iqd ファイルの小数点に使用する文字を設定するか、設定状態を返します。

Description プロパティー IqdDataSource オブジェクトの説明を設定する、または設定状態を返します。

External プロパティー モデルでデータ・ソースの値を使用するときに集計または自動集計として扱うかどうかを設定する、または設定状態を返します。

GenerateCategories プロパティー データ・ソースのカテゴリーを生成するかどうかを設定する、または設定状態を返します。

GeneratePowerCube プロパティー モデルでデータ・ソースを参照するかどうかを設定する、または設定状態を返します。

IsAnyColumnMismatched プロパティー データ・ソースの列が基礎になるデータと一致するかどうかを返します。

IsolationLevel プロパティー 許可されるトランザクションの定義に使用する分離レベルを設定する、または設定状態を返します。

LocalPath プロパティー ローカル・データ・ソースの場所を設定する、または設定状態を返します。

第 3 章 オブジェクト 99

プロパティー 説明

MaximizeSpeed プロパティー カテゴリーの生成速度を最適化するかどうかを設定する、または設定状態を返します。

Name プロパティー データ・ソースの一意の名前を設定する、または設定状態を返します。

Parent プロパティー 親オブジェクトを返します。

ServerPath プロパティー データ・ソース・ファイルの名前と場所を設定する、または設定状態を返します。

ServerQuery プロパティー データをローカルで処理するか、サーバーで処理するかを設定する、または設定状態を返します。

SetsCurrentPeriod プロパティー Transformer でデータ・ソースから現在期間の日付を検索するかどうかを設定する、または設定状態を返します。

SourceType プロパティー データ・ソースで使用するデータ・ファイルのタイプを設定する、または設定状態を返します。

SQLExpression プロパティー Impromptu クエリー定義ファイル (.iqd) を定義するために使用する SQL 式を返します。

ThousandPoint プロパティー 1000 の区切りに使用する文字を設定する、または設定状態を返します。

Type プロパティー オブジェクトのタイプを返します。返されるタイプは trIqdQuery ですが、DataSourcesコレクションからの取得または追加にはtrIqdDataSource タイプを使用する必要があります。

例datasource = model.DataSources.Add(xtrObjectType.trIqdDataSource)

Level オブジェクトLevel オブジェクトは、ディメンションに含まれるレベルを定義します。

解説

Level オブジェクトは、日付と直接関連しない PowerCube データすべてを表すために使用します。

100 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

モデルの各 Dimension オブジェクトに、Level オブジェクトが含まれる Levels コレクションがあります。レベルには次の 2 つのタイプがあります。

v データ・ソースから生成されるカテゴリーが含まれるソース・レベル。各ソース・レベルは、Association オブジェクトを通じてデータ・ソースの列とリンクされます。

v ソース列に関連付けない手動レベル。例えば、孤児カテゴリーが含まれる手動レベルを作成できます。

新規の Level オブジェクトを作成するには、Levels コレクションの Add メソッドを使用します。

レベルを代替ドリルダウン・パスの収束レベルにするには、CreateAlternateDrillDown メソッドを使用します。

このオブジェクトのプロパティーへの変更を保存するには、Update メソッドを使用します。

関連トピック

次の表は、関連するコレクション、メソッド、プロパティーを示します。

メソッド 説明

AssociateWith メソッド Level オブジェクトに作成元オブジェクトを関連付けます。

CreateAlternateDrillDown メソッド ディメンションの代替ドリルダウン・パスを作成します。

Delete メソッド Level オブジェクトを削除します。

Move メソッド レベルを Levels コレクションの別の位置に移動します。

SetAllocation メソッド オブジェクトで使用する数値データの割り当てタイプを変更します。

Update メソッド Level オブジェクトを更新します。

プロパティー 説明

AllocationMeasure プロパティー 加重係数として使用する Measure オブジェクトを返します。

AllocationType プロパティー オブジェクトで数値データを割り当てる方法を返します。

Application プロパティー Transformer Application オブジェクトを返します。

第 3 章 オブジェクト 101

プロパティー 説明

Associations プロパティー Associations コレクションを返します。

BlankSubstitute プロパティー Level オブジェクトに生成される空白カテゴリーのデフォルトのラベルを設定する、または設定状態を返します。

CanAllocate プロパティー 数値データ値の値を子孫のレベルとカテゴリーに割り当てることができるかどうかを返します。

CanAllocateByMeasure プロパティー 数値データで割り当てるときに、指定した数値データを加重係数として使用できるかどうかを返します。

CanAllocateMeasure プロパティー 指定した数値データを子孫のレベルとカテゴリーに割り当てることができるかどうかを返します。

CategoryCount プロパティー Level オブジェクトに含まれる標準カテゴリー数を返します。

Description プロパティー Level オブジェクトの説明を設定する、または設定状態を返します。

HasSubdimension プロパティー Level オブジェクトにサブディメンションが含まれるかどうかを返します。

Inclusion プロパティー キューブにカテゴリーが含まれるかどうかを設定する、または設定状態を返します。

IsManual プロパティー レベルがソース値に関連付けられているかどうかを返します。

LevelCategories プロパティー レベルに含まれるカテゴリーのコレクションを返します。

LevelDrillDowns プロパティー LevelDrillDowns コレクションを返します。

Name プロパティー オブジェクトの名前を設定する、または設定状態を返します。

NewCatsLocked プロパティー 新規のカテゴリーを Level オブジェクトに追加できるかどうかを設定する、または設定状態を返します。

OrderByDescending プロパティー 値を降順に表示するかどうかを設定する、または設定状態を返します。

102 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

プロパティー 説明

OrderByStorageType プロパティー 列の保管タイプに基づいてカテゴリーをソートする方法を設定する、または設定状態を返します。

Parent プロパティー 親オブジェクトを返します。

Partition プロパティー 手動パーティション番号を設定する、または設定状態を返します。

QualifiedName プロパティー Level オブジェクトの絶対パス名を設定する、または設定状態を返します。

RefreshDescription プロパティー 説明を更新するかどうかを設定する、または設定状態を返します。

RefreshLabel プロパティー ラベルを更新するかどうかを設定する、または設定状態を返します。

RefreshShortName プロパティー 短縮名を更新するかどうかを設定する、または設定状態を返します。

Type プロパティー オブジェクトのタイプを返します。

Unique プロパティー Transformer でレベルの各カテゴリーを一意のソース値で識別できるかどうかを設定する、または設定状態を返します。

UniqueMove プロパティー 関連付けられているカテゴリーを移動したときに一意のレベル・オブジェクトを扱う方法を設定する、または設定状態を返します。

例objTimeDimension = objModel.Dimensions.Item("Time")objLevel= objTimeDimension.DrillDowns.Item(1).Levels.Item("Month")

Measure オブジェクトMeasure オブジェクトは、キューブに含まれる量的な値を表します。

解説

数値データは、モデルの数値を識別するために使用します。数値データは、数量化が可能で、PowerPlay で業績の指標として使用します。

通常数値データ、算出数値データ、またはカテゴリー・カウント数値データの 3 種類の Measure オブジェクトを作成できます。数値データの各タイプは、それぞれ異なる方法で値を生成します。標準数値データは、Association オブジェクトを使用します。算出数値データは、ExpressionText プロパティーに定義された数式を使用

第 3 章 オブジェクト 103

します。カテゴリー・カウント数値データは、CategoryCountLevel プロパティーおよび ActivityMeasure プロパティーの設定を使用します。

Transformer が作成する数値データは、常に標準数値データです。算出数値データまたはカテゴリー・カウント数値データを作成するには、Measures コレクションのAdd メソッドを使用します。次に、CategoryCountLevel プロパティーおよびActivityMeasure プロパティーを使用してカテゴリー・カウント数値データを指定するか、または ExpressionText プロパティーを使用して算出数値データを指定します。

下位レベルの数値データ値の値は、上位レベルに自動集計されて要約されます。数値データ値の値を集計する方法を変更するには、このオブジェクトの rollup プロパティーを使用します。例えば、値を合計したり、平均を算出したり、加重を掛けたりすることができます。

Transformer Series 7 Version 4 以降のリリースでは、平均または加重平均の時状態数値データを自動集計するときに Null 値および欠落値を無視するように指定できます。欠落値が「NA」と表示される場合は、サポートされている数値データ・タイプの定義を作成または更新するときに、objMeasure オブジェクトのIgnoreMissingValue プロパティーを TRUE に設定します。

注:開始期間、最終期間、現在期間のデフォルト設定は保持する必要があります。これらの数値データ・タイプでは、Null 値と欠落値を集計計算から除外できません。最小または最大の集計計算では、Transformer で「0」または「n/a」(NA 設定) と表示されるように設定されている場合でも、欠落 (Null) データ値は常に除外されます。

複数のデータ・ソースがある場合は、SetAllocation メソッドを使用して、一方のデータ・ソースに関連付けられている数値データ値の値をもう一方のデータ・ソースに関連付けられているカテゴリーにどのように表示するかを定義できます。

このオブジェクトのプロパティーへの変更を保存するには、Update メソッドを使用します。

関連トピック

次の表は、関連するコレクション、メソッド、プロパティーを示します。

メソッド 説明

AddToFolder メソッド 数値データ・フォルダーに数値データを追加します。

AssociateWith メソッド Measure オブジェクトにソース・オブジェクトを関連付けます。

Delete メソッド Measure オブジェクトを削除します。

Move メソッド 数値データを Measures コレクションの別の位置に移動します。

104 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

メソッド 説明

RemoveFromFolder メソッド 現在の数値データ・フォルダーから子数値データを削除します。

Update メソッド Measure オブジェクトを更新します。

プロパティー 説明

ActivityMeasure プロパティー カテゴリー・カウント数値データで使用する数値データを設定する、または設定状態を返します。

AllowCurrencyConversion プロパティー 通貨を交換できるかどうかを設定する、または設定状態を返します。

AllowDrillThrough プロパティー キューブまたは数値データを、キューブまたはレポートへドリルスルーできるかどうかを設定する、または設定状態を返します。

Application プロパティー Transformer Application オブジェクトを返します。

Associations プロパティー Associations コレクションを返します。

CategoryCountLevel プロパティー カテゴリー・カウントが適用される Levelオブジェクトを設定する、または設定状態を返します。

ChildMeasures プロパティー 数値データ・フォルダーから子数値データのコレクションを返します。数値データ・フォルダーに子数値データがない場合は、空のコレクションが返されます。数値データ・フォルダーに数値データが含まれていない場合、例外が返されます。

Description プロパティー Measure オブジェクトの説明を設定する、または設定状態を返します。

DrillThroughTargets プロパティー Transformer モデルに関連付けられているドリルスルー・ターゲット・オブジェクトのコレクションを返します。

DuplicateRollup プロパティー 集約されたレコードから重複する数値データ値の値を自動集計する方法を設定する、または設定状態を返します。

DuplicateWeight プロパティー 平均加重係数を含む数値データの名前を設定する、または設定状態を返します。

第 3 章 オブジェクト 105

プロパティー 説明

ExpressionText プロパティー 算出数値データの値を定義する数式の内容を設定する、または設定状態を返します。現在のリリースでは、if-then-else 条件式がサポートされています。

Format プロパティー 数値を表示する書式を設定する、または設定状態を返します。

FormatDecimals プロパティー PowerPlay で表示する数値データの小数桁数を設定する、または設定状態を返します。

IgnoreMissingValue プロパティー 時状態データ集計で Null 値または欠落値を無視するかどうかを指定します。デフォルト:False

IsExpressionValid プロパティー 数式が有効かどうかを返します。

IsFolder プロパティー 数値データが数値データ・フォルダーかどうかを設定する、または設定状態を返します。

Label プロパティー PowerPlay に表示される説明的な名前を設定する、または設定状態を返します。

MeasureType プロパティー 数値データが通常、算出、またはカテゴリー・カウントかどうかを返します。

MissingValue プロパティー 空白または NULL 値の代わりに表示する値を設定する、または設定状態を返します。

Name プロパティー オブジェクトの名前を設定する、または設定状態を返します。

OutputScale プロパティー PowerPlay の値を整数から小数に変換するために使用するスケール値を設定する、または設定状態を返します。

Parent プロパティー 親オブジェクトを返します。

Precision プロパティー 計算に使用する数値データの小数桁数を設定する、または設定状態を返します。

RegularRollup プロパティー Measure オブジェクトの現在の標準集計関数を設定する、または設定状態を返します。

RegularWeight プロパティー 加重平均の計算に使用する数値データの名前を設定する、または設定状態を返します。

ReverseSign プロパティー PowerPlay で数値データの符号を反転するかどうかを設定する、または設定状態を返します。

106 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

プロパティー 説明

RollupTiming プロパティー 算出数値データの計算をいつ実行するかを設定する、または設定状態を返します。

ShortName プロパティー Measure オブジェクトの短縮名を設定する、または設定状態を返します。

StorageType プロパティー 数値データ型のサイズを設定する、または設定状態を返します。

TimeStateRollup プロパティー 時状態データ集計に使用する日付期間を設定する、または設定状態を返します。

TimeStateWeight プロパティー 加重平均の計算に使用する数値データの名前を設定する、または設定状態を返します。

Type プロパティー オブジェクトのタイプを返します。

例objMeasure = objModel.Measures("Forecast")

モデル・オブジェクトモデル・オブジェクトは、Transformer モデルを定義します。

解説

モデルは、Application オブジェクトの最上位にあるオブジェクトです。モデルからは、上位レベルのコレクションすべてを直接開くことができます。

新規のモデルと PowerCube を構築するには、次の手順を実行します。

関連トピック

次の表は、関連するコレクション、メソッド、プロパティーを示します。

コレクション 説明

Namespaces コレクション モデルの Namespace オブジェクトをすべて含みます。

SecurityObjects コレクション モデルの SecurityObject オブジェクトをすべて含みます。

第 3 章 オブジェクト 107

メソッド 説明

CheckLocalPowerCubes メソッド モデルに定義されたキューブを、関連付けられている PowerCube ファイル (.mdc) と照合します。

CheckModel メソッド 手動モデル・チェックを実行します。

CleanHouse メソッド モデルから非アクティブなカテゴリーを削除します。

Close メソッド モデルを閉じます。

CreateMDCFiles メソッド モデル内のキューブすべてとキューブ・グループの定義に基づいて PowerCube ファイル(.mdc) を作成します。

DeleteAllCustomViews メソッド モデルのカスタム・ビューをすべて削除します。

DeleteAllSecurityObjects メソッド モデルからセキュリティー・オブジェクトを削除します。

DeployCubes メソッド すべての配布場所にすべてのモデルPowerCube を配布します。

DoAutoDesign メソッド ディメンション、レベル、ドリルダウン・パス、キューブ、数値データを生成します。

GenerateCategories メソッド モデルにカテゴリーを生成します。

LoadCurrencyTable メソッド モデルに通貨表をロードします。

ResetPartitions メソッド 現在のキューブ・パーティションを削除します。

Save メソッド モデルを保存します。

SaveAs メソッド 新しい名前を付けてモデルを保存します。

TestBuild メソッド 小規模のテスト用のモデルまたはキューブを作成します。

Update メソッド モデル・オブジェクトを更新します。

プロパティー 説明

CubeCodePage プロパティー キューブを構築するために使用するモデルのキューブのコード・ページ設定を設定するか、設定状態を返します。

108 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

プロパティー 説明

Application プロパティー Transformer Application オブジェクトを返します。

Cubes プロパティー Cube オブジェクトと CubeGroup オブジェクトのコレクションを返します。

CurrencyRecords プロパティー CurrencyRecords コレクションを返します。

CurrencyTables プロパティー CurrencyTables コレクションを返します。

DataSources プロパティー DataSources コレクションを返します。

DateWizard プロパティー DateWizard オブジェクトを返します。

DefaultCategoryOrderBy プロパティー モデルのすべてのカテゴリーにデフォルトのソート順 (昇順) を設定します。

Description プロパティー モデル・オブジェクトの説明を設定する、または設定状態を返します。

Dimensions プロパティー Dimensions コレクションを返します。

FileName プロパティー Windows のフォルダーまたは WindowsExplorer に表示されるモデル・ファイルの名前を返します。

FullName プロパティー モデル・ファイルの名前と場所を返します。

Measures プロパティー Measures コレクションを返します。

ModelType プロパティー Windows のフォルダーまたは WindowsExplorer に表示されるモデル・ファイルのファイル拡張子を返します。

Name プロパティー オブジェクトの名前を設定する、または設定状態を返します。

Namespaces プロパティー Namespaces コレクションを返します。

Packages プロパティー Packages コレクションを返します。

Parent プロパティー 親オブジェクトを返します。

Path プロパティー モデル・ファイルの場所を返します。

SecurityObjects プロパティー SecurityObjects コレクションを返します。

ServerModelPath プロパティー モデルのサーバーの場所を設定する、または設定状態を返します。

第 3 章 オブジェクト 109

プロパティー 説明

Signon プロパティー Signons コレクションを返します。

Size プロパティー モデル・サイズをバイト単位で指定します。

Time プロパティー Windows のフォルダーまたは WindowsExplorer に表示されるモデルのタイム・スタンプを返します。

Type プロパティー オブジェクトのタイプを返します。

例objModel = objTransApp.OpenModel(strModelPath)

Name オブジェクトName オブジェクトは、名前またはメッセージのテキスト文字列を参照します。

解説

Names コレクションは、CheckModel メソッド (モデル・オブジェクト) によって返されます。

このコレクションの各 Name オブジェクトには、完全なメッセージ文字列が含まれます。Name プロパティーの戻り値を使用して CheckModel プロシージャーの結果を読み取ることができます。

関連トピック

次の表は、関連するコレクション、メソッド、プロパティーを示します。

プロパティー 説明

Application プロパティー Transformer Application オブジェクトを返します。

Name プロパティー オブジェクトの名前を返します。

Parent プロパティー 親オブジェクトを返します。

Type プロパティー オブジェクトのタイプを返します。

例MsgBox(objModel.CheckModel(intX).Name)

Namespace オブジェクトNamespace オブジェクトは、Transformer モデルに含まれるネームスペースを表します。

110 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

解説

モデル・オブジェクトに含まれる Namespaces プロパティーは、Namespace コレクションを返します。

コレクションに含まれる各 Namespace オブジェクトは、Transformer モデルに含まれるネームスペースを参照します。

ネームスペースは、SecurityObjects を作成するために使用されます。SecurityObjects は、Transformer PowerCube にユーザーまたはグループ・レベルのセキュリティーを提供するために CustomViews に追加されます。

Namespace オブジェクトを使用するには、Application オブジェクトの Logon メソッドを使用して、該当するネームスペースにログオンする必要があります。また、ネームスペース、ユーザー名、パスワードを指定する必要があります。

Namespace オブジェクトを使用するためには、Name プロパティーをネームスペースに設定するか、ID プロパティーをネームスペース ID に設定する必要があります。ユーザーにセキュリティーを適用している場合、ユーザーのユーザー名に Userプロパティーも設定する必要があります。グループや役割などの他のオブジェクトにセキュリティーが適用されている場合、オブジェクト名に ObjectName プロパティーを設定する必要があります。これらのプロパティーを適切に設定すると、他のプロパティーを、セキュリティー情報を取得するために使用できます。

関連トピック

次の表は、関連するコレクション、メソッド、プロパティーを示します。

メソッド 説明

Delete メソッド Namespace オブジェクトを削除します。

Update メソッド Namespace オブジェクトを更新します。

プロパティー 説明

Application プロパティー Transformer Application オブジェクトを返します。

CAMID プロパティー ネームスペースの CAMID を返します。

ID プロパティー ネームスペース ID を設定する、または設定状態を返します。

Name プロパティー ネームスペースの名前を返します。

ObjectCAMID プロパティー ObjectName プロパティーによって設定されるネームスペースに含まれるオブジェクトのCAMID を返します。

第 3 章 オブジェクト 111

プロパティー 説明

ObjectName プロパティー ネームスペース・オブジェクトの名前を設定するか、設定状態を返します。

Parent プロパティー 親オブジェクトを返します。

SecurityObjects プロパティー SecurityObjects のコレクションを返します。

User プロパティー ネームスペースに関連付けられているユーザー名を設定するか、設定状態を返します。

UserCAMID プロパティー User プロパティーによって設定されるユーザーの CAMID を返します。

例new_namespace = model.Namespaces.Add()

Package オブジェクトPackage オブジェクトは、Transformer モデルに含まれるパッケージ・データ・ソースを表します。

解説

モデル・オブジェクトの Packages プロパティーは、Package コレクションを返します。コレクションに含まれる各 Package オブジェクトは、Transformer モデルに含まれるパッケージ・データ・ソースを参照します。

関連トピック

次の表は、関連するコレクション、メソッド、プロパティーを示します。

メソッド 説明

Delete メソッド Package オブジェクトを削除します。

Update メソッド Package オブジェクトを更新します。

Verify メソッド Package オブジェクトを検証します。

プロパティー 説明

Application プロパティー Transformer Application オブジェクトを返します。

Name プロパティー オブジェクトの名前を設定する、または設定状態を返します。

112 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

プロパティー 説明

PackagesDatasourceConnections プロパティー

パッケージに関連付けられているPackageDatasourceConnection オブジェクトのコレクションを返します。

Parent プロパティー 親オブジェクトを返します。

Path プロパティー IBM Cognos Connection に含まれるパッケージへのパスを設定する、または設定状態を返します。

Queries プロパティー パッケージに関連付けられている Query オブジェクトのコレクションを返します。

TimeStamp プロパティー パッケージのタイム・スタンプを設定する、または設定状態を返します。

Type プロパティー オブジェクトのタイプを返します。

例new_package = model.Packages.Add()

PackageDatasourceConnection オブジェクトPackageDatasourceConnection オブジェクトは、Transformer モデルに含まれるパッケージ・データ・ソース接続を表します。

解説

複数の接続または複数のサインオンが設定されているデータ・ソースに基づくモデルの場合は、解消する必要があるあいまいさの問題が発生します。システムによりモデルがチェックされ、あいまいさを解消するパッケージ・データ・ソース接続が検索されます。この場合は、データ・ソース接続に属するデータ・ソース、接続、サインオンが使用されます。

関連トピック

次の表は、関連するコレクション、メソッド、プロパティーを示します。

メソッド 説明

Delete メソッド PackageDatasourceConnection オブジェクトを削除します。

Update メソッド PackageDatasourceConnection オブジェクトを更新します。

Verify メソッド PackageDatasourceConnection オブジェクトを検証します。

第 3 章 オブジェクト 113

プロパティー 説明

Application プロパティー Transformer Application オブジェクトを返します。

AlwaysUseTransformerSignon プロパティー 有効の場合は、Content Manager サインオンが使用される前に、Transformer サインオンが使用されます。無効の場合は、ContentManager サインオンがデフォルトで使用されます。

Connection プロパティー Content Manager 接続を設定するか、設定状態を返します。

DataSource プロパティー Content Manager データ・ソースを設定するか、設定状態を返します。

Parent プロパティー 親オブジェクトを返します。

Signon プロパティー Content Manager サインオンを設定するか、設定状態を返します。

TransformerSignon プロパティー パッケージ・データ・ソース接続 (IBMCognos サインオン) に関連付けられたTransformer Signon オブジェクトを設定するか、または設定状態を返します。

例package = model.Packages.Add()connection= package.PackageDatasourceConnections.Add()

Prompt オブジェクトPrompt オブジェクトは、Transformer モデルに含まれるプロンプトを表します。

解説

Prompts プロパティーは Prompts コレクションを返します (Query オブジェクト)。コレクションに含まれる各 Prompt オブジェクトは、Transformer モデルに含まれるプロンプトを参照します。

関連トピック

次の表は、関連するコレクション、メソッド、プロパティーを示します。

メソッド 説明

Delete メソッド Query オブジェクトを削除します。

114 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

メソッド 説明

Update メソッド Query オブジェクトを更新します。

プロパティー 説明

Application プロパティー Transformer Application オブジェクトを返します。

CurrentValueIndex プロパティー 現在のプロンプト値索引を設定する、または設定状態を返します。このプロパティーは、プロンプト値を繰り返すために使用します。

Name プロパティー オブジェクトの名前を設定する、または設定状態を返します。

Parent プロパティー 親オブジェクトを返します。

PromptValueType プロパティー プロンプトのタイプを設定する、または設定状態を返します。

Type プロパティー プロンプト値のデータ型を設定する、または設定状態を返します。

Value プロパティー プロンプトの値を設定する、または設定状態を返します。

ValuesCount プロパティー プロンプトに設定されている値の数を返します。

例new_report = model.Reports.Add()new_query = new_report.Queries.Add()new_prompt= new_query.Prompts.Add()

Query オブジェクトQuery オブジェクトは、レポートまたはパッケージの一部であるクエリーを表します。

解説

Package または Report オブジェクトの Queries プロパティーは、Query コレクションを返します。それぞれの Package または Report オブジェクトには、クエリー・オブジェクトが含まれています。これらのクエリー・オブジェクトは、基本となるパッケージまたはレポート・データ・ソース内の列を参照する列オブジェクトを含みます。このオブジェクトのプロパティーへの変更を保存するには、Update メソッドを使用します。

第 3 章 オブジェクト 115

関連トピック

次の表は、関連するコレクション、メソッド、プロパティーを示します。

メソッド 説明

Delete メソッド Query オブジェクトを削除します。

Update メソッド Query オブジェクトを更新します。

Verify メソッド Query オブジェクトを検証します。

プロパティー 説明

Application プロパティー Transformer Application オブジェクトを返します。

AutoSummary プロパティー クエリーの自動集計オプションを設定する、または設定状態を返します。

Columns プロパティー データ・ソースの全 Column オブジェクトを含む Columns コレクションを返します。

Filters プロパティー フィルター・オブジェクトを返します。

GenerateCategories プロパティー データ・ソースのカテゴリーを生成するかどうかを設定する、または設定状態を返します。

GeneratePowerCube プロパティー モデルでデータ・ソースを参照するかどうかを設定する、または設定状態を返します。

IsAnyColumnMismatched プロパティー データ・ソースの列が基礎になるデータと一致するかどうかを返します。

MaximizeSpeed プロパティー カテゴリーの生成速度を最適化するかどうかを設定する、または設定状態を返します。

Name プロパティー オブジェクトの名前を設定する、または設定状態を返します。

Parent プロパティー 親オブジェクトを返します。

Prompts プロパティー クエリーに関連付けられている Prompt オブジェクトのコレクションを返します。

SetsCurrentPeriod プロパティー Transformer でデータ・ソースから現在期間の日付を検索するかどうかを設定する、または設定状態を返します。

116 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

プロパティー 説明

StreamExtractAllowed プロパティー ストリーム抽出が許可されるかどうかを設定するか、設定状態を返します (SAP BW のみ)。

StreamExtractSize プロパティー StreamExtract が true に設定されている場合に SAP BW からのデータ転送に使用されるバッファーのサイズをメガバイト単位で設定する、または設定状態を返します。

SuppressNull プロパティー SAP BW データ・ソースに使用される Null消去オプションを設定する、または設定状態を返します。

例new_package = model.Packages.Add()new_query= new_package.Queries.Add()

Report オブジェクトReport オブジェクトは、Transformer モデルに含まれるレポート・データ・ソースを表します。

解説

Reports プロパティーは Reports コレクションを返します (モデル・オブジェクト)。コレクションに含まれる各 Report オブジェクトは、Transformer モデルに含まれるレポート・データ・ソースを参照します。

関連トピック

次の表は、関連するコレクション、メソッド、プロパティーを示します。

メソッド 説明

Delete メソッド Report オブジェクトを削除します。

Update メソッド Report オブジェクトを更新します。

Verify メソッド Query オブジェクトを検証します。

プロパティー 説明

Application プロパティー Transformer Application オブジェクトを返します。

Name プロパティー オブジェクトの名前を設定する、または設定状態を返します。

第 3 章 オブジェクト 117

プロパティー 説明

PackagesDatasourceConnections プロパティー

レポートに関連付けられているPackageDatasourceConnection オブジェクトのコレクションを返します。

Parent プロパティー 親オブジェクトを返します。

Path プロパティー IBM Cognos Connection に含まれるレポートへのパスを返します。

Queries プロパティー レポートに関連付けられている Query オブジェクトのコレクションを返します。

TimeStamp プロパティー レポートのタイム・スタンプを設定するか、設定状態を返します。

Type プロパティー オブジェクトのタイプを返します。

例new_report = model.Reports.Add()

SecurityObject オブジェクトSecurityObject オブジェクトは、Transformer モデルに含まれるセキュリティー・オブジェクトを表します。

解説

Namespace オブジェクトに含まれる SecurityObjects プロパティーは、SecurityObjects コレクションを返します。コレクションに含まれる各SecurityObject オブジェクトは、Transformer モデルに含まれるセキュリティー・オブジェクトを参照します。

ネームスペースは、SecurityObjects を作成するために使用されます。SecurityObjects は、Transformer PowerCube にユーザーまたはグループ・レベルのセキュリティーを提供するために CustomViews に追加されます。SecurityObjectの Name プロパティーは、ユーザー、グループ、または役割オブジェクトのCAMID に設定されます。Type プロパティーは、xtrSecurityType 定数に設定する必要があります。

関連トピック

次の表は、関連するコレクション、メソッド、プロパティーを示します。

メソッド 説明

AddToCustomView メソッド カスタム・ビューにセキュリティー・オブジェクトを追加します。

118 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

メソッド 説明

Delete メソッド SecurityObject オブジェクトを削除します。

Update メソッド SecurityObject オブジェクトを更新します。

Verify メソッド SecurityObject オブジェクトを検証します。

プロパティー 説明

Application プロパティー Transformer Application オブジェクトを返します。

DisplayName プロパティー SecurityObject オブジェクトの表示名を設定するか、設定状態を返します。

Name プロパティー SecurityObject オブジェクトの名前(CAMID) を設定する、または設定状態を返します。

Parent プロパティー 親オブジェクトを返します。

Type プロパティー オブジェクトのタイプを返します。

例new_namespace = model.Namespaces.Add()securityObject = new_namespace.SecurityObjects.Add()

Signon オブジェクトSignon オブジェクトは、サインオンのタイプとしてデータ・ソース・サインオンまたは Cognos サインオンのいずれかを定義します。サインオンのタイプがデータ・ソース・サインオン (IBM Cognos Series 7 ではデータベース・サインオン) の場合、データベース・サインオンに適用されます。IBM Cognos サインオンは、セキュリティー・ネームスペースにリンクされるセキュリティー・サインオンで、IBMCognos でのみ使用されます。

Signon オブジェクトは 1 つしかありません。Signon オブジェクトの SignonTypeプロパティーは、DatasourceSignon タイプと CognosSignon タイプのいずれを使用しているかを指定します。

解説v データ・ソース・サインオン

Transformer では、Signon オブジェクトの Name、Password、UserID プロパティーを使用して自動的にデータベースに接続されます。

v Impromptu ファイル

第 3 章 オブジェクト 119

Impromptu クエリー定義ファイル (.iqd) は、データベース・ソースを参照します。これらのファイルは、基礎になるデータ・ソースとの接続パラメーターに論理データベース名を使用します。モデルに Impromptu クエリー定義ファイルを追加すると、論理データベース名が設定された Signon オブジェクトがTransformer によって自動的に追加されます。これには、ユーザー ID とパスワード情報も設定されます。

Signons コレクションから返された Signon オブジェクトを使用して、ユーザーID とパスワードを編集します。

Transformer によって追加された Signon オブジェクトは、コレクションから削除できません。

v IBM Cognos Signon

Transformer は、セキュリティー・ネームスペースへの認証に CognosSignonタイプを使用します。

関連トピック

次の表は、関連するコレクション、メソッド、プロパティーを示します。

メソッド 説明

Delete メソッド Signon オブジェクトを削除します。

Update メソッド Signon オブジェクトを更新します。

プロパティー 説明

Application プロパティー Transformer Application オブジェクトを返します。

AutoLogon プロパティー サインオンに関連付けられているセキュリティー・ネームスペースに対して、アプリケーションが自動的に認証されるかどうかを定義します。CognosSignon タイプにのみ適用されます。

Description プロパティー オブジェクトの説明を設定する、または設定状態を返します。

Name プロパティー Signon オブジェクトの名前を返します。

Parent プロパティー 親オブジェクトを返します。

Password プロパティー Signon オブジェクトのパスワードを設定します (大文字と小文字を区別)。

120 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

プロパティー 説明

PromptForPassword プロパティー Transformer ユーザー・インターフェースの使用時に、ユーザーに対してパスワードの入力を常に要求するかどうかを定義します。DataSourceSignon タイプにのみ適用されます。

SignOnNamespace プロパティー CognosSignon タイプに関連付けられているセキュリティー・ネームスペースが含まれます。

SignonType プロパティー サインオンのタイプを定義します。ここではxtrSignonType です。

Type プロパティー オブジェクトのタイプを返します。

UserID プロパティー Signon オブジェクトのユーザー ID を設定する、または設定状態を返します。

例signon = model.Signons.Add()

SpecialCategory オブジェクトSpecialCategory オブジェクトは、データ・ソースの値を直接使用しないカテゴリーを定義します。

解説

このオブジェクトは、相対時間に基づくカテゴリー (年間累計など) の作成に使用します。

SpecialCategory オブジェクトのコレクションは、Dimension オブジェクトにより返されます。SpecialCategory オブジェクトを作成するには、Categories コレクションの Add メソッドを使用し、Type パラメーターを trSpecialCategory に設定します。

このオブジェクトのプロパティーへの変更を保存するには、Update メソッドを使用します。

関連トピック

次の表は、関連するコレクション、メソッド、プロパティーを示します。

メソッド 説明

ConnectWithCategory メソッド 子カテゴリーを同じレベルの新しい親カテゴリーに移動します。

第 3 章 オブジェクト 121

メソッド 説明

Delete メソッド SpecialCategory オブジェクトを削除します。

SetAllocation メソッド オブジェクトで使用する数値データの割り当てタイプを変更します。

Update メソッド SpecialCategory オブジェクトを更新します。

プロパティー 説明

Aggregate プロパティー 相対時間カテゴリーのタイプを設定する、または設定状態を返します。

AllocationMeasure プロパティー 加重係数として使用する Measure オブジェクトを返します。

AllocationType プロパティー オブジェクトで数値データを割り当てる方法を返します。

Application プロパティー Transformer Application オブジェクトを返します。

AutoLogon プロパティー サインオンに関連付けられているセキュリティー・ネームスペースに対して、アプリケーションが自動的に認証されるかどうかを定義します。CognosSignon タイプにのみ適用されます。

CanAllocate プロパティー 数値データ値の値を子孫のレベルとカテゴリーに割り当てることができるかどうかを返します。

CanAllocateByMeasure プロパティー 数値データで割り当てるときに、指定した数値データを加重係数として使用できるかどうかを返します。

CanAllocateMeasure プロパティー 指定した数値データを子孫のレベルとカテゴリーに割り当てることができるかどうかを返します。

ChildCategories プロパティー Categories コレクションを返します。

Code プロパティー ディメンションの特殊カテゴリーについて一意のコードを設定する、または設定状態を返します。

122 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

プロパティー 説明

ContextLevel プロパティー 日付期間を設定する、または設定状態を返します。

ContextOffset プロパティー 現在の期間を基準とする総括期間の位置を設定する、または設定状態を返します。

Description プロパティー SpecialCategory オブジェクトの説明を設定する、または設定状態を返します。

Dimensions プロパティー SpecialCategory オブジェクトのディメンションを返します。

ExpressionText プロパティー SpecialCategory オブジェクトの値を定義する数式の内容を設定する、または設定状態を返します。

Format プロパティー 数値を表示する書式を設定する、または設定状態を返します。

Inclusion プロパティー キューブにカテゴリーが含まれるかどうかを設定する、または設定状態を返します。

IsExpressionValid プロパティー 数式が有効かどうかを返します。

Label プロパティー オブジェクトの名前を設定する、または設定状態を返します。Transformer のユーザー・インターフェースでは、ラベルは「ソース値」ですが、デフォルト値は "" です。

LastUseDate プロパティー SpecialCategory オブジェクトを最後に変更または使用した日付を返します。

Level プロパティー SpecialCategory のレベルを返します。

Name プロパティー オブジェクトの名前を設定する、または設定状態を返します。

Parent プロパティー 親オブジェクトを返します。

ParentCategories プロパティー ParentCategories コレクションを返します。

ReverseSign プロパティー PowerPlay で数値データの符号を反転するかどうかを設定する、または設定状態を返します。

Rollup プロパティー 特殊カテゴリーの数値データ値を親カテゴリーに自動集計するかどうかを設定する、または設定状態を返します。

第 3 章 オブジェクト 123

プロパティー 説明

RunningPeriods プロパティー 累計に使用する期数を設定する、または設定状態を返します。

ShortName プロパティー SpecialCategory オブジェクトの短縮名を設定する、または設定状態を返します。

TargetLevel プロパティー 日付期間の詳細レベルを設定する、または設定状態を返します。

TargetOffset プロパティー 現在の期間を基準とする目標期間の位置を設定する、または設定状態を返します。

ToDateLevel プロパティー 期間累計に使用する日付期間を設定する、または設定状態を返します。

Type プロパティー オブジェクトのタイプを返します。

例objSpecCategory =_ objModel.Dimensions("Time").Categories.Add(xtrObjectType.trSpecialCategory)

SuspendedModel オブジェクトSuspendedModel オブジェクトは、既存の不完全なモデルを表します。

解説

このオブジェクトは、正しく閉じていないモデルをリカバリーするために使用します (例えば、システム・クラッシュや停電などの場合)。

Transformer では、ModelTemporaryFilesPath プロパティーまたは ModelsPath プロパティーに指定した場所で中断モデルがチェックされます。両方のプロパティーが設定されている場合は、ModelTemporaryFilesPath に指定した場所のみがチェックされます。両方とも設定していない場合は、環境変数に指定した Temp の場所がチェックされます。

中断モデルが破損しているか、または修復可能かどうかを調べるには、IsBad プロパティーを使用します。中断モデルが破損している場合は、RemoveSuspendedModel メソッドを使用して SuspendedModels コレクションから削除します。中断モデルがリカバリー可能な場合は、Transformer で開いてステータスを決定できます。

Transformer では、SuspendedModel オブジェクトにできるだけ多くの情報が保存されます。また、モデル作成プロセスの主要な段階ごとにチェックポイントが付加されます。チェックポイントは、ファイル拡張子が"qy?"で始まるテンポラリー・ファイルに書き込まれます。テンポラリー・ファイルはモデルが正常に閉じたときに削除されるため、テンポラリー・モデル・ファイルの存在は、Transformer が異常終了したことを示します。ファイル拡張子の 3 文字目は常に異なります。

124 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

Transformer では、モデルと同じ場所またはユーザーが指定した場所に保存されるログ・ファイル (.log) にもメッセージが書き込まれます。Transformer が処理失敗から自動的にリカバリーできない場合、または前の処理を破棄してやり直す場合、失敗の原因を特定するためにログ・ファイルを参照できます。

関連トピック

次の表は、関連するコレクション、メソッド、プロパティーを示します。

プロパティー 説明

Application プロパティー Transformer Application オブジェクトを返します。

IsBad プロパティー 中断モデルが破損しているかどうかを返します。

ModelName プロパティー 中断モデルの名前を返します。

Parent プロパティー 親オブジェクトを返します。

QyPath プロパティー 中断モデルのパスを返します。

Type プロパティー オブジェクトのタイプを返します。

例objSuspendedModel = objTransApp.SuspendedModels(intX)

View オブジェクトView オブジェクトは、ディメンションの部分的なビューを定義します。

解説

View オブジェクトは、PowerPlay ユーザーにディメンション情報のサブセットを表示するために使用します。

ディメンション・ビューとカスタム・ビューがあります。どちらのビューも、ディメンションのカテゴリーとレベルについて全部または一部の表示、あるいは非表示を選択できます。

v ディメンション・ビュー

各 Dimension オブジェクトには、2 つの View オブジェクトからなるコレクションが自動的に設定されます。デフォルトでは、DimensionView プロパティーがコレクションの最初のオブジェクトである"All Categories"に設定されます。キューブのディメンションを省略するには、DimensionView プロパティーをコレクションの 2 番目のオブジェクトである"Omit Dimension"に設定します。

ディメンションのカスタム・ビューを作成するには、最初に Add メソッドを使用してコレクションに View オブジェクトを追加し、ViewType プロパティーをtrViewTypeCustom に設定します。次に、Apex プロパティーを使用して新規のルート・カテゴリーを作成したり、SetViewStatus メソッドを使用して選択したレベルまたはカテゴリーに View オブジェクトを関連付けることができます。View オブジェクトを定義した後、DimensionView プロパティーを使用してView オブジェクトをキューブに関連付けます。

第 3 章 オブジェクト 125

v カスタム・ビュー

モデルにセキュリティーを設定すると、各 CustomView オブジェクトに Viewオブジェクトのコレクションが各ディメンション 1 つずつ自動的に設定されます。コレクションの各オブジェクトのデフォルト・ビューは、"All Categories"です。このビューは、DimensionInclude プロパティーを使用して全カテゴリーを省略したり、カスタム・ビューを指定して変更できます。

DimensionInclude プロパティーを使用してカスタム・ビューを指定する場合は、DimensionView プロパティーを使用してディメンションに関連付けられている View オブジェクトを返す必要があります。次に、Apex プロパティーを使用して新規のルート・カテゴリーを作成したり、SetViewStatus メソッドを使用して選択したレベルまたはカテゴリーに View オブジェクトを関連付けることができます。

カスタム・ビューを完了するには、カスタム・ビューをキューブに関連付ける必要があります。このためには、Add メソッドを使用してキューブのCubeCustomViews コレクションに CustomView オブジェクトを追加します。

このオブジェクトのプロパティーへの変更を保存するには、Update メソッドを使用します。

関連トピック

次の表は、関連するコレクション、メソッド、プロパティーを示します。

メソッド 説明

Delete メソッド View オブジェクトを削除します。

SetViewStatus メソッド Category、SpecialCategory、Level、またはDateLevel オブジェクトの表示方法を設定します。

Update メソッド View オブジェクトを更新します。

プロパティー 説明

Apex プロパティー ディメンション・ビューのルートになるCategory オブジェクトを設定する、または設定状態を返します。

Application プロパティー Transformer Application オブジェクトを返します。

CustomViews プロパティー ビューに関連付けられているカスタム・ビューを設定するか、設定状態を返します。

Name プロパティー オブジェクトの名前を設定する、または設定状態を返します。

126 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

プロパティー 説明

Parent プロパティー 親オブジェクトを返します。

Type プロパティー オブジェクトのタイプを返します。

ViewType プロパティー ディメンション・ビューでカテゴリーの全部または一部を表示する、表示しないかどうかを設定する、または設定状態を返します。

例objDimension = objModel.Dimensions("Retailers")objView= objDimension.Views.Add()

第 3 章 オブジェクト 127

128 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

第 4 章 メソッド

次の表は、Transformer OLE オートメーション・メソッドのリストです。

メソッド 説明

Add メソッド () コレクションにオブジェクトを追加します。

Add メソッド (Categories) Categories コレクションに Category オブジェクトまたは SpecialCategory オブジェクトを追加します。

Add メソッド (CustomViews) キューブを使用できるユーザーのリストにカスタム・ビューを追加します。

Add メソッド (DrillThroughTargets) Cube、CubeGroup または Measure オブジェクトの Reports コレクションに、新規のドリルスルー・カスタム・レポートを追加します。

Add メソッド (オブジェクト) 複数のタイプのオブジェクトを含むコレクションに、オブジェクトを追加します。

AddDeployLocation メソッド Copy および Activate の新しい配布場所を追加します。

AddToCustomView メソッド カスタム・ビューにセキュリティー・オブジェクトを追加します。

AddToFolder メソッド 数値データ・フォルダーに数値データを追加します。

AssociateWith メソッド モデルのオブジェクトをソース・オブジェクトに関連付け、Associations コレクションにAssociation オブジェクトを追加します。

CheckLocalPowerCubes メソッド モデルに定義されたキューブを、関連付けられている PowerCube ファイル (.mdc) と照合します。

CheckModel メソッド 現在のモデルをチェックし、オブジェクトとデータ・ソース、またはオブジェクト相互間に矛盾がないかを確認します。

CleanHouse メソッド モデルまたはディメンションから非アクティブなカテゴリーを削除します。

ClearDeployLocations メソッド すべての配布場所を削除します。

129

メソッド 説明

Close メソッド アクティブなモデルを閉じます。

ConnectWithCategory メソッド 子カテゴリーを同じレベルの新しい親カテゴリーに移動します。

CreateAlternateDrillDown メソッド ディメンションに代替ドリルダウン・パスを作成し、レベルを収束レベルにします。

CreateDateDimension メソッド DateWizard オブジェクトのプロパティーに基づいて DateDimension オブジェクトを作成します。

CreateMDCFile メソッド 1 つのキューブまたはキューブ・グループの全キューブについて PowerCube ファイル(.mdc) を作成します。

CreateMDCFiles メソッド モデルの全 PowerCube ファイル (.mdc) を作成します。

Delete メソッド オブジェクトを削除します。

DeleteAllCustomViews メソッド モデルのカスタム・ビューをすべて削除します。

DeleteAllSecurityObjects メソッド モデルからセキュリティー・オブジェクトを削除します。

DeployCube メソッド すべての配布場所に PowerCube を配布します。

DeployCubes メソッド すべての配布場所にモデルの PowerCube をすべて配布します。

DimensionAssociateWith メソッド 新規の DateDimension オブジェクトをソース・オブジェクトに関連付け、Associationsコレクションに Association オブジェクトを追加します。

DoAutoDesign メソッド ディメンション、レベル、ドリルダウン・パス、キューブ、数値データを生成します。

FindCategoryByCatCode メソッド 指定したカテゴリー・コードの文字列を含む、カテゴリー・オブジェクトを返します。

GenerateCategories メソッド モデルにカテゴリーを生成します。

GenerateDateCategories メソッド モデルにデータ・カテゴリーを生成します。

GetDefaultCategory メソッド ディメンションに属するデフォルトのカテゴリーを返します。

130 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

メソッド 説明

GetViewStatus メソッド Category、SpecialCategory、Level、またはDateLevel オブジェクトからビュー・ステータスを返します。

IsExcludeDateDimension メソッド 特定の日付ディメンションが除外されるかどうかを返します。

IsExcludeDateLevel メソッド 特定の日付レベルが除外されるかどうかを返します。

IsExcludeDimension メソッド ディメンションが制限されるかどうかを返します。

IsExcludeLevel メソッド レベルが制限されるかどうかを返します。

Item メソッド コレクション内の特定のオブジェクトを返します。

Item メソッド () コレクション内の特定のオブジェクトを返します。

Item メソッド () コレクション内の特定のオブジェクトを返します。

LoadCurrencyTable メソッド モデルに通貨表をロードします。

Logoff メソッド すべてのネームスペースからログオフします。

Logon メソッド ネームスペースにログオンします。

Move メソッド コレクション内のオブジェクトの位置を変更します。

MoveToCategory メソッド 子カテゴリーを別の親カテゴリーに移動します。

MoveToLevel メソッド 子カテゴリーを現在の親カテゴリーの下にある新しいレベルに移動します。

NewModel メソッド 新規モデルを作成します。

OpenModel メソッド 既存のモデルを開きます。

OpenSuspendedModel メソッド 中断モデルを開きます。

PublishDatasource メソッド PowerCube へのデータ・ソース接続を発行します。

第 4 章 メソッド 131

メソッド 説明

PublishPackage メソッド PowerCube へのデータ・ソースおよびパッケージの両方を発行します。

RemoveCubeCustomView メソッド キューブまたは子キューブからカスタム・ビューを削除します。

Remove メソッド 特定のオブジェクトをコレクションから削除します。

RemoveFromFolder メソッド 現在の数値データ・フォルダーから子数値データを削除します。

RemoveSuspendedModel メソッド 中断モデルを削除します。

ResetPartitions メソッド 現在のキューブ・パーティションを削除します。

Save メソッド 現在のモデルの変更を保存します。

SaveAs メソッド 現在のモデルを別のファイル名で保存します。

SetAllocation メソッド オブジェクトによって使用される数値データの割り当てタイプを変更します。

SetDefaultCategory メソッド ルート以外のディメンションの新規デフォルト・カテゴリーを指定します。

SetDeployType メソッド Copy および Activate の配布タイプを設定します。

SetExcludeDateDimension メソッド 特定の日付ディメンションを isRestricted の値に設定します。

SetExcludeDateLevel メソッド 特定の日付レベルを isRestricted の値に設定します。

SetExcludeDimension メソッド 指定したレポートとディメンションで、isRestricted パラメーターが True の場合にドリルスルー制限を True に設定します。

SetExcludeLevel メソッド 指定したレポートとレベルで、isRestrictedパラメーターが True の場合にドリルスルー制限を True に設定します。

SetViewStatus メソッド Category、SpecialCategory、Level、またはDateLevel オブジェクトからビュー・ステータスを返します。

132 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

メソッド 説明

TestBuild メソッド 小規模のテスト用のモデルまたはキューブを作成します。

Update メソッド 関連するオブジェクトを更新します。

Verify メソッド 関連するオブジェクトを検証します。

Add メソッド ()

Add メソッドは、オブジェクトをコレクションに追加します。

構文

collection .Add()

適用対象

Associations コレクション

CalculationDefinitions コレクション

CategorySets コレクション

Columns コレクション

CurrencyRecords コレクション

CurrencyTables コレクション

CustomViews コレクション

Filters コレクション

PackageDatasourceConnections コレクション

Packages コレクション

Queries コレクション

Measures コレクション

Namespaces コレクション

Reports コレクション

SecurityObjects コレクション

Signons コレクション

Views コレクション

第 4 章 メソッド 133

解説

このメソッドは、パラメーターを指定せずに、対応するコレクションにオブジェクトを追加するために使用します。

AssociateWith メソッドと DimensionAssociateWith メソッドを使用しても、Associations コレクションにオブジェクトを追加できます。

戻り値のタイプ

オブジェクト

例objCurrencyRecord = objModel.CurrencyRecords.Add()

Add メソッド (Categories)

Add メソッドは、Categories コレクションに Category オブジェクトまたはSpecialCategory オブジェクトを追加します。

構文

Categories .Add([Type] [, Level ])

適用対象

Categories コレクション

解説

CategorySet オブジェクトの Categories コレクションにオブジェクトを追加するには、Type パラメーターに既存の Category オブジェクトまたは SpecialCategoryオブジェクトを指定する必要があります。他のすべての Categories コレクションでは、Type パラメーターに xtrObjectType 値または xtrObjectType 値を設定する変数を指定します。

カテゴリーが属するレベルを指定するには、オプションの Level パラメーターを使用します。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

パラメーター 説明

タイプ オプション。ほとんどのコレクションでは、xtrObjectType の trCategory またはtrSpecialCategory 定数を指定します。CategorySet の Categories コレクションの場合、既存のオブジェクトに名前が付けられます。

タイプ:Variant

134 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

パラメーター 説明

レベル オプション。カテゴリーを追加するレベルの名前を指定します。省略した場合、カテゴリーは最下位レベルに追加されます。

タイプ:Object

戻り値のタイプ

オブジェクト

例objSpecCategory =_ objModel.Dimensions("Time").Categories.Add(xtrObjectType.trSpecialCategory)

Add メソッド (CustomViews)

Add メソッドは、キューブを使用できるユーザーのリストにカスタム・ビューを追加します。

構文

CubeCustomViews .Add(CustomView)

適用対象

CubeCustomViews

解説

このプロパティーを使用する前に、CustomView オブジェクトを作成し、そのプロパティーを設定および更新します。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

パラメーター 説明

CustomView 必須。Transformer モデルに含まれるカスタム・ビューを指定します。

タイプ:CustomView

戻り値のタイプ

CustomView

例cube = model.Cubes.Item("Sales and Marketing")cube.CubeCustomViews.Add(custom_view)

第 4 章 メソッド 135

Add メソッド (DrillThroughTargets)

Add メソッド (DrillThroughTargets) は、Cube、CubeGroup、ChildCube、またはMeasure オブジェクトの DrillThroughTargets コレクションに新しいドリルスルー・カスタム DrillThroughTarget を追加します。

構文

DrillThroughTargets .Add(DrillThroughTargetName, Description)

適用対象

DrillThroughTargets コレクション

解説

DrillThroughTarget オブジェクトは、Impromptu レポート (.imr)、Impromptu クエリー定義ファイル (.iqd)、PowerPlay レポート (.ppr)、PowerCube (.mdc)、またはマクロ・スクリプト・ファイル (.mac) を表します。

Measure オブジェクトの DrillThroughTargets コレクションにDrillThroughTarget オブジェクトを追加すると、ドリルスルー機能がその数値データのみに制限されます。Cube、ChildCube、または CubeGroup オブジェクトのDrillThroughTargets コレクションに DrillThroughTarget オブジェクトを追加すると、PowerPlay レポートの任意の位置でドリルスルー機能を使用できます。DrillThroughTargetName パラメーターは、DrillThroughTarget.Name プロパティーを設定します。DrillThroughTarget.Name プロパティーの設定には、完全修飾ファイル名を指定する必要があります。これは、Description パラメーターについても同様です。このパラメーターは、Description パラメーターとして渡される値に設定されます。

パラメーター 説明

DrillThroughTargetName 必須。ドリルスルー・ターゲットの完全なパス名を指定します。

タイプ:String

説明 必須。PowerPlay ユーザーにドリルスルー・ターゲットの目的を説明する、短いテキストを指定します。

タイプ:String

戻り値のタイプ

Object - DrillThroughTarget

例objReport = objMeasure.DrillThroughTargets.Add(strReportPath,"Default Report")

136 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

Add メソッド (オブジェクト)

Add メソッド (オブジェクト) は、複数のタイプのオブジェクトを含むコレクションにオブジェクトを追加します。

構文

collection .Add(Type)

適用対象

Cubes コレクション

DataSources コレクション

Dimensions コレクション

Levels コレクション

解説

DataSources コレクションのように、コレクションに複数のタイプのオブジェクトが含まれるときに使用します。Type パラメーターには、xtrObjectType 値リストの値を指定します。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

パラメーター 説明

タイプ DataSource オブジェクトのオプション。

注:DataSource タイプが指定されていない場合、デフォルトのタイプはFlatFileDataSource です。

他のオブジェクトではオプションです。値リスト xtrObjectType の定数を指定します。DateDimensions の追加時と、タイプtrDateDimension を使用しなければならない場合に必要になります。

タイプ:Variant

戻り値のタイプ

オブジェクト

例objDataSource = objModel.DataSources.Add(xtrObjectType.trFlatFileDataSource)

第 4 章 メソッド 137

AddDeployLocation メソッド

AddDeployLocation メソッドは、Copy および Activate の新しい配布場所を追加します。

構文

Cube .AddDeployLocation(deployPath)

適用対象

Cube オブジェクト

解説

このメソッドは、PowerCube の配布の設定に使用します。このメソッドを複数回呼び出して、Cube オブジェクトに複数の配布場所を追加できます。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

パラメーター 説明

deployPath PowerCube を配布するディレクトリーへのパスを指定します。

タイプ:String

戻り値のタイプ

なし

例cube = model.Cubes.Item("National")cube.AddDeployLocation("c:\NATIONAL\Deployment1")

AddToCustomView メソッド

AddToCustomView メソッドは、カスタム・ビューにセキュリティー・オブジェクトを追加します。

構文

SecurityObject .AddToCustomView

適用対象

SecurityObject オブジェクト

138 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

解説

CustomView オブジェクトに SecurityObject オブジェクトを追加するときに使用します。カスタム・ビューにユーザー、グループ、またはその他のセキュリティー・オブジェクトを追加するために使用します。

CustomView パラメーターは、セキュリティー・オブジェクトの追加先とするCustomView オブジェクトを指定します。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

パラメーター 説明

CustomView 必須。SecurityObject が適用されるCustomView を指定します。

タイプ:CustomView

戻り値のタイプ

なし

例new_namespace = model.Namespaces.Add()securityObject= new_namespace.SecurityObjects.Add()securityObject.AddToCustomView(customView)

AddToFolder メソッド

AddToFolder メソッドは、数値データを数値データ・フォルダーに追加します。

構文

measure .AddToFolder

適用対象

Measure オブジェクト

解説

まず IsFolder プロパティーを「True」に設定して、数値データ・フォルダーを作成します。この数値データ・フォルダーに数値を追加するには、AddToFolder メソッドを使用します。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

パラメーター 説明

数値データ 必須。追加する Measure オブジェクトを指定します。

タイプ:Object - Measure

第 4 章 メソッド 139

戻り値のタイプ

なし

AssociateWith メソッド

AssociateWith メソッドは、モデルに含まれるオブジェクトにソース・オブジェクトを関連付けます。

構文

object .AssociateWith Reference, Role [, Context]

適用対象

CurrencyTable オブジェクト

DateDimension オブジェクト

DateLevel オブジェクト

Dimension オブジェクト

Level オブジェクト

Measure オブジェクト

解説

このメソッドは、モデルのオブジェクトをデータ・ソースのオブジェクトに関連付けるために使用します。Reference パラメーターの機能は、Association オブジェクトの Reference プロパティーと同じです。Role パラメーターの機能は、AssociationRole プロパティーと同じです。Context パラメーターの機能は、Context プロパティーと同じです。

AssociateWith メソッドを使用すると、オブジェクトの Associations コレクションに Association オブジェクトが追加されます。例えば、Measure オブジェクトのAssociations コレクションにすでに 2 つのオブジェクトがある場合、AssociateWith メソッドを使用するとコレクションに 3 番目のオブジェクトが追加されます。

AssociateWith メソッドは、Associations コレクションの Add メソッドの代替機能です。

オブジェクトに AssociateWith メソッドを使用したときは、必ず同じオブジェクトの Update メソッドを実行します。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

140 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

パラメーター 説明

Reference 必須。関連付けのソースを指定します。

タイプ:Object

Role 必須。参照を使用する方法を指定します。このパラメーターには、値リストxtrAssociationRole の定数を指定します。

タイプ:定数

Context 並べ替えの関連付けに必須。レベルをソートするドリルダウン・パスを指定します。Level オブジェクトと DateLevel オブジェクトにのみ適用します。

タイプ:Object

戻り値のタイプ

Object - Association

例objLocationsDim = objModel.Dimensions("Sales regions")objLevel= objLocationsDim.DrillDowns(1).Levels("Employee")objAltDrill= objLevel.CreateAlternateDrillDownobjNewLevel= objAltDrill.Levels.Add(xtrObjectType.trLevel)objNewLevel.

AssociateWith(objRefSource, xtrAssociationRole.trAssociationSource)

CheckLocalPowerCubes メソッド

CheckLocalPowerCubes メソッドは、モデルに定義されたキューブを、関連付けられている PowerCube ファイル (.mdc) と照合します。

構文

Model .CheckLocalPowerCubes

適用対象

Model オブジェクト

解説

モデルに含まれるキューブのステータスをチェックし、必要に応じてステータスを変更します。

ステータスが Warning、Invalid、Busy または OK の場合、そのキューブに対し有効な PowerCube ファイルが存在するかどうかがチェックされます。PowerCubeファイルを見つけられない場合、PowerCube のステータスは Missing に設定されます。キューブ・ファイルが存在していても開くことができない場合、あるいはファイルの作成スタンプがモデルのスタンプと一致しない場合 (キューブが他のモデルまたは旧バージョンの現在のモデルから作成されたことを示す)、PowerCube のステータスは Invalid に設定されます。

第 4 章 メソッド 141

戻り値のタイプ

なし

CheckModel メソッド

CheckModel メソッドは、現在のモデルをチェックし、オブジェクトとデータ・ソース、またはオブジェクト相互間に矛盾がないかを確認します。

構文

Model .CheckModel

適用対象

モデル・オブジェクト

解説

Transformer では、カテゴリーの生成、またはキューブの作成前に常にモデルがチェックされますが、このメソッドを使用するといつでもモデルをチェックできます。

設計プロセスの主要な各段階 (新規のデータ・ソースや関連を追加したときなど)や、キューブの定義を作成した後に、モデルをチェックします。

CheckModel メソッドは、Names コレクションを返します。このコレクションの各Name オブジェクトには、完全なメッセージ文字列が含まれます。Name プロパティーを使用して CheckModel プロシージャーの結果を読み取ることができます。

戻り値のタイプ

Object - Names

例For intX = 1 To objModel.CheckModel.Count

CleanHouse メソッド

CleanHouse メソッドは、モデルまたはディメンションから非アクティブなカテゴリーを削除します。

構文

object .CleanHouse Date

適用対象

DateDimension オブジェクト

Dimension オブジェクト

142 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

モデル・オブジェクト

解説

このメソッドは、非アクティブなカテゴリーがあるかどうかを確認するために使用します。組織の変更に合わせて更新してきたモデルには、不要なカテゴリーが残っていることがあります。Date パラメーターで指定した日時以後、作成、更新、移動、または変更していないカテゴリーは、非アクティブと見なされます。

CleanHouse メソッドでは、Transformer により各 Category オブジェクトのLastUseDate プロパティーがチェックされ、Date パラメーターの値と比較されます。LastUseDate プロパティーの日付が Date パラメーターの値より古い場合は、カテゴリーが削除されます。

ディメンションに CleanHouse メソッドを使用した場合、そのディメンションが使用するカテゴリーのみがチェックされます。モデルに CleanHouse メソッドを使用した場合、モデルの全カテゴリーがチェックされます。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

パラメーター 説明

Date 必須。カテゴリーがアクティブかどうかの判断に使用する日付を YYYYMMDD の書式で指定します。

タイプ:Long

戻り値のタイプ

なし

ClearDeployLocations メソッド

ClearDeployLocations メソッドは、すべての配布場所を削除します。

構文

Cube .ClearDeployLocations

適用対象

Cube オブジェクト

解説

このメソッドは、Cube オブジェクトからすべての配布場所を削除するために使用します。このメソッドは、PowerCube の配布前の準備または PowerCube の配布後のクリーンアップに使用できます。キューブ・グループの場合、子キューブも影響を受けます。これは、時系列にパーティション化されたキューブには適用されません。

第 4 章 メソッド 143

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

戻り値のタイプ

なし

例cube = model.Cubes.Item("National")cube.ClearDeployLocations()'Remove the deployment locations from the model

Close メソッド

Close メソッドは、現在のモデルを閉じます。

構文

Model .Close

適用対象

モデル・オブジェクト

解説

このメソッドは、別のモデルを作成したり開いたりする前に、現在のモデルを閉じるために使用します。

モデルを保存する前に閉じると、Update メソッドによるオブジェクトの更新も含め、モデルの変更はすべて失われます。

戻り値のタイプ

なし

例objModel.Close()

ConnectWithCategory メソッド

ConnectWithCategory メソッドは、子カテゴリーを同じレベルの新しい親カテゴリーに移動します。

構文

Category .ConnectWithCategory(Parent [, DrillDown])

適用対象

Category オブジェクト

144 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

解説

MoveToCategory メソッドと MoveToLevel メソッドを使用しても、Category オブジェクトと SpecialCategory オブジェクトを別の位置またはコレクションへ移動できます。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

パラメーター 説明

Parent 必須。接続する親カテゴリーを指定します。

タイプ:Object

DrillDown オプション。親が複数のドリルダウン・パスに存在する場合、DateDrillDown またはDrillDown オブジェクトを指定します。値には、位置の数値インデックス、オブジェクト名の文字列、またはスクリプトに定義したオブジェクトを指定できます。

タイプ:Variant

戻り値のタイプ

なし

例objDimension = objModel.Dimensions("Retailers")objCategories= objDimension.DrillDowns(1).CategoriesobjParentCategory= objCategories(parent_category_index)objCategories= objDimension.DrillDowns(1).CategoriesobjCategory= objCategories(5)objChildCategory= objCategory.ChildCategories(1)objChildCategory.

ConnectWithCategory(objParentCategory)

CreateAlternateDrillDown メソッド

CreateAlternateDrillDown メソッドは、ディメンションに代替ドリルダウン・パスを作成し、レベルを収束レベルにします。

構文

object .CreateAlternateDrillDown

適用対象

DateLevel オブジェクト

Level オブジェクト

第 4 章 メソッド 145

解説

このメソッドは、ディメンションの代替ドリルダウン・パスの作成に使用します。このメソッドは、収束レベルとして指定するレベルに適用します。Transformer では、ディメンションの最初のレベルから収束レベルまでのドリルダウン・パスが作成されます。次に、収束レベルに接続する新規のドリルダウン・パスにレベルを挿入して、ソース値と新規のレベルを関連付ける必要があります。Transformer では、常にオブジェクトがコレクションの最後に追加されるため、新規のレベルをLevels コレクションの収束レベルより上位に移動する必要があります。

作成されるドリルダウン・パスのタイプ (DrillDown または DateDrillDown オブジェクト) は、レベルのタイプに依存します。新規のドリルダウン・パスは、そのディメンションの DrillDowns コレクションに追加されます。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

戻り値のタイプ

オブジェクト

例objLocationsDim = objModel.Dimensions("Sales regions")objLevel= objLocationsDim.DrillDowns(1).Levels("Employee")objAltDrill= objLevel.CreateAlternateDrillDown

CreateDateDimension メソッド

CreateDateDimension メソッドは、DateDimension オブジェクトを作成します。

構文

DateWizard .CreateDateDimension

適用対象

DateWizard オブジェクト

解説

DateWizard オブジェクトの該当するプロパティーを設定し、DimensionAssociateWith メソッドでデータ・ソースを割り当てた後、このメソッドを使用して新規の DateDimension オブジェクトを作成します。

このメソッドは、DateDimension オブジェクトを返します。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

戻り値のタイプ

Object - DateDimension

146 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

例objDateWizard = objModel.DateWizardobjDateWizard.DimensionAssociateWith(objColumn, xtrAssociationRole.trAssociationSource)

CreateMDCFile メソッド

CreateMDC File メソッドは、1 つのキューブまたはキューブ・グループの全キューブについて、PowerCube ファイル (.mdc) を作成します。

構文

object .CreateMDCFile

適用対象

Cube オブジェクト

CubeGroup オブジェクト

解説

このメソッドは、モデルのキューブまたはキューブ・グループの定義からPowerCube を作成するために使用します。

キューブを作成すると、Transformer では自動的にデータ・ソースの列からカテゴリーが生成されます。キューブにカテゴリーが含められるかどうかは、各種プロパティー (Consolidate、Inclusion、DuplicateRollup など) の設定に依存します。

このメソッドを使用する前に、LocalPath プロパティーと DataSourcePath プロパティーを正しく設定しておく必要があります。

モデルの全キューブを作成するには、CreateMDCFiles メソッドを使用します。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

戻り値のタイプ

なし

例objCube = objModel.Cubes.Item(1)objCube.CreateMDCFile()

CreateMDCFiles メソッド

CreateMDCFiles メソッドは、モデルの全 PowerCube ファイル (.mdc) を作成します。

構文

Model .CreateMDCFiles

第 4 章 メソッド 147

適用対象

Model オブジェクト

解説

このメソッドは、モデルの全キューブおよびキューブ・グループについてPowerCube を作成するために使用します。

キューブを作成すると、Transformer では自動的にデータ・ソースの列からカテゴリーが生成されます。キューブにカテゴリーが含められるかどうかは、各種プロパティー (Consolidate、Inclusion、DuplicateRollup など) の設定に依存します。

このメソッドを使用する前に、LocalPath プロパティーと DataSourcePath プロパティーを正しく設定しておく必要があります。

1 つのキューブまたはキューブ・グループについて PowerCube ファイル (.mdc)を作成するには、CreateMDCFile メソッドを使用します。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

戻り値のタイプ

なし

Delete メソッド

Delete メソッドは、オブジェクトをモデルから削除します。

構文

object .Delete()

適用対象

Delete メソッドは次のオブジェクトに適用されます。

Association オブジェクト

CalculationDefinition オブジェクト

Category オブジェクト

CategorySet オブジェクト

Column オブジェクト

CrossTabDataSource オブジェクト

61 ページの『Cube オブジェクト』

CubeGroup オブジェクト

148 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

CurrencyRate オブジェクト

CurrencyRecord オブジェクト

CurrencyTable オブジェクト

DateDimension オブジェクト

DateDrillDown オブジェクト

DataSource オブジェクト

DateLevel オブジェクト

DbDataSource オブジェクト

Dimension オブジェクト

DrillDown オブジェクト

DrillThroughTarget オブジェクト

Filter オブジェクト

FlatFileDataSource オブジェクト

IqdDataSource オブジェクト

Level オブジェクト

Measure オブジェクト

Namespace オブジェクト

PackageDatasourceConnection オブジェクト

Package オブジェクト

Prompt オブジェクト

Query オブジェクト

Report オブジェクト

SecurityObject オブジェクト

Signon オブジェクト

SpecialCategory オブジェクト

View オブジェクト

第 4 章 メソッド 149

解説

このメソッドは、オブジェクトがコレクションの外部にある場合、モデルからオブジェクトを削除するために使用します。コレクションからオブジェクトを削除するには、Remove メソッドを使用します。

Transformer で作成した各ディメンションのデフォルトの主ドリルダウン・パスは削除できません。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

戻り値のタイプ

なし

例objLevel= objTimeDimension.DrillDowns.Item(1).Levels.Item("Month")sobjLevel.Delete()

DeleteAllCustomViews メソッド

DeleteAllCustomViews メソッドは、モデルのカスタム・ビューをすべて削除します。

構文

Model .DeleteAllCustomViews()

適用対象

モデル・オブジェクト

解説

カスタム・ビューを削除するとに、割り当てられているセキュリティー・オブジェクトも削除されます。

戻り値のタイプ

なし

DeleteAllSecurityObjects メソッド

DeleteAllSecurityObjects メソッドは、モデルからセキュリティー・オブジェクトを削除します。

構文

Model .DeleteAllSecurityObjects()

150 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

適用対象

モデル・オブジェクト

解説

カスタム・ビューを削除すると、ビューに割り当てられているセキュリティー・オブジェクトも削除されます。

戻り値のタイプ

なし

DeployCube メソッド

DeployCube メソッドは、すべての配布場所に PowerCube を配布します。

構文

Cube .DeployCube()

適用対象

Cube オブジェクト

解説

このメソッドは、すべての PowerCube を配布するために使用します。PowerCubeの配布後、PublishDatasource または PublishPackage を呼び出します。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

戻り値のタイプ

なし

例cube = model.Cubes.Item("National")cube.DeployCube()

DeployCubes メソッド

DeployCubes メソッドは、すべての配布場所にモデルの PowerCube をすべて配布します。

構文

Model .DeployCubes()

適用対象

Model オブジェクト

第 4 章 メソッド 151

解説

このメソッドは、モデルの PowerCube をすべて配布するために使用します。PowerCube の配布後、PublishDatasource または PublishPackage を呼び出します。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

戻り値のタイプ

Boolean 値

DimensionAssociateWith メソッド

DimensionAssociateWith メソッドは、新規の DateDimension オブジェクトをソース・オブジェクトに関連付け、Associations コレクションに Association オブジェクトを追加します。

構文

DateWizard .DimensionAssociateWith Reference, Role [, Context]

適用対象

DateWizard オブジェクト

解説

このメソッドは、DateDimension オブジェクトをデータ・ソースのオブジェクトに関連付けるために使用します。Reference パラメーターの機能は、Association オブジェクトの Reference プロパティーと同じです。Role パラメーターの機能は、AssociationRole プロパティーと同じです。Context パラメーターの機能は、Context プロパティーと同じです。

DimensionAssociateWith メソッドを使用すると、DateDimension オブジェクトのAssociations コレクションに Association オブジェクトが追加されます。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

パラメーター 説明

Reference 必須。関連付けのソースを指定します。

タイプ:Object

Role 必須。参照を使用する方法を指定します。このパラメーターには、値リストxtrAssociationRole の定数を指定します。

タイプ:定数 - xtrAssociationRole

152 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

パラメーター 説明

Context 並べ替えの関連付けに必須。レベルをソートするドリルダウン・パスを指定します。Level オブジェクトと DateLevel オブジェクトにのみ適用します。

タイプ:Object

戻り値のタイプ

なし

例objDateWizard = objModel.DateWizardobjDateWizard.DimensionAssociateWith(objColumn, xtrAssociationRole.trAssociationSource)

DoAutoDesign メソッドDoAutoDesign メソッドは、ディメンション、レベル、ドリルダウン・パス、キューブ、数値データを生成します。

構文

Model .DoAutoDesign

適用対象

モデル・オブジェクト

解説

このメソッドは、新規モデルの主要なコレクションを生成したり、未使用の列に基づいてディメンションとレベルを既存のモデルに追加するために使用します。

このメソッドは、データ・ソースのデータ型、列名、構造のフレームワークを分析します。日付を時間ディメンションに、数値の列を Measures コレクションに、残りの列すべてを Dimension オブジェクトに配置します。新規ディメンションには、Levels コレクションと DrillDowns コレクションが含まれます。

戻り値のタイプ

なし

例objModel = objTransApp.NewModel objModel.DoAutoDesign()

FindCategoryByCatCode メソッドFindCategoryByCatCode メソッドは、指定したカテゴリー・コードの文字列を含むカテゴリー・オブジェクトを返します。

第 4 章 メソッド 153

構文

Dimension .FindCategoryByCatCode CatCode

適用対象

Dimension オブジェクト

解説

このメソッドは、指定したカテゴリー・コードを含む、カテゴリー・オブジェクトを返すために使用します。

指定したカテゴリー・コードを持つカテゴリーが見つからない場合、メソッドは何も返しません。このメソッドでカテゴリーを返す方法は、カテゴリーのコレクションからカテゴリーにアクセスする場合よりも高速です。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

パラメーター 説明

CatCode 必須。関連するカテゴリーを指定します。

タイプ:String

戻り値のタイプ

Category

GenerateCategories メソッド

GenerateCategories メソッドは、モデルにカテゴリーを配置します。

構文

Model .GenerateCategories

適用対象

モデル・オブジェクト

解説

このメソッドは、DoAutoDesign メソッドを使用した後、またはモデルにディメンションとレベルを手動で追加した後、データ・ソースからカテゴリーを生成するために使用します。Transformer では、カテゴリー生成時にデータ・ソースが読み取られて分析され、カテゴリーの階層が構築されます。カテゴリーは、キューブ作成時に自動生成されます。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

154 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

戻り値のタイプ

なし

例objModel.GenerateCategories()

GenerateDateCategories メソッド

GenerateDateCategories メソッドは、EarliestDate パラメーターと LatestDate パラメーターで指定された日付カテゴリーを、モデルに生成します。

構文

DateDimension .GenerateDateCategories()

適用対象

DateDimension オブジェクト

解説

このメソッドは、DateDimension オブジェクトと、関連する DrillDown オブジェクトを作成した後に、データ・ソースから日付カテゴリーを生成するために使用します。生成される日付カテゴリーの範囲は、EarliestDate と LatestDate で指定します。このメソッドは、DoAutoDesign メソッドを使用した後、またはディメンションとレベルを手動でモデルに追加した後に使用します。Transformer では、カテゴリー生成時にデータ・ソースが読み取られて分析され、カテゴリーの階層が構築されます。カテゴリーは、キューブ作成時に自動生成されます。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、TR0821 です。

戻り値のタイプ

なし

パラメーター 説明

EarliestDate 必須。最初の日付カテゴリーを指定します。この値は、日付書式"YYYYMMDD"にする必要があります。この値が日付値ではないか、日付ディメンション EarliestDate より前の日付である場合、保存されるモデルは無効になります。

タイプ:Long

LatestDate 必須。最後の日付カテゴリーを指定します。この値は、日付書式"YYYYMMDD"にする必要があります。

タイプ:Long

第 4 章 メソッド 155

例objDateDim= objModel.Dimensions("Date")objDateDim.GenerateDateCategories(19990101, 20101231)

GetDefaultCategory メソッド

GetDefaultCategory メソッドは、ディメンションに属するデフォルト・カテゴリーを返します。クロス集計レポートを初めて開いた場合、このカテゴリーを使用します。

構文

DateDimension .GetDefaultCategory

適用対象

DateDimension オブジェクト

Dimension オブジェクト

解説

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

戻り値のタイプ

Category オブジェクト

パラメーター 説明

なし

GetViewStatus メソッド

GetViewStatus メソッドは、Category、SpecialCategory、DateLevel、または Levelオブジェクトのビュー・ステータスを返します。

構文

View .GetViewStatus

適用対象

View オブジェクト

解説

View オブジェクトを取得したら、それを使用して、関連するCategory、SpecialCategory、DateLevel、または Level オブジェクトのビュー・ステータスを取得できます。返される定数は、xtrViewStatus 値リストのいずれかの値になります。

156 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

戻り値のタイプ

定数 - xtrViewStatus

パラメーター 説明

オブジェクト 必須。このメソッドは、Category、SpecialCategory、DateLevel、または Level オブジェクトのいずれかにのみ適用できます。

タイプ:Object

例objDimension = objModel.Dimensions("Retailers")objView= objDimension.Views.Add()If objView.GetViewStatus(objCategory)<> _xtrViewStatus.trViewStatusSummaryMom Then

IsExcludeDateDimension メソッド

isExcludeDateLevel メソッドは、特定の日付ディメンションが除外されるかどうかを返します。

構文

DrillThroughTarget .isExcludeDateDimension

適用対象

DrillThroughTarget オブジェクト

解説

このプロパティーは、特定の日付ディメンションがドリルスルー・ターゲットから制限されるかどうかを取得するために使用します。

パラメーター 説明

DateDimension 必須。プロパティーが適用される日付ディメンションを指定します。

戻り値のタイプ

文字列

アクセス

Read/Write

第 4 章 メソッド 157

IsExcludeDateLevel メソッド

isExcludeDateLevel メソッドは、特定の日付レベルが除外されるかどうかを返します。

構文

DrillThroughTarget .isExcludeDateLevel

適用対象

DrillThroughTarget オブジェクト

解説

このプロパティーは、特定の日付レベルがドリルスルー・ターゲットから制限されるかどうかを取得するために使用します。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

パラメーター 説明

DateLevel 必須。プロパティーが適用される日付レベルを指定します。

タイプ:DateLevel

戻り値のタイプ

Boolean 値

アクセス

Read/Write

IsExcludeDimension メソッド

isExcludeDimension メソッドは、ディメンションが除外されるかどうかを返します。

構文

DrillThroughTarget .isExcludeDimension

適用対象

DrillThroughTarget オブジェクト

解説

このプロパティーは、特定のディメンションがドリルスルー・ターゲットから制限されるかどうかを取得するために使用します。

158 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

パラメーター 説明

Level オブジェクト 必須。プロパティーが適用されるディメンションを指定します。

タイプ:Object - Level

タイプ

文字列

アクセス

Read/Write

IsExcludeLevel メソッド

isExcludeLevel メソッドは、指定したレポートに対し、レベルを除外するかどうかを指定します。

構文

DrillThroughTarget .isExcludeLevel

適用対象

DrillThroughTarget オブジェクト

解説

このプロパティーは、特定のレベルがドリルスルー・ターゲットから制限されるかどうかを取得するために使用します。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

パラメーター 説明

レベル 必須。プロパティーが適用されるレベルを指定します。

タイプ

文字列

アクセス

Read/Write

第 4 章 メソッド 159

Item メソッドItem メソッドは、コレクションに含まれる特定のオブジェクトを返します。

構文

collection .Item(Key, [Type])

適用対象

Categories コレクション

Cubes コレクション

DataSources コレクション

Dimensions コレクション

DrillDowns コレクション

Levels コレクション

PackageDatasourceConnections コレクション

Packages コレクション

Queries コレクション

Reports コレクション

解説

複数のオブジェクト・タイプを含むことのできるコレクションの場合、Type パラメーターによって Key パラメーターが変化します。Key パラメーターのみを指定した場合、Item メソッドでは、コレクションの最初から指定のオブジェクトまたはコレクションの最後までカウントされます。オプションの Type パラメーターを指定した場合は、そのタイプのオブジェクトのみがカウントされます。このように、Keyパラメーターと Type パラメーターを使用して、コレクションの特定の位置にある特定のオブジェクト・タイプを選択できます。

例えば、Dimensions コレクションには、Dimension オブジェクトとDateDimension オブジェクトの両方を含むことができます。タイプにかかわらずコレクションの 5 番目のオブジェクトを選択するには、次に示す命令文を使用します。この例は、VB.NET に適用されますが、C# には適用されないことに注意してください。C# では、使用するタイプにかかわらず両方のパラメーターを指定する必要があります。

Set objDim = objDimColl.Item(5)

Dimension dim = (Dimension)model.Dimensions.Item(5,null);

Dimension オブジェクトと DateDimension オブジェクトのコレクションにある 3番目の DateDimension オブジェクトを選択するには、次の命令文を使用します。

Set objDim = objDimColl.Item(3, "trDateDimension")

160 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

Key パラメーターには、オブジェクトの名前の文字列も指定できます。したがって、"Order Dates"という DateDimension オブジェクトを選択するには、次の命令文を使用します。

Set objDim = objDimColl.Item("Order Dates")

Type パラメーターは、Categories コレクション、Cubes コレクション、DataSources コレクション、Dimensions コレクションのオブジェクトにのみ適用されます。複数のオブジェクト・タイプを含むコレクションですべての項目を繰り返す場合は、Type パラメーターを Null に設定する必要があります。

Type パラメーターを指定しない場合は、Item メソッドを暗黙的に使用できます。例えば、次の命令文は同じ意味です。VB.NET にのみ適用されます。

objModel.Dimensions("Dates").DrillDowns(1).Levels("Month")

注:バージョン 7.0 から、Item メソッドでは大文字と小文字が区別されます。

例えば、次の例は"Line"というディメンションにのみ一致し、"line"には一致しません。

objModel.Dimension("Line")

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

パラメーター 説明

キー 必須。検索する位置の数値インデックス (1から開始)、またはオブジェクト名の文字列を指定します。

タイプ:Variant

タイプ オプション。値リスト xtrObjectType の定数を指定します。Categories、 Cubes、DataSources、 Dimensions、DimensionLevels、 DrillDowns、 Levels コレクションにのみ適用されます。

タイプ:定数

戻り値のタイプ

オブジェクト

例objDimensions = objModel.DimensionsobjLocationsDim= objDimensions.Item(3)objLocationsDim= objDimensions.Item(3)

Item メソッド ()

Item メソッドは、コレクションに含まれる特定のオブジェクトを返します。

第 4 章 メソッド 161

構文

collection .Item(Key)

適用対象

Associations コレクション

CalculationDefinitions コレクション

CategorySets コレクション

ChildCubes コレクション

Columns コレクション

CubeCustomViews コレクション

Cubes コレクション

CurrencyRates コレクション

CurrencyRecords コレクション

CurrencyTables コレクション

CustomViews コレクション

DrillThroughTargets コレクション

Filters コレクション

LevelDrillDowns コレクション

Measures コレクション

Names コレクション

Namespaces コレクション

Prompts コレクション

SecurityObjects コレクション

Signons コレクション

SuspendedModels コレクション

Views コレクション

解説

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

162 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

パラメーター 説明

キー 必須。検索する位置の数値インデックス (1から開始)、またはオブジェクト名の文字列を指定します。検索するオブジェクト名の文字列は、関連付けに対しては機能しません。

タイプ:Variant

戻り値のタイプ

オブジェクト

Item メソッド ()

Item メソッドは、コレクションに含まれる特定のオブジェクトを返します。

構文

collection .Item(Key, Type)

適用対象

DimensionLevels コレクション

LevelCategories コレクション

解説

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

パラメーター 説明

キー 必須。検索する位置の数値インデックス (1から開始)、またはオブジェクト名の文字列を指定します。検索するオブジェクト名の文字列は、関連付けに対しては機能しません。

タイプ:Variant

タイプ 必須。値リスト xtrObjectType の定数を指定します。Categories、 Cubes、DataSources、 Dimensions、DimensionLevels、 DrillDowns、 Levels コレクションにのみ適用されます。実装言語によっては、この値が不要である場合に、前に示されているように Null に設定する必要があります。

タイプ:定数

第 4 章 メソッド 163

戻り値のタイプ

オブジェクト

LoadCurrencyTable メソッドLoadCurrencyTable メソッドは、モデルに通貨表をロードします。

構文

Model .LoadCurrencyTable

適用対象

モデル・オブジェクト

解説

このメソッドは、外部データ・ソースから情報を通貨表にロードするために使用します。このメソッドを使用するには、CurrencyTables コレクションに少なくとも 1つの通貨表が必要です。

CurrencyTables コレクションにユーロ通貨表を追加するには、プロセスの 2 つの段階で LoadCurrencyTable メソッドを使用する必要があります。ユーロ表内の関連付けの役割と各データ・ソース列を関連付けた後、およびユーロ表に通貨レコードを追加した後、このメソッドを使用します。

戻り値のタイプ

なし

例objModel.LoadCurrencyTable()

Logoff メソッドLogoff メソッドは、すべてのネームスペースからログオフします。

構文

Application .Logoff()

適用対象

Application オブジェクト

解説

このプロパティーは、現在のネームスペースからログオフするために使用します。Logoff メソッドとともに使用します。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

164 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

戻り値のタイプ

なし

Logon メソッドLogon メソッドは、ネームスペースにログオンします。

構文

Application .Logon(Namespace, Username, Password)

適用対象

Application オブジェクト

解説

このプロパティーは、ネームスペースへのログオンに使用します。Logoff メソッドとともに使用します。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

パラメーター 説明

ネームスペース 必須。ログオン用のネームスペースを指定します。

タイプ:String

Username 必須。ログオン用のユーザー名を指定します。

タイプ:String

パスワード 必須。ユーザー名に対応するパスワードを指定します。

タイプ:String

戻り値のタイプ

なし

例objTransApp.Logon("Cognos", "", "") 'Log into the Cognosnamespace using Anonymous user.

Move メソッドMove メソッドは、コレクション内のオブジェクトを再配置します。

第 4 章 メソッド 165

構文

object .Move(Before, After)

適用対象

59 ページの『CrossTabDataSource オブジェクト』

DataSource オブジェクト

DateDimension オブジェクト

DateLevel オブジェクト

87 ページの『DbDataSource オブジェクト』

Dimension オブジェクト

FlatFileDataSource オブジェクト

98 ページの『IqdDataSource オブジェクト』

Level オブジェクト

Measure オブジェクト

解説

Before パラメーターと After パラメーターは、相互に排他的です。どちらか 1 つを使用してください。両方のパラメーターを省略した場合は、エラーとなり、COM例外が発生します。両方のパラメーターを使用した場合は、Before パラメーターのみが使用されます。無効なオブジェクトを使用した場合は、COM 例外が発生します。

コレクションに含まれるオブジェクトを選択するには、Items メソッドを使用します。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

パラメーター 説明

Before After を指定しない場合に必須。値には、位置の数値インデックス (1 から開始) またはスクリプトに定義したオブジェクトを指定できます。

タイプ:Variant

After Before を指定しない場合に必須。値には、位置の数値インデックス (1 から開始) またはスクリプトに定義したオブジェクトを指定できます。

タイプ:Variant

166 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

戻り値のタイプ

なし

例objMeasures = objModel.MeasuresobjMeasures.Item(2).Move(1)

MoveToCategory メソッドMoveToCategory メソッドは、子カテゴリーを別の親カテゴリーに移動します。

構文

Category .MoveToCategory(Parent [, Sibling]

適用対象

Category オブジェクト

解説

カテゴリーを新しい親の下にある任意のレベルに移動します。移動するカテゴリーと新しい位置にある既存カテゴリーとの位置関係を指定するには、Sibling パラメーターを使用します。

ConnectWithCategory メソッドと MoveToLevel メソッドを使用しても、カテゴリーを別の位置へ移動できます。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。次にいくつかの例を示します。

v "サーバーから例外が返されました(HRESULT からの例外: 0x80010105(RPC_E_SERVERFAULT))"

v "trCategory(Category) : 予期しないタイプのオブジェクトです" (いずれかのパラメーターが予期しないタイプの場合)

パラメーター 説明

Parent 必須。接続する親カテゴリーを指定します。

タイプ:Object

Sibling オプション。同じレベルの子カテゴリーを指定します。移動したカテゴリーはこの子カテゴリーの後に配置されます。指定しない場合、カテゴリーは子カテゴリーの最後に移動されます。値には、位置の数値インデックス、オブジェクト名の文字列、またはスクリプトに定義したオブジェクトを指定できます。

タイプ:Variant

第 4 章 メソッド 167

戻り値のタイプ

なし

例objCategory= objModel.Dimensions("Retailers").DrillDowns(1).Categories(2)objCatToMove= objCategory.ChildCategories(5)objCatToReceive= objModel.Dimensions("Retailers").DrillDowns(1).Categories(1)objCatToMove.MoveToCategory(objCatToReceive)

MoveToLevel メソッドMoveToLevel メソッドは、子カテゴリーを、現在の親カテゴリーの下にある別のレベルに移動します。

構文

Category .MoveToLevel(Level)

適用対象

Category オブジェクト

解説

カテゴリーを、元の親の下にある任意の上位または下位レベルに移動します。

ConnectWithCategory メソッドと MoveToCategory メソッドを使用しても、カテゴリーを別の位置へ移動できます。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

パラメーター 説明

レベル 必須。カテゴリーを移動するレベルを指定します。

タイプ:Object

戻り値のタイプ

なし

N/A

NewModel メソッドNewModel メソッドは、新しいモデルを作成します。

168 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

構文

Application .NewModel

適用対象

Application オブジェクト

解説

このメソッドは、新規モデルの作成に使用します。

新規に作成されたモデルは、実質的に空の状態です。キューブを構築する前に、データ・ソース、ディメンション、レベル、数値データを定義する必要があります。

新規モデルの定義を保存するには、Save メソッドではなく SaveAs メソッドを使用します。

既存のモデルを変更するには、OpenModel メソッドを使用します。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

戻り値のタイプ

モデル

例objModel = objTransApp.NewModel

OpenModel メソッドOpenModel メソッドは、既存のモデルを開きます。

構文

Application .OpenModel(Name)

適用対象

Application オブジェクト

解説

このメソッドは、変更が必要な場合、既存のモデルを参照するために使用します。

新規モデルを作成するには、NewModel メソッドを使用します。モデルの変更を保存するには、Save メソッドまたは SaveAs メソッドを使用します。モデルを閉じるには、Close メソッドを使用します。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

第 4 章 メソッド 169

パラメーター 説明

名前 必須。モデルの絶対パス名を指定します。

タイプ:String

Login 保護されたモデルに必須。モデルにアクセスするユーザーのユーザー ID を指定します。

タイプ:String

パスワード 保護されたモデルに必須。モデルにアクセスするユーザーのパスワードを指定します。

タイプ:String

UserClass 保護されたモデルに必須。モデルにアクセスするユーザーのユーザー・クラスを指定します。

タイプ:String

戻り値のタイプ

オブジェクト

例objModel = objTransApp.OpenModel(strModelPath)

OpenSuspendedModel メソッドOpenSuspendedModel メソッドは、既存の中断モデルを開きます。

構文

Application .OpenSuspendedModel(Name)])

適用対象

Application オブジェクト

解説

このメソッドは、既存の不完全なモデルを開くために使用します。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

パラメーター 説明

SuspendedModel Object 必須。既存の不完全なモデルを指定します。

タイプ: Object - 中断モデル

戻り値のタイプ

Object - Model

170 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

PublishDatasource メソッドPublishDatasource メソッドは、PowerCube へのデータ・ソース接続を発行します。

構文

Cube .PublishDatasource(overwrite)

適用対象

Cube オブジェクト

解説

このメソッドは、IBM Cognos サーバーでデータ・ソース接続を発行するために使用します。

IBM Cognos サーバーから各キューブへのアクセス元となる Windows、UNIX または Linux 上の場所を指定する必要があります。ユーザー認証が有効な場合は、設定済みネームスペースも指定する必要があります。成功した場合は True が返されます。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

パラメーター 説明

overwrite 必須。true の場合、すでに存在するデータ・ソースを再発行します。

タイプ:Boolean

戻り値のタイプ

Boolean 値 (発行が成功した場合 True)

例cube = model.Cubes.Item("National")cube.PublishDatasource(True)'Republish PowerCube if it already exists

PublishPackage メソッドPublishPackage メソッドは、PowerCube のデータ・ソースおよびパッケージの両方を発行します。

構文

Cube .PublishPackage(datasourceOverwrite, packageOverwrite)

第 4 章 メソッド 171

適用対象

Cube オブジェクト

解説

このメソッドは、IBM Cognos Analytics サーバーで PowerCube 用にデータ・ソース接続およびパッケージを発行するために使用します。

IBM Cognos サーバーから各キューブへのアクセス元となる Windows、UNIX または Linux 上の場所を指定する必要があります。ユーザー認証が有効な場合は、設定済みネームスペースも指定する必要があります。成功した場合は True が返されます。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

パラメーター 説明

datasourceOverwrite 必須。true の場合、すでに存在するデータ・ソースを再発行します。

タイプ:Boolean

packageOverwrite 必須。true の場合、すでに存在するパッケージを再発行します。

タイプ:Boolean

戻り値のタイプ

Boolean 値 (発行が成功した場合 True)

例cube = model.Cubes.Item("National")cube.PublishPackage(True,True) 'Re-publish both Datasource & Package

Remove メソッドRemove メソッドは、コレクションから特定のオブジェクトを削除します。

構文

collection .Remove(Item)

適用対象

Associations コレクション

CalculationDefinitions コレクション

Categories コレクション

172 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

CategorySets コレクション

Columns コレクション

CubeCustomViews コレクション

Cubes コレクション

CurrencyRates コレクション

CurrencyRecords コレクション

CurrencyTables コレクション

CustomViews コレクション

DataSources コレクション

Dimensions コレクション

DrillDowns コレクション

DrillThroughTargets コレクション

Filters コレクション

Levels コレクション

Measures コレクション

Namespaces コレクション

PackageDatasourceConnections コレクション

Packages コレクション

Prompts コレクション

Queries コレクション

Reports コレクション

SecurityObjects コレクション

Signons コレクション

Views コレクション

解説

コレクションから削除する特定のオブジェクトを選択するには、このメソッドのItem パラメーターを使用します。コレクションの外部にあるオブジェクト (Itemメソッドで選択するオブジェクトなど) を削除するには、Delete メソッドを使用します。

第 4 章 メソッド 173

Transformer で作成した各ディメンションのデフォルトの主ドリルダウン・パスは削除できません。

関連付けを削除すると、親オブジェクトで更新が呼び出され、親に加えられた変更がすべて保存されます。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

パラメーター 説明

アイテム 必須。コレクション内のオブジェクトまたは位置を指定します。値には、位置の数値インデックス (1 から開始)、オブジェクト名の文字列、またはスクリプトに定義したオブジェクトを指定できます。

タイプ:Variant

戻り値のタイプ

なし

例packages = model.Packages packages.Remove(temp_package)

RemoveCubeCustomView メソッドRemoveCubeCustomView メソッドは、キューブまたは子キューブからカスタム・ビューを削除します。

構文

Object .RemoveCubeCustomView

適用対象v ChildCube オブジェクト

v Cube オブジェクト

解説

このメソッドは、キューブまたは子キューブからキューブのカスタム・ビューを削除するために使用します。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

パラメーター 説明

CubeCustomView 必須。削除するカスタム・ビューを指定します。

タイプ:CustomView

174 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

戻り値のタイプ

なし

RemoveFromFolder メソッドRemoveFromFolder メソッドは、現在の数値データ・フォルダーから子数値データを削除します。

構文

Measure .RemoveFromFolder Item

適用対象

Measure オブジェクト

解説

数値データ・フォルダーから子数値データを削除するために使用します。子数値データが存在する場合は、数値フォルダーと同じレベルに移動されます。数値フォルダー内に子数値データが存在しない場合は、例外が返されます。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

パラメーター 説明

数値データ 必須。数値データ・フォルダーから削除するMeasure オブジェクトを指定します。

タイプ:Object - Measure

戻り値のタイプ

なし

RemoveSuspendedModel メソッドRemoveSuspendedModel メソッドは、SuspendedModels コレクションから中断モデルを削除します。

構文

Application .RemoveSuspendedModel (Model)

適用対象

Application オブジェクト

解説

中断モデルが破損しているか、または修復可能かどうかを調べるには、IsBad プロパティーを使用します。中断モデルが破損している場合は、

第 4 章 メソッド 175

RemoveSuspendedModel メソッドを使用して SuspendedModels コレクションから削除します。

パラメーター 説明

モデル 必須。存在する不完全なモデルを表す。

タイプ:SuspendedModel

戻り値のタイプ

ブール値

例objTransApp.RemoveSuspendedModel(objSuspendedModel)

ResetPartitions メソッドResetPartitions メソッドは、現在のキューブ・パーティションを削除します。

構文

Model .ResetPartitions

適用対象

モデル・オブジェクト

解説

キューブが非常に大きい場合や、通常と異なる構造をしている場合は、パーティションを手動で定義すると、作成時間を短縮したり、実行時のパフォーマンスを向上させたりできます。最初に、このメソッドを使用して、定義済みの自動または手動パーティションを削除します。次に、Partition プロパティーを使用して、選択したディメンションのカテゴリーにパーティション・レベル番号を割り当てます。

戻り値のタイプ

オブジェクト

例objModel.ResetPartitions()

Save メソッドSave メソッドは、現在のモデルへの変更を保存します。

構文

Model .Save

176 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

適用対象

モデル・オブジェクト

解説

このメソッドは、モデル・ファイル (.mdl) にモデルの変更を書き込むために使用します。変更を別のファイルに保存する場合や、新規のモデルを初めて保存する場合は、SaveAs メソッドを使用します。モデルを閉じる前に Save メソッドまたはSaveAs メソッドを使用しない場合、Update メソッドによる変更も含め、モデルの変更はすべて失われます。

戻り値のタイプ

なし

SaveAs メソッドSaveAs メソッドは、現在のモデルを別のファイル名で保存します。

構文

Model .SaveAs FileName

適用対象

モデル・オブジェクト

解説

このメソッドは、モデルへの変更を、別の名前のモデル・ファイル (.mdl) に書き込む場合に使用します。新規モデルを初めて保存する場合は、常に SaveAs を使用します。

同じファイル名で変更を保存するには、Save メソッドを使用します。モデルを閉じる前に Save メソッドまたは SaveAs メソッドを使用しない場合、Update メソッドによる変更も含め、モデルの変更はすべて失われます。

パラメーター 説明

FileName 必須。ファイル名とパス (必要な場合) を指定します。

タイプ:String

ファイル名のパスを指定しない場合、Transformer ではデフォルトのディレクトリーが使用されます。

戻り値のタイプ

なし

第 4 章 メソッド 177

例objModel.SaveAs("great outdoors salesX.mdl")

SetAllocation メソッドSetAllocation メソッドは、オブジェクトによって使用される数値データの割り当てタイプを変更します。

構文

object .SetAllocation Measure, AllocationType [, AllocationMeasure ]

適用対象

51 ページの『Category オブジェクト』

DateDimension オブジェクト

DateLevel オブジェクト

Dimension オブジェクト

Level オブジェクト

SpecialCategory オブジェクト

解説

割り当ては、モデルによって複数のデータ・ソースが使用されるときにのみ実行できます。このメソッドは、要約データをディメンション、レベル、カテゴリーに割り当てる方法、または割り当てを実行するかどうかを指定するために使用します。

レベルの割り当てタイプを変更すると、新しい割り当てタイプは、そのレベルのカテゴリーから子孫カテゴリーすべてに適用されます。

数値データ値のソースがモデルのディメンションを参照しないデータである場合、Transformer では自動的に数値データ値がディメンション全体に割り当てられ、数値データ値の値が定数としてディメンション全体に割り当てられます。この割り当てを元に戻すには、trAllocationNA 定数を指定して SetAllocation メソッドを使用します。

割り当てを実行するには、CanAllocate プロパティーの戻り値が True であることが必要です。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

パラメーター 説明

数値データ 必須。割り当てを適用する数値データを指定します。

タイプ: Object-Measure

178 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

パラメーター 説明

AllocationType 必須。割り当てオプションを設定します。値リスト xtrAllocationType の定数を指定します。割り当てる値のソースとして使用するオブジェクトを指定します。

タイプ:定数 - xtrAllocationType

AllocationMeasure オプション。AllocationType パラメーターをtrAllocationAllocated に設定したときにのみ適用されます。

タイプ:Object

戻り値のタイプ

なし

例objDimension.SetAllocation(objMeasure, xtrAllocationType.trAllocationNA)

SetDefaultCategory メソッドSetDefaultCategory メソッドは、シナリオ・カテゴリー・グループのルートまたは親以外の、ディメンションの新規デフォルト・カテゴリーを指定します。デフォルト・カテゴリーはディメンションごとに 1 つだけです。

構文

Dimension .SetDefaultCategory

適用対象v DateDimension オブジェクト

v Dimension オブジェクト

解説

シナリオ・ディメンションを作成するには、ルートまたは親 Category オブジェクトの HideValue プロパティーとともにこのメソッドを使用することを推奨します。

キューブを開くデフォルト・レベルを設定すると、レポートの作成者または利用者がキューブを開いたとき、予算値やその他のシナリオなどのデータを含んでいるキューブが、ゼロ、該当しない数値、または無意味な数値を表示しないようになります。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

第 4 章 メソッド 179

戻り値のタイプ

なし。

パラメーター 説明

Category 必須。特定のディメンションで、有効なCategory オブジェクトを指定します。

タイプ:Object - Category

SetDeployType メソッドSetDeployType メソッドは、Copy および Activate の配布戦略を設定します。

構文

Cube .SetDeployType(deployType

適用対象

Cube オブジェクト

解説

このメソッドは、PowerCube の配布前に使用します。

deployType パラメーターを使用することにより、配布戦略を設定できます。trDeployType_NONE は、PowerCube の配布が不可であることを指定します。

trDeployType_SWAPSINGLE は、1 つ以上の配布場所が使用できない場合に、指定したすべての場所への配布処理が中止されることを指定します。

trDeployType_SWAPTOGETHER は、配布場所に指定した 1 つ以上の場所(AddDeployLocation を参照) が使用できない場合に、PowerCube がこれら使用できない場所に配布されないよう指定します。ただし、配布可能な場所すべてに、配布されるとは限りません。

trDeployType_NONE 以外の値を指定する場合は、DeployCube メソッドを呼び出す前に配布場所を指定する必要があります。

キューブが、キューブ・グループに属する子キューブである場合、この子キューブは親キューブと同じ配布戦略を継承することができます。これは、時系列にパーティション化されたキューブには適用されません。

デフォルトの配布戦略は「配布しない」です。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

180 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

戻り値のタイプ

なし

パラメーター 説明

deployType 必須。配布タイプを指定します。このパラメーターには、値リスト xtrDeployType の定数を指定します。

タイプ:定数 - xtrDeploytype

例cube= model.Cubes.Item("National")cube.

SetDeployType(xtrDeployType.trDeployType_SWAPSINGLE)

SetExcludeDateDimension メソッド

SetExcludeDateDimension メソッドは、指定した DrillThroughTarget とDateDimension について、isRestricted パラメーターが True の場合にドリルスルー制限を True に設定します。制限を解除するには、isRestricted パラメーターをFalse に設定します。

構文

DrillThroughTarget .SetExcludeDateDimension

適用対象

DrillThroughTarget オブジェクト

解説

このプロパティーは、ドリルスルー・ターゲットから DateDimension を除外するために使用します。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

パラメーター 説明

日付ディメンション 必須。ドリルスルー処理から除外される日付ディメンション・オブジェクトを指定します。

タイプ:DateDimension

IsRestricted 必須。日付ディメンション・オブジェクトが除外されるかどうかを指定します。

タイプ:Boolean

第 4 章 メソッド 181

タイプ

ブール値

アクセス

Write

SetExcludeDateLevel メソッド

SetExcludeDateLevel メソッドは、指定した DrillThroughTarget と DateLevel にいて、isRestricted パラメーターが True の場合にドリルスルー制限を True に設定します。制限を解除するには、isRestricted パラメーターを False に設定します。

構文

DrillThroughTarget .SetExcludeDateLevel

適用対象

DrillThroughTarget オブジェクト

解説

このプロパティーは、ドリルスルー・ターゲットから DateLevel を除外するために使用します。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

パラメーター 説明

日付レベル 必須。ドリルスルー処理から除外される日付レベル・オブジェクトを指定します。

タイプ:Object - DateLevel

IsRestricted 必須。日付レベル・オブジェクトが除外されるかどうかを指定します。

タイプ:Boolean

タイプ

ブール値

アクセス

Write

182 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

SetExcludeDimension メソッドSetExcludeDimension メソッドは、指定した DrillThroughTarget と Dimensionについて、isRestricted パラメーターが True の場合にドリルスルー制限を Trueに設定します。制限を解除するには、isRestricted パラメーターを False に設定します。

構文

DrillThroughTarget .SetExcludeDimension

適用対象

DrillThroughTarget オブジェクト

解説

このプロパティーは、ドリルスルー・ターゲットから Dimension を除外するために使用します。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

パラメーター 説明

ディメンション 必須。ドリルスルー処理から除外されるディメンション・オブジェクトを指定します。

タイプ:Dimension

isRestricted 必須。ディメンションが除外されるかどうかを指定します。

タイプ:Boolean

戻り値のタイプ

なし

SetExcludeLevel メソッドSetExcludeLevel メソッドは、指定した DrillThroughTarget と Level について、isRestricted パラメーターが True の場合にドリルスルー制限を True に設定します。制限を解除するには、isRestricted パラメーターを False に設定します。

構文

DrillThroughTarget .SetExcludeLevel

適用対象

DrillThroughTarget オブジェクト

第 4 章 メソッド 183

解説

このプロパティーは、DrillThroughTarget からレベルを除外するために使用します。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

パラメーター 説明

レベル 必須。ドリルスルー処理から除外されるレベル・オブジェクトを指定します。

タイプ:Object

isRestricted 必須: レベルが除外されるかどうかを指定します。

タイプ:Boolean

戻り値のタイプ

ブール値

SetViewStatus メソッドSetViewStatus メソッドは、Category、SpecialCategory、Level、または DateLevelオブジェクトの表示方法を設定します。

構文

View .SetViewStatus Object, Status

適用対象

View オブジェクト

解説

View オブジェクトを取得したら、それを使用して、関連するCategory、SpecialCategory、DateLevel、または Level オブジェクトの ViewStatusを設定できます。ビューを定義するには、xtrViewStatus 値リストの定数を割り当てます。

1 つのカテゴリーと子カテゴリーのビューを作成するには、Apex プロパティーを使用します。

現在のビュー・ステータスをクリアするには、現在のステータスを検索し、その結果を使用して SetViewStatus を呼び出します。これにより、現在のステータスのオン/オフが切り替わって、それがクリアされます。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

184 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

パラメーター 説明

オブジェクト 必須。このメソッドは、Category、SpecialCategory、DateLevel、または Level オブジェクトにのみ適用できます。

タイプ:Object

戻り値のタイプ

定数 - xtrViewStatus

例objDimension = objModel.Dimensions("Retailers")objView= objDimension.Views.Add()objView.SetViewStatus(objCategory,xtrViewStatus.trViewStatusSummaryMom)

次の例は、現在のビュー・ステータスをクリアする方法を示しています。

xtrViewStatus currentStatus = objView.GetViewStatus(objCategory);objView.SetViewStatus(objCategory, currentStatus);

TestBuild メソッド

TestBuild メソッドは、小さなテスト・モデルまたはキューブを作成します。

構文

Model .TestBuild Records, BuildCubes

適用対象

Model オブジェクト

解説

テスト用のカテゴリーを生成したり、キューブを作成します。ソース・データが非常に大きい場合、大幅に時間を節約できます。

例えば、各データ・ソースの先頭から 350 のレコードを使用して、キューを構築するテスト・ビルドを指定できます。PowerPlay で評価できるカテゴリーを持つ小さなキューブが、すぐに作成されます。

パラメーター 説明

Records 必須。テストするレコード数を指定します。

タイプ:Long

第 4 章 メソッド 185

パラメーター 説明

BuildCubes 必須。カテゴリーの追加のみを行うか、カテゴリーを追加してキューブを構築するかを指定します。True に設定した場合、Transformer でキューブが構築されます。

タイプ:Boolean

戻り値のタイプ

なし

例objModel = objTransApp.NewModel objModel.TestBuild(20,True)

Update メソッド

Update メソッドは、関連付けられているオブジェクトを更新します。

構文

object .Update

適用対象

Association オブジェクト

CalculationDefinition オブジェクト

Category オブジェクト

CategorySet オブジェクト

ChildCube オブジェクト

Column オブジェクト

CrossTabDataSource オブジェクト

Cube オブジェクト

CubeGroup オブジェクト

CurrencyRate オブジェクト

CurrencyRecord オブジェクト

CurrencyTable オブジェクト

CustomView オブジェクト

186 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

DataSource オブジェクト

DateDimension オブジェクト

DateDrillDown オブジェクト

DateLevel オブジェクト

DbDataSource オブジェクト

Dimension オブジェクト

DrillDown オブジェクト

DrillThroughTarget オブジェクト

Filter オブジェクト

FlatFileDataSource オブジェクト

IqdDataSource オブジェクト

Level オブジェクト

Measure オブジェクト

Model オブジェクト

Namespace オブジェクト

Package オブジェクト

PackageDatasourceConnection オブジェクト

Prompt オブジェクト

Query オブジェクト

Report オブジェクト

SecurityObject オブジェクト

Signon オブジェクト

SpecialCategory オブジェクト

View オブジェクト

解説

このメソッドは、オブジェクトのプロパティー変更を設定するために使用します。モデルの変更を保存するには、モデルを閉じる前に Save メソッドまたは SaveAsメソッドを使用します。保存しないと、オブジェクトの更新はすべて失われます。Update メソッドを使用しない場合、モデルを保存するときにオブジェクトの変更が保存されません。

第 4 章 メソッド 187

Application オブジェクトまたは DateWizard オブジェクトの変更の設定には、Update メソッドは必要ありません。

Update を実行すると、Transformer ではオブジェクトの変更が有効かどうかがチェックされます。例えば、Category オブジェクトの ExpressionText プロパティーに正しくない数式を設定した場合、Update は失敗し、Transformer からエラー・メッセージが発行されます。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

戻り値のタイプ

なし

例objDimensions = objModel.DimensionsobjLocationsDim= objDimensions.Item(3)objLocationsDim.Update()

Verify メソッド

Verify メソッドは、関連付けられているオブジェクトを検証します。

構文

object .Verify()

適用対象

Package オブジェクト

PackageDatasourceConnection オブジェクト

Query オブジェクト

Report オブジェクト

SecurityObject オブジェクト

解説

このメソッドは、オブジェクトのプロパティー変更を検証するために使用します。Update メソッドもオブジェクトを検証するため、オブジェクトで Update が呼び出されたときには、このメソッドは必要ありません。Transformer は、オブジェクトへの変更をチェックし、変更が有効であるかどうかを判断します。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

戻り値のタイプ

なし

188 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

第 5 章 プロパティー

次の表は、Transformer OLE オートメーション・プロパティーのリストです。

プロパティー 説明

ActivityMeasure プロパティー カテゴリー・カウント数値データで使用する数値データを設定する、または設定状態を返します。

Aggregate プロパティー 相対時間カテゴリーの基本タイプを設定する、または設定状態を返します。

AllocationMeasure プロパティー 加重係数として使用する Measure オブジェクトを返します。

AllocationType プロパティー オブジェクトで数値データを割り当てる方法を返します。

AllowCurrencyConversion プロパティー 通貨を交換できるかどうかを設定する、または設定状態を返します。

AllowDrillThrough プロパティー キューブまたは数値データを、キューブまたはレポートへドリルスルーできるかどうかを設定する、または設定状態を返します。

AlternateQueryPath プロパティー キューブで使用する代替データ・ソース・パスを設定する、または設定状態を返します。

AltMDCFile プロパティー キューブの代替ファイル名を指定します。

AlwaysUseTransformerSignon プロパティー Transformer サインオンを使用するか、Content Manager サインオンを使用するかを指定します。

Apex プロパティー ディメンション・ビューのルートになるCategory オブジェクトを設定する、または設定状態を返します。

Application プロパティー Transformer Application オブジェクトを返します。

AssociationRole プロパティー Association オブジェクトで実行される役割を設定する、または設定状態を返します。

Associations プロパティー Associations コレクションを返します。

189

プロパティー 説明

AssociationType プロパティー Association オブジェクトに関連付けられているデータ・ソースのタイプを設定する、または設定状態を返します。

AutoLogon プロパティー True の場合は、サインオンに関連付けられているセキュリティー・ネームスペースに対して、アプリケーションが自動的に認証されるかどうかを定義します。

AutoSummary プロパティー クエリーの自動集計オプションを設定する、または設定状態を返します。

BlankSubstitute プロパティー 日付レベルに生成された空白カテゴリーに割り当てるデフォルトのラベルを設定する、または設定状態を返します。

BlockParentTotals プロパティー 除外されているカテゴリーの親が拒否された値を表示するかどうかを設定する、または設定状態を返します。

CacheCrossTabs プロパティー キューブの最初の PowerPlay クロス集計のために集計をキャッシュするかどうかを設定する、または設定状態を返します。

CalculationDefinitions プロパティー CalculationDefinition オブジェクトのコレクションを返します。

CAMID プロパティー ネームスペースの CAMID を返します。

CanAllocate プロパティー 数値データ値の値を子孫のレベルとカテゴリーに割り当てることができるかどうかを返します。

CanAllocateByMeasure プロパティー 数値データで割り当てるときに、指定した数値データを加重係数として使用できるかどうかを返します。

CanAllocateMeasure プロパティー 指定した数値データを子孫のレベルとカテゴリーに割り当てることができるかどうかを返します。

Categories プロパティー オブジェクトに関連付けられているCategories コレクションを返します。

Category プロパティー 特定の通貨レートを適用できる日付カテゴリーを返します。

CategoryCount プロパティー ディメンションまたはレベルに含まれる標準カテゴリー数を返します。

190 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

プロパティー 説明

CategoryCountLevel プロパティー カテゴリー・カウントが適用される Levelオブジェクトを設定する、または設定状態を返します。

CategorySets プロパティー CalculationDefinition オブジェクトが使用する CategorySets コレクションを返します。

CharacterType プロパティー データ・ソースで使用する文字セットのタイプを設定する、または設定状態を返します。

ChildCategories プロパティー Categories コレクションを返します。

ChildCubes プロパティー キューブ・グループから ChildCube オブジェクトのコレクションを返します。

ChildCustomViews プロパティー CustomView オブジェクトのコレクションを返します。

ChildMeasures プロパティー 数値データ・フォルダーから子数値データのコレクションを返します。

Code プロパティー ディメンション全体で、カテゴリーを一意に識別するコードを設定する、または設定状態を返します。

Columns プロパティー データ・ソースの Columns コレクションを返します。

ColumnsLoaded プロパティー モデルの構築にデータ・ソースの列を使用したかどうかを返します。

CompressMDC プロパティー キューブをコンパクトに保存するために圧縮するかどうかを設定する、または設定状態を返します。

Connection プロパティー Content Manager 接続を設定し、設定状態を取得します。

Consolidate プロパティー キューブを集約する方法を設定する、または設定状態を返します。

Context プロパティー レベルのカテゴリーを並べ替えるために使用するドリルダウン・パスを設定する、または設定状態を返します。

ContextLevel プロパティー 日付期間を設定する、または設定状態を返します。

ContextOffset プロパティー 現在の期間を基準とする総括期間の位置を設定する、または設定状態を返します。

第 5 章 プロパティー 191

プロパティー 説明

ConvergenceLevel プロパティー 代替ドリルダウン・パスの収束レベルを返します。

Count プロパティー コレクションに含まれるオブジェクトの個数を返します。

CountryCode プロパティー 通貨レコードを適用する国または地域のコードを設定するか、設定状態を返します。

CubeCodePage プロパティー キューブを構築するために使用するモデルのキューブのコード・ページ設定を設定するか、設定状態を返します。

CubeCreation プロパティー キューブを作成するかどうかを設定する、または設定状態を返します。

CubeCustomViews プロパティー CustomView オブジェクトのコレクションを返します。

Cubes プロパティー Cube オブジェクトと CubeGroup オブジェクトのコレクションを返します。

CubeStamp プロパティー キューブ作成のタイム・スタンプを返します。

CurrencyCountryLabel プロパティー 通貨の国または地域のラベルを設定するか、設定状態を返します。

CurrencyDecimals プロパティー 通貨に使用する小数桁数を設定する、または設定状態を返します。

CurrencyFormatOverride プロパティー 通貨の標準書式をオーバーライドできるかどうかを設定する、または設定状態を返します。

CurrencyIsEMU プロパティー レコードが EMU の通貨レコードかどうかを設定する、または設定状態を返します。

CurrencyIsEuro プロパティー 通貨レコードが基準ユーロ通貨かどうかを設定する、または設定状態を返します。

CurrencyRates プロパティー CurrencyRates コレクションを返します。

CurrencyRecord プロパティー CurrencyRate オブジェクトが適用されるCurrencyRecord オブジェクトを返します。

CurrencyRecords プロパティー CurrencyRecord オブジェクトのコレクションを返します。

192 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

プロパティー 説明

CurrencySymbol プロパティー 通貨に関連付けられた通貨記号を設定する、または設定状態を返します。

CurrencyTable プロパティー 通貨レートに関連付けられた CurrencyTableオブジェクトを返します。

CurrencyTables プロパティー CurrencyTable オブジェクトのコレクションを返します。

CurrencyTableType プロパティー 通貨表のタイプを設定する、または設定状態を返します。

CurrentModel プロパティー 現在アクティブなモデル・オブジェクトを返します。

CurrentValueIndex プロパティー 現在のプロンプト値索引を設定する、または設定状態を返します。

CustomView プロパティー ディメンション・ビューでカテゴリーの全部または一部を表示する、表示しないかどうかを設定する、または設定状態を返します。

CustomViews プロパティー CustomView オブジェクトのコレクションを返します。

DataCharacterSet プロパティー アプリケーションで使用するデフォルトの文字セットを設定する、または設定状態を返します。

DataClass プロパティー ソース列のデータ型を設定する、または設定状態を返します。

DataRange プロパティー データ・ソースのデータベース範囲の名前を設定する、または設定状態を返します。

DataSource プロパティー Content Manager データ・ソースを設定するか、設定状態を返します。

DataSourcePath プロパティー Transformer でデータ・ソース・ファイルを検索する場所を設定する、または設定状態を返します。

DataSources プロパティー モデルに含まれる DataSource オブジェクトのコレクションを返します。

DataSourceWindowsLocation プロパティー キューブの場所を完全パスとキューブ名で設定する、または設定状態を返します。

第 5 章 プロパティー 193

プロパティー 説明

DataTemporaryFilesPath プロパティー Transformer がキューブを生成するときにテンポラリー作業ファイルを作成するディレクトリーの名前を設定する、または設定状態を返します。

DateDegreeofDetail プロパティー レポートを作成する日付レベルを設定する、または設定状態を返します。

DateDegreeofDetailLevelName プロパティー

外部的に集計する数値データに適用する日付レベルを設定する、または設定状態を返します。

DateFormat プロパティー 日付を表示する書式を設定する、または設定状態を返します。

DateFunction プロパティー レベルに生成される日付カテゴリーを設定する、または設定状態を返します。

DateInputFormat プロパティー データ・ソースの日付書式の順序を設定する、または設定状態を返します。

DateLevel プロパティー 通貨レートが適用される時間ディメンションのレベルを設定する、または設定状態を返します。

DateWizard プロパティー DateWizard オブジェクトを返します。

DecimalPoint プロパティー 小数点に使用する文字を設定する、または設定状態を返します。

Decimals プロパティー ソース・データに定義されている場合、列の小数桁数を返します。

DefaultCategoryOrderBy プロパティー モデルのすべてのカテゴリーにデフォルトの並び替え順序を設定します。

DefaultDateFormat プロパティー DateInputFormat プロパティーのデフォルト設定を設定する、または設定状態を返します。

Description プロパティー オブジェクトの説明を設定する、または設定状態を返します。

DesiredPartitionSize プロパティー 最適なパーティション・サイズを設定する、または設定状態を返します。

DetachDataSource プロパティー データ・ソースとの接続を維持するかどうかを設定する、または設定状態を返します。

194 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

プロパティー 説明

DetailLevel プロパティー CubeGroup オブジェクトのキューブについて最下位の詳細レベルを設定する、または設定状態を返します。

Dimension プロパティー Category オブジェクトのディメンションを返します。

DimensionInclude プロパティー カスタム・ビューのビューのタイプを設定するか、設定状態を返します。

DimensionLevels プロパティー DimensionLevels コレクションを返します。

DimensionName プロパティー 新規 DateDimension オブジェクトの名前を設定します。

Dimensions プロパティー Dimension オブジェクトと DateDimensionオブジェクトのコレクションを返します。

DimensionView プロパティー キューブまたはカスタム・ビューに関連付けられている View オブジェクトを設定するか、設定状態を返します。

DimensionViewType プロパティー キューブに属するディメンションと表示を設定する、または設定状態を返します。

DisplayName プロパティー SecurityObject の表示名を設定するか、設定状態を返します。

DrillCode プロパティー ディメンション全体で、ドリルダウン・カテゴリーを一意に識別するコードを設定する、または設定状態を返します。

DrillDowns プロパティー DrillDowns コレクションを返します。

DrillInclusion プロパティー キューブにドリルダウン・パスが含まれるかどうかを設定する、または設定状態を返します。

DrillThroughTargets プロパティー Transformer モデルに関連付けられているドリルスルー・ターゲット・オブジェクトのコレクションを返します。

DuplicateRollup プロパティー 集約されたレコードから重複する数値データ値の値を自動集計する方法を設定する、または設定状態を返します。

DuplicateWeight プロパティー 平均加重係数を含む数値データの名前を設定する、または設定状態を返します。

第 5 章 プロパティー 195

プロパティー 説明

EarliestDate プロパティー カテゴリーの選択に使用する日付範囲の開始日付を設定します。

EMUEntryDate プロパティー 通貨のユーロ Triangulation (3 通貨変換) の計算を開始する日付を設定する、または設定状態を返します。

EnableMessageLogging プロパティー Transformer でメッセージをログ・ファイルに追加するか、前のログ・メッセージを上書きするかを設定する、または設定状態を返します。

EnableTimePeriod プロパティー 時間ディメンションの詳細レベルを設定します。

EstimatedRows プロパティー 自動パーティションの前にキューブに含まれるレコード数の推定値を設定する、または設定状態を返します。

ExcludeAutoPartition プロパティー ディメンションを自動パーティション・プロセスから除外するかどうかを設定する、または設定状態を返します。

ExpressionText プロパティー オブジェクトの値を定義する数式の内容を設定する、または設定状態を返します。

External プロパティー データ・ソースにあらかじめ集計した値が含まれているかどうかを設定する、または設定状態を返します。

FieldSeparator プロパティー データ・ソースで使用する文字セットのタイプを設定する、または設定状態を返します。

FileName プロパティー Windows のフォルダーまたは WindowsExplorer に表示されるモデル・ファイルの名前を返します。

Filters プロパティー クエリーに関連付けられている Filter オブジェクトのコレクションを返します。

FindCategoryByCatCode プロパティー 指定したカテゴリー・コードの文字列を含む、カテゴリー・オブジェクトを返します。

Format プロパティー 数値を表示する書式を設定する、または設定状態を返します。

FormatDecimals プロパティー PowerPlay で表示する数値データの小数桁数を設定する、または設定状態を返します。

FullName プロパティー モデル・ファイルの場所を返します。

196 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

プロパティー 説明

GenerateCategories プロパティー データ・ソースのカテゴリーを生成するかどうかを設定する、または設定状態を返します。

GenerateDateCategories プロパティー 日付レベルが日付カテゴリーを生成するかどうかを設定する、または設定状態を返します。

GenerateDates プロパティー DateWizard オブジェクトが日付カテゴリーを生成するかどうかを設定します。

GeneratePowerCube プロパティー モデルでデータ・ソースを参照するかどうかを設定する、または設定状態を返します。

GenerateTimePeriod プロパティー 時間ディメンションのカテゴリー生成オプションを設定する、または設定状態を返します。

Group プロパティー CalculationDefinition をカテゴリー・セットのカテゴリーとグループ化するかどうかを設定する、または設定状態を返します。

GroupDimension プロパティー キューブ・グループを構築するために使用するディメンションを設定する、または設定状態を返します。

GroupLevel プロパティー キューブ・グループに属するカテゴリーが、個々のキューブになるレベルを設定する、または設定状態を返します。

HasSubdimension プロパティー Level オブジェクトにサブディメンションが含まれるかどうかを返します。

HideValue プロパティー カテゴリー・オブジェクトの値を非表示にするかどうかを指定します。デフォルト:False

ID プロパティー ネームスペース ID を設定する、または設定状態を返します。

IgnoreMissingValue プロパティー 時状態データ集計で Null 値または欠落値を無視するかどうかを指定します。デフォルト:False

Inclusion プロパティー キューブにカテゴリーを含める条件を設定する、または設定状態を返します。

第 5 章 プロパティー 197

プロパティー 説明

IncrementalUpdate プロパティー キューブまたはキューブ・グループをデータ・ソースからインクリメンタルに更新するかどうかを設定する、または設定状態を返します。

InputScale プロパティー 列の値を小数から整数に変換するために使用するスケール値を設定する、または設定状態を返します。

IsAnyColumnMismatched プロパティー データ・ソースの列が基礎になるデータと一致するかどうかを返します。

IsBad プロパティー 中断モデルが破損しているかリカバリー可能かどうかを返します。

IsExpressionValid プロパティー 数式が有効かどうかを返します。

IsFolder プロパティー 数値データが数値データ・フォルダーかどうかを設定する、または設定状態を返します。

IsManual プロパティー レベルがソース値に関連付けられているかどうかを返します。

IsMDCInUse プロパティー キューブが使用中または再構築中であるかを返します。

IsolationLevel プロパティー 許可されるトランザクションの定義に使用する分離レベルを設定する、または設定状態を返します。

IsPrimary プロパティー 主ドリル・カテゴリーまたは主ドリルダウン・パスであるかどうかを設定する、または設定状態を返します。

IsTimeBasedPartitionedCube プロパティー キューブ・グループが時系列にパーティション化されたキューブとして指定されているかどうかを設定する、または設定状態を返します。

KeyName プロパティー 関連するデータ・ソース列に表示される値を設定する、または設定状態を返します。

Label プロパティー PowerPlay に表示される説明的な名前を設定する、または設定状態を返します。

LastUseDate プロパティー カテゴリーを最後に変更または使用した日付を返します。

LatestDate プロパティー カテゴリーの選択に使用する日付範囲の最終日付を設定します。

198 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

プロパティー 説明

Level プロパティー Category オブジェクトまたはSpecialCategory オブジェクトのレベルを返します。

LevelCategories プロパティー 特定レベルのカテゴリーを設定する、または設定状態を返します。

LevelDrillDowns プロパティー LevelDrillDowns コレクションを返します。

Levels プロパティー Levels コレクションを返します。

LocalPath プロパティー ローカル・データ・ソースの場所を設定する、または設定状態を返します。

LogErrorLevel プロパティー 記録するエラー・メッセージの重大度を設定する、または設定状態を返します。

LogFileAppend プロパティー Transformer でメッセージをログ・ファイルに付加するか、前のログ・メッセージに上書きするかを設定する、または設定状態を返します。

LogFileName プロパティー ログ・ファイルの名前を設定する、または設定状態を返します。

LogFilesPath プロパティー Transformer でログ・ファイルを保存する場所を設定する、または設定状態を返します。

Lunar プロパティー オブジェクトが月暦年に基づくかどうかを設定する、または設定状態を返します。

ManualCurrentPeriod プロパティー 現在の期間を手動または自動で設定するかを設定する、または設定状態を返します。

MaximizeSpeed プロパティー カテゴリーの生成速度を最適化するかどうかを設定する、または設定状態を返します。

MaxNumPartLevels プロパティー Transformer でキューブをパーティション化するときに、データ・ソースを読み取る最大回数を設定する、または設定状態を返します。

MaxTransactionNumber プロパティー Transformer で変更をキューブにコミットする前に処理する最大レコード数を設定する、または設定状態を返します。

MDCFile プロパティー PowerCube ファイル (.mdc) の名前を設定する、または設定状態を返します。

第 5 章 プロパティー 199

プロパティー 説明

MeasureInclude プロパティー キューブ、キューブ・グループ、またはユーザー・クラスに含める数値データの名前を設定する、または設定状態を返します。

MeasureName プロパティー PowerPlay ディメンション・ラインの数値データを識別する説明的なタイトルを設定する、または設定状態を返します。

Measures プロパティー Measures コレクションを返します。

MeasureType プロパティー 数値データが通常、算出、またはカテゴリー・カウントかどうかを返します。

MissingValue プロパティー 空白または NULL 値の代わりに表示する値を設定する、または設定状態を返します。

ModelName プロパティー 中断モデルの名前を返します。

ModelsPath プロパティー Transformer でモデル・ファイルを開いたり保存する場所を設定する、または設定状態を返します。

ModelTemporaryFilesPath プロパティー Transformer でテンポラリー・モデル・ファイル (.qy?) を作成する場所を設定する、または設定状態を返します。

ModelType プロパティー Windows のフォルダーまたは WindowsExplorer に表示されるモデル・ファイルのファイル拡張子を返します。

MonthType プロパティー 時間ディメンションの月レベルを計算する方法を設定します。

Name プロパティー オブジェクトの名前を設定する、または設定状態を返します。

Namespaces プロパティー Namespaces コレクションを返します。

NewCatsLocked プロパティー 新規カテゴリーを追加できるかどうかを設定する、または設定状態を返します。

ObjectCAMID プロパティー ObjectName プロパティーによって設定されるネームスペースに含まれるオブジェクトのCAMID を返します。

ObjectName プロパティー ネームスペース・オブジェクトの名前を設定するか、設定状態を返します。

Optimize プロパティー 現在のキューブの最適化オプションを設定する、または設定状態を返します。

200 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

プロパティー 説明

OrderByDescending プロパティー 値を降順に表示するかどうかを設定する、または設定状態を返します。

OrderByStorageType プロパティー 列の保管タイプに基づいてカテゴリーをソートする方法を設定する、または設定状態を返します。

Origin プロパティー 指定したオブジェクトの原点を返します。

OriginalName プロパティー データ・ソースの列名を設定する、または設定状態を返します。

Orphanage プロパティー カテゴリーが孤児かどうかを設定する、または設定状態を返します。

OutputScale プロパティー PowerPlay の値を整数から小数に変換するために使用するスケール値を設定する、または設定状態を返します。

Packages プロパティー Transformer モデルに関連付けられているPackage オブジェクトのコレクションを返します。

PackagesDatasourceConnections プロパティー

Package または Report オブジェクトに関連付けられているPackageDatasourceConnection オブジェクトのコレクションを返します。

Parent プロパティー オブジェクトの親の名前を返します。

ParentCategories プロパティー カテゴリーの親カテゴリーのコレクションを返します。

Partition プロパティー 手動パーティション番号を設定する、または設定状態を返します。

Password プロパティー パスワードを設定します (大文字と小文字を区別)。

PatFile プロパティー 関連するユーザー・インターフェースのロケールに対するパターン・ファイル"cogtr_<ロケール>.pat" ("cogtr_en.pat"など) の場所を設定するか、または設定状態を返します。

Path プロパティー モデル・ファイルの場所を返します。

PopulateByDataSource プロパティー 通貨レートをデータ・ソースから取り込むか、Transformer で設定するかを設定する、または設定状態を返します。

第 5 章 プロパティー 201

プロパティー 説明

Position プロパティー データ・ソースの列の開始位置を設定する、または設定状態を返します。

PowerCubesPath プロパティー Transformer で PowerCube ファイル(.mdc) を作成する場所を設定する、または設定状態を返します。

PowerPlayPath プロパティー "PowerPlay.exe" 実行可能ファイルの場所を設定する、または設定状態を返します。

Precision プロパティー 計算に使用する数値データの小数桁数を設定する、または設定状態を返します。

PromptForPassword プロパティー UI モードで Transformer を使用する場合に、ユーザーに対してパスワードの入力を常に要求するかどうかを指定します。DataSource サインオン・タイプにのみ適用されます。

Prompts プロパティー クエリーに関連付けられている Prompt オブジェクトのコレクションを返します。

PromptValueType プロパティー プロンプトのタイプを設定する、または設定状態を返します。

QualifiedName プロパティー レベルの絶対パス名を返します。

QuarterType プロパティー 時間ディメンションの四半期レベルを計算する方法を設定します。

Queries プロパティー Package または Report オブジェクトに関連付けられている Query オブジェクトのコレクションを返します。

QyPath プロパティー 中断モデルの場所を返します。

Rate プロパティー 通貨交換レートを設定する、または設定状態を返します。

RefName プロパティー データ・ソースのフィルター名を設定する、または設定状態を返します。

RefreshDescription プロパティー 説明を更新するかどうかを設定する、または設定状態を返します。

RefreshLabel プロパティー ラベルを更新するかどうかを設定する、または設定状態を返します。

RefreshShortName プロパティー 短縮名を更新するかどうかを設定する、または設定状態を返します。

202 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

プロパティー 説明

RegularRollup プロパティー オブジェクトの現在の標準集計関数を設定する、または設定状態を返します。

RegularWeight プロパティー 加重平均の計算に使用する数値データの名前を設定する、または設定状態を返します。

Reports プロパティー Transformer モデルに関連付けられているReport オブジェクトのコレクションを返します。

ReverseSign プロパティー PowerPlay で数値データの符号を反転するかどうかを設定する、または設定状態を返します。

Rollup プロパティー 特殊カテゴリーの数値データ値を親カテゴリーに自動集計するかどうかを設定する、または設定状態を返します。

RollupTiming プロパティー 算出数値データの計算をいつ実行するかを設定する、または設定状態を返します。

RowsAsSample プロパティー DoAutoDesign メソッドでモデルを作成するときにサンプリングする行数を設定する、または設定状態を返します。

RowsChecked プロパティー DoAutoDesign メソッドでデータ・ソースから読み取る最大行数を設定する、または設定状態を返します。

RunningPeriods プロパティー 累計に使用する期数を設定する、または設定状態を返します。

SecurityObjects プロパティー SecurityObjects のコレクションを返します。

Server プロパティー キューブをローカルで処理するか、サーバーで処理するかを設定する、または設定状態を返します。

ServerModelPath プロパティー モデルのサーバーの場所を設定する、または設定状態を返します。

ServerPath プロパティー データ・ソースのサーバーの場所を設定する、または設定状態を返します。

ServerQuery プロパティー データをローカルで処理するか、サーバーで処理するかを設定する、または設定状態を返します。

ServicesBuildNumber プロパティー Transformer のバージョン番号を数値書式で返します。

第 5 章 プロパティー 203

プロパティー 説明

ServicesVersionText プロパティー Transformer のバージョン番号をテキスト書式で返します。

SetsCurrentPeriod プロパティー Transformer でデータ・ソースから現在期間の日付を検索するかどうかを設定する、または設定状態を返します。

ShortName プロパティー 数値データの短縮名を設定する、または設定状態を返します。

Signon プロパティー キューブまたはキューブ・グループで使用する Signon オブジェクトを設定する、または設定状態を返します。

SignOnNamespace プロパティー IBM Cognos サインオンに関連付けられているセキュリティー・ネームスペースが含まれます。

Signons プロパティー モデルの Signons コレクションを返します。

SignonType プロパティー サインオン・タイプを設定する、または設定状態を返します。サインオンのタイプには、DataSource サインオンと IBM Cognos サインオンの 2 種類があります。

Size プロパティー 列またはモデル・ファイル (.mdl) のサイズを設定する、または設定状態を返します。

SortComparisonRule プロパティー Transformer でデータをソートするときに使用する比較法を設定する、または設定状態を返します。

SourceType プロパティー データ・ソースで使用するデータ・ファイルのタイプを設定する、または設定状態を返します。

SpecialCategoryCount プロパティー ディメンションのドリル、ルート、および特殊カテゴリーの数を返します。

SQLExpression プロパティー Impromptu クエリー定義ファイル (.iqd) を定義するために使用する SQL 式を返します。

Status プロパティー キューブを最後に作成したときに関連付けられた問題のステータスを返します。

StorageType プロパティー 数値データ型のサイズを設定する、または設定状態を返します。

204 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

プロパティー 説明

StreamExtractAllowed プロパティー ストリーム抽出が可能かどうかを決定するフラグを設定する、または設定状態を返します(SAP BW データ・ソースのみに適用)。

StreamExtractSize プロパティー StreamExtract が true に設定されている場合に SAP からのデータ転送に使用されるバッファーのサイズをメガバイト単位で設定する、または設定状態を返します。

SummaryLevel プロパティー キューブ・グループの外部カテゴリーを集計するために使用するレベルを設定する、または設定状態を返します。

SuppressNull プロパティー SAP BW データ・ソースに使用される Null消去オプションを設定する、または設定状態を返します。

SuspendedModels プロパティー SuspendedModel オブジェクトのコレクションを返します。

TargetLevel プロパティー 日付期間の詳細レベルを設定する、または設定状態を返します。

TargetOffset プロパティー 現在の期間を基準とする目標期間の位置を設定する、または設定状態を返します。

ThousandPoint プロパティー 1000 の区切りに使用する文字を設定する、または設定状態を返します。

Time プロパティー Windows のフォルダーまたは WindowsExplorer に表示されるモデルのタイム・スタンプを返します。

TimeArrayColumn プロパティー オブジェクトが日付配列を表すときに配列の1 列目の名前を設定する、または設定状態を返します。

TimeArrayStartMonth プロパティー オブジェクトに日付配列が含まれているときに会計年度の開始月を設定する、または設定状態を返します。

TimeArrayType プロパティー 日付値に使用する配列のタイプを設定する、または設定状態を返します。

TimeRank プロパティー 時間ディメンションに含まれる日付レベルの相対ランクを設定する、または設定状態を返します。

第 5 章 プロパティー 205

プロパティー 説明

TimeStamp プロパティー Package または Report オブジェクトのタイム・スタンプを設定するか、設定状態を返します。

TimeStateRollup プロパティー 時状態データ集計に使用する日付期間を設定する、または設定状態を返します。

TimeStateWeight プロパティー 加重平均の計算に使用する数値データの名前を設定する、または設定状態を返します。

ToDateLevel プロパティー 期間累計に使用する日付期間を設定する、または設定状態を返します。

TransdaPath プロパティー "transda.exe"実行可能ファイルの場所を設定する、または設定状態を返します。

TransformerSignon プロパティーパッケージ・データ・ソース接続 (IBMCognos サインオン) に関連付けられたTransformer Signon オブジェクトを設定するか、または設定状態を返します。

Type プロパティー オブジェクトのタイプを設定する、または設定状態を返します。

Unique プロパティー Transformer でレベルの各カテゴリーを一意のソース値で識別できるかどうかを設定する、または設定状態を返します。

UniqueMove プロパティー 関連付けられているカテゴリーを移動したときに一意のレベルを扱う方法を設定する、または設定状態を返します。

UseAltMDCFile プロパティー 一時ファイル名を使用できるかどうかを設定する、または設定状態を返します。

User プロパティー ネームスペースに関連付けられているユーザー名を設定するか、設定状態を返します。

UserCAMID プロパティー User プロパティーによって設定されるユーザーの CAMID を返します。

UserID プロパティー サインオンのユーザー ID を設定する、または設定状態を返します。

Value プロパティー プロンプトの値を設定する、または設定状態を返します。

ValuesCount プロパティー プロンプトに設定されている値の数を返します。

206 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

プロパティー 説明

Version プロパティー Transformer のバージョン番号を返します。

Views プロパティー Views コレクションを返します。

ViewType プロパティー ディメンション・ビューでカテゴリーの全部または一部を表示する、表示しないかどうかを設定する、または設定状態を返します。

WeekAdd プロパティー 月暦年に追加する日数を設定する、または設定状態を返します。

WeekSpan プロパティー 2 つの年にまたがる週を扱う方法を設定する、または設定状態を返します。

WeekStart プロパティー 週の開始日を設定する、または設定状態を返します。

WeekStartDay プロパティー 週の開始日を設定します。

WorkingDay プロパティー 特定の曜日が週日であるかどうかを設定する、または設定状態を返します。

WorkingDays プロパティー 週日を設定する、または設定状態を返します。

YearStartDay プロパティー 年の開始日を設定する、または設定状態を返します。

YearType プロパティー 時間ディメンションの年レベルを計算する方法を設定します。

ActivityMeasure プロパティーActivityMeasure プロパティーは、カテゴリー・カウント数値データで使用する数値データを設定するか、または設定状態を返します。

構文

Measure .ActivityMeasure

適用対象

Measure オブジェクト

解説

カテゴリーをカウントする数値データを定義します。例えば、特定の製品を購入した顧客数を、月、四半期、または年単位で、顧客の種類別に示す数値データを作成できます。任意の一意のレベル (顧客番号など) に基づき、数値データは欠落値、ゼ

第 5 章 プロパティー 207

ロ値を除くすべてをカウントします。ただし、ダブル・カウントはしません。例えば、ある製品を同じ顧客が同じ四半期に 2 回買う場合、四半期ごとの集計では、この顧客を一度しかカウントしません。

ActivityMeasure プロパティーは、カテゴリー・カウントに適用する特定のアクティビティー数値データを指定するために使用します。指定しない場合、モデルで基準に適合する数値データすべてを使用して結果が生成されます。

アクティビティー数値データには、算出数値データ、集計後の数値データ、または外部集計数値データを指定できません。

カテゴリー・カウント数値データを作成するには、数値データを Measures コレクションに追加し、CategoryCountLevel プロパティーをカテゴリーをカウントするレベルに設定します。指定するレベルは一意である必要があります。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

タイプ

Object - Measure

アクセス

Read/Write

例objMeasure.CategoryCountLevel = objLevelobjMeasure.ActivityMeasure= objActMeasure

Aggregate プロパティーAggregate プロパティーは、相対時間カテゴリーのタイプを設定するか、または設定状態を返します。

構文

SpecialCategory .Aggregate

適用対象

SpecialCategory オブジェクト

解説

このプロパティーは、現在の期間を基準とする特定の期間の数値データを追跡できるように、カテゴリーをカスタマイズする場合に使用します。相対時間カテゴリーは、次のように指定できます。

v 単一の期間を指定して、2 つの期間の変化を表示する

v 連続した複数の期間を指定して、現在と過去の業績を比較するために期間累計を表示する

v 相対時間期間を指定して、例えば過去の 6 カ月間の累計を表示する

208 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

Aggregate プロパティーには、xtrTimeAggregate の値を使用します。

例えば、当月までの 6 カ月間と前年の同期間について累計カテゴリーを作成するには、次のように設定します。

Aggregate = trAggregateRunningGrouped

ContextLevel = "Year"

ContextOffset = -1

RunningPeriods = 6

TargetLevel = "Month"

TargetOffset = 0

タイプ

定数 - xtrTimeAggregate

アクセス

Read/Write

例objSpecCategory= _ objModel.Dimensions("Time").Categories.Add(xtrObjectType.trSpecialCategory)objSpecCategory.Aggregate= xtrTimeAggregate.trAggregateRunning

AllocationMeasure プロパティーAllocationMeasure プロパティーは、加重係数として使用する Measure オブジェクトを返します。

構文

object .AllocationMeasure(Measure)

適用対象

Category オブジェクト

Dimension オブジェクト

DateLevel オブジェクト

DateDimension オブジェクト

Level オブジェクト

SpecialCategory オブジェクト

解説

数値データを子孫カテゴリーに比例配分する場合は、加重係数として 2 番目の数値データを使用する必要があります。このプロパティーは、現在の割り当ての設定を決定するため、AllocationType プロパティーとともに使用します。

第 5 章 プロパティー 209

例えば、地域別売上など別の数値データを使用して、固定費の数値データを各地域に割り当てることができます。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

パラメーター 説明

数値データ 必須。子孫カテゴリーに比例配分する数値データを指定します。

タイプ:Object

タイプ

Object - Measure

アクセス

読み取り

AllocationType プロパティーAllocationType プロパティーは、オブジェクトが数値データを割り当てる方法を返します。

構文

object .AllocationType(Measure)

適用対象

Category オブジェクト

Dimension オブジェクト

DateLevel オブジェクト

DateDimension オブジェクト

Level オブジェクト

SpecialCategory オブジェクト

解説

数値データは、子孫カテゴリーに比例配分したり、定数として割り当てることができます。また、まったく割り当てないこともできます。このプロパティーは、現在の割り当ての設定を決定するため、AllocationMeasure プロパティーとともに使用します。

AllocationType プロパティーには、xtrAllocationType の値を使用します。

210 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

パラメーター 説明

数値データ 必須。子孫カテゴリーに割り当てる (または割り当てない) 数値データを指定します。

タイプ:Object - Measure

タイプ

定数 - xtrAllocationType

アクセス

読み取り

例objLevel= objModel.Dimensions("Products").DimensionLevels(1)IfobjLevel.AllocationType(objMeasure)<> _xtrAllocationType.trAllocationByAnotherMeasure Then

AllowCurrencyConversion プロパティー

AllowCurrencyConversion プロパティーは、PowerPlay において通貨を表す数値データを別の通貨に変更できるかどうかを設定するか、またはその設定状態を返します。

構文

Measure .AllowCurrencyConversion

適用対象

Measure オブジェクト

解説

このプロパティーは、通貨表を設定した後にのみ設定します。PowerPlay ユーザーが選択できる通貨は、CurrencyRecords コレクションに定義されているものに制限されます。

デフォルト:False

タイプ

ブール値

アクセス

Read/Write

例objMeasure.CategoryCountLevel = objLevel.AllowCurrencyConversion= False

第 5 章 プロパティー 211

AllowDrillThrough プロパティー

AllowDrillThrough プロパティーは、キューブまたは数値データを、キューブまたはレポートへドリルスルーできるかどうかを設定するか、または設定状態を返します。

構文

object .AllowDrillThrough

適用対象

ChildCube オブジェクト

Cube オブジェクト

CubeGroup オブジェクト

Measure オブジェクト

解説

このプロパティーを使用して、キューブまたは数値データが、Impromptu レポートや PowerCube などの外部ファイルへドリルスルーできるかどうかを決定します。

ドリルスルー機能を使用可能にするには、最初に Report オブジェクトを使用してドリルスルー・リンクを作成し、次に AllowDrillThrough プロパティーを True に設定します。

デフォルト:False

タイプ

ブール値

アクセス

Read/Write

例objMeasure = objModel.Measures.Item("Quantity")objMeasure.AllowDrillThrough= True

AlternateQueryPath プロパティー

AlternateQueryPath プロパティーは、キューブで使用する代替データ・ソースの名前を設定するか、または設定状態を返します。

構文

object .AlternateQueryPath(DataSource)

212 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

適用対象

Cube オブジェクト

CubeGroup オブジェクト

解説

このプロパティーは、キューブ作成時に Transformer で代替データ・ソースからデータを読み取るように指定するために、DataSource パラメーターとともに使用します。最初に、データベース・ソフトウェアに付属しているアクセス・ツールを使用して、モデルのソース・ファイルと同じ構造の代替ソース・ファイルを設定する必要があります。代替データ・ソースは、Transformer のモデルに読み込むためにソースと同じ列が含まれている必要があります。

例えば、販売部門ごとに異なるソース・ファイルからキューブを構築するときも、同じ販売分析モデルを使用できます。複数の Impromptu クエリー定義 (.iqd) ファイルを作成し、それぞれ 1 つの販売部門のデータのみを取得するようにフィルターを設定します。

パラメーター 説明

DataSource プロパティーを設定する場合は必須。代替データ・ソースの参照に使用するオブジェクトを指定します。

タイプ:Object

タイプ

文字列

アクセス

Read/Write

AltMDCFile プロパティー

AltMDCFile プロパティーは、キューブの代替ファイル名を指定します。

構文

object .AltMDCFile

適用対象

Cube オブジェクト

CubeGroup オブジェクト

ChildCube オブジェクト

第 5 章 プロパティー 213

解説

キューブが他のアプリケーションで使用中の場合に使用するファイル名を指定します。このプロパティーを有効にするには、UseAltMDCFile プロパティーを「true」に設定します。

キューブが使用中かどうかを確認するには、IsMDCInUse プロパティーを使用します。

このプロパティーはオプションです。UseAltMDCFile プロパティーが True であれば、このプロパティーを使用して代替ファイル名を指定できます。このプロパティーが設定されていない場合は、デフォルトの代替名が自動的に使用されます。ファイル名の後ろに 1~100 の数字が 1 から順番に追加され、最初に許可されたファイル名が使用されます。

タイプ

文字列

アクセス

Read/Write

AlwaysUseTransformerSignon プロパティー

AlwaysUseTransformerSignon プロパティーは、Transformer サインオンを使用するか、Content Manager サインオンを使用するかを指定します。

構文

PackageDatasourceConnection .AlwaysUseTransformerSignon

適用対象

PackageDatasourceConnection オブジェクト

解説

True の場合は、Transformer サインオンが Content Manager サインオンよりも優先されます。False の場合は、Content Manager サインオンがデフォルトで使用されます。

タイプ

ブール値

アクセス

Read/Write

例package = model.Packages.Add()connection.AlwaysUseTransformerSignon= True

214 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

Apex プロパティー

Apex プロパティーは、ディメンション・ビューのルートに表示される Categoryオブジェクトを設定するか、または設定状態を返します。

構文

View .Apex

適用対象

View オブジェクト

解説

このプロパティーを使用して、PowerPlay に表示されるカテゴリーを、ユーザーが必要とするサブセットのみに制限します。

ディメンション・ビューを作成し、指定したカテゴリーに Apex プロパティーを適用できます。キューブを作成した後、キューブには筆頭指定したカテゴリーと直接の子孫のみが含まれます。先祖、親族、親族の子孫は、すべて表示から省略されます。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

タイプ

オブジェクト

アクセス

Read/Write

例objProductsDim = objModel.Dimensions.Item("Products")objViewItem.Apex= objProductsDim.Drilldowns(1).Categories(1)

Application プロパティー

Application プロパティーは、Transformer Application オブジェクトを返します。

構文

object .Application

適用対象

Associations コレクション

Association オブジェクト

CalculationDefinitions コレクション

第 5 章 プロパティー 215

CalculationDefinition オブジェクト

Categories コレクション

Category オブジェクト

CategorySets コレクション

CategorySet オブジェクト

Columns コレクション

Column オブジェクト

CrossTabDataSource オブジェクト

Cubes コレクション

Cube オブジェクト

CubeCustomViews コレクション

CubeGroup オブジェクト

ChildCubes コレクション

ChildCube オブジェクト

CurrencyRecords コレクション

CurrencyRecord オブジェクト

CurrencyRates コレクション

CurrencyRate オブジェクト

CurrencyTables コレクション

CurrencyTable オブジェクト

CustomViews コレクション

CustomView オブジェクト

DateDimension オブジェクト

DateLevel オブジェクト

DataSources コレクション

DataSource オブジェクト

DateWizard オブジェクト

DbDataSource オブジェクト

216 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

DateDrillDown オブジェクト

Dimensions コレクション

Dimension オブジェクト

DimensionLevels コレクション

DrillDowns コレクション

DrillDown オブジェクト

DrillThroughTargets コレクション

DrillThroughTarget オブジェクト

FlatFileDataSource オブジェクト

Filters コレクション

Filter オブジェクト

IqdDataSource オブジェクト

PackageDatasourceConnections コレクション

PackageDatasourceConnection オブジェクト

Packages コレクション

Package オブジェクト

Prompts コレクション

Prompt オブジェクト

Queries コレクション

Query オブジェクト

Levels コレクション

Level オブジェクト

LevelDrillDowns コレクション

Measures コレクション

Measure オブジェクト

Model オブジェクト

Namespaces コレクション

Namespace オブジェクト

第 5 章 プロパティー 217

Names コレクション

Name オブジェクト

Reports コレクション

Report オブジェクト

SecurityObjects コレクション

SecurityObject オブジェクト

SuspendedModels コレクション

SuspendedModel オブジェクト

Signons コレクション

Signon オブジェクト

SpecialCategory オブジェクト

Views コレクション

View オブジェクト

解説

このプロパティーは、モデルの他のオブジェクトおよびコレクションから、Transformer Application オブジェクトのプロパティーを参照するために使用します。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

タイプ

オブジェクト

アクセス

読み取り

AssociationRole プロパティー

AssociationRole プロパティーは、Association オブジェクトの役割を設定するか、または設定状態を返します。

構文

Association .AssociationRole

218 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

適用対象

Associations コレクション

解説

通貨表、日付ディメンション、レベル、日付レベル、ディメンション、数値データは、Associations コレクションを通じてソース・データと関連付けられます。AssociationRole プロパティーは、コレクションに含まれる各 Association オブジェクトの役割を決定するために使用します。

例えば、レベル内の各カテゴリーの値を product_code などの 1 つの列から取り込み、ラベルの値を product_name などの別の列から取り込みます。この場合、コレクションにはそれぞれ違う役割を持つ 2 つの Association オブジェクトが含まれます。

AssociationRole には、xtrAssociationRole の値を使用します。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

タイプ

Object - Associations

アクセス

Read/Write

例objAssociation= objDrill.ConvergenceLevel.Associations.Add()objAssociation.AssociationRole= xtrAssociationRole.trAssociationOrderBy

Associations プロパティー

Associations プロパティーは、Association オブジェクトのコレクションを返します。

構文

object .Associations

適用対象

CurrencyTable オブジェクト

DateDimension オブジェクト

DateLevel オブジェクト

Dimension オブジェクト

第 5 章 プロパティー 219

Level オブジェクト

Measure オブジェクト

解説

モデルの特定のオブジェクトは、Associations コレクションを通じてソース列と関連付けられます。Association は、オブジェクトに値のソースを設定します。

例えば、レベル内の各カテゴリーの値を product_code などの 1 つの列から取り込み、ラベルの値を product_name などの別の列から取り込みます。この場合、コレクションにはそれぞれ違う役割を持つ 2 つの Association オブジェクトが含まれます。

Measure オブジェクトの関連付けは、オブジェクトの MeasureType プロパティーが trRegularMeasure に設定されているときのみに有効です。Association を通じて値を取り込む数値データには、ExpressionText プロパティーとCategoryCountLevel プロパティーを使用できません。これらは、相互に排他的です。

タイプ

オブジェクト

アクセス

読み取り

例objAssociation = objDrill.ConvergenceLevel.Associations.Add()

AssociationType プロパティー

AssociationType プロパティーは、Association オブジェクトにデータ・ソースとの関連付けがあるかどうかを設定するか、または設定状態を返します。

構文

Association .AssociationType

適用対象

Association オブジェクト

解説

AssociationType プロパティーには、xtrAssociationType の値を使用します。

タイプ

定数 - xtrAssociationType

220 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

アクセス

Read/Write

例objAssociation= objDrill.ConvergenceLevel.Associations.Add()objAssociation.AssociationType= xtrAssociationType.trAssociationQuery

AutoLogon プロパティー

True の場合、AutoLogon プロパティーはサインオンに関連付けられているセキュリティー・ネームスペースに対して、アプリケーションが自動的に認証されるかどうかを定義します。

構文

Query .AutoSummary

適用対象

Signon オブジェクト

解説

このプロパティーを True に設定すると、サインオンに関連付けられているセキュリティー・ネームスペースに対して、アプリケーションが自動的に認証されます。

AutoLogon プロパティーは、CognosSignon タイプにのみ適用されます。

タイプ

ブール値

アクセス

Read/Write

例signon = model.Signons.Add()signon.AutoLogon = True

AutoSummary プロパティーAutoSummary プロパティーは、クエリーの自動集計オプションを設定するか、または設定状態を返します。

構文

query .AutoSummary

適用対象

Query オブジェクト

第 5 章 プロパティー 221

解説

このプロパティーは、パッケージに対して設定する必要があります。レポートには設定しないでください。

タイプ

ブール値

アクセス

Read/Write

例new_package = model.Packages.Add()new_query.AutoSummary= True

BlankSubstitute プロパティーBlankSubstitute プロパティーは、レベルに生成された空白カテゴリーに割り当てるデフォルトのラベルを設定するか、または設定状態を返します。

構文

object .BlankSubstitute

適用対象

DateLevel オブジェクト

Level オブジェクト

解説

標準カテゴリーに関連付けられたソース値がない場合、このプロパティーに指定した文字列がデフォルトのラベルとして割り当てられます。このようにして、特定のカテゴリー階層を保持するために、データ・ソースに意図的に空白のカテゴリーを含めることもできます。

タイプ

文字列

アクセス

Read/Write

例objLocationsDim = objModel.Dimensions("Sales regions")objLevel= objLocationsDim.DrillDowns(1).Levels("Employee")objAltDrill= objLevel.CreateAlternateDrillDownobjNewLevel= objAltDrill.Levels.Add(xtrObjectType.trLevel)objNewLevel.BlankSubstitute= "No Value"

222 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

BlockParentTotals プロパティー

BlockParentTotals プロパティーは、除外されている子の親が、拒否された値または除外されていない子の総数のいずれを表示するかを設定するか、または設定状態を返します。

構文

Cube .BlockParentTotals

適用対象

Cube オブジェクト

解説

このオプションのプロパティーは、除外されている子の親が、除外されていない子の総数ではなく、拒否された値を表示することを指定または確認します。これにより、除外されていないカテゴリーのみを不正確に集計したデータが表示されることを妨げます。欠落値は拒否された値より優先され、欠落値の扱いに関するキューブでの数値データの設計に従って、ゼロ、NA (利用不可)、空白 (セル中に値なし)、または欠落値として引き続き表示されます。これにより、ユーザーは欠落値と拒否された値を区別できます。

デフォルト:False

注: 6.6 以前のバージョンで作成されたキューブは、キューブを 7.0 にインポートした後に、BlockParentTotals プロパティーを True に設定しない限り、どのバージョンで開いても以前と同じように動作します。

タイプ

ブール値

アクセス

Read/Write

例objCube = objModel.Cubes.Item(1)objCube.BlockParentTotals= True

CacheCrossTabs プロパティー

CacheCrossTabs プロパティーは、集計をキャッシュするかどうかを設定するか、または設定状態を返します。

構文

object .CacheCrossTabs

第 5 章 プロパティー 223

適用対象

Cube オブジェクト

CubeGroup オブジェクト

解説

このプロパティーは、最初の PowerPlay クロス集計の集計をキューブに保存するために使用します。最初のクロス集計は、最初のディメンションを行として、次のディメンションを列として表示されます。これにより、この初期クロス集計についてのみ PowerPlay のアクセス時間が最適化されます。

デフォルト:False

タイプ

ブール値

アクセス

Read/Write

例objCube = objModel.Cubes.Item(1)objCube.CacheCrossTabs= True

CalculationDefinitions プロパティー

CalculationDefinitions プロパティーは、ディメンションに関連付けられているCalculationDefinition オブジェクトのコレクションを返します。

構文

object .CalculationDefinitions

適用対象

DateDimension オブジェクト

Dimension オブジェクト

解説

CalculationDefinition オブジェクトは、計算に 1 つ以上のカテゴリーの値を使用する複雑な数式からなります。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

タイプ

Object - CalculationDefinitions

224 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

アクセス

読み取り

例calcDef = dimension.CalculationDefinitions.Add()

CAMID プロパティー

CAMID プロパティーは、ネームスペースの CAMID を返します。

構文

Namespace .CAMID

適用対象

Namespace オブジェクト

解説

このプロパティーは、ネームスペースの CAMID を取得するために使用します。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

タイプ

文字列

アクセス

読み取り

例CAMID_of_Namespace = new_namespace.CAMID

CanAllocate プロパティー

CanAllocate プロパティーは、数値データ値の値を子孫のレベルとカテゴリーに割り当てることができるかどうかを返します。

構文

object .CanAllocate

適用対象

Category オブジェクト

DateDimension オブジェクト

DateLevel オブジェクト

第 5 章 プロパティー 225

Dimension オブジェクト

Level オブジェクト

SpecialCategory オブジェクト

解説

1 つのデータ・ソースの数値データを、別のデータ・ソースに関連付けられているレベルおよびカテゴリーに割り当てることができるかどうかを決定します。割り当てによって、ディメンションの集計レベルにあるデータが下位レベルに分配されます。次のレベルに割り当てられます。

v ディメンションを参照しないデータ・ソースに数値データが含まれるとき、全ディメンション

v 数値データがディメンションのあるレベルですでに指定されているとき、ディメンションに含まれるレベル

v 数値データが特定のレベルにすでに指定されているとき、レベルに含まれるカテゴリー

例えば、四半期ごとの売上高予測に対して、毎日の売上高を追跡する場合があります。比例配分の割り当ては、四半期ごとの予測を月と日のレベルに配分するのに便利です。

このプロパティーは、モデルが 2 つ以上のデータ・ソースを使用するときのみTrue になります。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

タイプ

ブール値

アクセス

読み取り

例objLevel = objModel.Dimensions("Products").DimensionLevels(1)If objLevel.CanAllocate= True Then

CanAllocateByMeasure プロパティー

CanAllocateByMeasure プロパティーは、数値データで割り当てるときに、指定し数値データを加重係数として使用できるかどうかを返します。

構文

object .CanAllocateByMeasure(Measure)

226 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

適用対象

Category オブジェクト

DateDimension オブジェクト

DateLevel オブジェクト

Dimension オブジェクト

Level オブジェクト

SpecialCategory オブジェクト

解説

数値データを比例配分する場合は、別の数値データの値を加重係数として使用します。PowerPlay ユーザーには全子孫カテゴリーの割り当て値が表示されます。このプロパティーは、指定した数値データを加重係数として使用できるかどうかを決定するために使用します。

数値データの値を子孫カテゴリーすべてに割り当てるには、SetAllocation メソッドを使用します。割り当て機能によって、ディメンションの集計レベルにあるデータが下位レベルに分配されます。

例えば、固定費の数値データを、地域別売上など別の数値データを使用して、各地域に割り当てることができます。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

パラメーター 説明

数値データ Measure は必須。加重係数して使用するMeasure オブジェクトを指定します。

タイプ:Object - Measure

タイプ

ブール値

アクセス

読み取り

例objLevel= objModel.Dimensions("Products").DimensionLevels(1)IfobjLevel.CanAllocateByMeasure(objByMeasure)= True Then

第 5 章 プロパティー 227

CanAllocateMeasure プロパティー

CanAllocateMeasure プロパティーは、指定した数値データを子孫のレベルとカテゴリーに割り当てることができるかどうかを返します。

構文

object .CanAllocateMeasure(Measure)

適用対象

Category オブジェクト

DateDimension オブジェクト

DateLevel オブジェクト

Dimension オブジェクト

Level オブジェクト

SpecialCategory オブジェクト

解説

特定の数値データを割り当てることができるかどうかを決定します。数値データを比例配分する場合、加重係数として使用できる数値データを決定するには、CanAllocateByMeasure プロパティーを使用します。

数値データの値を子孫カテゴリーすべてに割り当てるには、SetAllocation メソッドを使用します。割り当て機能によって、ディメンションの集計レベルにあるデータが下位レベルに分配されます。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

パラメーター 説明

数値データ Measure は必須。加重係数して使用するMeasure オブジェクトを指定します。

タイプ:Object

タイプ

ブール値

アクセス

読み取り

228 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

例objLevel= objModel.Dimensions("Products").DimensionLevels(1)IfobjLevel.CanAllocateMeasure(objMeasure)= True Then

Categories プロパティー

説明

Categories プロパティーは、オブジェクトに関連付けられている Categories コレクションを返します。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

構文

object .Categories

適用対象

CategorySet オブジェクト

DateDimension オブジェクト

Dimension オブジェクト

DateDrillDown オブジェクト

DrillDown オブジェクト

解説

CategorySet オブジェクトの Categories プロパティーは、計算に使用するカテゴリーを返します。

Dimension オブジェクトの Categories プロパティーは、特殊カテゴリーのコレクションを返します。また、特殊カテゴリーに接続された算出カテゴリーも返します。

DrillDown オブジェクトの Categories プロパティーは、レベルの全カテゴリーを返します。子カテゴリーのコレクションを取得するには、ChildCategories プロパティーを使用します。

タイプ

オブジェクト

アクセス

読み取り

第 5 章 プロパティー 229

例objCategory = objModel.Dimensions("Retailers").DrillDowns(1).Categories(2)

Category プロパティー

Category プロパティーは、特定の通貨レートを適用できる日付カテゴリーを返します。

構文

CurrencyRate .Category

適用対象

CurrencyRate オブジェクト

解説

通貨レートを有効にするには、日付カテゴリー (日、週、月、四半期、年) を関連付ける必要があります。例えば、月ごとにレートを設定した場合、特定の通貨レートが適用される月が返されます。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

タイプ

オブジェクト

アクセス

読み取り

例objCurrencyRecord = objModel.CurrencyRecords.Add()objCurrencyRate= objCurrencyRecord.CurrencyRates(intX)Select Case objCurrencyRate.Category.KeyName

CategoryCount プロパティー

CategoryCount プロパティーは、ディメンションまたはレベルに含まれる標準カテゴリー数を返します。

構文

object .CategoryCount

適用対象

DateDimension オブジェクト

DateLevel オブジェクト

230 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

Dimension オブジェクト

Level オブジェクト

解説

このプロパティーは、標準カテゴリーのみカウントします。ルート、ドリル、特殊カテゴリーをカウントするには、SpecialCategoryCount プロパティーを使用します。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

タイプ

Long

アクセス

読み取り

例objDateDrillDown = objModel.Dimensions("Years").DrillDowns(1)objLevel= objDateDrillDown.Levels("Year") For intX = 1 To objLevel.CategoryCount

CategoryCountLevel プロパティー

CategoryCountLevel プロパティーは、カテゴリー・カウントが適用される Levelオブジェクトを設定するか、または設定状態を返します。

構文

Measure .CategoryCountLevel

適用対象

Measure オブジェクト

解説

カテゴリーをカウントする数値データを定義します。例えば、特定の製品を購入した顧客数を、月、四半期、または年単位で、顧客の種類別に示す数値データを作成できます。

このプロパティーは、カテゴリー・カウント数値データが適用されるレベルを指定するために使用します。Transformer では、欠落値またはゼロ値のカテゴリーはカウントされません。カテゴリー・カウントは、数値データの数値になります。

このプロパティーを設定した後、MeasureType プロパティーの戻り値はtrCountMeasure になります。カテゴリー・カウント数値データでは、カテゴリーをカウントして値を求めます。関連または数式は使用できません。

第 5 章 プロパティー 231

このプロパティーを設定する前に、レベルまたは日付レベルの Unique プロパティーを True に設定します。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

タイプ

オブジェクト

アクセス

Read/Write

例objMeasure.CategoryCountLevel = objLevelobjMeasure.CategoryCountLevel= objLevel

CategorySets プロパティー

CategorySets プロパティーは、計算の定義に関連付けられた CategorySet オブジェクトのコレクションを返します。

構文

CalculationDefinition .CategorySets

適用対象

CalculationDefinition オブジェクト

解説

CategorySet オブジェクトには、計算に使用する 1 つ以上のカテゴリーが含まれます。

計算の定義を作成するとき、一部の関数では 1 つ以上のカテゴリー・セットをパラメーターとして指定できます。例えば、変化率の関数は、最初のパラメーターと 2番目のパラメーターを比較して変化の割合を計算します。

タイプ

Object - Category Sets

アクセス

読み取り

例catSet = calcDef.CategorySets.Add()

232 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

CharacterType プロパティー

説明

CharacterType プロパティーは、データ・ソースで使用する文字セットのタイプを設定する、または設定状態を返します。

構文

FlatFileDataSource .CharacterType

適用対象

FlatFileDataSource オブジェクト

解説

このプロパティーを使用して、Windows ANSI (ISO 8859-1) または DOS (OEM)文字セットを設定します。

クライアント/サーバー・モデルを開発する場合は、拡張文字 (128 以上) が正しく表示されるように、クライアントとサーバーの両方で同じ文字セットを使用することを推奨します。

CharacterType プロパティーには、xtrCharacterType の値を使用します。

タイプ

定数 - xtrCharacterType

アクセス

Read/Write

例objDataSource= objModel.DataSources.

Add(xtrObjectType.trFlatFileDataSource)objDataSource.CharacterType= xtrCharacterType.trCharAnsiSingleByte

ChildCategories プロパティー

ChildCategories プロパティーは、Categories コレクションを返します。

構文

object .ChildCategories

適用対象

Category オブジェクト

SpecialCategory オブジェクト

第 5 章 プロパティー 233

解説

ChildCategories プロパティーは、各 Category オブジェクトの下位レベルについてCategories コレクションを取得するために使用します。

タイプ

Object - Categories

アクセス

読み取り

例objCategory= objModel.Dimensions("Retailers").DrillDowns(1).Categories(2)objCatToMove= objCategory.ChildCategories(5)

ChildCubes プロパティー

ChildCubes プロパティーは、キューブ・グループから ChildCube オブジェクトのコレクションを返します。

構文

CubeGroup .ChildCubes

適用対象

CubeGroup オブジェクト

解説

キューブ・グループは、ディメンション内の 1 つのレベルを表します。コレクションの各子キューブには、レベルに含まれる 1 つのカテゴリーが反映され、そのカテゴリーの子孫カテゴリーが含まれています。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

タイプ

Object - ChildCubes

アクセス

読み取り

例objCubesByRegion = objModel.Cubes.Add(xtrObjectType.trCubeGroup)objChildCube =objCubesByRegion.ChildCubes("Central Europe")

234 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

ChildCustomViews プロパティー

ChildCustomViews プロパティーは、CustomView オブジェクトのコレクションを返します。

構文

CustomView .ChildCustomViews

適用対象

CustomView オブジェクト

解説

このプロパティーは、カスタム・ビュー内にネストされたカスタム・ビューを作成するために使用します。新しいカスタム・ビューを追加するには、CustomViews コレクションの Add メソッドを使用します。カスタム・ビューをコレクションに追加した後は、新しい CustomView オブジェクトのプロパティーを更新できます。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

タイプ

CustomViews

アクセス

読み取り

例currentCustomView = model.CustomViews.Add()childCustomView= currentCustomView.ChildCustomViews.Add()

ChildMeasures プロパティー

ChildMeasures プロパティーは、数値データ・フォルダーから子数値データのコレクションを返します。

構文

Measure .ChildMeasures

適用対象

Measure オブジェクト

解説

すべての子数値データを取得するために使用します。返されるコレクションは、同じプロパティーとメソッドを持つ MeasureCollection オブジェクトです。このプロパティーを標準数値データに使用すると、例外が発生します。

第 5 章 プロパティー 235

数値データ・フォルダーに子数値データがない場合は、空のコレクションが返されます。COM 例外が発生し、「trMeasure (ChildMeasures) : このオブジェクトに対する処理は許可されていません。」というメッセージが表示されます。

モデル・オブジェクトから取得される MeasureCollection にも、数値データ・フォルダーとその子数値データが含まれます。これらのフォルダーや子数値データへは、他の MeasureCollection と同様にアクセスできます。ただし、モデル・オブジェクトから返された MeasureCollection では、数値データ・フォルダーや、数値データ・フォルダーの子数値データに Move メソッドを適用すると、例外が返されます。

タイプ

Object - Categories

アクセス

読み取り

Code プロパティー

Code プロパティーは、ディメンション全体でカテゴリーを一意に識別するコードを設定するか、または設定状態を返します。

構文

object .Code

適用対象

Category オブジェクト

SpecialCategory オブジェクト

解説

コードは、英字または英数字の内部的な識別子で、Transformer でカテゴリーを生成するときに自動的に設定されます。コードを変更して、より説明的にすることもできます。指定したコードがすでに存在する場合、Transformer では数値のサフィックスが付けられ、一意なコードが作成されます。

タイプ

文字列

アクセス

Read/Write

236 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

例objSpecCategory= _ objModel.Dimensions("Time").Categories.Add(xtrObjectType.trSpecialCategory)objSpecCategory.Code= "Five Month Period"

Columns プロパティー

Columns プロパティーは、データ・ソース内のすべての Column オブジェクトを含む Columns コレクションを返します。

構文

object .Columns

適用対象

CrossTabDataSource オブジェクト

DbDataSource オブジェクト

FlatFileDataSource オブジェクト

IqdDataSource オブジェクト

Query オブジェクト

解説

列は、キューブ作成時に Transformer で使用される全データのソースです。

モデルのディメンション、レベル、数値データを構築するために列データを使用したかどうかを決定するには、ColumnsLoaded プロパティーを使用します。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

タイプ

オブジェクト

アクセス

読み取り

例objDataSource= objModel.DataSources.Add(xtrObjectType.trFlatFileDataSource)objColumn= objDataSource.Columns(1)

第 5 章 プロパティー 237

ColumnsLoaded プロパティー

ColumnsLoaded プロパティーは、モデルの構築にデータ・ソースの列を使用したかどうかを返します。

構文

object .ColumnsLoaded

適用対象

CrossTabDataSource オブジェクト

DbDataSource オブジェクト

FlatFileDataSource オブジェクト

IqdDataSource オブジェクト

解説

戻り値が True の場合、モデルの Column オブジェクトがデータ・ソースの列とリンクしていることを示します。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

タイプ

ブール値

アクセス

読み取り

CompressMDC プロパティー

CompressMDC プロパティーは、キューブを圧縮するかどうかを設定するか、または設定状態を返します。

構文

object .CompressMDC

適用対象

Cube オブジェクト

CubeGroup オブジェクト

解説

このプロパティーは、キューブの配布を最適化するために使用します。

238 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

Transformer では、キューブが作成されるたびにキューブが圧縮されます。圧縮キューブでインクリメンタル更新、キューブ・ステータスの確認などの Transformerの操作を行うと、キューブの圧縮が解凍され、操作が完了すると再圧縮が行われます。

圧縮キューブを PowerPlay で初めて開くときは、開くまでに少し時間がかかります。その後、キューブは元のサイズに戻り、正常に開きます。

デフォルト:False

タイプ

ブール値

アクセス

Read/Write

例objCube = objModel.Cubes.Item(1)objCube.CompressMDC =False

Connection プロパティー

Connection プロパティーは、Content Manager 接続を設定するか、または設定状態を返します。

構文

PackageDatasourceConnection .Connection

適用対象

PackageDatasourceConnection オブジェクト

解説

このプロパティーは、Content Manager 接続を取得するために使用します。

タイプ

文字列

アクセス

Read/Write

例package = model.Packages.Add()connection= package.PackageDatasourceConnections.Add()connection.Connection= "great_outdoors_warehouse"

第 5 章 プロパティー 239

Consolidate プロパティー

Consolidate プロパティーは、キューブを集約する方法を設定するか、または設定状態を返します。

構文

object .Consolidate

適用対象

ChildCube オブジェクト

Cube オブジェクト

CubeGroup オブジェクト

解説

このプロパティーは、キューブのサイズを小さくし、PowerPlay のアクセス時間を短縮するために使用します。集約されたキューブは、同じ非数値データ値の値を 1つのレコードにまとめ、数値データ値を集計します。

このプロパティーには、xtrCubeConsolidate の値を使用します。

データ・レコードの非数値データ値の値は、次の場合に同じになります。

v ソースにあるトランザクションの非数値データ値の値が同じ場合。例えば、顧客が同じ日に同じ製品を 2 回購入した場合です。

v 詳細度による場合。例えば、DateDegreeofDetail プロパティーを月に設定すると、キューブを集約するときにソースにあるトランザクションの日の値が無視されます。

v ディメンションがキューブから省略されている場合。例えば、同じ日に別の店で同じ製品が 2 個販売される場合です。支店がキューブから除外されると、販売金額レコードの非数値データ値は同じになります。

v キューブのカテゴリーが集計または消去されている場合。例えば、同じ日に同じ製品が同じ顧客に 2 個販売されましたが、製品の色が異なる場合です。これらのディメンション・ビュー・オプションのいずれかを使用して、キューブから色を除外すると、販売金額レコードの非数値データ値は同じになります。

最初の 3 つのシナリオでは、DuplicateRollup プロパティーの値 (None 以外) を使用して、非数値データ列の値が同じレコードを集約します。最後のシナリオでは、数値データの TimeStateRollup プロパティーを None 以外の値に設定しない限り RegularRollup プロパティーの値を使用して、ディメンション・ビューにより同じ値になったレコードを集約します。

タイプ

定数 - xtrCubeConsolidate

240 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

アクセス

Read/Write

例objCube.Consolidate = xtrCubeConsolidate.trConsolidateDefault

Context プロパティー

Context プロパティーは、レベルのカテゴリーをソートするために使用するドリルダウン・パスを設定するか、または設定状態を返します。

構文

Association .Context

適用対象

Association オブジェクト

解説

デフォルトでは、カテゴリーはデータ・ソースと同じ順序でレベル (最終的にはキューブ) に表示されます。オブジェクトをソートするには、Association オブジェクトを使用して AssociationRole プロパティーを trAssociationOrderBy に設定します。

ソートを適用するドリルダウン・パスに名前を付けるには、Context プロパティーを使用します。レベルが複数のドリルダウン・パスの収束レベルになっている場合は、それぞれ異なるソートの順序を適用できます。

ソートの順序を指定するには、OrderByDescending プロパティーを使用します。数値データの列を使用してソートを定義する場合は、OrderByStorageType を使用してデータ型のサイズを指定します。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

タイプ

オブジェクト

アクセス

Read/Write

例objAssociation = objDrill.ConvergenceLevel.Associations.Add()objAssociation.Context= objDrill

第 5 章 プロパティー 241

ContextLevel プロパティー

ContextLevel プロパティーは、日付期間を設定するか、または設定状態を返します。

構文

SpecialCategory .ContextLevel

適用対象

SpecialCategory オブジェクト

解説

現在の期間を基準とする特定の期間の数値データを追跡するため、特殊カテゴリーを作成します。ContextLevel プロパティーと ContextOffset プロパティーは、前年または前四半期などの相対時間カテゴリーを定義するために使用します。

ContextLevel プロパティーは、TargetLevel プロパティーまたは ToDateLevel プロパティーの総括期間を指定するために使用します。例えば、目標期間を月に設定した場合、総括期間には年または四半期を指定します。

タイプ

文字列

アクセス

Read/Write

例objSpecCategory= _ objModel.Dimensions("Time").Categories.Add(xtrObjectType.trSpecialCategory)objSpecCategory.ContextLevel= "Quarter"

ContextOffset プロパティー

ContextOffset プロパティーは、現在の期間を基準とする総括期間の位置を設定するか、または設定状態を返します。

構文

SpecialCategory .ContextOffset

適用対象

SpecialCategory オブジェクト

242 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

解説

このプロパティーは、現在の期間を基準とする ContextLevel プロパティーのオフセット値を指定するために使用します。例えば、総括期間が年の場合、総括期間オフセットの 1 は昨年に対応します。

相対期間またはグループ化した期間の場合、ContextOffset プロパティーは、特殊カテゴリーのグループのオフセットを指定します。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

タイプ

Short

アクセス

Read/Write

例objSpecCategory= _ objModel.Dimensions("Time").Categories.Add(xtrObjectType.trSpecialCategory)objSpecCategory.ContextOffset= -3

ConvergenceLevel プロパティー

ConvergenceLevel プロパティーは、主ドリルダウン・パスと代替ドリルダウン・パスが結合または収束するレベルを返します。

構文

object .ConvergenceLevel

適用対象

DateDrillDown オブジェクト

DrillDown オブジェクト

解説

PowerPlay で別の視点からデータを検討できるように、ディメンションに代替ドリルダウン・パス構造を設定します。このようなパスは、収束レベルで主パスと接続します。収束レベルの各カテゴリーは、一意かつ明確でなければなりません。

レベルが複数のドリルダウン・パスの収束レベルになっている場合は、それぞれ異なるソートの順序を適用できます。ソートでは、選択したドリルダウン・パスをAssociation オブジェクトの Context プロパティーに設定する必要があります。

代替ドリルダウン・パスを作成するには、CreateAlternateDrillDown メソッドを使用します。

第 5 章 プロパティー 243

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

タイプ

オブジェクト

アクセス

読み取り

objAssociation = objDrill.ConvergenceLevel.Associations.Add()

Count プロパティー

Count プロパティーは、コレクションに含まれるオブジェクトの個数を返します。

構文

collection .Count

適用対象

Associations コレクション

CalculationDefinitions コレクション

Categories コレクション

CategorySets コレクション

ChildCubes コレクション

Columns コレクション

CubeCustomViews コレクション

Cubes コレクション

CurrencyRates コレクション

CurrencyRecords コレクション

CurrencyTables コレクション

CustomViews コレクション

DataSources コレクション

DimensionLevels コレクション

Dimensions コレクション

244 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

DrillDowns コレクション

DrillThroughTargets コレクション

Filters コレクション

LevelCategories コレクション

LevelDrillDowns コレクション

Levels コレクション

Measures コレクション

Names コレクション

Namespaces コレクション

PackageDatasourceConnections コレクション

Packages コレクション

Prompts コレクション

Queries コレクション

Reports コレクション

SecurityObjects コレクション

Signons コレクション

SuspendedModels コレクション

Views コレクション

解説

値が 0 の場合は、コレクションにオブジェクトがないことを示します。

タイプ

Long

アクセス

読み取り

例For intX = 1 To objModel.CheckModel.Count

第 5 章 プロパティー 245

CountryCode プロパティー

CountryCode プロパティーは、国または地域のコードを設定するか、あるいは設定状態を返します。

構文

CurrencyRecord .CountryCode

適用対象

CurrencyRecord オブジェクト

解説

Transformer では、Windows のコントロール・パネルにある「地域」の設定で指定した国または地域を使用して、通貨の属性 (通貨記号や小数桁数など) のデフォルト値が決定されます。CountryCode プロパティーは、このデフォルト値をオーバーライドするために使用します。

デフォルトの国または地域のコードは、通貨を使用する国または地域を指定する 3文字の ISO-3166 コード (イタリアの ITA など) です。必要な場合、このコードを変更できます。

タイプ

文字列

アクセス

Read/Write

例objCurrencyRecord = objModel.CurrencyRecords.Add()objCurrencyRecord.CountryCode= "AUS"

CubeCodePage プロパティー

CubeCodePage プロパティーは、キューブを構築するために使用するモデルのキューブのコード・ページ設定を設定するか、設定状態を返します。モデルのデフォルト設定がオペレーティング・システムのコード・ページである場合は、空の文字列が返されます。

構文

Model .CubeCodePage

適用対象

Model オブジェクト

246 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

解説

このプロパティーは、モデルのキューブのコード・ページ処理の設定を取得または変更するために使用します。キューブの作成後に「キューブのコード・ページ」の設定を変更する場合は、元のコード・ページを使用して作成されたキューブを削除し、新しいコード・ページ設定を使用してキューブを再作成する必要があります。有効な文字列のみが受け入れられます。無効な値が割り当てられた場合は、デフォルトの設定にリセットされます。現在サポートされている値を次に示します。

v ANSI_X3.4-1968

v Big5

v EUC-CN

v EUC-KR

v Extended_UNIX_Code_Packed_Format_for_Japanese

v GB_2312

v GB_2312-80

v GB18030

v GBK

v hp-roman8

v IBM850

v ISO_8859-1

v ISO_8859-1:1987

v ISO_8859-2:1987

v ISO_8859-3:1988

v ISO_8859-4:1988

v ISO_8859-5:1988

v ISO_8859-6:1987

v ISO_8859-7:1987

v ISO_8859-8:1988

v ISO_8859-9:1989

v ISO_8859-10

v ISO_8859-11

v ISO_8859-13

v ISO_8859-14

v ISO_8859-15

v KS_C_5601-1987

v Shift_JIS

v TIS-620

v UTF-8

v windows-1250

v windows-1251

v windows-1252

第 5 章 プロパティー 247

v windows-1253

v windows-1254

v windows-1255

v windows-1256

v windows-1257

v windows-874

v windows-936

タイプ

文字列

アクセス

Read/Write

CubeCreation プロパティー

CubeCreation プロパティーは、キューブを作成するかどうかを設定するか、または設定状態を返します。

構文

object .CubeCreation

適用対象

ChildCube オブジェクト

Cube オブジェクト

CubeGroup オブジェクト

解説

このプロパティーは、作成可能なキューブのサブセットを選択するフィルターとして、Status プロパティーとともに使用します。例えば、警告が発行された全キューブを選択できます。

これらの 2 つのプロパティーは、一般に、全キューブ、過去に正常に作成されたキューブ、または過去に作成時に問題があったキューブを選択するために使用します。

CubeCreation プロパティーには、xtrCubeCreation の値を使用します。

タイプ

定数 - xtrCubeCreation

248 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

アクセス

Read/Write

例objCubesByRegion= objModel.Cubes.Add(xtrObjectType.trCubeGroup)objChildCube.CubeCreation= xtrCubeCreation.trCubeCreationON

CubeCustomViews プロパティー

CubeCustomViews プロパティーは、CustomView オブジェクトのコレクションを返します。

構文

object .CubeCustomViews

適用対象

ChildCube オブジェクト

Cube オブジェクト

CubeGroup オブジェクト

解説

このプロパティーは、カスタム・ビューをキューブに関連付けるために使用します。最初に CustomView オブジェクトのプロパティーを使用してカスタム・ビューを定義します。次に、Add メソッドを使用して、キューブの CubeCustomViewsコレクションに CustomView オブジェクトを追加します。

各 Cube オブジェクト、CubeGroup オブジェクト、または ChildCube オブジェクトは、CubeCustomViews コレクションを定義します。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

タイプ

Object - CubeCustomViews

アクセス

読み取り

例cube = model.Cubes.Item("Sales and Marketing")cube.CubeCustomViews.Add(custom_view)

第 5 章 プロパティー 249

Cubes プロパティー

Cubes プロパティーは、Cube オブジェクトおよび CubeGroup オブジェクトのコレクションを返します。

構文

Model .Cubes

適用対象

モデル・オブジェクト

解説

このコレクションには子キューブは含まれません。キューブ・グループから子キューブを取得するには、ChildCubes プロパティーを使用します。

タイプ

Object - Cubes

アクセス

読み取り

例objCube = objModel.Cubes.Item(1)

CubeStamp プロパティー

CubeStamp プロパティーは、キューブ作成時のタイム・スタンプを返します。

構文

object .CubeStamp

適用対象

Cube オブジェクト

CubeGroup オブジェクト

解説

CubeStamp の値は、内部的に設定されます。この値がモデルと一致しない場合、Transformer では PowerCube のステータスが Invalid に設定されます。

Invalid のステータスは、キューブが他のモデルまたは旧バージョンの現在のモデルから作成されたことを示します。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

250 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

タイプ

Long

アクセス

読み取り

CurrencyCountryLabel プロパティー

CurrencyCountryLabel プロパティーは、通貨の国または地域のラベルを設定するか、または設定状態を返します。

構文

CurrencyRecord .CurrencyCountryLabel

適用対象

CurrencyRecord オブジェクト

解説

これは、通貨の名前を指定する説明的な名前です。

タイプ

文字列

アクセス

Read/Write

CurrencyDecimals プロパティー

CurrencyDecimals プロパティーは、通貨に使用する小数桁数を設定するか、または設定状態を返します。

構文

CurrencyRecord .CurrencyDecimals

適用対象

CurrencyRecord オブジェクト

解説

Transformer では、Windows のコントロール・パネルにある「地域」の設定で指定した国または地域を使用して、通貨に使用する小数桁数のデフォルト値が決定されます。小数桁数の値は、CountryCode プロパティーを設定したときに更新されます。

第 5 章 プロパティー 251

CurrencyDecimals プロパティーは、小数桁数を設定するために使用します。この設定は、「地域」の設定や CountryCode プロパティーをオーバーライドします。

CurrencyDecimals プロパティーを変更する前に、CurrencyFormatOverride プロパティーを True に設定する必要があります。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

タイプ

Long

アクセス

Read/Write

例objCurrencyRecord = objModel.CurrencyRecords.Add()objCurrencyRecord.CurrencyDecimals= 2

CurrencyFormatOverride プロパティー

CurrencyFormatOverride プロパティーは、通貨の属性をオーバーライドできるかどうかを設定するか、または設定状態を返します。

構文

CurrencyRecord .CurrencyFormatOverride

適用対象

CurrencyRecord オブジェクト

解説

Transformer では、Windows のコントロール・パネルにある「地域」の設定で指定した国または地域を使用して、通貨の属性 (通貨記号や小数桁数など) のデフォルト値が決定されます。通貨の属性は、CountryCode プロパティーを使用して設定できます。特に、通貨の属性をオーバーライドするために CurrencyDecimals プロパティーまたは CurrencySymbol プロパティーを使用する場合は、最初にCurrencyFormatOverride プロパティーを True に設定する必要があります。

通貨の属性は、次の場合にオーバーライドします。

v PowerPlay ユーザーのコンピューターで、Windows コントロール・パネルの「地域」の設定に国または地域が定義されていないか、または複数の通貨が使用される場合。

v 説明的な通貨記号を追加する場合。例えば、ドル記号の前に"AUS"、"CDN"、または"US"を付けて、PowerPlay に表示される各通貨を区別できます。

デフォルト:False

252 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

タイプ

ブール値

アクセス

Read/Write

例objCurrencyRecord= objModel.CurrencyRecords.Add()objCurrencyRecord.CurrencyFormatOverride= True

CurrencyIsEMU プロパティー

CurrencyIsEMU プロパティーは、レコードが欧州通貨統合 (EMU) の通貨レコードかどうかを設定するか、または設定状態を返します。

構文

CurrencyRecord .CurrencyIsEMU

適用対象

CurrencyRecord オブジェクト

解説

EMU 通貨には、基準テーブルとは別にユーロ表が必要です。このプロパティーは、ユーロ表に通貨レコードを追加するために使用します。このプロパティーを設定する場合は、EMUEntryDate プロパティーも設定する必要があります。

EMU 通貨から EMU 以外の通貨に変換する場合、Transformer では Triangulation(3 通貨変換) プロセスが使用され、次のように変換が行われます。

v ソース通貨から基準ユーロ通貨へ

v 基準ユーロ通貨から基準通貨へ

v 基準通貨からターゲット通貨へ

Transformer で非 EMU 通貨から EMU 通貨へ変換するときも同様です。

ユーロ表を作成する場合は、プロセスの 2 つの段階で LoadCurrencyTable メソッドを使用する必要があります。次の時点でこのメソッドを使用します。

v ユーロ表の関連付けの役割と各データ・ソース列を関連付けた後

v ユーロ表に通貨レコードを追加した後

デフォルト:False

タイプ

Boolean 値

第 5 章 プロパティー 253

アクセス

Read/Write

例objCurrencyRec = objModel.CurrencyRecords(1)objCurrencyRec.CurrencyIsEMU= True

CurrencyIsEuro プロパティー

CurrencyIsEuro プロパティーは、通貨レコードが基準ユーロ通貨かどうかを設定するか、または設定状態を返します。

構文

CurrencyRecord .CurrencyIsEuro

適用対象

CurrencyRecord オブジェクト

解説

このプロパティーは、CurrencyRecords コレクションの特定の通貨レコードを、基準ユーロ通貨として識別するために使用します。ユーロ変換では、ユーロ表の他の通貨レートすべてに適用する基準値が必要です。

CurrencyTables コレクションにユーロ表を追加すると、Transformer により自動的に <Base Euro> レコードの CurrencyIsEuro プロパティーが True に設定されます。他のレコードは、すべて False を返します。

タイプ

ブール値

アクセス

Read/Write

例objCurrencyRecord = objModel.CurrencyRecords.Add()objCurrencyRecord.CurrencyIsEuro= False

CurrencyRates プロパティー

CurrencyRates プロパティーは、CurrencyRate オブジェクトのコレクションを返します。

構文

CurrencyRecord .CurrencyRates

254 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

適用対象

CurrencyRecord オブジェクト

解説

CurrencyRate オブジェクトは、CurrencyRecord オブジェクトの通貨変換レートを表します。

各オブジェクトの通貨レートは、年、四半期、月、週、または日の日付レベルで設定されます。特定の通貨レートに関連付けられている日付カテゴリーを取得するには、CurrencyRate オブジェクトの Category プロパティーを使用します。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

タイプ

Object - CurrencyRates

アクセス

読み取り

例objCurrencyRate = objCurrencyRecord.CurrencyRates(intX)

CurrencyRecord プロパティー

CurrencyRecord プロパティーは、CurrencyRate オブジェクトが適用されるCurrencyRecord オブジェクトを返します。

構文

CurrencyRate .CurrencyRecord

適用対象

CurrencyRate オブジェクト

解説

各 CurrencyRecord オブジェクトは、通貨表にある 1 行の通貨変換情報を表します。例えば、レコードと通貨レートに関連付けられている国または地域のコードを取得するには、CurrencyRecord オブジェクトの CountryCode プロパティーを使用します。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

タイプ

Object - CurrencyRecord

第 5 章 プロパティー 255

アクセス

読み取り

CurrencyRecords プロパティー

CurrencyRecords プロパティーは、モデルに含まれる全 CurrencyRecord オブジェクトのコレクションを返します。

構文

Model .CurrencyRecords

適用対象

モデル・オブジェクト

解説

各 CurrencyRecord オブジェクトは、CurrencyTable オブジェクトの 1 行の通貨変換情報を表します。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

タイプ

Object - CurrencyRecords

アクセス

読み取り

例objCurrencyRecord = objModel.CurrencyRecords.Add()

CurrencySymbol プロパティー

CurrencySymbol プロパティーは、通貨に使用する通貨記号を設定するか、または設定状態を返します。

構文

CurrencyRecord .CurrencySymbol

適用対象

CurrencyRecord オブジェクト

256 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

解説

Transformer では、Windows のコントロール・パネルにある「地域」の設定で指定した国または地域を使用して、通貨記号のデフォルト値が決定されます。通貨記号は、CountryCode プロパティーを設定したときに更新されます。

CurrencySymbol プロパティーは、特に、通貨記号を設定して「地域」の設定やCountryCode プロパティーをオーバーライドするために使用します。例えば、ドル記号の前に"AUS"、"CDN"、または"US"を付けて、PowerPlay に表示される各通貨を区別できます。

CurrencySymbol プロパティーを変更する前に、CurrencyFormatOverride プロパティーを True に設定する必要があります。

タイプ

文字列

アクセス

Read/Write

例objCurrencyRecord.CurrencySymbol = "$"

CurrencyTable プロパティー

CurrencyTable プロパティーは、通貨レートと関連する CurrencyTable オブジェクトを返します。

構文

CurrencyRate .CurrencyTable

適用対象

CurrencyRate オブジェクト

解説

CurrencyTable オブジェクトには、通貨変換に使用する通貨変換レコードが保存されます。PowerPlay では、ユーザーが定義した任意の通貨を単位とする通貨に固有な数値データ値の値が、変換レートが適用される日付レベルで表示されます。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

タイプ

Object - CurrencyTable

第 5 章 プロパティー 257

アクセス

読み取り

CurrencyTables プロパティー

CurrencyTables プロパティーは、CurrencyTable オブジェクトのコレクションを返します。

構文

Model .CurrencyTables

適用対象

Model オブジェクト

解説

このプロパティーは、CurrencyTable オブジェクトの追加、選択、または削除に使用します。Transformer では、ユーザーが PowerPlay でキューブを表示するときに通貨レートが正しく変換されるように、CurrencyTable オブジェクトの通貨表情報が使用されます。

EMU 通貨変換では、2 つのテーブルが必要です。一方のテーブルのCurrencyTableType プロパティーを trCurrencyTableBase に、もう一方のテーブルの CurrencyTableType プロパティーを trCurrencyTableEuro に設定します。CurrencyTables コレクションには、各タイプのテーブルを 1 つだけ含めることができます。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

タイプ

Object - CurrencyTables

アクセス

読み取り

例objBaseTable = objModel.CurrencyTables.Add()

CurrencyTableType プロパティー

CurrencyTableType プロパティーは、通貨表のタイプを設定するか、または設定状態を返します。

構文

CurrencyTable .CurrencyTableType

258 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

適用対象

CurrencyTable オブジェクト

解説

このプロパティーは、通貨表のタイプを指定するために使用します。

v 基準。Windows のコントロール・パネルで設定したユーザーの地域の通貨を表す通貨表です。

v ユーロ。1999 年 1 月 1 日現在のユーロに設定された欧州通貨統合 (EMU) 通貨のテーブルです。

v その他。カスタマイズした通貨表です。

EMU 通貨変換では、2 つのテーブルが必要です。一方のテーブルのCurrencyTableType プロパティーを trCurrencyTableBase に、もう一方のテーブルの CurrencyTableType プロパティーを trCurrencyTableEuro に設定します。CurrencyTables コレクションには、各タイプのテーブルを 1 つだけ含めることができます。

CurrencyTableType プロパティーには、xtrCurrencyTableType の値を使用します。

タイプ

定数 - xtrCurrencyTableType

アクセス

Read/Write

例objBaseTable = objModel.CurrencyTables.Add()objBaseTable.CurrencyTableType= xtrCurrencyTableType.trCurrencyTableBase

CurrentModel プロパティー

CurrentModel プロパティーは、Transformer で現在開いているモデル・オブジェクトを返します。

構文

Application .CurrentModel

適用対象

Application オブジェクト

解説

このプロパティーは、スクリプトでアクティブなモデルを参照する必要がある場合に使用します。

第 5 章 プロパティー 259

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

タイプ

Object - Model

アクセス

読み取り

CurrentValueIndex プロパティーCurrentValueIndex プロパティーは、現在のプロンプト値のインデックスを設定するか、または設定状態を返します。

構文

Prompt .CurrentValueIndex

適用対象

Prompt オブジェクト

解説

このプロパティーは、複数の値があるプロンプトのプロンプト値を繰り返すために使用します。インデックスの初期値は 1 です。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

タイプ

Integer

アクセス

Read/Write

例new_report = model.Reports.Add()new_query = new_report.Queries.Add()new_prompt= new_query.Prompts.Add()new_prompt.CurrentValueIndex = index

CustomView プロパティー

CustomView プロパティーは、ビューに、ディメンション内のすべてのカテゴリーを含めるか、一部のカテゴリーを含めるか、またはディメンション内のカテゴリーを含めないかを設定するか、または設定状態を返します。

構文

View .CustomView

260 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

適用対象

View オブジェクト

解説

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

タイプ

Object - CustomView

アクセス

Read/Write

CustomViews プロパティー

CustomViews プロパティーは、CustomView オブジェクトのコレクションを返します。

構文

model .CustomViews

適用対象

View オブジェクト

モデル・オブジェクト

解説

このプロパティーは、モデル内にカスタム・ビューを作成するために使用します。新しいカスタム・ビューを追加するには、CustomViews コレクションの Add メソッドを使用します。カスタム・ビューをコレクションに追加した後は、新しいCustomView オブジェクトのプロパティーを更新できます。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

タイプ

Object - CustomViews

アクセス

読み取り

例custom_view = model.CustomViews.Add()

第 5 章 プロパティー 261

DataCharacterSet プロパティー

DataCharacterSet プロパティーは、アプリケーションで使用するデフォルトの文字セットを設定するか、または設定状態を返します。

構文

Application .DataCharacterSet

適用対象

Application オブジェクト

解説

このプロパティーは、文字セットを変更するために使用します。Transformer では、Windows ANSI (ISO 8859-1) および DOS (OEM) 文字セットの両方がサポートされます。

クライアント/サーバー・モデルを開発する場合は、拡張文字 (128 以上) が正しく表示されるように、クライアントとサーバーの両方で同じ文字セットを使用することを推奨します。

DataCharacterSet プロパティーには、xtrCharacterType の値を使用します。

タイプ

定数 - xtrCharacterType

アクセス

Read/Write

例objTransApp.DataCharacterSet = xtrCharacterType.trCharDefault

DataClass プロパティー

DataClass プロパティーは、データ・ソース列のデータ・タイプを設定するか、または設定状態を返します。

構文

Column .DataClass

適用対象

Column オブジェクト

262 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

解説

このプロパティーに値を設定すると、DoAutoDesign メソッドの動作が高速になります。一般に、構造、時間、業績の各データには、それぞれテキスト、日付、数値タイプのデータ・クラスを使用します。

ExpressionText プロパティーで列を参照する場合、その列の DataClass プロパティーに有効なエントリーを設定しないと実行時エラーが発生します。

DataClass プロパティーには、xtrDataClass の値を使用します。

タイプ

定数 - xtrDataClass

アクセス

Read/Write

例objDataSource= objModel.DataSources.

Add(xtrObjectType.trFlatFileDataSource)objDataSource.DataClass= xtrDataClass.trDataClassDate

DataRange プロパティー

DataRange プロパティーは、データベース範囲の名前を設定するか、または設定状態を返します。

構文

DbDataSource .DataRange

適用対象

DbDataSource オブジェクト

解説

このプロパティーは、データベース・ソース・ファイルに定義されているデータのテーブルまたはブロックの名前を指定するために使用します。

タイプ

文字列

アクセス

Read/Write

第 5 章 プロパティー 263

DataSource プロパティー

DataSource プロパティーは、Content Manager のデータ・ソースを設定するか、または設定状態を返します。

構文

PackageDatasourceConnection .DataSource

適用対象

PackageDatasourceConnection オブジェクト

解説

このプロパティーは、Content Manager にあるデータ・ソースを取得および設定するのに使用します。

タイプ

文字列

アクセス

Read/Write

DataSourcePath プロパティー

DataSourcePath プロパティーは、Transformer でデータ・ソース・ファイルを検索する場所を設定するか、または設定状態を返します。

構文

Application .DataSourcePath

適用対象

Application オブジェクト

解説

場所を指定しない場合、Transformer では、PowerPlay をインストールしたフォルダーが検索されます。

各データ・ソースのパスとファイル名を指定するには、LocalPath プロパティーを使用します。LocalPath プロパティーに相対パスを指定した場合、パスはDataSourcePath プロパティーに設定されている値に追加されます。この場合、連結された値が正しい場所を示すことが必要です。

タイプ

文字列

264 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

アクセス

Read/Write

例objTransApp.DataSourcePath = strStartLocation

DataSources プロパティー

DataSources プロパティーは、モデルに含まれる DataSource オブジェクトのコレクションを返します。

構文

Model .DataSources

適用対象

モデル・オブジェクト

解説

このコレクションは、モデルに含まれる全データ・ソースをグループ化するために使用します。このグループには、DataSource のような一般的なオブジェクトとIqdDataSource のような特殊なソース・オブジェクトが含まれます。

データ・ソースには、DataSource オブジェクトを除き、Columns コレクションが含まれます。列は、ディメンションに含まれるレベルのソースになります。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

タイプ

オブジェクト

アクセス

読み取り

例objDataSource = objModel.DataSources.Add(xtrObjectType.trFlatFileDataSource)

DataSourceWindowsLocation プロパティー

DataSourceWindowsLocation プロパティーは、キューブの場所を完全パスとキューブ名で設定するか、または設定状態を返します。

構文

Cube .DataSourceWindowsLocation

第 5 章 プロパティー 265

適用対象

Cube オブジェクト

解説

このプロパティーを使用して、IBM Cognos Analytics サーバーの枠組みでのキューブの場所を設定します。

タイプ

文字列

アクセス

Read/Write

例cube = model.Cubes.Item("National")cube.DataSourceWindowsLocation= "c:\NATIONAL\Deployment1\National.mdc"

DataTemporaryFilesPath プロパティー

DataTemporaryFilesPath プロパティーは、Transformer でキューブを生成するときに、一時作業ファイルを作成する場所の名前を設定するか、または設定状態を返します。

構文

Application .DataTemporaryFilesPath

適用対象

Application オブジェクト

解説

このプロパティーは、ファイルのディスク領域として 1 つのディレクトリーでは不足する場合、大きいキューブを処理する 1 つ以上の場所を指定するために使用します。複数のディレクトリーは、セミコロン (;) で区切って指定します。

場所を指定しない場合、次の場所が順に検索されます。

v ModelTemporaryFilesPath プロパティーで指定した場所

v ModelsPath プロパティーで指定した場所

v PowerCubesPath プロパティーで指定した場所

v PowerPlay をインストールした場所

v "cs7g.ini"ファイルの「Services」セクションで Temporary = を使用して設定した場所

v TEMP 環境変数で設定した場所

v TMP 環境変数で設定した場所

266 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

タイプ

文字列

アクセス

Read/Write

例objTransApp.DataTemporaryFilesPath = strStartLocation

DateDegreeofDetail プロパティー

DateDegreeofDetail プロパティーは、レポートを作成する日付レベルを設定するか、または設定状態を返します。

構文

Column .DateDegreeofDetail

適用対象

Column オブジェクト

解説

このプロパティーは、Transformer でレポートを作成できる日付レベルを定義するために使用します。日付レベルは、日、週、月、四半期、または年です。

レベルを設定すると、ディメンションに含まれる数値データのレポートがそのレベルの詳細度までに制限されます。DateInputFormat プロパティーに設定した日付入力より下位のレベルは、指定できません。例えば、日付入力を四半期に設定した場合、詳細度を月に設定できません。

DateDegreeofDetail プロパティーには、xtrDateLevel の値を使用します。定数trDateLevelUnspecified を割り当てた場合、Transformer ではソース列の他の属性に基づいて詳細度が設定されます。

タイプ

定数 - xtrDateLevel

アクセス

Read/Write

例objDataSource= objModel.DataSources.Add(xtrObjectType.trFlatFileDataSource)objDataSource.Columns("EuroDate").DateDegreeofDetail= xtrDateLevel.trDateLevelMonth

第 5 章 プロパティー 267

DateDegreeofDetailLevelName プロパティー

DateDegreeofDetailLevelName プロパティーは、外部的に集計する数値データに適用する日付レベルを設定するか、または設定状態を返します。

構文

Column .DateDegreeofDetailLevelName

適用対象

Column オブジェクト

解説

構造データとトランザクション・データを別のファイルに保存するには、トランザクション・データのソース・ファイルで自動集計数値データ値の値を指定します。

このプロパティーは、Column オブジェクトが外部自動集計数値データを表す場合に Transformer でカテゴリーを生成する日付レベルを指定するために使用します。日付ディメンションのレベルに対応する詳細度のレベルを指定する必要があります。

このプロパティーを使用するには、DataSource オブジェクトの External プロパティーも True に設定する必要があります。

タイプ

文字列

アクセス

Read/Write

例.Columns("EuroDate").DateDegreeofDetail = xtrDateLevel.trDateLevelMonth

DateFormat プロパティー

DateFormat プロパティーは、Transformer でレベルに日付を表示するために使用する書式コードを設定するか、または設定状態を返します。

構文

DateLevel .DateFormat

適用対象

DateLevel オブジェクト

268 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

解説

時間ディメンションのレベルでは、日付の要素 (年、月、四半期、日など) を表すコードを使用して、日付を表示する書式が構成されます。コードを組み合わせて、カスタムの日付書式を構成できます。

コードを組み合わせると、次のような日付書式を作成できます。

v "YYYY MMM DD" (表示例 1999 Jan 01)

v "YY""Q""Q" (表示例 99 Q1)

コード 意味 例 (英語版)

YY 2 桁の年 99

YYYY 4 桁の年 1999

Q 1 桁の四半期インディケーター

1

MM 2 桁の月 (1 年以内) 01

MMM 省略形の月名 Jan

MMMM 非省略形の月名 January

DD 2 桁の日 01

DDDD 曜日 Sunday

/、-、空白文字など 他種日付コードの区切り文字 1999/01/01、1999-01-01

引用符で囲まれた文字列 文字列 "AD" で AD という略語を表示

月暦年の場合、四半期は Q1~4、月は 1~12 または 13、日は 1~28 の範囲でレベル付けされます。

タイプ

文字列

アクセス

Read/Write

例objDateLevel = objDateDim.DimensionLevels("Month")objDateLevel.DateFormat= "MMMM, yyyy"

DateFunction プロパティー

DateFunction プロパティーは、レベルに生成される日付カテゴリーを設定するかまたは設定状態を返します。

構文

DateLevel .DateFunction

第 5 章 プロパティー 269

適用対象

DateLevel オブジェクト

解説

このプロパティーは、日付を含むソース列から、正しい日付カテゴリーを作成するために使用します。例えば、月のカテゴリーを生成するには、trSpecialFunctionMonth 定数を指定します。

DateFunction プロパティーには、xtrSpecialFunction の値を使用します。

タイプ

定数 - xtrSpecialFunction

アクセス

Read/Write

例objDateWizard = objModel.DateWizardobjDateDim= objDateWizard.CreateDateDimension()objDateLevel= objDateDim.DimensionLevels(1)objDateLevel.DateFunction= xtrSpecialFunction.trSpecialFunctionLunarQuarter

DateInputFormat プロパティー

DateInputFormat プロパティーは、入力日付値の年、月、日の並び順を設定するか、または設定状態を返します。

構文

Column .DateInputFormat

適用対象

Column オブジェクト

解説

このプロパティーには、xtrDateFormat の値を使用します。日付書式セルを含むスプレッドシートのようにデータ・ソースに書式が定義されている場合は、trPredefined 定数を使用します。

タイプ

定数 - xtrDateFormat

アクセス

Read/Write

270 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

例objDataSource= objModel.DataSources.Add(xtrObjectType.trFlatFileDataSource)objDataSource.Columns("EuroDate").DateInputFormat= xtrDateFormat.trMDY

DateLevel プロパティー

DateLevel プロパティーは、通貨レコードと関連する DateLevel オブジェクトを設定するか、または設定状態を返します。

構文

CurrencyRecord .DateLevel

適用対象

CurrencyRecord オブジェクト

解説

このプロパティーは、通貨レコードのレートが適用される時間ディメンションのレベル (月、週、日など) を指定するために使用します。Transformer では、指定した日付レベルと使用可能な日付の範囲に基づいて CurrencyRate オブジェクトのコレクションが作成されます。

レートを編集するには、Rate プロパティーを使用します。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

タイプ

Object - DateLevel

アクセス

Read/Write

例objCurrencyRecord = objModel.CurrencyRecords.Add()objCurrencyRecord.DateLevel =objLevel

DateWizard プロパティー

DateWizard プロパティーは、DateWizard オブジェクトを返します。

構文

Model .DateWizard

第 5 章 プロパティー 271

適用対象

モデル・オブジェクト

解説

DateWizard オブジェクトは、時間ディメンションと日付レベルを簡単に作成するために使用します。プロセスを完了するには、CreateDateDimension メソッドを使用します。この手順では、年間累計など、特殊 (相対時間) カテゴリーの標準的なセットが自動的に追加されます。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

タイプ

Object - DateWizard

アクセス

読み取り

例objDateWizard = objModel.DateWizard

DecimalPoint プロパティー

DecimalPoint プロパティーは、小数点に使用する区切り文字を設定するか、または設定状態を返します。

構文

Object .DecimalPoint

適用対象

CrossTabDataSource オブジェクト

DbDataSource オブジェクト

FlatFileDataSource オブジェクト

IqdDataSource オブジェクト

解説

NULL 文字 (文字なし) は使用できません。

タイプ

文字列

272 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

アクセス

Read/Write

例objDataSource.DecimalPoint = "."

Decimals プロパティー

Decimals プロパティーは、ソースのメタデータに定義されている小数桁数を返します。

構文

Column .Decimals

適用対象

Column オブジェクト

解説

データ・ソース (フラット・ファイルなど) に小数桁数のメタデータ情報が含まれていない場合、実行時に PowerPlay に表示される数値データ値の値を調整するには、InputScale プロパティーと OutputScale プロパティーを使用します。

タイプ

Long

アクセス

読み取り

DefaultCategoryOrderBy プロパティー

DefaultCategoryOrderBy プロパティーは、モデルのすべてのカテゴリーにデフォルトのソート設定 (昇順) 設定します。

構文

Model .DefaultCategoryOrderBy

適用対象

モデル・オブジェクト

解説

このプロパティーを使用して、モデルが設定を使用してモデル内のすべてのカテゴリーの順序付けを行うように指定します。つまり、ラベルは五十音順 (昇順) に並び替えられます。

第 5 章 プロパティー 273

このプロパティーでは trUsePreference 値を使用します。

タイプ

定数 - xtrDefaultOrderBy

アクセス

Read/Write

DefaultDateFormat プロパティー

DefaultDateFormat プロパティーは、DateInputFormat プロパティーのデフォルト設定を設定するか、または設定状態を返します。

構文

Application .DefaultDateFormat

適用対象

Application オブジェクト

解説

このプロパティーは、DateInputFormat プロパティーでデータ・ソースにあらかじめ定義されている日付書式、または Windows のコントロール・パネルにある「地域」の設定に定義されている日付書式を使用することを指定するために使用します。

テキスト・ファイルなど、データ・ソースに日付書式が定義されていない場合、Transformer では YYYYMMDD 書式が使用されます。

このプロパティーには、xtrPreferences の値を使用します。

タイプ

定数 - xtrPreferences

アクセス

Read/Write

例objTransApp.DefaultDateFormat = xtrPreferences.trDateFormatFromControlPanel

Description プロパティー

Description プロパティーは、オブジェクトの説明を設定するか、または設定状態を返します。

274 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

構文

object .Description

適用対象

Association オブジェクト

CalculationDefinition オブジェクト

Category オブジェクト

CategorySet オブジェクト

ChildCube オブジェクト

Column オブジェクト

CrossTabDataSource オブジェクト

Cube オブジェクト

CubeGroup オブジェクト

CustomView オブジェクト

DataSource オブジェクト

DateDimension オブジェクト

DateLevel オブジェクト

DbDataSource オブジェクト

Dimension オブジェクト

DrillThroughTarget オブジェクト

FlatFileDataSource オブジェクト

IqdDataSource オブジェクト

Level オブジェクト

Measure オブジェクト

Model オブジェクト

Signon オブジェクト

SpecialCategory オブジェクト

解説

このプロパティーは、内部資料として PowerPlay の「説明」ウィンドウに情報を表示するために使用します。

第 5 章 プロパティー 275

例えば、PowerPlay で算出数値データの説明を取り込み、計算式の作成方法を説明できます。

タイプ

文字列

アクセス

Read/Write

例objMeasure.Description = "Forcasted volume for productline."

DesiredPartitionSize プロパティー

DesiredPartitionSize プロパティーはキューブの各パーティションに最適なパーティション・サイズを設定するか、または設定状態を返します。

構文

object .DesiredPartitionSize

適用対象

Cube オブジェクト

CubeGroup オブジェクト

解説

このプロパティーは、自動パーティション・プロセスの一部として、キューブの各パーティションに最適な最大サイズを設定するために使用します。指定した値は、ユーザーがドリルダウンまたはドリルアップする際に、PowerPlay により値が検索されるパーティションのサイズを正確に制限します。パーティション・サイズを小さくすると、該当するキューブのカテゴリーで上位レベルの要約へのアクセスが高速になります。

このプロパティーを設定するには、Optimize プロパティーで trOptimizeDefault定数または trOptimizeAutoPartition 定数を指定する必要があります。EstimatedRows プロパティーと MaxNumPartLevels プロパティーのキューブ・プロパティーも設定する必要があります。

手動でパーティションを作成するには、Partition プロパティーとMaxNumPartLevels プロパティーを使用します。

デフォルト:推定集約レコード数の 5%

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

276 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

タイプ

Long

アクセス

Read/Write

例objCube = objModel.Cubes.Item(1)objCube.DesiredPartitionSize= 500000

DetachDataSource プロパティー

DetachDataSource プロパティーは、データ・ソースとの接続を維持するかどうかを設定するか、または設定状態を返します。

構文

Application .DetachDataSource

適用対象

Application オブジェクト

解説

True に設定した場合、Transformer では、モデルにデータを取り込んでキューブを作成したときにデータ・ソースが解放され、必要なときにデータ・ソースに再接続されます。False に設定した場合、データ・ソースと接続した状態が維持されます。

デフォルト:False

タイプ

ブール値

アクセス

Read/Write

例objTransApp.DetachDataSource = True

DetailLevel プロパティー

DetailLevel プロパティーは、キューブ・グループのキューブについて最下位の詳細度を定義する Level オブジェクトを設定するか、または設定状態を返します。

構文

CubeGroup .DetailLevel

第 5 章 プロパティー 277

適用対象

CubeGroup オブジェクト

解説

設定しない場合、Transformer では GroupLevel プロパティーで指定したレベルのカテゴリーおよびその子孫カテゴリーがすべて取り込まれます。

重複する名前は、親カテゴリーの名前により識別されます。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

タイプ

オブジェクト

アクセス

Read/Write

例objCubesByRegion= objModel.Cubes.Add(xtrObjectType.trCubeGroup)objCubesByRegion.DetailLevel= objRegionsDrill.Levels("Branch")

Dimension プロパティー

Dimension プロパティーは、Category オブジェクトまたは SpecialCategory オブジェクトのディメンションを返します。

構文

Object .Dimension

適用対象

Category オブジェクト

SpecialCategory オブジェクト

解説

カテゴリーまたは特殊カテゴリーは、1 つのディメンションのみに属します。

タイプ

Object - Dimension

アクセス

読み取り

278 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

DimensionInclude プロパティー

DimensionInclude プロパティーは、カスタム・ビューのビューのタイプを設定するか、または設定状態を返します。

構文

CustomView .DimensionInclude(Dimension)

適用対象

CustomView オブジェクト

解説

各 CustomView オブジェクトには、各ディメンションに 1 つずつ View オブジェクトからなるコレクションが自動的に設定されます。コレクションの各オブジェクトのデフォルト・ビューは、"All Categories"です。このプロパティーは、全カテゴリーを省略したり、カスタム・ビューを作成するために使用します。

このプロパティーを設定する場合は、Dimension オブジェクトをパラメーターとして指定する必要があります。このパラメーターには、ビューが適用されるディメンションを指定します。

キューブからディメンションの全カテゴリーを省略するビューを定義するには、このプロパティーを trViewTypeOmitDimension に設定します。

カスタム・ビューは、PowerPlay ユーザーにキューブ情報の特定のサブセットを表示します。カスタム・ビューでは、レベル全体またはレベル内の各カテゴリーを要約できます。カスタム・ビュー (trViewTypeCustom) を指定する場合は、DimensionView プロパティーを使用して Dimension に関連付けられている Viewオブジェクトを返す必要があります。次に、Apex プロパティーを使用して新規のルート・カテゴリーを作成したり、SetViewStatus メソッドを使用して選択したレベルまたはカテゴリーに View オブジェクトを関連付けることができます。

カスタム・ビューを完了するには、カスタム・ビューをキューブに関連付ける必要があります。Add メソッドを使用して、キューブの CubeCustomViews コレクションに CustomView オブジェクトを追加します。

DimensionInclude プロパティーは、xtrViewType 値リストの定数を返します。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

パラメーター 説明

ディメンション 必須。ビューを適用するディメンションを指定します。

タイプ:Dimension

第 5 章 プロパティー 279

タイプ

定数 - xtrViewType

アクセス

Read/Write

例custom_view = model.CustomViews.Add()custom_view.DimensionInclude(dimension) =xtrViewType.trViewTypeCustom

DimensionLevels プロパティー

DimensionLevels プロパティーは、DimensionLevels コレクションを返します。

構文

object .DimensionLevels

適用対象

DateDimension オブジェクト

Dimension オブジェクト

解説

Levels コレクションには、ディメンションの一意のレベルが含まれます。ディメンションに代替ドリルダウン・パスがある場合、1 つのレベルがディメンションに 2回以上表示されることがありますが、ディメンションに表示される回数にかかわらず、Levels コレクションにある同じレベルの参照は 1 つのみです。

レベルに複数のドリルダウン・パスがあるときは、Context プロパティーを使用してパスを指定します。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

タイプ

Object - DimensionLevels

アクセス

読み取り

例objLevel = objModel.Dimensions("Products").DimensionLevels(1)

280 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

DimensionName プロパティー

DimensionName プロパティーは、新しい DateDimension オブジェクトの名前を設定するか、設定状態を返します。

構文

DateWizard .DimensionName

適用対象

DateWizard オブジェクト

解説

時間ディメンションの名前を指定しない場合は、エラーになります。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

タイプ

文字列

アクセス

Write

例objDateWizard.DimensionName = "Dates"

Dimensions プロパティー

Dimensions プロパティーは、モデルに含まれる Dimension オブジェクトとDateDimension オブジェクトのコレクションを返します。

構文

Model .Dimensions

適用対象

モデル・オブジェクト

解説

コレクションが返された後、Item メソッドを使用して特定のディメンションを選択し、プロパティーを変更します。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

第 5 章 プロパティー 281

タイプ

Object - Dimensions

アクセス

読み取り

例objTimeDimension = objModel.Dimensions.Item("Time")

DimensionView プロパティー

DimensionView プロパティーは、キューブまたはカスタム・ビューに関連付けられている View オブジェクトを設定するか、または設定状態を返します。

構文

object .DimensionView(Dimension)

適用対象

Cube オブジェクト

CubeGroup オブジェクト

CustomView オブジェクト

解説

このプロパティーを設定する場合は、Dimension オブジェクトをパラメーターとして指定する必要があります。このパラメーターには、ビューが適用されるディメンションを指定します。

DimensionView プロパティーは、ディメンションのカスタム・ビューを作成するときに使用します。カスタム・ビューは、PowerPlay ユーザーにキューブ情報の特定のサブセットを表示します。例えば、カスタム・ビューではレベル全体またはレベル内の選択したカテゴリーの階層を要約できます。

各 Dimension オブジェクトには、2 つの View オブジェクトからなるコレクションが自動的に設定されます。デフォルトでは、DimensionView プロパティーがViews コレクションの最初のオブジェクトである"All Categories"に設定されます。キューブのディメンションを省略するには、DimensionView プロパティーをコレクションの 2 番目のオブジェクトである"Omit Dimension"に設定します。ディメンションのカスタム・ビューを作成するには、Add メソッドを使用してコレクションに View オブジェクトを追加し、ViewType プロパティーを trViewTypeCustomに設定します。

Apex プロパティーを使用して新規のルート・カテゴリーを作成したり、SetViewStatus メソッドを使用して選択したレベルまたはカテゴリーに View オブジェクトを関連付けることができます。その後、新規に定義した View オブジェクトを使用して、DimensionView プロパティーを設定します。

282 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

カスタム・ビュー

DimensionInclude プロパティーを使用してカスタム・ビューを指定する場合は、DimensionView プロパティーを使用してディメンションに関連付けられているView オブジェクトを返す必要があります。次に、Apex プロパティーを使用して新規のルート・カテゴリーを作成したり、SetViewStatus メソッドを使用して選択したレベルまたはカテゴリーに View オブジェクトを関連付けることができます。

カスタム・ビューを完了するには、カスタム・ビューをキューブに関連付ける必要があります。このためには、Add メソッドを使用してキューブのCubeCustomViews コレクションに CustomView オブジェクトを追加します。

パラメーター 説明

ディメンション 必須。カスタム・ビューを定義するディメンションを指定します。

タイプ:Object

タイプ

オブジェクト

アクセス

Read/Write (Cube)

Read (CustomView)

例objCube = objModel.Cubes("Sales and Marketing")objCube.DimensionView(objDimension)= objView

DimensionViewType プロパティー

DimensionViewType プロパティーは、キューブのディメンションに割り当てられているビューのタイプを返します。

構文

object .DimensionViewType(Dimension [, View] )

適用対象

Cube オブジェクト

CubeGroup オブジェクト

第 5 章 プロパティー 283

解説

このプロパティーは、ディメンションに含まれるカテゴリーの表示方法 (全部、一部、または非表示) を決定するために使用します。

DimensionViewType プロパティーには、xtrViewType の値を使用します。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

パラメーター 説明

ディメンション 必須。ディメンションを指定します。

タイプ:Object

View オプション。タイプ trViewTypeCustom のビューを指定します。

タイプ:Object

タイプ

定数 - xtrViewType

アクセス

Read/Write

例objCube= objModel.Cubes("Sales and Marketing")If objCube.

DimensionViewType(objDimension)= _xtrViewType.trViewTypeAllCategories Then

DisplayName プロパティー

DisplayName プロパティーは、SecurityObject オブジェクトの表示名を設定するか、設定状態を返します。

構文

SecurityObject .DisplayName

適用対象

SecurityObject オブジェクト

解説

このプロパティーは、Transformer のユーザー・インターフェースで Security オブジェクトの下に表示される表示名を設定するか、設定状態を返すために使用します。

284 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

タイプ

文字列

アクセス

Read/Write

例new_namespace.DisplayName = Name_of_Object

DrillCode プロパティー

DrillCode プロパティーは、ディメンション全体でドリルダウン・カテゴリーを一意に識別するコードを設定するか、または設定状態を返します。

構文

object .DrillCode

適用対象

DateDrillDown オブジェクト

DrillDown オブジェクト

解説

コードは、任意の英字または英数字 (By Product Line など) で、Transformer では文字列のデータ型として扱われます。

タイプ

文字列

アクセス

Read/Write

例objDateDim = objDateWizard.CreateDateDimension()objDrillDown= objDateDim.DrillDowns(1)objDrillDown.DrillCode = "By Dates"

DrillDowns プロパティー

DrillDowns プロパティーは、DateDrillDown オブジェクトまたは DrillDown オブジェクトのコレクションを返します。

構文

object .DrillDowns

第 5 章 プロパティー 285

適用対象

DateDimension オブジェクト

Dimension オブジェクト

解説

DateDrillDown オブジェクトと DrillDown オブジェクトは、どちらもドリルダウン・パスを定義します。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

タイプ

Object - DrillDowns

アクセス

読み取り

例objDrill = objModel.Dimensions("Retailers").DrillDowns(2)

DrillInclusion プロパティー

DrillInclusion プロパティーは、キューブにドリルダウン・パスが含まれるかどうかを設定するか、または設定状態を返します。

構文

object .DrillInclusion

適用対象

DateDrillDown オブジェクト

DrillDown オブジェクト

解説

PowerPlay では、含まれるドリルダウン・カテゴリーが、そのドリルダウン・パスに関連付けられた子カテゴリーのフォルダーとして表示されます。消去するドリルダウン・カテゴリーは PowerPlay に表示されませんが、子カテゴリーは表示されます。

DrillInclusion プロパティーには、xtrInclusion 値リストの 3 つの定数のみを使用します。

v trInclusionDefault (ドリルダウン・カテゴリーを表示)

v trInclusionSuppress (ドリルダウン・カテゴリーを非表示)

v trInclusionGenerate (ドリルダウン・カテゴリーを表示)

286 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

タイプ

定数 - xtrInclusion

アクセス

Read/Write

例objDrillDown = objDateDim.DrillDowns(1)objDrillDown.DrillInclusion= xtrInclusion.trInclusionSuppress

DrillThroughTargets プロパティー

DrillThroughTargets プロパティーは、数値データまたはキューブ (子キューブまたはキューブ・グループ) に関連付けられているドリルスルー・ターゲット・オブジェクトのコレクションを返します。

構文

Object .DrillThroughTargets

適用対象

ChildCube オブジェクト

Cube オブジェクト

CubeGroup オブジェクト

Measure オブジェクト

解説

このプロパティーは、モデル・オブジェクトのドリルスルー・ターゲットの繰り返し、新規ドリルスルー・ターゲットの追加、およびドリルスルー・ターゲットの変更または削除に使用します。

DrillThroughTargets プロパティーは次のものを表します。

v PowerCube (.mdc)

v PowerPlay レポート (.ppr、.ppx)

v Impromptu Web Query ファイル (.iwq) および Cognos Query ファイル(.iqd)

v Impromptu レポート (.imr)

v ローカル・サード・パーティーの OLAP ソース (MS SSOS .cub ファイル、Essbase リンク・パーティションまたはレポート・オブジェクト)

v 関連ファイル (.mac、.doc、.xls、.ppt)

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

第 5 章 プロパティー 287

タイプ

Object - DrillThroughTargets

アクセス

読み取り

例objReport = objMeasure.DrillThroughTargets.Add(strReportPath,"Default Report")

DuplicateRollup プロパティー

DuplicateRollup プロパティーは、集約レコードから数値データ値を自動集計する方法を設定するか、または設定状態を返します。

構文

Measure .DuplicateRollup

適用対象

Measure オブジェクト

解説

このプロパティーは、Transformer でソース・データの重複レコードを要約するときに適用する関数を指定するために使用します。例えば、このプロパティーをtrDuplicateRollupSum に設定すると、集約レコードの集計は重複レコードの数値データ値の合計になります。Transformer では、標準集計の前に重複データ集計が実行されます。

このプロパティーを trDuplicateRollupNone 以外の値に設定すると、Consolidateプロパティーの trConsolidateNO の設定がオーバーライドされ、Transformer によるキューブ生成時にデータ・ソース・ファイルが集約されます。

DuplicateRollup プロパティーを trDuplicateRollupAverage に設定した場合は、DuplicateWeight プロパティーも設定する必要があります。

このプロパティーには、xtrDuplicateRollup の値を使用します。

タイプ

定数 - xtrDuplicateRollup

アクセス

Read/Write

288 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

例objMeasures = objModel.MeasurescurrentMeasure= objMeasures("Revenue")currentMeasure.DuplicateRollup= xtrDuplicateRollup.trDuplicateRollupAverage

DuplicateWeight プロパティー

DuplicateWeight プロパティーは、加重係数を含む数値データの名前を設定するか、または設定状態を返します。

構文

Measure .DuplicateWeight

適用対象

Measure オブジェクト

解説

このプロパティーは、集計数値データについて真の平均ではなく、加重平均を計算するために使用します。数値データ B を加重係数として数値データ A の加重平均を計算する場合は、次のような算出式を使用します。

∑ (Ai * Bi) / ∑ Bi

自動集計する数値データは、trDuplicateRollupAverage に設定する必要があります。

タイプ

文字列

アクセス

Read/Write

例objMeasures = objModel.MeasurescurrentMeasure = objMeasures("Revenue")currentMeasurecurrentMeasure.DuplicateWeight = objModel.Measures("Quantity").Name

EarliestDate プロパティー

EarliestDate プロパティーは、日付カテゴリーの範囲の開始日付を設定するか、または設定状態を返します。

構文

object .EarliestDate

第 5 章 プロパティー 289

適用対象

DateDimension オブジェクト

DateWizard オブジェクト

解説

このプロパティーと LatestDate プロパティーは、時間ディメンションに含まれる日付カテゴリーの範囲を制限するために使用します。範囲を指定することにより、PowerPlay ユーザーに無関係なカテゴリー (過去の年など) を除外します。

日付カテゴリーのみを生成するには GenerateTimePeriod プロパティー(DateDimension オブジェクト) または GenerateDates プロパティー (DateWizardオブジェクト) を使用します。

指定した範囲外の日付値があると、Transformer では、範囲外の日付の時期に応じて「期間前日付」または「期間後日付」カテゴリー、あるいは両方が生成されます。期間前でも期間後でもなく、指定した範囲に該当しない日付があると、「無効な日付」カテゴリーが生成されます。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

タイプ

Long

アクセス

Write (DateWizard)

Read/Write (DateDimension)

例objDateWizard = objModel.DateWizardobjDateWizard.EarliestDate= 19930101

EMUEntryDate プロパティー

EMUEntryDate プロパティーは、通貨のユーロ Triangulation の計算を開始する日付を設定するか、または設定状態を返します。

構文

CurrencyRecord .EMUEntryDate

適用対象

CurrencyRecord オブジェクト

290 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

解説

このプロパティーの日付書式は YYYYMMDD です。このプロパティーを使用するには、CurrencyIsEMU プロパティーを True に設定する必要があります。

デフォルト: 19990101

タイプ

文字列

アクセス

Read/Write

例objCurrencyRec = objModel.CurrencyRecords(1)objCurrencyRec.EMUEntryDate= "19990101"

EnableMessageLogging プロパティー

EnableMessageLogging プロパティーは、Transformer でメッセージをログ・ファイルに追加するか、前のログ・メッセージを上書きするかを設定するか、または設定状態を返します。

構文

Application .EnableMessageLogging

適用対象

Application オブジェクト

解説

このプロパティーは、ログ・ファイルを作成するために使用します。このプロパティーを True に設定した後、次のプロパティーを使用できます。

v 記録するエラー・メッセージの重大度を指定する LogErrorLevel プロパティー

v ログ・ファイルの名前を指定する LogFileName プロパティー

v ログ・ファイルの保存場所を設定する LogFilesPath プロパティー

デフォルト:True

タイプ

ブール値

アクセス

Read/Write

第 5 章 プロパティー 291

例objTransApp.EnableMessageLogging = True

EnableTimePeriod プロパティー

EnableTimePeriod プロパティーは、時間ディメンションの詳細レベルを設定します。

構文

DateWizard .EnableTimePeriod(TimeType)

適用対象

DateWizard オブジェクト

解説

このプロパティーは、時間ディメンションに追加する日付レベル (年、四半期、月など) を指定するために使用します。このプロパティーを使用しない場合、Transformer ではデータ・ソースから推定されます。

TimeType パラメーターは、日付の詳細度を示します。例えば、TimeType をtrTimeTypeMonth に設定した場合、現在の期間に年から月までが表示されます。

このプロパティーには、xtrTimeType の値を使用します。

パラメーター 説明

TimeType 必須。xtrTimeType の値を指定します。

タイプ:定数

タイプ

ブール値

アクセス

Write

例objDateWizard= objModel.DateWizardobjDateWizard.EnableTimePeriod(xtrTimeType.trTimeTypeYear)= True

EstimatedRows プロパティー

EstimatedRows プロパティーは、キューブに含まれるレコード数の推定値を設定するか、または設定状態を返します。

292 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

構文

object .EstimatedRows

適用対象

Cube オブジェクト

CubeGroup オブジェクト

解説

Transformer では、ユーザーが指定した推定値が使用され、キューブ生成プロセスでキューブに追加された実際の集約レコード数を反映するように値が更新されます。

このプロパティーを設定するには、Optimize プロパティーで trOptimizeDefault定数または trOptimizeAutoPartition 定数を指定する必要があります。DesiredPartitionSize プロパティーと MaxNumPartLevels プロパティーのキューブ・プロパティーも設定する必要があります。

手動でパーティションを作成するには、Partition プロパティーとMaxNumPartLevels プロパティーを使用します。

デフォルト: 10,000,000

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

タイプ

Long

アクセス

Read/Write

例objCube = objModel.Cubes.Item(1)objCube.EstimatedRows= 10000000

ExcludeAutoPartition プロパティー

ExcludeAutoPartition プロパティーは、指定したディメンションを自動パーティション・プロセスから除外するかどうかを設定するか、または設定状態を返します。

構文

object .ExcludeAutoPartition

第 5 章 プロパティー 293

適用対象

DateDimension オブジェクト

Dimension オブジェクト

解説

このプロパティーを True に設定すると、キューブ作成時にディメンションのパーティション・レベルが作成されません。

パーティションでは複数の従属パーティションのキューブ・データが集計され、PowerPlay での検索が高速になります。パーティションを指定すると Transformerでのキューブ作成に必要な時間が長くなるため、このタイプの最適化が不要なディメンションは ExcludeAutoPartition プロパティーを使用して除外します。

デフォルト:False

タイプ

ブール値

アクセス

Read/Write

例objDimensions = objModel.DimensionsobjLocationsDim= objDimensions.Item(3)objLocationsDim.ExcludeAutoPartition= True

ExpressionText プロパティー

ExpressionText プロパティーは、数値または文字列の演算に使用する数式を設定するか、または設定状態を返します。現在のリリースでは、if-then-else 条件式がサポートされています。

構文

object .ExpressionText

適用対象

CalculationDefinition オブジェクト

Category オブジェクト

Column オブジェクト

Measure オブジェクト

SpecialCategory オブジェクト

294 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

解説

このプロパティーは、数式に使用する要素を指定するために使用します。数式は、関数や演算子から構成され、通常は値のソースとして数値データ、列、またはカテゴリーを参照します。

また、数式は、参照するオブジェクトのデータ型に応じてテキスト、日付、または数値になります。Transformer では、標準的な数学の規則に従って数式が計算されます。

ExpressionText プロパティーで列を参照する場合、その列の DataClass プロパティーに有効なエントリーを設定しないと実行時エラーが発生します。無効な設定は、trDataClassIgnore と trDataClassDefault (デフォルト値でデータ・クラスが指定されない場合) です。

数式が完了した後、IsExpressionValid プロパティーを使用して数式の要素がすべて有効かどうかを判定できます。

Measure オブジェクトに ExpressionText プロパティーを使用する場合は、数値データを算出数値データとして定義します。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

タイプ

文字列

アクセス

Read/Write

例calcDef = dimension.CalculationDefinitions.Add()calcDef.ExpressionText= "share ( catset ( ""Set 1"" ) , """ & _ parentCategory.Code& """)"

External プロパティー

External プロパティーは、データ・ソースにらかじめ集計した値が含まれているかどうかを設定するか、または設定状態を返します。

構文

object .External

適用対象

CrossTabDataSource オブジェクト

DataSource オブジェクト

DbDataSource オブジェクト

第 5 章 プロパティー 295

FlatFileDataSource オブジェクト

IqdDataSource オブジェクト

解説

構造データとトランザクション・データを別のファイルに保存する場合、トランザクション・データのソース・ファイルで数値データ値の値をあらかじめ集計できます。

構造データのソース使用してディメンションを定義します。各トランザクション・データ・ソースの External プロパティーを True に設定し、Measures コレクションに数値データを追加します。各 Measure オブジェクトの RegularRollup プロパティーを trRollupExternal に設定します。次に、適用される各ディメンションのAssociateWith メソッドを使用して、トランザクション・データ・ソースの列を指定します。この列は、構造データ・ソースの列と対応する必要があります。

数値データを割り当てるモデルの場合は、DateDegreeofDetailLevelName プロパティーを使用して詳細度を指定します。

デフォルト:False

タイプ

ブール値

アクセス

Read/Write

例objDataSource= objModel.DataSources.Add(xtrObjectType.trFlatFileDataSource)objDataSource.External= False

FieldSeparator プロパティー

FieldSeparator プロパティーは、データ・ソースに使用されているフィールド区切りのタイプを設定するか、または設定状態を返します。

構文

FlatFileDataSource .FieldSeparator

適用対象

FlatFileDataSource オブジェクト

296 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

解説

このプロパティーは、データ・ソースのフィールド区切りに使用する文字を指定するために使用します。Transformer では、ダブル・バイト文字およびマルチバイト文字の 1 バイト目のみを判定して、入力ストリームの文字が指定した区切り文字と一致するかどうかが決定されます。

このプロパティーは、SourceType プロパティーが trFlatFile またはtrFlatFileColumnNames に設定されているフラット・ファイルにのみ適用されます。

標準の区切り文字 (コンマ、セミコロン、空白文字など) は、各文字セットに共通です。ソース・データが DOS コード・ページ文字セット (OEM) で表示される場合、Transformer では、区切り文字が OEM 文字セットに変換されます。

タイプ

文字列

アクセス

Read/Write

例objDataSource= objModel.DataSources.

Add(xtrObjectType.trFlatFileDataSource)objDataSource.FieldSeparator= ","

FileName プロパティー

FileName プロパティーは、Windows のフォルダーまたは Windows Explorer に表示されるモデル・ファイルの名前を返します。

構文

Model .FileName

適用対象

Model オブジェクト

解説

このプロパティーは、モデル・ファイルの名前を表示したり、ログ・ファイルに名前を書き込むために使用します。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

タイプ

文字列

第 5 章 プロパティー 297

アクセス

読み取り

例MsgBox(objModel.FileName & " " & .Size &" " & .Time)

Filters プロパティーFilters プロパティーは、クエリーに関連付けられている Filter オブジェクトのコレクションを返します。

構文

Query .Filters

適用対象

Query オブジェクト

解説

このプロパティーは、Query オブジェクトのフィルターの繰り返し、新規フィルターの追加、およびフィルターの変更または削除に使用します。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

タイプ

フィルター

アクセス

読み取り

例new_package = model.Packages.Add()new_query = new_package.Queries.Add()new_filter= new_query.Filters.Add()

FindCategoryByCatCode プロパティーFindCategoryByCatCode プロパティーは、指定したカテゴリー・コードの文字列を含むカテゴリー・オブジェクトを返します。

構文

Dimension .FindCategoryByCatCode

298 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

適用対象

Dimension オブジェクト

解説

パラメーター 説明

CategoryCode 必須。カテゴリー・コード名を指定します。

タイプ:String

タイプ

Object - Category

アクセス

読み取り

Format プロパティーFormat プロパティーは、数値の書式を設定するか、または設定状態を返します。

構文

object .Format

適用対象

Category オブジェクト

Measure オブジェクト

SpecialCategory オブジェクト

解説

このプロパティーは、数値の書式を指定するために使用します。PowerPlay では、PowerPlay レポートに書式付きの値が使用されます。書式文字列は引用符 ("") で囲む必要があります。

数値データ値に小数桁数を追加するには、FormatDecimals プロパティーを使用します。

使用できる書式を次に示します。一部の書式 (通貨記号や 1000 の区切りなど) は、Windows のコントロール・パネルにある「地域」に設定したプロパティーによって異なる場合があります。

書式 例

0 1000000

第 5 章 プロパティー 299

書式 例

#,##0 1,000,000

$0 $1000000

$#,##0 $1,000,000

0% 100%

%0 %100

0E+00 1E+09

0K 1000K

#,##0K 1,000K

K0 K1000

K#,##0 K1,000

$0K $1000K

$#,##0K $1,000K

0M 1000M

#,##0M 1,000M

M0 M1000

M#,##0 M1,000

$0M $1000M

$#,##0M $1,000M

タイプ

文字列

アクセス

Read/Write

例objMeasures= objModel.MeasurescurrentMeasure = objMeasures("Revenue")currentMeasure.Format= "$#,##0"

300 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

FormatDecimals プロパティー

FormatDecimals プロパティーは、PowerPlay で表示する数値データまたは算出カテゴリーの小数桁数を設定するか、または設定状態を返します。

構文

Object .FormatDecimals

適用対象

Category オブジェクト

Measure オブジェクト

解説

このプロパティーは、書式の設定に使用します。

範囲:0~9

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

タイプ

Long (Measure オブジェクト)、Int (Category オブジェクト)

アクセス

Read/Write

例objMeasures = objModel.MeasurescurrentMeasure= objMeasures("Revenue")currentMeasure.FormatDecimals= 2

FullName プロパティー

FullName プロパティーは、モデル・ファイルの場所を返します。

構文

Model .FullName

適用対象

モデル・オブジェクト

解説

このプロパティーは、モデル・ファイルの名前と場所を表示したり、絶対パス名をログ・ファイルに書き込んだりするために使用します。

第 5 章 プロパティー 301

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

タイプ

文字列

アクセス

読み取り

GenerateCategories プロパティー

GenerateCategories プロパティーは、データ・ソースのカテゴリーを生成するかどうかを設定するか、または設定状態を返します。

構文

object .GenerateCategories

適用対象

CrossTabDataSource オブジェクト

DataSource オブジェクト

DbDataSource オブジェクト

FlatFileDataSource オブジェクト

IqdDataSource オブジェクト

Query オブジェクト

解説

このプロパティーを False に設定すると、Transformer ではカテゴリー生成時に常にデータ・ソースが無視されます。このプロパティーは、次の場合に False に設定します。

v 複数のデータ・ソースがあり、特定のデータ・ソースのカテゴリー生成を除外する

v 他のデータ・ソースをインクリメンタルに更新する

v 通貨レートのデータ・ソースで日付カテゴリーを生成する必要がない

GeneratePowerCube プロパティーを使用して、Transformer でデータ・ソースを参照する方法を指定することもできます。

デフォルト:True

タイプ

ブール値

302 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

アクセス

Read/Write

例objDataSource= objModel.DataSources.

Add(xtrObjectType.trFlatFileDataSource)objDataSource.GenerateCategories= True

GenerateDateCategories プロパティー

GenerateDateCategories プロパティーは、日付レベルが日付カテゴリーを生成するかどうかを設定するか、または設定状態を返します。

構文

DateLevel .GenerateDateCategories

適用対象

DateLevel オブジェクト

解説

日付レベルのカテゴリーを生成するには、このプロパティーを trGenerateDatesAllに設定します。レベルに日付カテゴリーを生成しない場合は、このプロパティーをtrGenerateDatesNone に設定します。

このプロパティーには、xtrDateCategoriesGeneration の値を使用します。

タイプ

定数 - xtrDateCategoriesGeneration

アクセス

Read/Write

例objDateDim = objModel.Dimensions("Date")objDateDim.GenerateDateCategories= xtrDateCategoriesGeneration.trGenerateDatesAll

GenerateDates プロパティー

GenerateDates プロパティーは、DateWizard オブジェクトが日付カテゴリーを生成するかどうかを設定します。

構文

DateWizard .GenerateDates

第 5 章 プロパティー 303

適用対象

DateWizard オブジェクト

解説

このプロパティーは、日付カテゴリーを生成するために使用します。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

タイプ

ブール値

アクセス

Write

GeneratePowerCube プロパティー

GeneratePowerCube プロパティーは、モデルでデータ・ソースを参照するかどうかを設定するか、または設定状態を返します。

構文

object .GeneratePowerCube

適用対象

CrossTabDataSource オブジェクト

DataSource オブジェクト

DbDataSource オブジェクト

FlatFileDataSource オブジェクト

IqdDataSource オブジェクト

Query オブジェクト

解説

このプロパティーは、カテゴリー生成時またはキューブ作成時、あるいはその両方で、特定のデータ・ソースを参照するかどうかを指定します。複数のデータ・ソースがあるモデルでは、アクセスするデータ・ソースを制限して不要な処理を省き、モデルの効率を最適化できます。

GeneratePowerCube プロパティーには、xtrPowerCubeGeneration の値を使用します。

GenerateCategories プロパティーを使用して、Transformer でカテゴリー生成時に参照するデータ・ソースを指定することもできます。

304 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

タイプ

定数 - xtrPowerCubeGeneration

アクセス

Read/Write

例objDataSource= objModel.DataSources.Add(xtrObjectType.trFlatFileDataSource)objDataSource.GeneratePowerCube= xtrPowerCubeGeneration.trGenerationDefault

GenerateTimePeriod プロパティー

GenerateTimePeriod プロパティーは、時間ディメンションのカテゴリー生成オプションを設定するか、または設定状態を返します。

構文

DateDimension .GenerateTimePeriod(TimeType)

適用対象

DateDimension オブジェクト

解説

このプロパティーは、時間ディメンションのカテゴリーを生成する前に日付の詳細度を指定するために使用します。TimeType パラメーターには、データ・ソースの時間列からレポートに表示できるレベル (年、四半期、月、週、または日) を設定します。

生成する日付カテゴリーの範囲を指定するには、EarliestDate プロパティーとLatestDate プロパティーを使用します。

TimeType パラメーターには、xtrTimeType の定数を指定します。このプロパティーは、xtrGenerateOptions の定数を設定するか、または設定状態を返します。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

パラメーター 説明

TimeType 必須。xtrTimeType の値を指定します。

タイプ:定数

タイプ

定数 - xtrTimeType

第 5 章 プロパティー 305

アクセス

Read/Write

例objDateDim= objModel.Dimensions("Date")objDateDim.GenerateTimePeriod(xtrTimeType.trTimeTypeMonth)= _ xtrGenerateOptions.trGenerateAll

Group プロパティー

Group プロパティーは、算出カテゴリーをグループ化するかどうかを設定するか、または設定状態を返します。

構文

CalculationDefinition .Group

適用対象

CalculationDefinition オブジェクト

解説

True に設定すると、PowerPlay レポートで各レベルの算出カテゴリーがグループ化されます。Transformer では、数式がレベルの全カテゴリーに適用される場合、算出カテゴリーがグループ化されます。

False に設定すると、レポートの算出カテゴリーは、それぞれ参照するカテゴリーの横に並べられます。

デフォルト:True

タイプ

ブール値

アクセス

Read/Write

例calcDef = dimension.CalculationDefinitions.Add()calcDef.Group= False

GroupDimension プロパティー

GroupDimension プロパティーは、キューブ・グループを構築するために使用するディメンションを設定するか、または設定状態を返します。

306 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

構文

CubeGroup .GroupDimension

適用対象

CubeGroup オブジェクト

解説

キューブ・グループは、1 つのディメンションを参照します。このプロパティーを使用して、ディメンションを何にするかを指定し、次に GroupLevel プロパティーを使用して、指定したレベルの各カテゴリーに対し 1 つの子キューブを定義します。

次に、DetailLevel プロパティーと SummaryLevel プロパティーを使用して、最も関連のあるデータのみが PowerPlay ユーザーに表示されるように詳細度を定義します。

例えば、4 つの地域営業所を持っている企業を想定します。最近の四半期における販売実績をそれぞれ追跡できるように、各営業所の責任者用にキューブ・グループを作成します。各営業所の責任者は、他の 3 営業所に関する詳細を閲覧する必要がないため、これらのオフィスで集計データだけが表示されるようにグループを定義します。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

タイプ

オブジェクト

アクセス

Read/Write

例objCubesByRegion= objModel.Cubes.Add(xtrObjectType.trCubeGroup)objCubesByRegion.GroupDimension= objModel.Dimensions("Sales region")

GroupLevel プロパティー

GroupLevel プロパティーは、キューブ・グループの各キューブを定義するために使用するレベルを設定するか、または設定状態を返します。

構文

CubeGroup .GroupLevel

適用対象

CubeGroup オブジェクト

第 5 章 プロパティー 307

解説

キューブ・グループは、1 つのディメンションを参照します。GroupDimension プロパティーを使用して、ディメンションを何にするかを指定し、次にこのプロパティーを使用して、指定したレベルの各カテゴリーに対し 1 つの子キューブを定義します。

次に、DetailLevel プロパティーと SummaryLevel プロパティーを使用して、最も関連のあるデータのみが PowerPlay ユーザーに表示されるように詳細度を定義します。

例えば、4 つの地域営業所を持っている企業を想定します。最近の四半期における販売実績をそれぞれ追跡できるように、各営業所の責任者用にキューブ・グループを作成します。各営業所の責任者は、他の 3 営業所に関する詳細を閲覧する必要がないため、これらのオフィスで集計データだけが表示されるようにグループを定義します。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

タイプ

オブジェクト

アクセス

Read/Write

例objCubesByRegion= objModel.Cubes.Add(xtrObjectType.trCubeGroup)objCubesByRegion.GroupLevel= objRegionsDrill.Levels("Sales region")

HasSubdimension プロパティー

HasSubdimension プロパティーは、レベルにサブディメンションが含まれているかどうかを返します。

構文

object .HasSubdimension

適用対象

DateLevel オブジェクト

Level オブジェクト

解説

サブディメンションは、特定のカテゴリーに異なる詳細度を設定し、バランスのとれていない階層とも呼ばれます。サブディメンションのカテゴリーは、ディメンシ

308 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

ョンの他の部分のレベルから独立しています。サブディメンションの外部にあるレベルを変更しても、サブディメンション内のカテゴリーには影響しません。逆についても、同様です。

例えば、一部の支店では製品販売レポートを項目レベルまで作成するのに対し、他の支店では製品レベルまでしか作成しないとします。項目レベルまでレポートを作成する支店にサブディメンションを設定できます。

タイプ

ブール値

アクセス

読み取り

HideValue プロパティー

HideValue プロパティーは、カテゴリー・オブジェクトの値を非表示にするかどうかを指定します。プロパティーを True に設定すると、そのカテゴリーに関連付けられている値は表示されません。

SetDefaultCategory メソッドとともに使用して、このオプションをシナリオ・ディメンションのカテゴリーの親に設定することを推奨します。OLE を使用して、ユーザー・インターフェースの表示と同様に適用されます。

デフォルト:False。

構文

Category .HideValue

適用対象

Category オブジェクト

アクセス

Read/Write

ID プロパティー

ID プロパティーは、ネームスペース ID を設定するか、または設定状態を返します。

構文

NameSpace .ID

適用対象

Namespace オブジェクト

第 5 章 プロパティー 309

解説

このプロパティーは、ネームスペース ID を設定するために使用します。

タイプ

文字列

アクセス

Read/Write

例new_namespace.ID = ID_of_Namespace

IgnoreMissingValue プロパティー

IgnoreMissingValue プロパティーは、Transformer Series 7 Version 4 以降のリリースでは、平均または加重平均のタイプの時状態集計値で、NULL 値または欠落値を無視するかどうかを指定します。プロパティーを True に設定すると、その数値データに関連付けられている値は集計値に含まれません。

デフォルト:False。

注:このプロパティーは、開始期間、最終期間、現在期間のタイプの時状態集計値には設定できません。その場合、NULL 値と欠落値は常に集計値に含まれます。最小または最大の集計計算では、Transformer で「0」または「n/a」(NA 設定) と表示されるように設定されている場合でも、欠落 (Null) データ値は常に除外されます。OLE を使用して、ユーザー・インターフェースの表示と同様に適用されます。

構文

Measure .IgnoreMissingValue

適用対象

Measure オブジェクト

タイプ

ブール値

アクセス

Read/Write

例objMeasures = objModel.MeasurescurrentMeasure= objMeasures("Revenue")currentMeasure.IgnoreMissingValue= False

310 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

Inclusion プロパティー

Inclusion プロパティーは、キューブにカテゴリーが含まれるかどうかを設定するか、または設定状態を返します。

構文

object .Inclusion

適用対象

Category オブジェクト

DateLevel オブジェクト

Level オブジェクト

SpecialCategory オブジェクト

解説

このプロパティーは、キューブに含めるカテゴリーを指定するために使用します。例えば、ソース値が空白のカテゴリーを除外できます。

Level オブジェクトの Inclusion プロパティーを設定すると、その設定がtrInclusionDefault に設定されているレベルの全カテゴリーに適用されます。

Category オブジェクトの Inclusion プロパティーを設定すると、そのカテゴリーにのみ適用されます。

Inclusion プロパティーには、xtrInclusion の値を使用します。

タイプ

定数 - xtrInclusion

アクセス

Read/Write

例objLocationsDim= objModel.Dimensions("Sales regions")objLevel= objLocationsDim.DrillDowns(1).Levels("Employee")objAltDrill= objLevel.CreateAlternateDrillDownobjNewLevel= objAltDrill.Levels.Add(xtrObjectType.trLevel)objNewLevel.Inclusion= xtrInclusion.trInclusionGenerate

IncrementalUpdate プロパティー

IncrementalUpdate プロパティーは、キューブまたはキューブ・グループをデータ・ソースからインクリメンタルに更新するかどうかを設定するか、または設定状態を返します。

第 5 章 プロパティー 311

構文

object .IncrementalUpdate

適用対象

Cube オブジェクト

CubeGroup オブジェクト

解説

このプロパティーは、インクリメンタル・データを含むデータ・ソースに関連付けられているキューブを更新するために使用します。古いキューブのデータは保持されます。

パーティション・スキームを最適化するには、キューブ全体を定期的に再作成する必要があります。例えば、キューブを 1 日ごとに更新し、1 週間ごとに再作成します。モデルの構造を変更したときは、必ず次のインクリメンタル更新を実行する前にキューブを再作成する必要があります。

このプロパティーをキューブ・グループについて True に設定すると、グループ内の全キューブがインクリメンタルに更新されます。

デフォルト:False

タイプ

ブール値

アクセス

Read/Write

例objCube = objModel.Cubes.Item(1)objCube.IncrementalUpdate= False

InputScale プロパティー

InputScale プロパティーは、列の値を小数から整数に変換するために使用するスケール値を設定するか、または設定状態を返します。

構文

Column .InputScale

適用対象

Column オブジェクト

312 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

解説

このプロパティーは、小数を整数に変換するために Float 以外のデータ型に使用します。指定した値により、データ・ソースから値を読み込むときに適用する乗算を定義します。

例えば、このプロパティーを「2」に設定した場合、Transformer では、ソース値「94.5」が「9450」(つまり 94.5*10^2) としてキューブに書き込まれます。その結果PowerPlay では値「9450」が表示されます。

スケール値を適用した値を元の値に戻すには、OutputScale プロパティーとFormatDecimals プロパティーを使用します。OutputScale プロパティーは、PowerPlay 実行時にソース値に適用する除算を指定します。つまり、InputScale プロパティーで計算に使用する桁数を減らし、OutputScale プロパティーとFormatDecimals プロパティーで元に戻します。

例えば、OutputScale を「2」に設定した場合、PowerPlay には"95" (丸めた値) と表示されます。FormatDecimals を「1」に設定した場合、PowerPlay には "94.5"と表示されます。

スケール値の範囲は、-16~16 (10**16~10**16) です。

デフォルト: 0

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。例えば、値が -16~16 の範囲外の場合、Update()で例外が発生します。

タイプ

Long

アクセス

Read/Write

例objDataSource= objModel.DataSources.Add(xtrObjectType.trFlatFileDataSource)objColumn.InputScale= 0

IsAnyColumnMismatched プロパティー

IsAnyColumnMismatched プロパティーは、データ・ソースの列が基礎になるデータと一致するかどうかを返します。

構文

object .IsAnyColumnMismatched

第 5 章 プロパティー 313

適用対象

CrossTabDataSource オブジェクト

DataSource オブジェクト

DbDataSource オブジェクト

FlatFileDataSource オブジェクト

IqdDataSource オブジェクト

Query オブジェクト

解説

このプロパティーは、モデルに定義されている列が、ソース・ファイルの列と一致することを確認するために使用します。不一致がない場合は False が、不一致がある場合は True が返されます。

モデルを作成する際、各データ・ソースの列はモデル定義の一部として保存されます。ソース・ファイルの列について並べ替え、追加、削除、または名前の変更を実行した場合は、モデルを更新する必要があります。

タイプ

ブール値

アクセス

読み取り

例new_package = model.Packages.Add()new_query= new_package.Queries.Add()If new_query.IsAnyColumnMismatched= True Then

IsBad プロパティー

IsBad プロパティーは、中断モデルが破損しているかリカバリー可能かどうかを返します。

構文

SuspendedModel .IsBad

適用対象

SuspendedModel オブジェクト

314 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

解説

中断モデルは、システム・クラッシュや停電などでモデルが正しく閉じなかったときに作成されます。Transformer では、できるだけ多くの情報が SuspendedModelsコレクションの SuspendedModel オブジェクトに保存されます。

モデルが破損している場合は、Remove メソッドまたは Delete メソッドを使用してコレクションから削除します。中断モデルがリカバリー可能な場合は、OpenModel メソッドを使用して、FileName パラメーターを QyPath プロパティーの戻り値に設定します。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

タイプ

ブール値

アクセス

読み取り

例objSuspendedModel = objTransApp.SuspendedModels(intX)If objSuspendedModel.IsBad= True Then

IsExpressionValid プロパティー

IsExpressionValid プロパティーは、数式が有効であるかどうかを返します。

構文

object .IsExpressionValid

適用対象

CalculationDefinition オブジェクト

Category オブジェクト

Column オブジェクト

Measure オブジェクト

SpecialCategory オブジェクト

解説

ExpressionText プロパティーで数式を作成することにより、データ・ソースに直接基づいていない情報をモデルに追加できます。Transformer では、親オブジェクトが更新されたときと実行時に、数式がすべて計算されます。IsExpressionValid は、数式の要素がすべて有効かどうかを判定し、予期されないエラーを防止するために使用します。

第 5 章 プロパティー 315

タイプ

ブール値

アクセス

読み取り

IsFolder プロパティー

IsFolder プロパティーは、数値データを数値データ・フォルダーとするかどうかを設定するか、または設定状態を返します。

構文

Measure .IsFolder

適用対象

Measure オブジェクト

解説

数値データを数値データ・フォルダーに変更する場合、またはその逆の場合に使用します。

タイプ

ブール値

アクセス

Read/Write

IsManual プロパティー

IsManual プロパティーは、レベルがソース値に関連付けられているかどうかを返します。

構文

object .IsManual

適用対象

DateLevel オブジェクト

Level オブジェクト

316 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

解説

手動レベルは、ソース値と関連付けされていません。代わりに、多数の子カテゴリーをグループ化したり、データ・ソースにない属性に基づくカテゴリーをグループ化するために使用する中間レベルとして、手動で作成します。

例えば、データ・ソースに州と市の列がある場合、手動レベルを作成して、州や郡以外の地理的な区分で市をグループ化するために必要なカテゴリーを設定できます。

手動レベルには、直接関連付けられているソース・データ列がなく、通常は子カテゴリーに接続されます。

値が True の場合、手動レベルを示します。False の場合、ソース・データのレベルを示します。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

タイプ

ブール値

アクセス

読み取り

IsMDCInUse プロパティー

IsMDCInUse プロパティーは、キューブが使用中または再構築中であるかを返します。

構文

object .IsMDCInUse

適用対象

Cube オブジェクト

CubeGroup オブジェクト

ChildCube オブジェクト

解説

PowerPlay Client で使用中の場合、または更新中の場合は、キューブがロックされます。キューブが開かれているかどうかを確認するには、IsMDCInUse を使用します。

例えば、別の PowerPlay Client アプリケーションでキューブが開かれている場合、または別のユーザーがキューブを構築しようとしている場合、IsMDCInUse では「True」が返されます。

第 5 章 プロパティー 317

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

タイプ

ブール値

アクセス

読み取り

IsolationLevel プロパティー

IsolationLevel プロパティーは、Impromptu クエリー定義ファイル (.iqd) を参照するときに可能なトランザクションのタイプを設定するか、または設定状態を返します。

構文

IqdDataSource .IsolationLevel

適用対象

IqdDataSource オブジェクト

解説

このプロパティーには、次のトランザクションの設定のいずれかを使用します。

Long 値 説明

0 デフォルトデータ・ソースを作成したときに指定した分離レベルを使用します。

1 ReadUncommitted。他のトランザクションによる変更を、ただちに任意のトランザクションで使用可能にする

2 ReadCommitted。他のトランザクションにコミットされた行だけにトランザクションのアクセスを許可します。

3 CursorStability。トランザクションが位置する行で、他のトランザクションによる更新を禁止します。

4 ReproducibleRead。最初のトランザクションが完了するまで、任意のトランザクションで選択、または更新した行へ他のトランザクションによる変更の追加を禁止する

5 PhantomProtection。トランザクションの開始以後に挿入または削除された行に、そのトランザクションがアクセスすることを禁止する

6 Serializable。複数のトランザクションを並列に実行した場合、順番に実行したときと同じ結果になるようにする

318 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

タイプ

Long

アクセス

Read/Write

例datasource= model.DataSources.Add(xtrObjectType.trIqdDataSource)datasource.IsolationLevel= 0

IsPrimary プロパティー

IsPrimary プロパティーは、オブジェクトが主ドリル・カテゴリーであるかどうかを設定するか、または設定状態を返します。

構文

object .IsPrimary

適用対象

DateDrillDown オブジェクト

DrillDown オブジェクト

Category オブジェクト

解説

このプロパティーは、DrillDowns コレクションの最初のドリルダウン・パスではTrue に、それ以外のドリルダウン・パスでは False になります。False は、代替ドリルダウン・パスを示します。代替ドリルダウン・パスは、CreateAlternateDrillDown メソッドを使用して作成します。

例えば、販売経路ディメンションには 2 つのパスがあります。主要パスは販売経路の種類によるもので、代替パスは地域によるものです。主要パスでドリルダウンすると、販売経路の種類から顧客にドリルダウンします。代替パスでドリルダウンすると、地域から顧客にドリルします。

Category オブジェクトについては、IsPrimary プロパティーを変更できません。DateDrillDown オブジェクトと DrillDown オブジェクトについては、False からTrue へ変更できますが、True から False へは変更できません。ドリルダウン・パスを True に設定すると、代替ドリルダウン・パスが主ドリルダウン・パスになり、前の主ドリルダウン・パスが代替ドリルダウン・パスになります。

Transformer での割り当てとパーティションは、主ドリルダウン・パスに基づいています。PowerPlay では、カテゴリーの集計値が主ドリルダウン・パスの最上位レベルへ集計されます。

第 5 章 プロパティー 319

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

タイプ

ブール値

アクセス

Read (Category)

Read/Write (DateDrillDown および DrillDown)

例objLocationsDim = objModel.Dimensions("Sales regions")objLevel = objLocationsDim.DrillDowns(1).Levels("Employee")objAltDrill= objLevel.CreateAlternateDrillDownobjAltDrill.IsPrimary = True

IsTimeBasedPartitionedCube プロパティー

IsTimeBasedPartitionCube プロパティーは、キューブ・グループが時系列にパーティション化されたキューブとして指定されているかどうかを設定するか、または設定状態を返します。

構文

CubeGroup .IsTimeBasedPartitionedCube

適用対象

CubeGroup オブジェクト

解説

時系列にパーティション化されたキューブは、CubeGroup オブジェクトを定義し、IsTimeBasedPartitionedCube プロパティーを「True」に設定して作成します。このプロパティーが「True」に設定されている場合、「False」に設定を変更すると例外が発生します。レベルとディメンションは CubeGroup オブジェクトと同様に設定できますが、アクセスは時系列にパーティション化されたキューブを通じて行います。

デフォルト:False

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

タイプ

ブール値

アクセス

Read (多数の場合)/Write (1 回の場合)

320 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

KeyName プロパティーKeyName プロパティーは、関連するデータ・ソース列に表示される値を設定する、または設定状態を返します。

構文

Category .KeyName

適用対象

Category オブジェクト

解説

この値は、カテゴリーの直接の親が所有する全カテゴリーで一意でなければなりません。収束レベルでは、この値はレベルの全カテゴリーで一意でなければなりません。

タイプ

文字列

アクセス

Read/Write

例objCategory = objModel.Dimensions("Sales region").Drilldowns(1).Categories(2)IfobjCategory.KeyName <> "Central Europe" Then

Label プロパティーLabel プロパティーは、PowerPlay に表示される説明的な名前を設定するか、または設定状態を返します。

構文

object .Label

適用対象

Association オブジェクト

Category オブジェクト

CategorySet オブジェクト

CurrencyRecord オブジェクト

Measure オブジェクト

SpecialCategory オブジェクト

第 5 章 プロパティー 321

解説

標準カテゴリーのデフォルトのラベルは、Name プロパティーです。

通貨レコードのデフォルトのラベルは、CountryCode プロパティーに設定されている国または地域のコードです。

特殊カテゴリーのデフォルトのラベルは、Name プロパティーです。他のオブジェクトのデフォルトのラベルは、Name プロパティーです。Association のラベルは、参照オブジェクトの名前です。

ラベルは一意である必要はありません。

タイプ

文字列

アクセス

Read/Write

例objAssociation = objDrill.ConvergenceLevel.Associations.Add()objAssociation.Label= objColumn.Name

LastUseDate プロパティーLastUseDate プロパティーは、カテゴリーまたは特殊カテゴリーが最後にアクティブになった日付を返します。

構文

object .LastUseDate

適用対象

Category オブジェクト

SpecialCategory オブジェクト

解説

このプロパティーは、Transformer でカテゴリーが生成された日付、またはカテゴリーのプロパティーが変更された日付を取得するために使用します。

非アクティブなカテゴリーを削除するには、このプロパティーの戻り値をCleanHouse メソッドとともに使用します。LastUseDate の日付が CleanHouse のDate パラメーターの日付より古い場合、Transformer ではカテゴリーが非アクティブと見なされ削除されます。

タイプ

Long

322 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

アクセス

読み取り

LatestDate プロパティーLatestDate プロパティーは、カテゴリーを選択する範囲の最終日付を設定します。

構文

object .LatestDate

適用対象

DateDimension オブジェクト

DateWizard オブジェクト

解説

このプロパティーと EarliestDate プロパティーは、時間ディメンションに含まれる日付カテゴリーの範囲を制限するために使用します。範囲を設定することにより、PowerPlay ユーザーに無関係なカテゴリー (過去の年など) を除外できます。

Transformer では、キューブのカテゴリーを生成するとき、またはキューブを作成するときに自動的に全カテゴリーが更新されます。日付カテゴリーのみを生成するには GenerateTimePeriod プロパティー (DateDimension オブジェクト) を使用します。Transformer では、EarliestDate プロパティーと LatestDate プロパティーに指定した範囲にあるレコードのサブセットのみが生成されます。

指定した範囲外の日付値があると、Transformer では、範囲外の日付の時期に応じて「期間前日付」または「期間後日付」カテゴリー、あるいは両方が生成されます。期間前でも期間後でもなく、指定した範囲に該当しない日付があると、「無効な日付」カテゴリーが生成されます。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

タイプ

Long

アクセス

Read/Write (DateDimension)

Write (DateWizard)

例.LatestDate = 19941231

第 5 章 プロパティー 323

Level プロパティーLevel プロパティーは、Category オブジェクトまたは SpecialCategory オブジェクトのレベルを返します。

構文

Category .Level

SpecialCategory .Level

適用対象

Category オブジェクト

SpecialCategory オブジェクト

解説

このプロパティーは、カテゴリーまたは特殊カテゴリーが属するレベルを見つけるために使用します。カテゴリーまたは特殊カテゴリーは、1 つのレベルのみに属します。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

タイプ

Object - Level

アクセス

読み取り

LevelCategories プロパティーLevelCategories プロパティーは、レベルに含まれるカテゴリーのコレクションを返します。

構文

Object .LevelCategories

適用対象

DateLevel オブジェクト

Level オブジェクト

解説

このプロパティーは、レベルに含まれるカテゴリーのコレクションにアクセスするために使用します。カテゴリーは 1 つだけのレベルに属します。

324 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

タイプ

Object - LevelCategories

アクセス

読み取り

LevelDrillDowns プロパティーLevelDrillDowns プロパティーは、レベルが属するドリルダウン・パス・オブジェクトのコレクションを返します。

構文

object .LevelDrillDowns

適用対象

DateLevel オブジェクト

Level オブジェクト

解説

ほとんどのレベルでは、ドリルダウン・パスは 1 つであるため、LevelDrillDownsコレクションには DrillDown または DateDrillDown オブジェクトが 1 つのみ含まれます。複数のドリルダウン・パスがある収束レベルの場合、コレクションには同数のエントリーが含まれます。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

タイプ

Object - LevelDrillDowns

アクセス

読み取り

例objDateDrillDown = objModel.Dimensions("Years").DrillDowns(1)

Levels プロパティーLevels プロパティーは、Level オブジェクトまたは DateLevel オブジェクトのコレクションを返します。

第 5 章 プロパティー 325

構文

object .Levels

適用対象

DateDrillDown オブジェクト

DrillDown オブジェクト

解説

モデルの各ディメンションには 1 つ以上のドリルダウン・パスが含まれ、それぞれに Levels コレクションがあります。

CreateDateDimension メソッドは、日付レベルのコレクションを自動的に作成します。DoAutoDesign メソッドは、モデルのドリルダウン・パスごとにレベルのコレクションを自動的に作成します。

Levels コレクションには、Level オブジェクトまたは DateLevel オブジェクトのどちらか一方が含まれます。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

タイプ

Object - Levels

アクセス

読み取り

例objTimeDimension = objModel.Dimensions.Item("Time")objLevel= objTimeDimension.DrillDowns.Item(1).Levels.Item("Month")

LocalPath プロパティーLocalPath プロパティーは、データ・ソースの場所を設定するか、または設定状態を返します。

構文

object .LocalPath

適用対象

CrossTabDataSource オブジェクト

DbDataSource オブジェクト

FlatFileDataSource オブジェクト

326 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

IqdDataSource オブジェクト

解説

このプロパティーには、相対パスとファイル名または絶対パスを指定できます。データ・ソースがサーバーにある場合は、ServerPath プロパティーを使用します。

相対パスを指定した場合、Transformer では、DataSource プロパティーで指定した開始パスの値に相対パスが付加されます。DataSource プロパティーを指定しない場合、PowerPlay をインストールした場所に LocalPath の値が付加されます。どちらの場合も、連結された値が正しい場所を示すことが必要です。

タイプ

文字列

アクセス

Read/Write

例objDataSource= objModel.DataSources.

Add(xtrObjectType.trFlatFileDataSource)objDataSource.LocalPath= strDataPath

LogErrorLevel プロパティーLogErrorLevel プロパティーは、記録するエラー・メッセージの重大度を設定するか、または設定状態を返します。

構文

Application .LogErrorLevel

適用対象

Application オブジェクト

解説

このプロパティーは、記録するメッセージまたは警告のレベルを指定するために使用します。例えば、定数 trLogInformationAndAbove を指定すると、全メッセージがファイルに記録されます。メッセージを記録するには、最初にEnableMessageLogging プロパティーを True に設定する必要があります。

このプロパティーには、xtrPreferences の値を使用します。

タイプ

定数

第 5 章 プロパティー 327

アクセス

Read/Write

例objTransApp.LogErrorLevel = xtrPreferences.trLogErrorsAndAbove

LogFileAppend プロパティーLogFileAppend プロパティーは、Transformer でメッセージをログ・ファイルに付加するか、ログ・メッセージに上書きするかを設定するか、または設定状態を返します。

構文

Application .LogFileAppend

適用対象

Application オブジェクト

解説

このプロパティーを True に設定すると、Transformer ではログ・ファイルに情報が付加されます。False に設定すると、ログ・ファイルに上書きされます。

ログ・ファイルの名前と場所を指定するには、LogFileName プロパティーとLogFilesPath プロパティーを使用します。指定しない場合、Transformer ではPowerPlay アプリケーションをインストールしたフォルダーにファイルが作成されます。

メッセージを記録するには、EnableMessageLogging プロパティーを True に設定する必要があります。

デフォルト:False

タイプ

ブール値

アクセス

Read/Write

例objTransApp.LogFileAppend = True

LogFileName プロパティーLogFileName プロパティーは、ログ・ファイルの名前を設定するか、または設定状態を返します。

328 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

構文

Application .LogFileName

適用対象

Application オブジェクト

解説

空白の場合、現在のモデルと同じ名前で、拡張子が .log のログ・ファイルが使用されます。現在のモデル名がない場合は、"Tfmr001e.log"などの任意のファイル名が生成されます。

ログ・ファイルの保存場所を指定するには LogFilesPath プロパティーを使用します。メッセージを記録するには、最初に EnableMessageLogging プロパティーをTrue に設定する必要があります。

タイプ

文字列

アクセス

Read/Write

例objTransApp.LogFileName = "TrModelsLog.log"

LogFilesPath プロパティーLogFilesPath プロパティーは、Transformer でログ・ファイルを保存する場所を設定するか、または設定状態を返します。

構文

Application .LogFilesPath

適用対象

Application オブジェクト

解説

このプロパティーは、Transformer でログ・ファイルを保存する場所を指定するために使用します。場所を指定しない場合、Transformer では ModelsPath プロパティーで指定した場所に保存されます。ModelsPath を指定していない場合、PowerPlay をインストールしたディレクトリーにログ・ファイルが保存されます。

ログ・ファイルの名前を指定するには、LogFileName プロパティーを使用します。メッセージを記録するには、最初に EnableMessageLogging プロパティーを Trueに設定する必要があります。

第 5 章 プロパティー 329

タイプ

文字列

アクセス

Read/Write

例objTransApp.LogFilesPath = strStartLocation

Lunar プロパティーLunar プロパティーは、DateDrillDown オブジェクトが月暦年に基づくかどうかを設定するか、または設定状態を返します。

構文

DateDrillDown .Lunar

適用対象

DateDrillDown オブジェクト

解説

DateDrillDown オブジェクトが表す暦のタイプ (標準暦または月暦) は、親時間ディメンションの性質によって決まります。False は、標準暦を示します。

タイプ

ブール値

アクセス

Read/Write

例objDateWizard= objModel.DateWizardobjDateDim= objDateWizard.CreateDateDimension()objDrillDown= objDateDim.DrillDowns(1)objDrillDown.Lunar= True

ManualCurrentPeriod プロパティーManualCurrentPeriod プロパティーは、現在の期間を手動で設定するかTransformer で設定するかを設定するか、または設定状態を返します。

構文

DateDimension .ManualCurrentPeriod

330 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

適用対象

DateDimension オブジェクト

解説

True の場合は、現在の期間を時間ディメンションの任意のカテゴリーに手動で設定できます。通常は、時間ディメンションの最下位レベル (週レベル以下など) に設定します。

特殊カテゴリーの当月、前月、四半期間累計などの相対時間期間は、現在の期間を使用して作成されます。

False の場合は、Transformer で最新の日付カテゴリーを使用して現在の期間が設定されます。SetsCurrentPeriod プロパティーは、現在の期間のデータ・ソースを示します。検出されるカテゴリーが「期間前日付」のみの場合、Transformer にディメンションの現在時間が設定されることはありません。

デフォルト:False

タイプ

ブール値

アクセス

Read/Write

例objDateDim = objModel.Dimensions("Date")MsgBox("CurrentPeriod:" + objDateDim.ManualCurrentPeriod.Name)

MaximizeSpeed プロパティーMaximizeSpeed プロパティーは、Transformer がカテゴリーの一意性を検証するかどうかを設定するか、または設定状態を返します。

構文

object .MaximizeSpeed

適用対象

CrossTabDataSource オブジェクト

DataSource オブジェクト

DbDataSource オブジェクト

FlatFileDataSource オブジェクト

IqdDataSource オブジェクト

第 5 章 プロパティー 331

解説

このプロパティーは、速度を最適化するために使用します。True に設定すると、Transformer では、ディメンションのレベルに取り込まれる際にカテゴリーの一意性はチェックされません。

False に設定すると、レベルの定義に一意性の問題がないかどうかが検査されます。Transformer におけるレベルの一意性とは、レベル内の各カテゴリーの値が異なることを意味します。

デフォルト:False

タイプ

ブール値

アクセス

Read/Write

例objDataSource= objModel.DataSources.Add(xtrObjectType.trFlatFileDataSource)objDataSource.MaximizeSpeed= True

MaxNumPartLevels プロパティーMaxNumPartLevels プロパティーは、パーティション・レベルの最大数を設定するか、または設定状態を返します。

構文

object .MaxNumPartLevels

適用対象

Cube オブジェクト

CubeGroup オブジェクト

解説

このプロパティーは、Transformer でソース・データを読み取る最大回数を設定するために使用します。パーティション・レベル数が大きいほど、必要なデータのパス数も多くなります。

Optimize プロパティーを自動パーティションに設定している場合、DesiredPartitionSize プロパティーと EstimatedRows プロパティーのキューブ・プロパティーも設定する必要があります。

手動でパーティションを作成するには、レベルまたはカテゴリーの Partition プロパティーを使用します。MaxNumPartLevels は、少なくとも追加するパーティション・レベルの数と同じ大きさに設定する必要があります。

332 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

デフォルト:パス数 5

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

タイプ

Long

アクセス

Read/Write

例objCube = objModel.Cubes.Item(1)objCube.MaxNumPartLevels= 5

MaxTransactionNumber プロパティーMaxTransactionNumber プロパティーは、Transformer で変更をキューブにコミットする前に処理する最大レコード数を設定する、または設定状態を返します。

構文

Application .MaxTransactionNumber

適用対象

Application オブジェクト

解説

このプロパティーは、Transformer でキューブを生成する各段階でいつチェックポイントを挿入するかを決定するために使用します。この設定により、チェックポイントを挿入する前に一時的に保持するレコードの数が制限されます。エラーのためキューブが完成しなかった場合、最後にコミットされたチェックポイントから処理を再開できます。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

デフォルト:500,000

タイプ

Long

アクセス

Read/Write

例objTransApp.MaxTransactionNumber = 500000

第 5 章 プロパティー 333

MDCFile プロパティーMDCFile プロパティーは、PowerCube ファイル (.mdc) の名前を設定するか、または設定状態を返します。

構文

object .MDCFile

適用対象

ChildCube オブジェクト

Cube オブジェクト

CubeGroup オブジェクト

解説

このプロパティーは、ファイル名を指定するために使用します。

PowerCube ファイルの保存場所を指定するには、PowerCubesPath プロパティーを使用します。Transformer では、最初に PowerCubesPath プロパティー、次にModelsPath プロパティーがチェックされて保存場所が検索されます。保存場所を指定しない場合、PowerPlay をインストールした場所に PowerCube ファイルが保存されます。

タイプ

文字列

アクセス

Read/Write

例objCube = objModel.Cubes.Item(1)objCube.MDCFile = "GoCube"

MeasureInclude プロパティーMeasureInclude プロパティーは、指定したオブジェクトに数値データを含めるかどうかを設定するか、または設定状態を返します。

構文

object .MeasureInclude(Measure)

適用対象

Cube オブジェクト

CubeGroup オブジェクト

CustomView オブジェクト

334 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

解説

特定の数値データを含めるには、その名前をパラメーターに指定し、MeasureInclude プロパティーを True に設定します。数値データを除外するには、このプロパティーを False に設定します。複数の数値データを含めるか設定するには、パラメーターを各数値データに置き換えながら、このプロパティーを繰り返し使用します。

キューブに含まれている算出数値データから数式に使用されている数値データを除外した場合、この数値データは計算のためにキューブに含められますが、PowerPlay ユーザーには表示されません。

デフォルト:True

パラメーター 説明

数値データ 必須。指定したオブジェクトに含める (または除外する)Measure オブジェクトを指定します。

タイプ:Object

タイプ

ブール値

アクセス

Read/Write

例objCubesByRegion= objModel.Cubes.Add(xtrObjectType.trCubeGroup)objCubesByRegion.MeasureInclude(objModel.Measures("Product cost"))= False

MeasureName プロパティーMeasureName プロパティーは、数値データを識別する説明的なタイトルを設定するか、または設定状態を返します。

構文

object .MeasureName

適用対象

ChildCube オブジェクト

Cube オブジェクト

CubeGroup オブジェクト

第 5 章 プロパティー 335

解説

このプロパティーは、PowerPlay のディメンション・ラインに表示されるデフォルトの「Measures」というタイトルを置き換えるために使用します。

タイプ

文字列

アクセス

Read/Write

例objCubesByRegion= objModel.Cubes.Add(xtrObjectType.trCubeGroup)objCubesByRegion.MeasureName= "Revenue Made"

Measures プロパティーMeasures プロパティーは、Measure オブジェクトのコレクションを返します。

構文

Model .Measures

適用対象

モデル・オブジェクト

解説

Measures コレクションには、通常数値データ、算出数値データ、またはカテゴリー・カウント数値データが含まれます。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

タイプ

Object - Measures

アクセス

読み取り

例objMeasures = objModel.Measures

MeasureType プロパティーMeasureType プロパティーは、Measure オブジェクトのタイプを返します。

336 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

構文

Measure .MeasureType

適用対象

Measure オブジェクト

解説

Measures は通常数値データ、算出数値データ、またはカテゴリー・カウント数値データの 3 種類から構成されます。DoAutoDesign メソッドを使用すると、タイプがtrRegularMeasure に自動的に設定されます。標準数値データは、列または属性と関連付けられます。

算出数値データを定義するには ExpressionText プロパティーを、カテゴリー・カウント数値データを定義するには CategoryCountLevel プロパティーを使用します。

MeasureType プロパティーには、xtrMeasureType の値を使用します。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

タイプ

定数 - xtrMeasureType

アクセス

読み取り

MissingValue プロパティーMissingValue プロパティーは、データ・ソースで数値データの値が欠落している場合、代わりに使用する値を設定するか、または設定状態を返します。

構文

Measure .MissingValue

適用対象

Measure オブジェクト

解説

デフォルトでは、欠落値すべては PowerPlay で 0 と表示されます。PowerPlay で欠落値を「na」と表示することもできます。この方法では、欠落値が誤って 0 値と解釈されることを防止できます。

MissingValue プロパティーには、xtrMissingValue の値を使用します。

第 5 章 プロパティー 337

タイプ

定数 - xtrMissingValue

アクセス

Read/Write

例objMeasures= objModel.MeasurescurrentMeasure= objMeasures("Revenue")currentMeasure.MissingValue= xtrMissingValue.trMissingValueZERO

ModelName プロパティーModelName プロパティーは、異常終了によって生成されたテンポラリー・ファイルが存在するモデルの名前 (.qy?) を設定するか、または設定状態を返します。

構文

SuspendedModel .ModelName

適用対象

SuspendedModel オブジェクト

解説

SuspendedModels プロパティーは、クライアント・ベースのモデルが異常終了のために保存されなかった場合、中断モデルのコレクションを取得するために使用します。各モデルを取得するには Item メソッドを、モデルが破損しているかどうかを調べるには IsBad プロパティーを使用します。

障害の前にモデル名を付けていなかった場合は、New Model という名前が返されます。

タイプ

文字列

アクセス

Read/Write

例objSuspendedModel = objTransApp.SuspendedModels(intX)MsgBox("Model:" + objSuspendedModel.ModelName + _", located at " + objSuspendedModel.QyPath+ " is corrupt")

ModelsPath プロパティーModelsPath プロパティーは、Transformer でモデル・ファイルを開いたり保存する場所を設定するか、または設定状態を返します。

338 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

構文

Application .ModelsPath

適用対象

Application オブジェクト

解説

場所を指定しない場合、モデル・ファイルは PowerPlay をインストールしたディレクトリーに保存されます。

タイプ

文字列

アクセス

Read/Write

例objTransApp.ModelsPath = strStartLocation

ModelTemporaryFilesPath プロパティーModelTemporaryFilesPath プロパティーは、Transformer でテンポラリー・モデル・ファイル (.qy?) を作成する場所を設定するか、または設定状態を返します。

構文

Application .ModelTemporaryFilesPath

適用対象

Application オブジェクト

解説

致命的エラーが発生した場合は、テンポラリー・モデル・ファイルを使用して中断モデルをリカバリーします。このプロパティーを指定しない場合、次の場所が順番に検索されます。

v ModelsPath プロパティーで指定した場所

v PowerPlay をインストールした場所

v "cs7g.ini"ファイルの「Services」セクションで Temporary = を使用して設定した場所

v TEMP 環境変数で設定した場所

v TMP 環境変数で設定した場所

タイプ

文字列

第 5 章 プロパティー 339

アクセス

Read/Write

例objTransApp.ModelTemporaryFilesPath = strStartLocation

ModelType プロパティーModelType プロパティーは、Windows のフォルダーまたは Windows Explorerに表示されるモデル・ファイルの拡張子を返します。

構文

Model .ModelType

適用対象

Model オブジェクト

解説

このプロパティーは、モデル・ファイルのタイプをチェックしたり、タイプをログ・ファイルに書き込むために使用します。モデルは、テキスト・ファイル (.mdl)またはバイナリー・ファイル (.py?) で保存されます。Transformer では、疑問符は数値または文字で置き換えられます。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

タイプ

文字列

アクセス

読み取り

MonthType プロパティーMonthType プロパティーは、時間ディメンションの月レベルを計算する方法を設定します。

構文

DateWizard .MonthType

適用対象

DateWizard オブジェクト

340 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

解説

このプロパティーは、暦年の月であるか月暦年の月であるかを指定するために使用します。

MonthType プロパティーには、xtrSpecialFunction の値を使用します。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

タイプ

定数 - xtrSpecialFunction

アクセス

Write

例objModel.MonthType = xtrSpecialFunction.trSpecialFunctionMonth

Name プロパティーName プロパティーは、オブジェクトの名前を設定するか、または設定状態を返します。

構文

object .Name

適用対象

45 ページの『Application オブジェクト』

Association オブジェクト

CalculationDefinition オブジェクト

Category オブジェクト

CategorySet オブジェクト

ChildCube オブジェクト

Column オブジェクト

CrossTabDataSource オブジェクト

Cube オブジェクト

CubeGroup オブジェクト

CurrencyTable オブジェクト

CustomView オブジェクト

第 5 章 プロパティー 341

DataSource オブジェクト

DateDimension オブジェクト

DateDrillDown オブジェクト

DateLevel オブジェクト

DbDataSource オブジェクト

Dimension オブジェクト

DrillDown オブジェクト

DrillThroughTarget オブジェクト

Filter オブジェクト

FlatFileDataSource オブジェクト

IqdDataSource オブジェクト

Level オブジェクト

Measure オブジェクト

Model オブジェクト

Name オブジェクト

Namespace オブジェクト

Package オブジェクト

Prompt オブジェクト

Query オブジェクト

117 ページの『Report オブジェクト』

SecurityObject オブジェクト

Signon オブジェクト

SpecialCategory オブジェクト

View オブジェクト

解説

ディメンションのオブジェクトを作成するには、名前を指定する必要があります。

一部のオブジェクトには、Name プロパティーと Label プロパティー、またはName プロパティーと ShortName プロパティーを指定します。オブジェクトの

342 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

Label または ShortName の値を指定しない場合、Transformer ではデフォルトのソース・データとして Name プロパティーを使用します。

新規に作成したオブジェクトの名前に値のソースがない場合は、Transformer で作成され、一意の識別子が付けられます ("Products View1"、"Products View2"など)。

Category オブジェクトの場合、Name プロパティーおよび Code プロパティーのデフォルトのソースとして KeyName プロパティーを使用します。

タイプ

文字列

アクセス

Read (Application、Name、Report)

Read/Write (他の全オブジェクト)

例objCube = objModel.Cubes.Item(1)objCube.Name = "GreatOutdoors Sales (Optimized)"

Namespaces プロパティー

Namespaces プロパティーは、Namespaces コレクションを返します。

構文

Model .Namespaces

適用対象

モデル・オブジェクト

解説

このプロパティーは、モデル・オブジェクトのネームスペースの繰り返し、新規ネームスペースの追加、およびネームスペースの変更または削除に使用します。

タイプ

Object - Namespaces

アクセス

読み取り

例new_namespace = model.Namespaces.Add()

第 5 章 プロパティー 343

NewCatsLocked プロパティーNewCatsLocked プロパティーは、オブジェクトに新しいカテゴリーを追加できるかどうかを設定するか、または設定状態を返します。

構文

object .NewCatsLocked

適用対象

DateDimension オブジェクト

DateLevel オブジェクト

Dimension オブジェクト

Level オブジェクト

解説

このプロパティーは、カテゴリー生成の結果として新規カテゴリーが追加されないように、レベルまたはディメンションをロックするために使用します。ディメンションの NewCatsLocked プロパティーを True に設定すると、そのディメンションの全レベルの NewCatsLocked プロパティーも True に設定されます。

True に設定した場合、Transformer ではモデルの既存カテゴリーと関連付けられていないデータ・ソース値が無視されます。

デフォルト:False

タイプ

ブール値

アクセス

Read/Write

例objLocationsDim = objModel.Dimensions("Sales regions")objLevel= objLocationsDim.DrillDowns(1).Levels("Employee")objLevel.NewCatsLocked= False

ObjectCAMID プロパティー

ObjectCAMID プロパティーは、ObjectName プロパティーによって設定されるネームスペースに含まれるオブジェクトの CAMID を返します。

構文

Namespace .ObjectCAMID

344 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

適用対象

Namespace オブジェクト

解説

このプロパティーは、ネームスペースに含まれるオブジェクトの CAMID を取得するために使用します。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

タイプ

文字列

アクセス

読み取り

例new_namespace = model.Namespaces.Add()CAMID_of_Object= new_namespace.ObjectCAMID

ObjectName プロパティー

ObjectName プロパティーは、ネームスペース・オブジェクトの名前を設定するか、または設定状態を返します。

構文

Namespace .ObjectName

適用対象

Namespace オブジェクト

解説

このプロパティーは、ObjectCAMID プロパティーからオブジェクトの CAMID を取得するためのネームスペース・オブジェクトの名前を設定するために使用します。

タイプ

文字列

アクセス

Read/Write

例new_namespace = model.Namespaces.Add()new_namespace.ObjectName= Name_of_Object 'Authors is a group

第 5 章 プロパティー 345

Optimize プロパティーOptimize プロパティーは、モデルおよび環境に合わせて現在のキューブを最適化するオプションを設定するか、または設定状態を返します。

構文

object .Optimize

適用対象

ChildCube オブジェクト

Cube オブジェクト

CubeGroup オブジェクト

解説

Transformer および PowerPlay のパフォーマンスを向上させるためにキューブを最適化します。例えば、trOptimizeDataPasses 定数を指定すると、キューブ作成時に一時作業ファイルのパス数を最適化できます。

このプロパティーを trOptimizeAutoPartition に設定している場合、DesiredPartitionSize プロパティー、EstimatedRows プロパティー、MaxNumPartLevels プロパティーの各キューブ・プロパティーも設定する必要があります。ExcludeAutoPartition プロパティーを使用すると、ディメンションを自動パーティション・プロセスから除外できます。

Optimize プロパティーには、xtrCubeOptimize の値を使用します。

タイプ

定数 - xtrCubeOptimize

アクセス

Read/Write

例objCube = objModel.Cubes.Item(1)objCube.Optimize= xtrCubeOptimize.trOptimizeAutoPartition

OrderByDescending プロパティーOrderByDescending プロパティーは、カテゴリーを降順にソートするかどうかを設定するか、または設定状態を返します。

構文

object .OrderByDescending(DrillDown)

346 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

適用対象

DateLevel オブジェクト

Level オブジェクト

解説

レベルが複数のドリルダウン・パスの収束レベルになっている場合は、それぞれ異なるソートの順序を適用できます。ソートを適用するドリルダウン・パスを指定するには、DrillDown パラメーターを使用します。

デフォルトでは、カテゴリーを昇順にソートします。

デフォルト:False

パラメーター 説明

DrillDown 必須。レベルを表示するドリルダウン・パスの構造を指定します。

タイプ:Variant

タイプ

ブール値

アクセス

Read/Write

例objDrill= objModel.Dimensions("Retailers").DrillDowns(2)objDrill.Levels("Retailer site").OrderByDescending(objAssociation.Context)= False

OrderByStorageType プロパティーOrderByStorageType プロパティーは、列の保管タイプに基づいてカテゴリーをソートする方法を設定するか、または設定状態を返します。

構文

object .OrderByStorageType(DrillDown)

適用対象

DateLevel オブジェクト

Level オブジェクト

第 5 章 プロパティー 347

解説

このプロパティーは、数値データ・クラスの列に基づいてカテゴリーをソートするときに、ソートを定義するために使用します。例えば、販売数量に基づいて製品レベルをソートする場合、"数量"列と関連付けられた"数量"という数値データの保存タイプは 16 ビット整数です。

OrderByStorageType プロパティーには、xtrStorage の値を使用します。

パラメーター 説明

DrillDown 必須。レベルを表示するドリルダウン・パスの構造 (コンテキスト) を指定します。

タイプ:Variant

タイプ

定数 - xtrStorage

アクセス

Read/Write

Origin プロパティーOrigin プロパティーは、指定されたオブジェクトの元データを返します。

構文

Column .Origin

適用対象

Column オブジェクト

解説

属性または列オブジェクトは、いくつかの方法により生成されます。例えば、ほとんどの列オブジェクトは Transformer によりデータ・ソースから生成されますが、算出列は手動で作成します。

Origin プロパティーには、xtrOrigin の値を使用します。

タイプ

定数 - xtrOrigin

アクセス

読み取り

348 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

OriginalName プロパティーOriginalName プロパティーは、データ・ソースの列名を設定するか、または設定状態を返します。

構文

Column .OriginalName

適用対象

Column オブジェクト

解説

このプロパティーは、使用するモデルのデータと元データ・ソースにあるデータとの相互参照に使用します。

戻り値は、データ・ソースの形式によって異なります。

ソース・データ OriginalName

Impromptu クエリー定義ファイル (.iqd) 使用するクエリー定義で定義された名前

列タイトル付き区切りフィールド・テキスト 列タイトル

区切り付きテキスト・ファイル 「Things like」が前に付けられた、データ・ソースの最初のレコードで対応するフィールドの値から構成された名前

固定フィールド・テキスト・ファイル オリジナル名なし

dBase、Paradox、Lotus1-2-3、Excel、Clipper、または FoxPro のテーブル

テーブルで定義された列名

IBM Cognos パッケージ 使用するクエリー定義で定義された名前

IBM Cognos レポート 使用するクエリー定義で定義された名前

Lotus 1-2-3 または Excel のクロス集計 クロス集計データ・ソースの列を表す範囲名

PowerHouse ポータブル・サブファイル サブファイルで定義された名前

タイプ

文字列

アクセス

読み取り

第 5 章 プロパティー 349

例new_package= model.Packages.Add()new_query= new_package.Queries.Add()new_column1= new_query.Columns.Add()new_column1.OriginalName= "[Sales (query)].[Time dimension].[Date]"

Orphanage プロパティーOrphanage プロパティーは、カテゴリーが孤児かどうかを設定するか、または設定状態を返します。

構文

Category .Orphanage

適用対象

Category オブジェクト

解説

孤児は、孤児カテゴリーが生成されるディメンションに使用します。

孤児は、手動レベルに作成するカテゴリーです。孤児を作成した後に生成される、モデルで位置が定義されていないカテゴリーは、孤児の子になります。適切なカテゴリーに接続できるまで、孤児カテゴリーを使用して新しいデータを別個に保存します。

孤児を作成するには、そのディメンションの Levels コレクションにレベルを追加します。ディメンション全体の新規カテゴリーの値を孤児に集めるには、Move メソッドを使用して孤児をコレクションの最初の位置に移動します。

Categories コレクションにカテゴリーを追加するには、Add (カテゴリー) メソッドを使用します。Add メソッドのパラメーターに、オブジェクトのタイプ(trCategory) とカテゴリーが属する手動レベルを指定します。最後に、Orphanageプロパティーを True に設定します。

デフォルト:False

タイプ

ブール値

アクセス

Read/Write

例.OutputScale = 0

350 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

OutputScale プロパティーOutputScale プロパティーは、整数を PowerPlay に表示する小数に変換するために使用するスケール値を設定するか、または設定状態を返します。

構文

object .OutputScale

適用対象

Column オブジェクト

Measure オブジェクト

解説

このプロパティーには、ソース値の除算に使用する 10 の指数を設定します。例えば、2 に設定した場合、9450 は PowerPlay で 95 (すなわち 9450/10^2 を小数点以下で丸めた値) と表示されます。

出力される値に小数点以下の桁を含めるには、FormatDecimals プロパティーを使用します。上記の例で FormatDecimals プロパティーを 2 に設定した場合は、PowerPlay に 94.50 と表示されます。

データ・ソースからソース値を読み込むときに適用する乗算を指定するには、InputScale プロパティーを使用します。

スケール値の範囲は、0~16 (10**16) です。

デフォルト: 0

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。例えば、値が 0~16 の範囲外に設定されると、Update() で例外が発生します。

タイプ

Long

アクセス

Read/Write

例objMeasure.CategoryCountLevel = objLevelobjMeasure.OutputScale= 0

Packages プロパティーPackages プロパティーは、Transformer モデルに関連付けられている Package オブジェクトのコレクションを返します。

第 5 章 プロパティー 351

構文

Model .Packages

適用対象

モデル・オブジェクト

解説

このプロパティーは、モデル・オブジェクトのパッケージの繰り返し、新規パッケージの追加、およびパッケージの変更または削除に使用します。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

タイプ

パッケージ

アクセス

読み取り

例new_package = model.Packages.Add()

PackagesDatasourceConnections プロパティーPackageDataSourceConnections プロパティーは、Package または Report オブジェクトに関連付けられている PackageDatasourceConnection オブジェクトのコレクションを返します。

構文

object .PackageDatasourceConnections

適用対象

Package オブジェクト

解説

このプロパティーを使用するためには、Package または Report に少なくとも 1 つのクエリーが割り当てられていることを確認してください。

このプロパティーは、Package または Report へのデータ・ソース接続の繰り返し、新規接続の追加、および接続の変更または削除に使用します。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

352 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

タイプ

PackageDatasourceConnections

アクセス

読み取り

例package = model.Packages.Add()connection= package.PackageDatasourceConnections.Add()

Parent プロパティーParent プロパティーは、親オブジェクトを返します。

構文

object .Parent

適用対象

Association オブジェクト

Associations コレクション

CalculationDefinition オブジェクト

CalculationDefinitions コレクション

Categories コレクション

Category オブジェクト

CategorySet オブジェクト

CategorySets コレクション

ChildCube オブジェクト

ChildCubes コレクション

Column オブジェクト

Columns コレクション

CrossTabDataSource オブジェクト

Cube オブジェクト

CubeCustomViews コレクション

CubeGroup オブジェクト

Cubes コレクション

第 5 章 プロパティー 353

CurrencyRate オブジェクト

CurrencyRates コレクション

CurrencyRecord オブジェクト

CurrencyRecords コレクション

CurrencyTable オブジェクト

CurrencyTables コレクション

CustomView オブジェクト

CustomViews コレクション

DataSource オブジェクト

DataSources コレクション

DateDimension オブジェクト

DateDrillDown オブジェクト

DateLevel オブジェクト

DateWizard オブジェクト

DbDataSource オブジェクト

Dimension オブジェクト

DimensionLevels コレクション

Dimensions コレクション

DrillDown オブジェクト

DrillDowns コレクション

DrillThroughTarget オブジェクト

DrillThroughTargets コレクション

Filter オブジェクト

Filters コレクション

FlatFileDataSource オブジェクト

IqdDataSource オブジェクト

Level オブジェクト

LevelCategories コレクション

354 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

LevelDrillDowns コレクション

Levels コレクション

Measure オブジェクト

Measures コレクション

モデル・オブジェクト

Name オブジェクト

Names コレクション

Namespace オブジェクト

Namespaces コレクション

Package オブジェクト

PackageDatasourceConnections コレクション

PackageDatasourceConnection オブジェクト

Packages コレクション

Prompt オブジェクト

Prompts コレクション

Queries コレクション

Query オブジェクト

Report オブジェクト

Reports コレクション

SecurityObject オブジェクト

SecurityObjects コレクション

Signon オブジェクト

Signons コレクション

SpecialCategory オブジェクト

SuspendedModel オブジェクト

SuspendedModels コレクション

View オブジェクト

Views コレクション

第 5 章 プロパティー 355

解説

このプロパティーは、オブジェクトまたはコレクションの直接の先祖を取得するために使用します。親オブジェクトのプロパティーにアクセスして更新する場合は、ドット表記を使用できます。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

タイプ

オブジェクト

アクセス

読み取り

例objView = objDimension.Views.Add()objView.Parent.Update()

ParentCategories プロパティーParentCategories プロパティーは、親カテゴリーのコレクションを返します。

構文

object .ParentCategories

適用対象

Category オブジェクト

SpecialCategory オブジェクト

解説

複数のドリルダウン・パスに同じカテゴリーが含まれている場合、親カテゴリーが2 つ以上になることがあります。各親カテゴリーは、別のレベルおよび別のドリルダウン・パスに関連付けられます。

タイプ

オブジェクト

アクセス

読み取り

Partition プロパティーPartition プロパティーは、手動パーティション番号を設定するか、または設定状態を返します。

356 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

構文

object .Partition

適用対象

Category オブジェクト

DateLevel オブジェクト

Level オブジェクト

解説

Partition プロパティーは、パーティション・レベル番号を指定し、レベル内のカテゴリーをキューブにあるパーティションの先頭にします。パーティションに最適な候補は、数レベルの階層があり、全体的にカテゴリー対レベルの比率が同じようなカテゴリーです。

ソース・データとユーザーの要求を熟知している場合は、特定のディメンションにあるレベルとカテゴリーにパーティション・レベル番号を割り当てることにより、手動でパーティションを定義できます。その場合、多数のカテゴリーとレベルを備え、カテゴリー対レベルの比率が類似しているディメンションを選択します。代替ドリルダウン・パス構造を持つディメンション、または特殊カテゴリーを含むレベルのパーティションは避けます。リーフ・カテゴリー、ドリル・カテゴリーまたはルート・カテゴリーには、パーティション番号を指定しないでください。

パーティションを作成するには、最初に ResetPartitions メソッドを使用して既存の自動または手動パーティションを削除します。次に、Partition プロパティーを使用して、パーティション・レベルを作成します。Transformer でソース・データを処理するパス数を指定するには、MaxNumPartLevels プロパティーを使用します。

xtrInclusion の値によって消去またはフィルターされたカテゴリーは、パーティションに含まれません。

PowerCube をインクリメンタル更新する場合は、新規のパーティション・レベルを追加できません。モデルのパーティションを変更するには、モデルのパーティションを再度設定し、すべてのインクリメンタル・データを使用して、最初からPowerCube を再構築する必要があります。

範囲: 0 から 15。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

タイプ

Long

アクセス

Read/Write

第 5 章 プロパティー 357

例objCategory= objModel.Dimensions("Sales region").Drilldowns(1).

Categories(2)objCategory.Partition= 1

Password プロパティーPassword プロパティーは、大文字と小文字が区別されるパスワードを設定します。

構文

object .Password

適用対象

ChildCube オブジェクト

Cube オブジェクト

CubeGroup オブジェクト

Signon オブジェクト

解説

キューブ・グループのルート・ノードでパスワードを定義すると、グループ内のすべてのキューブに同じパスワードが適用されます。ただし、グループ内の個別の子キューブに対する Password プロパティーを変更することによりグループのルート・レベルで定義されたパスワードは、キューブ・グループのメンバーに対して定義されたパスワードによって上書きされます。DataSource サインオンは .iqd ファイルでインポートされること、つまり、データ・ソースがパスワードを要求するように構成されている場合にインポートされることに注意してください。

外部ネームスペースに対する認証に IBM Cognos を使用するには、userID、Password、および関連付けられているネームスペースを使用して Signonオブジェクトを構成する必要があります。最初に Signon オブジェクトを作成する必要があります。

Signon オブジェクトの場合、Password プロパティーはデータベースの自動アクセスに必要なパスワードを指定します。自動アクセスでは、UserID プロパティーも設定する必要があります。

データベースへの自動ログオンは、Signon オブジェクトのパスワードと論理データベース名を保存することで設定できます。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

タイプ

文字列

358 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

アクセス

Write

例signon = model.Signons.Add()signon.Password = "sa"

PatFile プロパティーPatFile プロパティーは、関連するユーザー・インターフェースのロケールに対するパターン・ファイル"cogtr_<ロケール>.pat" ("cogtr_en.pat"など) の場所を設定するか、または設定状態を返します。

このファイルは、パターン認識を利用してモデルの設計を自動化するために使用されるもので、installation_location/bin ディレクトリーに IBM Cognos Transformerとともにインストールされます。

構文

Application .PatFile

適用対象

Application オブジェクト

解説

このプロパティーは、関連するユーザー・インターフェースのロケールに対するパターン・ファイル"cogtr_<ロケール>.pat" ("cogtr_en.pat"など) の場所をTransformer で示すために使用します。

タイプ

文字列

アクセス

Read/Write

Path プロパティーPath プロパティーは、モデル・オブジェクトの場合はモデル・ファイルの場所を返します。Report オブジェクトまたは Package オブジェクトについては、IBMCognos Connection に含まれるパッケージまたはレポートへのパスを返します。

構文

object .Path

第 5 章 プロパティー 359

適用対象

Model オブジェクト

Package オブジェクト

Report オブジェクト

解説

このプロパティーは、モデル・ファイルの場所を取得したり、この場所の情報をログ・ファイルに書き込むために使用します。ファイル名を取得するには、FileNameプロパティーを使用します。ファイルの絶対パス名を取得するには、FullName プロパティーを使用します。

モデルを保存する場所を指定するには、ModelsPath プロパティーを使用します。

このプロパティーは、パッケージまたはレポートのデータ・ソースへのパスを取得または設定するために使用します。パッケージ・パスの構文の表示例は、次のとおりです。

/content/package[@name='GO Data Warehouse (analysis)']

タイプ

文字列

アクセス

Read (Model の場合)

Read/Write (Package または Report の場合)

例new_package = model.Packages.Add()new_package.Path = "/content/package[@name='GOData Warehouse (analysis)']"

PopulateByDataSource プロパティーPopulateByDataSource プロパティーは、通貨レートをデータ・ソースから取り込むか、Transformer で設定するかを設定するか、または設定状態を返します。

構文

CurrencyRate .PopulateByDataSource

適用対象

CurrencyRate オブジェクト

解説

True は、外部データ・ソースで通貨レートを定義することを示します。False は、Transformer で通貨レートを設定することを示します。

360 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

デフォルト:False

タイプ

ブール値

アクセス

Read/Write

例objCurrencyRecord = objModel.CurrencyRecords.Add()objCurrencyRate= objCurrencyRecord.CurrencyRates(intX)If objCurrencyRate.PopulateByDataSource= False Then

Position プロパティーPosition プロパティーは、データ・ソースの列の位置を設定するか、または設定状態を返します。

構文

Column .Position

適用対象

Column オブジェクト

解説

この位置は、固定フィールド・テキスト・データ・ソースからのフィールド以外のすべてのフィールドでは、データ・ソースにある列の元の位置に対応します。ソース列の位置は 1 から開始されます。

固定フィールド・テキスト・ファイルのデータ・ソースを使用している場合、Position プロパティーは列の開始位置のバイトに対応しています。レコードの最初のバイトはバイト番号 1 となります。位置の値がゼロ (0) の場合は、列に欠落値があることを示します。例えば、最初のフィールドに 30 バイトのデータ (1 文字当たり 1 バイト) がある場合、2 番目のフィールドの先頭にあるバイトのオフセット位置は 31 になります。

タイプ

Long

アクセス

Read/Write

PowerCubesPath プロパティーPowerCubesPath プロパティーは、Transformer で PowerCube ファイル (.mdc)を作成する場所を設定するか、または設定状態を返します。

第 5 章 プロパティー 361

構文

Application .PowerCubesPath

適用対象

Application オブジェクト

解説

このプロパティーは、PowerCube の場所を指定するために使用します。ファイル名を指定するには、MDCFile プロパティーを使用します。

ディレクトリーを指定しない場合、次の場所が順に検索されます。

v ModelsPath プロパティーで指定した場所

v PowerPlay のインストール・ディレクトリー

タイプ

文字列

アクセス

Read/Write

例objTransApp.PowerCubesPath = strStartLocation

PowerPlayPath プロパティーPowerPlayPath プロパティーは、"PowerPlay.exe" の場所を設定するか、または設定状態を返します。この実行可能ファイルは、PowerPlay アプリケーションのインストール時にインストールされます。

構文

Application .PowerPlayPath

適用対象

Application オブジェクト

解説

このプロパティーは、Transformer が "PowerPlay.exe" ファイルを検索する場所を指定するために使用します。

タイプ

文字列

アクセス

Read/Write

362 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

Precision プロパティーPrecision プロパティーは、計算に使用する数値データの小数桁数を設定するか、または設定状態を返します。

構文

Measure .Precision

適用対象

Measure オブジェクト

解説

このプロパティーは、PowerPlay が集計と算出カテゴリーの計算に使用する小数桁数を指定するために使用します。このプロパティーは、Measure オブジェクトのStorageType プロパティーが trStorageBigFloat のとき、または算出数値データにのみ使用できます。

Precision の設定が OutputScale の設定より小さいとき、PowerPlay では値が次の上位桁に丸められます。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

タイプ

Long

アクセス

Read/Write

例objMeasure.CategoryCountLevel = objLevel objMeasure.Precision = 0

PromptForPassword プロパティーPromptForPassword プロパティーは、UI モードで Transformer を使用する場合に、ユーザーに対してパスワードの入力を常に要求するかどうかを指定します。

構文

Signon .PromptForPassword

適用対象

Signon オブジェクト

第 5 章 プロパティー 363

解説

このプロパティーは、UI モードで Transformer を使用する場合に、ユーザーに対してパスワードの入力を常に要求するかどうかを指定します。このプロパティーは、DataSource サインオン・タイプにのみ適用されます。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

タイプ

ブール値

アクセス

Read/Write

例signon = model.Signons.Add()signon.PromptForPassword = False

Prompts プロパティーPrompts プロパティーは、クエリーに関連付けられている Prompt オブジェクトのコレクションを返します。

構文

Query .Prompts

適用対象

Query オブジェクト

解説

このプロパティーは、Query オブジェクトのプロンプトの繰り返し、新規プロンプトの追加、およびプロンプトの変更または削除に使用します。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

タイプ

Prompts

アクセス

読み取り

例new_report = model.Reports.Add()new_query = new_report.Queries.Add()new_prompt= new_query.Prompts.Add()

364 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

PromptValueType プロパティーPromptValueType プロパティーは、プロパティーのタイプを設定するか、または設定状態を返します。

構文

Prompt .PromptValueType

適用対象

Prompt オブジェクト

解説

このプロパティーは、Prompt オブジェクトの Value プロパティーを設定する前に割り当てる必要があります。

PromptValueType は、xtrPrompValueType の値を使用します。

タイプ

定数 - xtrPrompValueType

アクセス

Read/Write

例new_report = model.Reports.Add()new_query= new_report.Queries.Add()new_prompt.PromptValueType= xtrPromptValueType.trSingleValuePrompt

QualifiedName プロパティーQualifiedName プロパティーは、レベルの完全修飾名を返します。

構文

object .QualifiedName

適用対象

DateLevel オブジェクト

Level オブジェクト

解説

このプロパティーは、レベルが属するディメンションを決定するために使用します。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

第 5 章 プロパティー 365

タイプ

文字列

アクセス

読み取り

QuarterType プロパティーQuarterType プロパティーは、時間ディメンションの四半期レベルを計算する方法を設定します。

構文

DateWizard .QuarterType

適用対象

DateWizard オブジェクト

解説

このプロパティーは、暦年の四半期であるか月暦年の四半期であるかを指定するために使用します。

QuarterType プロパティーには、xtrSpecialFunction の値を使用します。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

タイプ

定数 - xtrSpecialFunction

アクセス

Write

例objModel.QuarterType = xtrSpecialFunction.trSpecialFunctionQuarter

Queries プロパティーQueries プロパティーは、Package または Report オブジェクトに関連付けられている Query オブジェクトのコレクションを返します。

構文

object .Queries

366 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

適用対象

Package オブジェクト

Report オブジェクト

解説

このプロパティーは、Package または Report のクエリーの繰り返し、新規クエリーの追加、およびクエリーの変更または削除に使用します。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

タイプ

Queries

アクセス

読み取り

例new_package = model.Packages.Add()new_query = new_package.Queries.Add()

QyPath プロパティー

QyPath プロパティーは、中断されたモデルの場所を返します。

構文

SuspendedModel .QyPath

適用対象

SuspendedModel オブジェクト

解説

モデルで作業する際、Transformer ではテンポラリー・ファイルが作成され、チェックポイントが設定されます。テンポラリー・ファイルはモデルが正常に閉じたときに削除されます。そのため、テンポラリー・モデル・ファイルの存在は、Transformer が異常終了したことを示します。

システム・クラッシュや停電などでモデルが正しく閉じなかった場合、Transformerでは最後のチェックポイントまでの中断モデルの情報が保持されます。中断モデルは .qy? ファイル拡張子を付けて保存されます (? の値は Transformer のバージョンによります)。

中断モデルのコレクションを取得するには、SuspendedModels プロパティーを使用します。コレクションのモデルが破損しているか、またはリカバリー可能かどうかを調べるには、IsBad プロパティーを使用します。

第 5 章 プロパティー 367

タイプ

文字列

アクセス

読み取り

例objSuspendedModel = objTransApp.SuspendedModels(intX)MsgBox("Model:" + objSuspendedModel.ModelName + _", located at " + objSuspendedModel.QyPath+ " is corrupt")

Rate プロパティー

Rate プロパティーは、通貨変換レートのタイプを設定するか、または設定状態を返します。

構文

CurrencyRate .Rate

適用対象

CurrencyRate オブジェクト

解説

Transformer では、通貨表に追加された各レコードに CurrencyRate オブジェクトのコレクションが作成されます。コレクションのサイズは、詳細度と日付範囲によって異なります。例えば、詳細度を月に、日付範囲を 2 年に設定した場合、24 の通貨レートが必要です。

レコードを手動で作成する場合は、モデル内でレートを設定して管理するためにRate プロパティーを使用します。

一方、レコードを外部データ・ソースから取り込む場合は、データ・ソース内でレートを設定して管理します。この場合、データ・ソースで指定した値を取得するために Rate プロパティーを使用します。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

タイプ

Double

アクセス

Read/Write

368 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

例objCurrencyRecord = objModel.CurrencyRecords.Add()objCurrencyRate= objCurrencyRecord.CurrencyRates(intX)objCurrencyRate.Rate = 1.54

RefName プロパティー

RefName プロパティーは、データ・ソースのフィルター名を設定するか、または設定状態を返します。

構文

Filter .RefName

適用対象

Filter オブジェクト

解説

このプロパティーは、使用するモデルのフィルターと元データ・ソースにあるフィルターとの相互参照に使用します。

タイプ

文字列

アクセス

Read/Write

例new_package = model.Packages.Add()new_query = new_package.Queries.Add()new_filter= new_query.Filters.Add()new_filter.RefName = "[go_data_warehouse].[2004]"

RefreshDescription プロパティー

RefreshDescription プロパティーは、説明が更新されているかどうかを設定するか、または設定状態を返します。

構文

object .RefreshDescription

適用対象

DateLevel オブジェクト

Level オブジェクト

第 5 章 プロパティー 369

解説

このプロパティーは、Transformer でカテゴリーを生成するたびにカテゴリーのDescription プロパティーを更新する場合に使用します。レベルには、AssociationRole プロパティーを trAssociationDescription に設定した Associationオブジェクトが必要です。

デフォルト:False

タイプ

ブール値

アクセス

Read/Write

例objLocationsDim = objModel.Dimensions("Sales regions")objLevel= objLocationsDim.DrillDowns(1).Levels("Employee") objAltDrill= objLevel.CreateAlternateDrillDownobjNewLevel= objAltDrill.Levels.Add(xtrObjectType.trLevel)objNewLevel.RefreshDescription= True

RefreshLabel プロパティー

RefreshLabel プロパティーは、ラベルが更新されているかどうかを設定するか、または設定状態を返します。

構文

object .RefreshLabel

適用対象

DateLevel オブジェクト

Level オブジェクト

解説

このプロパティーは、Transformer でカテゴリーを生成するたびにカテゴリーのLabel プロパティーを更新する場合に使用します。レベルには、AssociationRole プロパティーを trAssociationLabel に設定した Association オブジェクトが必要です。

デフォルト:False

タイプ

ブール値

370 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

アクセス

Read/Write

例objLocationsDim= objModel.Dimensions("Sales regions")objLevel= objLocationsDim.DrillDowns(1).Levels("Employee")objAltDrill= objLevel.CreateAlternateDrillDownobjNewLevel= objAltDrill.Levels.Add(xtrObjectType.trLevel)objNewLevel.RefreshLabel= True

RefreshShortName プロパティー

RefreshShortName プロパティーは、短縮名が更新されているかどうかを設定するか、または設定状態を返します。

構文

object .RefreshShortName

適用対象

DateLevel オブジェクト

Level オブジェクト

解説

このプロパティーは、Transformer でカテゴリーを生成するたびにカテゴリーのShortName プロパティーを更新する場合に使用します。レベルには、AssociationRole プロパティーを trAssociationShortName に設定した Associationオブジェクトが必要です。

デフォルト:False

タイプ

ブール値

アクセス

Read/Write

例objLocationsDim= objModel.Dimensions("Sales regions")objLevel= objLocationsDim.DrillDowns(1).Levels("Employee")objAltDrill= objLevel.CreateAlternateDrillDownobjNewLevel= objAltDrill.Levels.Add(xtrObjectType.trLevel)objNewLevel.RefreshShortName= True

第 5 章 プロパティー 371

RegularRollup プロパティー

RegularRollup プロパティーは、有効な標準集計関数のタイプを設定するか、または設定状態を返します。

構文

Measure .RegularRollup

適用対象

Measure オブジェクト

解説

このプロパティーは、数値データの値を自動集計する方法を変更するために使用します。

集計は、子カテゴリーすべてに計算を実行することによりレベル内の各カテゴリーの値を要約します。PowerPlay では、デフォルトで、カテゴリーの自動集計に合計が使用されます。このデフォルトは、xtrRollup の定数を使用して、最小、最大、平均、カウント、全てをカウント、適宜または外部に変更できます。

Transformer では、重複する非数値データ値の値を含む (つまり、カテゴリー名が同じ) レコードが集約されます。

RegularRollup プロパティーを trRollupAverage に設定する場合は、RegularWeight プロパティーも設定する必要があります。

RegularRollup プロパティーと TimeStateRollup プロパティーを両方とも使用すると、PowerPlay では、最初に標準集計が実行され、次に時状態データ集計が実行されます。

CanAllocateMeasure プロパティー、Consolidate プロパティー、DuplicateRollupプロパティー、TimeStateRollup プロパティー、RollupTiming プロパティーは、数値データを集計する方法とタイミングに影響します。

このプロパティーには、xtrRollup の値を使用します。

タイプ

定数 - xtrRollup

アクセス

Read/Write

例objMeasures= objModel.MeasurescurrentMeasure= objMeasures("Revenue")currentMeasure.RegularRollup= xtrRollup.trRollupAverage

372 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

RegularWeight プロパティー

RegularWeight プロパティーは、加重平均の計算に使用する数値データの名前を設定するか、または設定状態を返します。

構文

Measure .RegularWeight

適用対象

Measure オブジェクト

解説

RegularWeight プロパティーは、集計数値データについて真の平均ではなく、加重平均を計算するために使用します。

数値データ B を加重係数として数値データ A の加重平均を計算する場合は、次のような算出式を使用します。

∑ (Ai * Bi) / ∑ Bi

自動集計する数値データは xtrRollup の trRollupAverage に設定し、加重数値データとして指定する数値データは xtrRollup の trRollupDefault または trRollupSumに設定する必要があります。

標準集計と時状態データ集計の両方に、加重平均を指定することはできません。

タイプ

文字列

アクセス

Read/Write

例objMeasures = objModel.MeasurescurrentMeasure= objMeasures("Revenue")currentMeasure.RegularWeight= objModel.Measures("Quantity").Name

Reports プロパティー

Reports プロパティーは、Transformer モデルに関連付けられている Report オブジェクトのコレクションを返します。

構文

Model .Reports

第 5 章 プロパティー 373

適用対象

モデル・オブジェクト

解説

このプロパティーは、モデル・オブジェクトのレポートの繰り返し、新規レポートの追加、およびレポートの変更または削除に使用します。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

タイプ

Objects - Reports

アクセス

読み取り

例new_report = model.Reports.Add()

ReverseSign プロパティー

ReverseSign プロパティーは、PowerPlay で数値データの符号を反転するかどうかを設定するか、または設定状態を返します。

構文

object .ReverseSign

適用対象

Category オブジェクト

Measure オブジェクト

SpecialCategory オブジェクト

解説

ReverseSign プロパティーを True に設定すると、数値データとその数値データに基づくカテゴリーの値の符号が反転します。

このプロパティーは、財務レポート・システムで、支出などの特定の場合に正の符号、それ以外は負の符号で表示する必要のある数値が含まれる場合に使用します。

PowerPlay で符号を反転した値を表示する場合、数値データと関連するカテゴリーの両方について ReverseSign を True に設定する必要があります。

デフォルト:False

374 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

タイプ

ブール値

アクセス

Read/Write

例objMeasure.CategoryCountLevel = objLevelobjMeasure.CategoryCountLevel= objLevel objMeasure.ReverseSign = False

Rollup プロパティー

Rollup プロパティーは、特殊カテゴリーの数値データ値を親カテゴリーに集計するかどうかを設定するか、または設定状態を返します。

構文

SpecialCategory .Rollup

適用対象

SpecialCategory オブジェクト

解説

自動集計するカテゴリーには、子カテゴリーの値の要約が表示されます。特殊カテゴリーの子すべてについて Rollup プロパティーを False に設定すると、そのカテゴリーは、特殊カテゴリーの階層内のプレースホルダーとしてのみ機能します。

デフォルト:True

タイプ

ブール値

アクセス

Read/Write

例objSpecCategory= _ objModel.Dimensions("Time").Categories.Add(xtrObjectType.trSpecialCategory)objSpecCategory.Rollup= True

RollupTiming プロパティー

RollupTiming プロパティーは、算出数値データの計算をいつ実行するかを設定するか、または設定状態を返します。

第 5 章 プロパティー 375

構文

Measure .RollupTiming

適用対象

Measure オブジェクト

解説

自動集計するカテゴリーには、その子カテゴリーの値の要約が表示されます。算出カテゴリーでは、集計前または後に数値データ値の計算を実行できます。このプロパティーは、この計算のタイミングを指定するために使用します。

算出数値データでは、trTimingBeforeRollup を指定した場合、自動パーティションとレコード集約は使用できません。キューブに自動パーティションまたは集約を含めるには、算出数値データの代わりに算出列を使用します。算出列では、集計前に同じ計算を実行できます。

このプロパティーには、xtrRollupTiming の値を使用します。

タイプ

定数 - xtrRollupTiming

アクセス

Read/Write

例objMeasures = objModel.MeasurescurrentMeasure= objMeasures("Revenue")currentMeasure.RollupTiming= xtrRollupTiming.trTimingDefault

RowsAsSample プロパティー

RowsAsSample プロパティーは、DoAutoDesign メソッドでモデルを作成するときにサンプリングする行数を設定するか、または設定状態を返します。

構文

Application .RowsAsSample

適用対象

Application オブジェクト

解説

このプロパティーは、DoAutoDesign メソッドでレベルの階層関係を決定するときにサンプルとして使用する行数を指定するために使用します。RowsChecked プロパティーに設定した行数が上限になります。

376 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

最小:10 行。最大:1000 行。

デフォルト:300 行

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

タイプ

Long

アクセス

Read/Write

例objTransApp.RowsAsSample = 600

RowsChecked プロパティー

RowsChecked プロパティーは、DoAutoDesign メソッドでデータ・ソースから読み取る最大行数を設定するか、または設定状態を返します。

構文

Application .RowsChecked

適用対象

Application オブジェクト

解説

DoAutoDesign メソッドは、行をチェックしてレベルと数値データのソース列を決定します。

DoAutoDesign メソッドの精度を上げるには、行数を増やします。Transformer でモデルを作成する速度を上げるには、行数を減らします。

ゼロを指定すると、DoAutoDesign メソッドでデータ・ソース全体が読み取られます。

デフォルト: 600 行。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

タイプ

Long

第 5 章 プロパティー 377

アクセス

Read/Write

例objTransApp.RowsChecked = 600

RunningPeriods プロパティー

RunningPeriods プロパティーは、累計の計算に使用する期間数を設定するか、または設定状態を返します。

構文

SpecialCategory .RunningPeriods

適用対象

SpecialCategory オブジェクト

解説

このプロパティーは、現在を基準とする特定の期間の数値データを追跡する特殊カテゴリーを定義するために、TargetLevel プロパティー、ContextLevel プロパティー、TargetOffset プロパティー、ContextOffset プロパティーとともに使用します。

このプロパティーを使用するには、Aggregate プロパティーをtrAggregateRunning または trAggregateRunningGrouped に設定する必要があります。例えば、当月までの 6 カ月間と前年の同期間について累計カテゴリーを作成するには、次のように設定します。

Aggregate = trAggregateRunningGrouped

ContextLevel = "Year"

ContextOffset = -1

TargetLevel = "Month"

TargetOffset = 0

RunningPeriods = 6

タイプ

Long

アクセス

Read/Write

例objSpecCategory= _ objModel.Dimensions("Time").Categories.Add(xtrObjectType.trSpecialCategory)objSpecCategory.RunningPeriods= 5

378 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

SecurityObjects プロパティー

SecurityObjects プロパティーは、SecurityObjects のコレクションを返します。

構文

Object .SecurityObjects

適用対象

CustomView オブジェクト

Namespace オブジェクト

解説

このプロパティーは、Namespace のセキュリティー・オブジェクトの繰り返し、新規セキュリティー・オブジェクトの追加、およびセキュリティー・オブジェクトの変更または削除に使用します。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

タイプ

SecurityObjects

アクセス

読み取り

例new_namespace = model.Namespaces.Add()securityObject= new_namespace.SecurityObjects.Add()

Server プロパティー

Server プロパティーは、キューブをローカルで処理するかサーバーで処理するかを設定するか、または設定状態を返します。

構文

object .Server

適用対象

Cube オブジェクト

CubeGroup オブジェクト

解説

True に設定すると、サーバーでキューブが処理されます。

第 5 章 プロパティー 379

サーバーのモデル・ファイル (.mdl) の名前を指定するには、ServerModelPath を使用します。サーバーの接続名を指定するには、ServerConnect プロパティーを使用します。

デフォルト:False

タイプ

ブール値

アクセス

Read/Write

例securityObject = new_namespace.SecurityObjects.Add()

ServerModelPath プロパティー

ServerModelPath プロパティーは、サーバーのモデル・ファイル (.mdl) の名前を設定するか、または設定状態を返します。

構文

Model .ServerModelPath

適用対象

Model オブジェクト

解説

このプロパティーは、ファイル名を指定するために使用します。Transformer(UNIX 版) では、モデルはデフォルトのディレクトリーに保存されます。モデル・ファイルを別のディレクトリーに保存するには、絶対パスとファイル名を指定する設定を作成します。

接続文字列を指定するには、ServerConnect プロパティーを使用します。

タイプ

文字列

アクセス

Read/Write

ServerPath プロパティー

ServerPath プロパティーは、データ・ソース・ファイルの名前と場所を設定するか、または設定状態を返します。

380 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

構文

object .ServerPath

適用対象

DbDataSource オブジェクト

FlatFileDataSource オブジェクト

IqdDataSource オブジェクト

解説

完全パス名か、またはファイル名のみを指定します。ファイル名のみを指定した場合、Transformer で DataSourcePath プロパティーのディレクトリー名がチェックされます。DataSourcePath を指定しない場合、PowerPlay をインストールしたディレクトリーがチェックされます。

Transformer モデルをローカルで処理するには、LocalPath プロパティーを使用してデータ・ソースの場所を指定します。

タイプ

文字列

アクセス

Read/Write

ServerQuery プロパティー

ServerQuery プロパティーは、データをローカルで処理するかサーバーで処理するかを設定するか、または設定状態を返します。

構文

object .ServerQuery

適用対象

CrossTabDataSource オブジェクト

DataSource オブジェクト

DbDataSource オブジェクト

FlatFileDataSource オブジェクト

IqdDataSource オブジェクト

第 5 章 プロパティー 381

解説

True に設定すると、サーバーでデータが処理されます。この場合は、ServerPathプロパティーを使用してデータ・ソースの場所を指定します。

デフォルト:False

タイプ

ブール値

アクセス

Read/Write

ServicesBuildNumber プロパティー

ServiceBuildNumber プロパティーは、Transformer のビルド番号を返します。

構文

Application .ServicesBuildNumber

適用対象

Application オブジェクト

解説

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

タイプ

Long

アクセス

読み取り

ServicesVersionText プロパティー

ServicesVersionText プロパティーは、Transformer のビルド・バージョンを返します。

構文

Application .ServicesVersionText

適用対象

Application オブジェクト

382 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

解説

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

タイプ

文字列

アクセス

読み取り

SetsCurrentPeriod プロパティー

SetsCurrentPeriod プロパティーは、Transformer でデータ・ソースから現在期間の日付を検索するかどうかを設定するか、または設定状態を返します。

構文

object .SetsCurrentPeriod

適用対象

CrossTabDataSource オブジェクト

DataSource オブジェクト

DbDataSource オブジェクト

FlatFileDataSource オブジェクト

IqdDataSource オブジェクト

Query オブジェクト

解説

True に設定すると、Transformer では、関連付けられたデータ・ソース (日付列にある最新の日付) を使用して現在の期間の日付が決定されます。

相対時間カテゴリーの値は、現在の期間の日付を使用して決定されます。例えば、現在の日付が「20010831」の場合は、「前月」カテゴリーに"7 月"と表示されます。

モデルに複数のデータ・ソースがある場合、Transformer で現在の期間の日付を検索するために使用するデータ・ソースを選択します。このプロパティーを指定しないと、Transformer では、全データ・ソースがチェックされて最新の日付が選択されます。

通貨表に値を読み込むために使用するデータ・ソースでは、このプロパティーをFalse に設定します。または、日付列名を時間ディメンションで使われている名前と別の名前にします。

第 5 章 プロパティー 383

デフォルト:True

タイプ

ブール値

アクセス

Read/Write

例objDataSource= objModel.DataSources.Add(xtrObjectType.trFlatFileDataSource)objDataSource.SetsCurrentPeriod= True

ShortName プロパティー

ShortName プロパティーは、オブジェクトの短縮名を設定するか、または設定状態を返します。

構文

object .ShortName

適用対象

Category オブジェクト

DateDrillDown オブジェクト

DrillDown オブジェクト

Measure オブジェクト

SpecialCategory オブジェクト

解説

このプロパティーは、PowerPlay でオブジェクトに意味のある名前を表示するために使用します。

タイプ

文字列

アクセス

Read/Write

例objMeasures = objModel.MeasurescurrentMeasure= objMeasures("Revenue")currentMeasure.ShortName= "Revenue"

384 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

Signon プロパティー

Signon プロパティーは、キューブ、キューブ・グループ、またはパッケージ・データ・ソース接続 (IBM Cognos サインオン) に関連付けられた Signon オブジェクトを設定するか、または設定状態を返します。

構文

object .Signon

適用対象

Cube オブジェクト

CubeGroup オブジェクト

PackageDatasourceConnection オブジェクト

解説

モデルに Impromptu クエリー定義ファイル (.iqd) を追加すると、Signon オブジェクトが Transformer により自動的に追加されます。Signon オブジェクトには、論理データベース名、ユーザー ID、パスワード情報が設定されます。

PackageDatasourceConnection サインオンを使用するには、外部ネームスペースに対して認証を行うための Signon オブジェクトを追加する必要があります。これにより、ユーザーは、バッチ・モードでキューブを作成できるようになります。Transformer で IBM Cognos サインオンを自動的に使用するためには、Signon オブジェクトの AutoLogon プロパティーを有効にする必要があります。このサインオンでは、ユーザー ID、パスワード、および関連付けられているネームスペースが保持されます。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

タイプ

Signon (Cube オブジェクトおよび Cube Group オブジェクト)

String (PackageDatasourceConnection)

アクセス

Read/Write

例package = model.Packages.Add()connection= package.PackageDatasourceConnections.Add()connection.Signon= "great_outdoors_warehouse"

第 5 章 プロパティー 385

SignOnNamespace プロパティー

SignOnNamespace プロパティーには、IBM Cognos サインオンに関連付けられているセキュリティー・ネームスペースが含まれます。

構文

Signon .SignonNamespace

適用対象

Signon オブジェクト

解説

SignOnNamespace プロパティーは、IBM Cognos サインオン・タイプにのみ適用されます。

タイプ

ブール値

アクセス

Read/Write

例signon = model.Signons.Add()signon.SignOnNamespace ="Cognos"

Signons プロパティー

Signons プロパティーは、モデルの Signons コレクションを返します。

構文

Model .Signons

適用対象

モデル・オブジェクト

解説

Signon オブジェクトを追加または変更するには、最初に Signons コレクションを取得する必要があります。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

タイプ

オブジェクト

386 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

アクセス

読み取り

例signon = model.Signons.Add()

SignonType プロパティー

SignonType プロパティーは、サインオンのタイプ、xtrSignonType を設定するか、または設定状態を返します。

構文

Signon .SignonType

適用対象

Signon オブジェクト

解説

データ・ソース・サインオンおよび xtrSignonType に対してはtrDataSourceSignon が使用され、 IBM Cognos サインオンに対してはtrCognosSignon が使用されます。

タイプ

定数 - xtrSignonType

アクセス

Read/Write

例signon = model.Signons.Add()signon.SignonType = xtrSignonType.trDataSourceSignon

Size プロパティー

Size プロパティーは、列またはモデル・ファイル (.mdl) のサイズを設定するか、または設定状態を返します。

構文

object .Size

適用対象

Column オブジェクト

Model オブジェクト

第 5 章 プロパティー 387

解説

Column オブジェクトの場合、このプロパティーは、特定のデータ・ソースについて列のサイズをバイト単位で設定するか、または設定状態を返します。列のサイズは、データ・ソースの SourceType プロパティーがtrPowerHousePortable、trFixedAscii、または trFixedAsciiNoCRLF のときにのみ適用されます。

モデル・オブジェクトの場合、このプロパティーは、Windows フォルダーまたはWindows Explorer に表示されるファイルのサイズを返します。

タイプ

Long (Column)

String (Model)

アクセス

Read/Write (Column)

Read (Model)

例MsgBox(objModel.FileName & " " & .Size &" " & .Time)

SortComparisonRule プロパティー

SortComparisonRule プロパティーは、Transformer でカテゴリー名をソートするときに使用するテキストの比較規則を設定するか、または設定状態を返します。

構文

Application .SortComparisonRule

適用対象

Application オブジェクト

解説

Windows のコントロール・パネルにある「地域」の設定により決定される比較法、または各文字列のバイナリー表現を 1 バイトずつ比較する Transformer 内部の比較法のいずれかを選択できます。

このプロパティーの設定を既存のモデルについて変更した場合、新しい比較法は新規のカテゴリーにのみ適用されます。既存のカテゴリーは並べ替えません。このため、既存のカテゴリーと新規のカテゴリーのソートに一貫性がなくなることがあります。

Transformer でレベル内のカテゴリーをソートするには、ソート情報が含まれている Association オブジェクトを削除してから、新規に作成する必要があります。

388 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

レベル内のカテゴリーをソートするには、そのレベルの Association オブジェクトを作成し、AssociationRole プロパティーを trAssociationOrderBy に設定します。

このプロパティーには xtrPreferences の値を使用します。

タイプ

定数 - xtrPreferences

アクセス

Read/Write

例objTransApp.SortComparisonRule = xtrPreferences.trSortIgnoreControlPanel

SourceType プロパティー

SourceType プロパティーは、データ・ファイルのタイプを設定するか、または設定状態を返します。

構文

object .SourceType

適用対象

CrossTabDataSource オブジェクト

DataSource オブジェクト

DbDataSource オブジェクト

FlatFileDataSource オブジェクト

IqdDataSource オブジェクト

解説

モデルの各データ・ソース・オブジェクトは、データ・ファイルのタイプを参照します。このプロパティーと xtrSourceType の値を使用して、適切なソースを定義します。

データ・ソースをコレクションに追加する際は、Add メソッドの Type パラメーターに xtrObjectType 値リストの定数を指定します。例えば、スプレッドシート・ファイルを指定するには、Add メソッドで trCrossTabDataSource パラメーターを設定します。次に、SourceType プロパティーを使用して、Transformer でファイルを読み取る方法を指定します。この例では、スプレッドシート・ファイルがクロス集計ファイルかデータベース・ファイルかを、SourceType プロパティーで設定します。

第 5 章 プロパティー 389

タイプ

定数 - xtrSourceType

アクセス

Read/Write

例objDataSource= objModel.DataSources.Add(xtrObjectType.trFlatFileDataSource)objDataSource.SourceType= xtrSourceType.trFlatFileColumnNames

SpecialCategoryCount プロパティー

SpecialCategoryCount プロパティーは、ディメンションのドリル、ルート、および特殊カテゴリーの数を返します。

構文

object .SpecialCategoryCount

適用対象

DateDimension オブジェクト

Dimension オブジェクト

解説

このプロパティーは、ドリル、ルート、特殊カテゴリーのみカウントします。Category オブジェクトをカウントするには、CategoryCount プロパティーを使用します。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

タイプ

Long

アクセス

読み取り

SQLExpression プロパティー

SQLExpression プロパティーは、SQL 式を返します。

構文

IqdDataSource .SQLExpression

390 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

適用対象

IqdDataSource オブジェクト

解説

このプロパティーは、Impromptu クエリー定義ファイル (.iqd) の基礎になる SQL式を調べるために使用します。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

タイプ

文字列

アクセス

Read/Write

Status プロパティーStatus プロパティーは、キューブの前の作成ステータスを返します。

構文

object .Status

適用対象

ChildCube オブジェクト

Cube オブジェクト

CubeGroup オブジェクト

解説

ステータス情報は、キューブ作成を適格なキューブのみに制限するために使用します。例えば、警告が発行された全キューブには、CubeCreation プロパティーをFalse に設定できます。

Status プロパティーには、xtrCubeStatus の値を使用します。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

タイプ

定数 - xtrCubeStatus

アクセス

読み取り

第 5 章 プロパティー 391

StorageType プロパティーStorageType プロパティーは、数値データ型のサイズを設定するか、または設定状態を返します。

構文

object .StorageType

適用対象

Column オブジェクト

Measure オブジェクト

解説

StorageType は、Transformer でキューブを構築するために使用する作業ファイルで、数値データの値を保管する方法を指定するために使用します。xtrStorage 値リストから、ソース値に十分な大きさの定数を指定します。

集計とレコードの集約を処理するために十分な大きさの値を指定します。

タイプ

定数 - xtrStorage

アクセス

Read/Write

例objMeasure.StorageType = xtrStorage.trStorageDefault

StreamExtractAllowed プロパティーStreamExtractAllowed プロパティーは、ストリーム抽出が許可されるかどうかを設定するか、または設定状態を返します。ストリーム抽出は、SAP BW データ・ソースのみに適用されます。

構文

Query .StreamExtractAllowed

適用対象

Query オブジェクト

解説

このプロパティーは、SAP BW データ・ソース以外では無視されます。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

392 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

タイプ

ブール値

アクセス

Read/Write

StreamExtractSize プロパティーStreamExtractSize プロパティーは、StreamExtract が true に設定されている場合に SAP からのデータ転送に使用されるバッファーのサイズをメガバイト単位で設定するか、または設定状態を返します。

構文

Query .StreamExtractSize

適用対象

Query オブジェクト

解説

このプロパティーは、構造クエリーに対しては 0 に設定され、無視されます。

数値データを取得するように構成されているトランザクション・クエリーに対しては 10 に設定されます。

この値がゼロ (0) 以外で、すべての列の元データが適切である場合、データの読み取りにはストリーム抽出が使用されます。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

タイプ

Integer

アクセス

Read/Write

SummaryLevel プロパティーSummaryLevel プロパティーは、キューブ・グループの外部カテゴリーを集計するために使用するレベルを設定するか、または設定状態を返します。

構文

CubeGroup .SummaryLevel

第 5 章 プロパティー 393

適用対象

CubeGroup オブジェクト

解説

このプロパティーは、キューブ・グループに含まれる他のキューブのカテゴリーを要約するために使用します。

キューブ・グループの子キューブは、それぞれ 1 つのカテゴリーを表します。外部カテゴリーは、1 つの子キューブについて、その子キューブが参照するカテゴリーとその子孫カテゴリーを除くディメンション内の全カテゴリーです。PowerPlay では、キューブ・グループの他のキューブから、このプロパティーで指定したレベルまでデータを表示できます。

値を指定しないと、Transformer でキューブ・グループの各キューブから外部カテゴリーがすべて除外されます。

タイプ

オブジェクト

アクセス

Read/Write

例objCubesByRegion= objModel.Cubes.Add(xtrObjectType.trCubeGroup)objCubesByRegion.SummaryLevel= objRegionsDrill.Levels("Sales region")

SuppressNull プロパティーSuppressNull プロパティーは、SAP BW データ・ソースに使用される Null 消去オプションを設定するか、または設定状態を返します。

構文

Query .SuppressNull

適用対象

Query オブジェクト

解説

このオプションは、SAP BW データ・ソースにのみ適用されます。

クエリーによっては、Null 値が除外されていないためサイズが非常に大きくなる場合があります。Null 消去を実行すると、すべての値が Null (空白) の行または列が削除されます。Null 消去は SAP BW で実行します。これにより、Transformer に転送されるデータ量が減少し、パフォーマンスが向上します。

394 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

データ・ソースに Null 消去を適用する場合、データ取得時の Null 消去を制御します。これは、パッケージの発行時に Null 消去を適用する場合と異なります。後者の場合は、Null 値の表示のみを制御します。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

タイプ

Integer

アクセス

Read/Write

SuspendedModels プロパティーSuspendedModels プロパティーは、SuspendedModel オブジェクトのコレクションを返します。

構文

Application .SuspendedModels

適用対象

Application オブジェクト

解説

システム障害などのためにモデルが正常に閉じなかった場合、Transformer ではSuspendedModel オブジェクトが SuspendedModels コレクションに追加されます。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

タイプ

Object - SuspendedModels

アクセス

読み取り

例objSuspendedModel = objTransApp.SuspendedModels(intX)

TargetLevel プロパティー

TargetLevel プロパティーは、日付期間の詳細レベルを設定するか、または設定状態を返します。

第 5 章 プロパティー 395

構文

SpecialCategory .TargetLevel

適用対象

SpecialCategory オブジェクト

解説

特殊カテゴリーで、現在の期間を基準とする特定の期間の数値データを追跡します。

このプロパティーは、レポートの期間を指定するために使用します。例えば、目標期間を月に設定した場合、PowerPlay には月の期間が表示されます。

目標期間に関連する設定には、TargetOffset プロパティー、ContextLevel プロパティー、ContextOffset プロパティー、RunningPeriods プロパティーを使用します。例えば、目標期間が月の場合、各プロパティーで次の設問に答えます。

v 目標期間が現在の月か (TargetOffset)。

v 総括期間が四半期または年か (ContextLevel)。

v 総括期間が現在の四半期または年か (ContextOffset)。

v 目標期間がいくつあるか (RunningPeriods)。

タイプ

文字列

アクセス

Read/Write

例objSpecCategory= _ objModel.Dimensions("Time").Categories.Add(xtrObjectType.

trSpecialCategory)objSpecCategory.TargetLevel= "Month"

TargetOffset プロパティー

TargetOffset プロパティーは、現在の期間を基準とする目標期間の位置を設定するか、または設定状態を返します。

構文

SpecialCategory .TargetOffset

適用対象

SpecialCategory オブジェクト

396 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

解説

このプロパティーは、現在の期間を基準とする TargetLevel プロパティーのオフセット値を指定するために使用します。例えば、目標期間が月の場合、前月の特殊カテゴリーを作成するには TargetOffset を 1 に設定します。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

タイプ

Short

アクセス

Read/Write

例objSpecCategory= _ objModel.Dimensions("Time").Categories.Add(xtrObjectType.trSpecialCategory)objSpecCategory.TargetOffset= -1

ThousandPoint プロパティー

ThousandPoint プロパティーは、1000 の区切りに使用する文字を設定するか、または設定状態を返します。

構文

Object .ThousandPoint

適用対象

CrossTabDataSource オブジェクト

DbDataSource オブジェクト

FlatFileDataSource オブジェクト

IqdDataSource オブジェクト

解説

例えば、このプロパティーは次のことを実行するために使用します。

v 値内のコンマの指定。例:1,000。

v 値内のスペースの指定。例:1 000。

このプロパティーに NULL 文字 (文字なし) は使用できません。

タイプ

文字列

第 5 章 プロパティー 397

アクセス

Read/Write

Time プロパティー

Time プロパティーは、Windows のフォルダーまたは Windows Explorer に表示されるモデルのタイム・スタンプを返します。

構文

Model .Time

適用対象

Model オブジェクト

解説

このプロパティーは、モデルが最後に変更された日付をチェックするために使用します。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

タイプ

文字列

アクセス

読み取り

例MsgBox(objModel.FileName & " " & .Size &" " & .Time)

TimeArrayColumn プロパティー

TimeArrayColumn プロパティーは、日付配列の 1 列目の名前を設定するか、または設定状態を返します。

構文

Column .TimeArrayColumn

適用対象

Column オブジェクト

398 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

解説

日付配列は、四半期または月ごとのトランザクションの値を含む、連続した 4 列または 12 列のグループです。トランザクション・データを月または四半期ごとに保存する場合は、列を個別の数値データではなく、日付配列のメンバーとして定義することを推奨します。

日付列の各値は、会計年度の開始月を表します。トランザクションの各列は、月または四半期の期間に対応します。例えば、四半期レベルのレポートを作成する場合、データ・ソースには次のような行が保存されます。

DATE,PRODUCT,Q1,Q2,Q3,Q4

199901,Product1,100,200,150,400

199901,Product2,1110,2265,1995,4200

200001,Product1,110,210,160,420

時間ディメンションを作成した後、配列の 1 列目を取得し、同じ Column オブジェクトの Name プロパティーを使用して TimeArrayColumn を設定します。TimeArrayType プロパティーと TimeArrayStartMonth プロパティーも設定する必要があります。Transformer では、他の列が配列に自動的に追加され、データ・クラスが trDataClassArrayMember に設定されます。最後に、配列の最初のメンバーのみが Measures コレクションに追加されます。複数の配列がある場合は、各配列の最初のメンバーを Measures コレクションに追加します。

タイプ

文字列

アクセス

Read/Write

TimeArrayStartMonth プロパティー

TimeArrayStartMonth プロパティーは、日付配列の会計年度の開始月を設定するか、または設定状態を返します。

構文

Column .TimeArrayStartMonth

適用対象

Column オブジェクト

解説

日付配列は、四半期または月ごとのトランザクションの値を含む、連続した 4 列または 12 列のグループです。トランザクション・データを月または四半期ごとに保存する場合は、列を個別の数値データではなく、日付配列のメンバーとして定義することを推奨します。

第 5 章 プロパティー 399

このプロパティーには、配列の長さにかかわらず、年の開始月を指定します。

TimeArrayColumn プロパティーと TimeArrayType プロパティーも設定する必要があります。

タイプ

Long

アクセス

Read/Write

TimeArrayType プロパティー

TimeArrayType プロパティーは、日付値に使用する配列のタイプを設定するか、または設定状態を返します。

構文

Column .TimeArrayType

適用対象

Column オブジェクト

解説

日付配列は、四半期または月ごとのトランザクションの値を含む、連続した 4 列または 12 列のグループです。トランザクション・データを月または四半期ごとに保存する場合は、列を個別の数値データではなく、日付配列のメンバーとして定義することを推奨します。

このプロパティーには、月または四半期の配列を指定します。TimeArrayColumnプロパティーと TimeArrayStartMonth プロパティーも設定する必要があります。

TimeArrayType には、xtrTimeArrayType の値を使用します。

タイプ

定数 - xtrTimeArrayType

アクセス

Read/Write

TimeRank プロパティー

TimeRank プロパティーは、時間ディメンションに含まれる日付レベルの相対ランキングを設定するか、または設定状態を返します。

400 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

構文

DateLevel .TimeRank

適用対象

DateLevel オブジェクト

解説

ランキングの絶対値ではなく、他の日付値ランキングとの相対値が重要となります。時間ディメンションに DateLevel オブジェクトを追加する場合は、このプロパティーを前の日付レベルより大きい値に設定します。

Transformer のランク割り当てでは、前レベルのランクよりも 10 単位大きな値か、前レベルと次レベルの中間点か、いずれか小さい方が割り当てられます。

時間ディメンションに複数のドリルダウン・パスがある場合は、相対的なランクが明確でないレベルが生成されることがあります。同じランクを持つ同じディメンションの 2 つのレベルは、等価である (同じタイプの期間である) と仮定されます。この仮定は、レベルの名前やソース列が異なる場合にも適用されます。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

タイプ

Long

アクセス

Read/Write

TimeStamp プロパティーTimeStamp プロパティーは、Package オブジェクトまたは Report オブジェクトのタイム・スタンプを設定するか、設定状態を返します。

タイトル

object .TimeStamp

適用対象

Package オブジェクト

解説

このプロパティーは、パッケージまたはレポートのタイム・スタンプを提供または取得するために使用します。パッケージのタイム・スタンプの表示例は、次のとおりです。

/content/folder/[@name='Oracle']/package[@name='oracle_gosales']/model[@name='2008-04-24T17:46:18.796Z'

第 5 章 プロパティー 401

タイプ

文字列

アクセス

Read/Write

例new_package = model.Packages.Add()new_package.TimeStamp= "/content/package[@name='GO Data Warehouse (analysis)']" _& "/model[@name='" & timestamp & "']"

TimeStateRollup プロパティーTimeStateRollup プロパティーは、時状態データ集計に使用する日付期間を設定するか、または設定状態を返します。

構文

Measure .TimeStateRollup

適用対象

Measure オブジェクト

解説

集計は、カテゴリーが使用する数値データ値の値を集計します。時状態データ集計は、特定の時点における数値データの状態を表す方法です。

最初に、DateDegreeofDetail プロパティーを最下位の詳細度に設定します。例えば、ソース・ファイルに毎日のトランザクションが保存されている場合は、詳細度を日に設定します。次に、xtrTimeRollup 値リストの定数を使用して、TimeStateRollup を設定します。

RegularRollup プロパティーと TimeStateRollup プロパティーを両方とも使用すると、PowerPlay では、最初に標準集計が実行され、次に時状態データ集計が実行されます。ただし、標準集計は時間ディメンションに適用されません。

TimeStateRollup プロパティーを trTimeRollupAverage に設定する場合は、TimeStateWeight プロパティーも設定する必要があります。

CanAllocateMeasure プロパティー、Consolidate プロパティー、DuplicateRollupプロパティー、RollupTiming プロパティー、RegularRollup プロパティーの値は、数値データを集計する方法とタイミングに影響します。

タイプ

定数 - xtrTimeRollup

アクセス

Read/Write

402 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

TimeStateWeight プロパティー

説明

TimeStateWeight プロパティーは、加重平均の計算に使用する数値データの名前を設定するか、または設定状態を返します。

構文

Measure .TimeStateWeight

適用対象

Measure オブジェクト

解説

TimeStateWeight プロパティーは、集計数値データについて真の平均ではなく、加重平均を計算するために使用します。例えば、数値データ A と数値データ B の加重平均を計算する場合は、次の計算式を使用します。

∑ (Ai * Bi) / ∑ Bi

集計する数値データの TimeStateRollup プロパティーを trTimeRollupAverage に設定し、加重数値データとして指定する数値データの RegularRollup プロパティーを trRollupDefault または trRollupSum に設定する必要があります。

標準集計と時状態データ集計の両方に、加重平均を指定することはできません。

タイプ

文字列

アクセス

Read/Write

ToDateLevel プロパティー

ToDateLevel プロパティーは、期間累計に使用する日付期間を設定するか、または設定状態を返します。

構文

SpecialCategory .ToDateLevel

適用対象

SpecialCategory オブジェクト

第 5 章 プロパティー 403

解説

特殊カテゴリーで、現在の期間を基準とする特定の期間の数値データを追跡します。

ToDateLevel プロパティーは、レポートの期間を指定するために使用します。例えば、ToDateLevel プロパティーを四半期に設定すると、PowerPlay に四半期の期間が表示されます。このプロパティーを使用するには、Aggregate プロパティーをtrAggregateTodate または trAggregateTodateGrouped に設定する必要があります。

累計期間に関連する設定には、ContextLevel プロパティーと ContextOffset プロパティーを使用します。例えば、累計期間が四半期の場合、各プロパティーで次の設問に答えます。

v 総括期間が四半期または年か (ContextLevel)。

v 総括期間が現在の四半期または年か (ContextOffset)。

タイプ

文字列

アクセス

Read/Write

TransdaPath プロパティーTransdaPath プロパティーは、"transda.exe"実行可能ファイルの場所を設定するか、または設定状態を返します。この実行ファイルは、Transformer アプリケーションのインストール時にインストールされます。インストール場所は、"<インストール先ディレクトリー>/CS7Gateways/bin"です。<インストール先ディレクトリー>の例を次に示します。

構文c:\Program Files\Cognos\

Application .TransdaPath

適用対象

Application オブジェクト

解説

このプロパティーは、Transformer が"transda.exe"ファイルを検索する場所を指定するために使用します。

タイプ

文字列

404 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

アクセス

Read/Write

TransformerSignon プロパティーTransformerSignon プロパティーは、パッケージ・データ・ソース接続 (IBMCognos サインオン) に関連付けられた Transformer Signon オブジェクトを設定するか、または設定状態を返します。

構文

PackageDatasourceConnection .TransformerSignon

適用対象

PackageDatasourceConnection オブジェクト

解説

PackageDatasourceConnection サインオンを使用するには、外部ネームスペースに対して認証を行うための Signon オブジェクトを追加する必要があります。これにより、ユーザーは、バッチ・モードでキューブを作成できるようになります。Transformer で IBM Cognos サインオンを自動的に使用するためには、Signon オブジェクトの AutoLogon プロパティーを有効にする必要があります。このサインオンでは、ユーザー ID、パスワード、および関連付けられているネームスペースが保持されます。AlwaysUseTransformerSignon プロパティーが True に設定されている場合は、Signon プロパティーの代わりにこの値が使用されます。

タイプ

String (PackageDatasourceConnection)

アクセス

Read/Write

例package= model.Packages.Add()connection= package.PackageDatasourceConnections.Add()connection.TransformerSignon= "great_outdoors_warehouse"

Type プロパティー

Type プロパティーは、オブジェクトのタイプを返します。

構文

object .Type

第 5 章 プロパティー 405

適用対象

45 ページの『Application オブジェクト』

Association オブジェクト

CalculationDefinition オブジェクト

Category オブジェクト

CategorySet オブジェクト

ChildCube オブジェクト

Column オブジェクト

CrossTabDataSource オブジェクト

Cube オブジェクト

CubeGroup オブジェクト

CurrencyRate オブジェクト

CurrencyRecord オブジェクト

CurrencyTable オブジェクト

CustomView オブジェクト

DataSource オブジェクト

DateDimension オブジェクト

DateDrillDown オブジェクト

DateLevel オブジェクト

DateWizard オブジェクト

DbDataSource オブジェクト

Dimension オブジェクト

DrillDown オブジェクト

DrillThroughTarget オブジェクト

FlatFileDataSource オブジェクト

IqdDataSource オブジェクト

Level オブジェクト

Measure オブジェクト

406 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

Model オブジェクト

Name オブジェクト

Package オブジェクト

Prompt オブジェクト

117 ページの『Report オブジェクト』

SecurityObject オブジェクト

Signon オブジェクト

SpecialCategory オブジェクト

SuspendedModel オブジェクト

View オブジェクト

解説

このプロパティーは、オブジェクトのタイプを決定するために使用します。この戻り値は、複数タイプのオブジェクトを含むコレクションからオブジェクトを取得するときに便利です。例えば、Dimensions コレクションからは、Dimension オブジェクトまたは DateDimension オブジェクトが返されます。

Transformer の DataSource オブジェクトを除く各オブジェクトの Type プロパティーの値は、xtrObjectType の定数に対応します。DataSource オブジェクトのType プロパティーの値は、DataSource オブジェクトが現在表しているDataSources コレクションのオブジェクトにより設定されます。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

タイプ

定数 - xtrObjectType

アクセス

読み取り

例new_namespace= model.Namespaces.Add()securityObject= new_namespace.SecurityObjects.Add()securityObject.Type= xtrSecurityType.trSecurityType_Role

Unique プロパティー

Unique プロパティーは、レベルの各カテゴリーを一意なソース値で識別できるかどうかを設定するか、または設定状態を返します。

第 5 章 プロパティー 407

構文

object .Unique

適用対象

DateLevel オブジェクト

Level オブジェクト

解説

レベルが代替ドリルダウン・パスの収束レベルであるとき、またはモデルに複数のデータ・ソースが含まれる場合は、レベルの一意性を指定します。

このプロパティーを True に設定すると、レベル内のカテゴリーをソース値のみで(先祖を参照しないで) 識別することが Transformer に通知されます。レベル内の 2つのカテゴリーが同じ値を持つことはできません。

レベルの列を含むデータ・ソースが先祖レベルに必要な列もすべて含む場合は、一意性を指定する必要はありません。この場合、Transformer では、データ・ソース内の他の列からレベルのカテゴリーを識別できます。ただし、先祖レベルの列が別のデータ・ソースにある場合は、先祖レベル内のカテゴリーの値に一意性を指定する必要があります。

カテゴリーが一意であることを示すと、一意性の検証は行われません。このため、事実に反してレベルが一意であると認識された場合、不正なディメンションが作成されます。

一意のレベルからカテゴリーを移動すると、移動したカテゴリーのコンテキストが変わるため、カテゴリー生成時に唯一性の違反が報告されます。この問題に対処するには、UniqueMove プロパティーを使用します。

デフォルト:False

タイプ

ブール値

アクセス

Read/Write

例objLocationsDim= objModel.Dimensions("Sales regions")objLevel= objLocationsDim.DrillDowns(1).Levels("Employee")objAltDrill= objLevel.CreateAlternateDrillDownobjNewLevel= objAltDrill.Levels.Add(xtrObjectType.trLevel)objNewLevel.Unique= True

408 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

UniqueMove プロパティー

UniqueMove プロパティーは、カテゴリーを移動するときに一意のレベルを扱う方法を設定するか、または設定状態を返します。

構文

object .UniqueMove

適用対象

DateLevel オブジェクト

Level オブジェクト

解説

UniqueMove プロパティーは、一意のレベルのカテゴリーを、ソース・データの変更に合わせて手動で再構築する必要がないように設定するために使用します。一意のレベルからカテゴリーを移動すると、移動したカテゴリーのコンテキストが変わるため、カテゴリー生成時に一意性違反が発生することがあります。

このような変更を一意な移動として扱うように指定するには、このプロパティーをTrue に設定します。設定後は、古いデータ構造で蓄積されたものも含め、数値データ値の値が移動先のカテゴリーへの新しいパスに自動集計されます。

このプロパティーは、Unique プロパティーを True に設定したレベルでのみ使用できます。

デフォルト:False

タイプ

ブール値

アクセス

Read/Write

例objLocationsDim = objModel.Dimensions("Sales regions")objLevel = objLocationsDim.DrillDowns(1).Levels("Employee") objLevel.UniqueMove= True

UseAltMDCFile プロパティー

UseAltMDCFile プロパティーは、一時ファイル名を使用できるかどうかを設定するか、または設定状態を返します。

構文

object .UseAltMDCFile

第 5 章 プロパティー 409

適用対象

Cube オブジェクト

CubeGroup オブジェクト

ChildCube オブジェクト

解説

UseAltMDCFile プロパティーは、キューブを代替ファイル名を使用して保存できるかどうかの確認に使用します。

このプロパティーを「True」に設定すると、オブジェクトを一時ファイル名で保存できます。このプロパティーは、Cube オブジェクト、CubeGroup オブジェクト、ChildCube オブジェクトに使用できます。

IsMDCInUse プロパティーで「True」が返される場合、キューブは別のアプリケーションで使用中です。この場合は、UseAltMDCFile プロパティーを「True」に設定し、AltMDCFile プロパティーに代替ファイル名を指定できます。

デフォルト:False

タイプ

ブール値

アクセス

Read/Write

User プロパティー

User プロパティーは、ネームスペースに関連付けられているユーザー名を設定するか、設定状態を返します。

構文

Namespace .User

適用対象

Namespace オブジェクト

解説

このプロパティーは、UserCAMID プロパティーからユーザーの CAMID を取得するためにユーザー名を設定するために使用します。

タイプ

文字列

410 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

アクセス

Read/Write

例new_namespace = model.Namespaces.Add()new_namespace.User= Name_of_User

UserCAMID プロパティー

UserCAMID プロパティーは、Signon オブジェクトのユーザー ID を設定するか、または設定状態を返します。

構文

Namespace .UserCAMID

適用対象

Namespace オブジェクト

解説

このプロパティーは、ネームスペースに含まれるユーザーの CAMID を取得するために使用します。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

タイプ

文字列

アクセス

読み取り

例new_namespace = model.Namespaces.Add()CAMID_of_User = new_namespace.UserCAMID

UserID プロパティー

UserID プロパティーは、サインオンのユーザー ID を設定するか、または設定状態を返します。

構文

Signon .UserID

適用対象

Signon オブジェクト

第 5 章 プロパティー 411

解説

Transformer では、Signon オブジェクトの情報を使用して、保護されたデータベースに自動的にアクセスします。次の場合には、このプロパティーの値を変更できません。

v Signon オブジェクトが IBM Cognos Signon オブジェクトである

v Impromptu クエリー定義ファイル (.iqd) サインオンを参照している

タイプ

文字列

アクセス

Read/Write

例signon = model.Signons.Add()signon.UserID = "sa"

Value プロパティー

Value プロパティーは、プロンプトのタイプを設定するか、または設定状態を返します。

構文

Prompt .Value

適用対象

Prompt オブジェクト

解説

このプロパティーは、Prompt オブジェクトの CurrentValueIndex に関連付けられているプロンプト値を設定または取得するために使用します。

タイプ

文字列

アクセス

Read/Write

例new_report = model.Reports.Add()new_query = new_report.Queries.Add()new_prompt.Value= "2005-01-01"

ValuesCount プロパティー

ValuesCount プロパティーは、プロンプトに設定されている値の数を返します。

412 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

構文

Prompt .ValuesCount

適用対象

Prompt オブジェクト

解説

このプロパティーは、CurrentValueIndex プロパティーとともに使用して、プロンプト値を繰り返すために使用します。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

タイプ

Integer

アクセス

読み取り

例new_report = model.Reports.Add()new_query= new_report.Queries.Add()new_prompt.CurrentValueIndex= indexFor index = 1 To new_prompt.ValuesCount

Version プロパティー

Version プロパティーは、Transformer のバージョン番号を返します。

構文

Application .Version

適用対象

Application オブジェクト

解説

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

タイプ

文字列

アクセス

読み取り

第 5 章 プロパティー 413

Views プロパティー

Views プロパティーは、ディメンション、時間ディメンションまたはビューに関連付けられた View オブジェクトのコレクションを返します。

構文

object .Views

適用対象

CustomView オブジェクト

DateDimension オブジェクト

Dimension オブジェクト

解説

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

タイプ

オブジェクト

アクセス

読み取り

例objView = objDimension.Views.Add()

ViewType プロパティー

ViewType プロパティーは、ビューに、ディメンション内のすべてのカテゴリーを含めるか、一部のカテゴリーを含めるか、またはディメンション内のカテゴリーを含めないかを設定するか、または設定状を返します。

構文

View .ViewType

適用対象

View オブジェクト

解説

デフォルトでは、ディメンション・ビューのタイプは trViewTypeAllCategories になります。

414 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

カスタム・ビューを定義するには、ViewType プロパティーを trViewTypeCustomに設定します。これにより、次の操作を実行できます。

v Apex プロパティーを使用して、1 つのカテゴリーおよび子カテゴリーのビューを作成する

v SetViewStatus メソッドを使用して、カテゴリーまたはレベルのビューを定義する

ViewType プロパティーには、xtrViewType の値を使用します。

タイプ

定数 - xtrViewType

アクセス

Read/Write

例objProductsDim = objModel.Dimensions.Item("Products")objViewItem.ViewType= xtrViewType.trViewTypeCustom

WeekAdd プロパティー

WeekAdd プロパティーは、月暦年に追加する日数を設定するか、または設定状態を返します。

構文

object .WeekAdd

適用対象

DateDrillDown オブジェクト

DateWizard オブジェクト

解説

月暦年の期間を使用する場合、1 年は、各 7 日の 52 週からなります。したがって、月暦の 1 年は 364 日で、暦年に比べて通常 1 日、うるう年で 2 日短くなります。

このプロパティーは、月暦年に 1 週を追加するために使用します。この操作により、月暦年と暦年を同期させます。4 日から 7 日までの余分な週を指定できます。追加しないことも指定できます。

この余分な週は、年の最後の月または四半期に追加されます。これにより、各月暦年で指定した年開始日を使用する一方で、暦年との差を最小に保つことができます。

第 5 章 プロパティー 415

年の最後の月暦月が xtrSpecialFunction に設定された 4-4-5 パターンの 5 週に当たる場合、四半期の余分な週は、Transformer で無効な 4-4-6 パターンではなく4-5-5 パターンとなるように、前の月暦月に追加されます。

このプロパティーには、xtrWeekAdd の値を使用します。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

タイプ

定数 - xtrWeekAdd

アクセス

Read/Write (DateDrillDown)

Write (DateWizard)

例objDateWizard= objModel.DateWizardobjDateDim= objDateWizard.CreateDateDimension()objDrillDown= objDateDim.DrillDowns(1)objDrillDown.WeekAdd= xtrWeekAdd.trWeekAddDays4

WeekSpan プロパティー

WeekSpan プロパティーは、2 つの年にまたがる週を扱う方法を設定するか、または設定状態を返します。

構文

object .WeekSpan

適用対象

DateDrillDown オブジェクト

DateWizard オブジェクト

解説

時間ディメンションの暦年に週レベルがある場合、最後の週と年の最後の日が一致しないことがあります (月暦の年は、常に週の終わりが最終日になります)。WeekSpan には、最後の週をシフトまたは分割する方法を指定します。

このプロパティーには、xtrWeekSpan の値を使用します。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

416 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

タイプ

定数 - xtrWeekSpan

アクセス

Read/Write (DateDrillDown)

Write (DateWizard)

例objDateWizard = objModel.DateWizardobjDateWizard.WeekSpan= xtrWeekSpan.trWeekSpanNone

WeekStart プロパティー

WeekStart プロパティーは、週の開始日を設定するか、または設定状態を返します。

構文

DateDrillDown .WeekStart

適用対象

DateDrillDown オブジェクト

解説

モデルに週レベルが含まれる場合、Transformer では、このプロパティーを使用して週の開始日が決定されます。

このプロパティーには、xtrWeekDay の値を使用します。

四半期以下の詳細レベルが含まれる月暦の時間ディメンションに代替ドリルダウン・パスを作成する場合は、WeekStart プロパティーと WeekAdd プロパティーを並べる必要があります。

時間ディメンションの代替ドリルダウン・パスについては、Transformer オンライン・ヘルプを参照してください。

タイプ

定数 - xtrWeekDay

アクセス

Read/Write

第 5 章 プロパティー 417

例objDateWizard= objModel.DateWizardobjDateDim= objDateWizard.CreateDateDimension()objDrillDown= objDateDim.DrillDowns(1)objDrillDown.WeekStart= xtrWeekDay.trMonday

WeekStartDay プロパティーWeekStartDay プロパティーは、週の開始日を設定します。

構文

DateWizard .WeekStartDay

適用対象

DateWizard オブジェクト

解説

DateWizard オブジェクトを使用して週レベルを含む時間ディメンションを構築する場合、Transformer では、このプロパティーの設定を使用して週のカテゴリーが定義されます。例えば、このプロパティーを trSunday に設定すると、日曜日が週の開始日になります。

このプロパティーには、xtrWeekDay の値を使用します。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

タイプ

定数 - xtrWeekDay

アクセス

Write

例objDateWizard = objModel.DateWizardobjDateWizard.WeekStartDay= xtrWeekDay.trMonday

WorkingDay プロパティー

WorkingDay プロパティーは、週日かどうかを設定するか、または設定状態を返します。

構文

object .WorkingDay(WeekDay)

418 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

適用対象

DateDimension オブジェクト

DateWizard オブジェクト

解説

WorkingDay プロパティーは、週日を各曜日ごとに設定するために使用します。これに対して、複数の週日を一度に設定するには、WorkingDays プロパティーを使用します。WorkingDays プロパティーと WorkingDay プロパティーを両方とも使用して、週日を定義することもできます。

時間ディメンションに週レベルが含まれる場合、Transformer では、WorkingDayプロパティーと WorkingDays プロパティーで指定した曜日のカテゴリーが生成されます。

このプロパティーには、xtrWeekDay の値を使用します。

デフォルト:False

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

パラメーター 説明

WeekDay 必須。xtrWeekDay の値を指定します。

タイプ:定数

タイプ

ブール値

アクセス

Read/Write (DateDimension)

Write (DateWizard)

例objDateWizard = objModel.DateWizardobjDateWizard.WorkingDays(127)

WorkingDays プロパティー

WorkingDays プロパティーは、週日を設定するか、または設定状態を返します。

構文

object .WorkingDays(WeekDays)

第 5 章 プロパティー 419

適用対象

DateDimension オブジェクト

DateWizard オブジェクト

解説

WorkingDays プロパティーは、週日の曜日を 1 つの命令文でまとめて指定するために使用します。これに対して、週日を各曜日ごとに指定するには、WorkingDayプロパティーを使用します。

時間ディメンションに週レベルが含まれる場合、Transformer では、WorkingDaysプロパティーと WorkingDay プロパティーで指定した曜日のカテゴリーが生成されます。

WeekDays パラメーターには、プラス記号 (+) で結合した xtrWeekday の値、次の数値の 1 つまたは 2 つ以上の合計を指定できます。

v 日曜日 = 1

v 月曜日 = 2

v 火曜日 = 4

v 水曜日 = 8

v 木曜日 = 16

v 金曜日 = 32

v 土曜日 = 64

例えば、月曜日から金曜日までを週日に指定するには「62」(2、4、8、16、32 の合計) または「trMonday+trTuesday+trWednesday+trThursday+trFriday」と入力します。

7 日すべてを指定する場合には「127」と入力します。WorkingDays プロパティーと WorkingDay プロパティーの両方を使用すると、週日を定義できます。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

パラメーター 説明

WeekDays 必須。プラス記号 (+) で結合した xtrWeekday の値、または各曜日に割り当てられている数値の 1 つ以上の合計を指定します。

注: プラス記号で結合された別の xtrWeekday を追加する方法は、使用されている導入言語に応じて異なります。例えば C# では、次のようにします。

(int) xtrWeekDay.trMonday+ (int) xtrWeekDay.trWednesday+ (int) xtrWeekDay.trFriday;

タイプ:Long

420 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

タイプ

Long

アクセス

Read/Write (DateDimension)

Write (DateWizard)

例objDateWizard = objModel.DateWizardobjDateWizard.WorkingDays(127)

YearStartDay プロパティー

YearStartDay プロパティーは、年の開始日を設定するか、または設定状態を返します。

構文

object .YearStartDay

適用対象

DateDrillDown オブジェクト

DateWizard オブジェクト

解説

このプロパティーは、会計年度や月暦年など、1 月 1 日以外の年の開始日を指定するために使用します。

月暦年には 365 日ではなく 52 週が含まれるため、YearStartDay プロパティーとWeekStart プロパティーを一致させる必要があります。例えば、YearStartDay を20000104 に設定した場合、WeekStart の値は trMonday でなければなりません。

日付は、YYYYMMDD 書式で指定します。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

タイプ

Long

アクセス

Read/Write (DateDrillDown)

Write (DateWizard)

第 5 章 プロパティー 421

例objDateWizard = objModel.DateWizardobjDateDim= objDateWizard.CreateDateDimension()objDrillDown= objDateDim.DrillDowns(1)objDrillDown.YearStartDay = 19900101

YearType プロパティー

YearType プロパティーは、時間ディメンションの年レベルを計算する方法を設定します。

構文

DateWizard .YearType

適用対象

DateWizard オブジェクト

解説

このプロパティーは、年を暦年または月暦年として定義するために使用します。

YearType プロパティーには、xtrSpecialFunction の値を使用します。

エラーの場合は COM 例外が発生します。例外とともに渡されるメッセージは、エラーの状態によって異なります。

タイプ

定数 - xtrSpecialFunction

アクセス

Write

例objDateWizard = objModel.DateWizardobjDateWizard.YearType= xtrSpecialFunction.trSpecialFunctionYear

422 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

第 6 章 定数

定数とは、式の中で使用できる固定の値のことです。

xtrAllocationType 値リストモデルで数値データを割り当てる方法を決定します。

適用対象

AllocationType プロパティー

SetAllocation メソッド

解説

この値リストの定数は、DateDimension、Dimension、DateLevel、Level、Category、SpecialCategory オブジェクトの AllocationType プロパティーや SetAllocation メソッドとともに使用します。

xtrAllocationType の定数を割り当てない場合、Category または SpecialCategoryオブジェクトは関連する Level オブジェクトまたは DateLevel オブジェクトの設定を継承し、Level オブジェクトまたは DateLevel オブジェクトは関連するDimension オブジェクトまたは DateDimension オブジェクトからデフォルトの設定を継承します。

Transformer では、モデルに複数のデータ・ソースが含まれている場合、自動的に1 つのデータ・ソースの数値データが別のデータ・ソースと関連付けられているレベルおよびカテゴリーに割り当てられます。この場合、数値データ値は、ディメンション全体に定数として割り当てられます。これは、trAllocationConstant を使用することと同じです。デフォルトの割り当ては、trAllocationNA を使用して元に戻すことができます。

数値データは、別の数値データの値に基づいて比例するように割り当てることができます。この場合は、タイプを trAllocationByAnotherMeasure に設定し、SetAllocation メソッドに別の数値データを指定します。

レベルの割り当てタイプを設定する場合、新しい割り当てタイプは、そのレベルのカテゴリーから子孫カテゴリーすべてに適用されます。

定数 説明

trAllocationByAnotherMeasure 別のオブジェクトの値に基づいて割り当てます。数値データ値の値を、別の数値データ値の値を使用して比例するように子孫カテゴリーに割り当てることができます。

423

定数 説明

trAllocationConstant 現在のカテゴリーと関連付けられている数値データ値を子孫カテゴリーすべてに定数として使用します。

trAllocationDefault 上位レベルのオブジェクトに設定されている割り当てを使用します。

trAllocationNA 数値データを割り当てません。

xtrAssociationRole 値リストAssociation オブジェクトの役割を決定します。

適用対象

140 ページの『AssociateWith メソッド』

218 ページの『AssociationRole プロパティー』

152 ページの『DimensionAssociateWith メソッド』

解説

この値リストの定数は、Association オブジェクトの AssociationRole プロパティーや、AssociateWith メソッドおよび DimensionAssociateWith メソッドとともに使用します。

Association オブジェクトは、モデル・オブジェクトとその基礎になるデータ・ソースとの関連を定義します。関連にはそれぞれ役割があります。多くの場合、定数trAssociationSource のようにデータのソース・データとしての役割を果たします。他の役割もあります。関連の役割は、データの性格に制限されます。xtrAssociationRole の定数は、ソース・データの項目すべてに適用されるものではありません。

定数 説明

trAssociationCategoryCode 一意のカテゴリー・コードのソースとして機能します。

trAssociationCountryCode 通貨の国または地域のコードのソースとして機能します。

trAssociationCurrencyDate 通貨日付のソースとして機能します。

trAssociationDescription 説明のソースとして機能します。

trAssociationDrillThrough ドリルスルー情報のソースとして機能します。

trAssociationLabel ラベルのソースとして機能します。

trAssociationOrderBy ソート情報のソースとして機能します。

trAssociationRate 通貨レートのソースとして機能します。

trAssociationRoleNone (デフォルト) 関連設定しません。

trAssociationShortName 短縮名のソースとして機能します。

trAssociationSource データのソースとして機能します。

424 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

xtrAssociationType 値リストAssociation オブジェクトのタイプを決定します。

適用対象

AssociationType プロパティー

解説

この値リストの定数は、Association オブジェクトのタイプを決定するために、Association オブジェクトの AssociationType プロパティーとともに使用します。

定数 説明

trAssociationQuery データ・ソースとの関連を表します。

trAssociationTypeNone (デフォルト) 関連がありません。

xtrCharacterType 値リストオブジェクトで使用する文字セットを決定します。

適用対象

CharacterType プロパティー

DataCharacterSet プロパティー

解説

この値リストの定数は、Transformer で使用する文字セットを指定するためにApplication オブジェクトとともに、またはデータ・ソースで使用する文字セットを指定するために FlatFileDataSource オブジェクトとともに使用します。

定数 説明

trCharAnsiDoubleByte 作成元の Windows アプリケーションが全角文字を使用することを指定します。

trCharAnsiSingleByte 作成元の Windows アプリケーションが全角文字を使用しないことを指定します。

trCharDefault デフォルトの設定 trCharAnsiDoubleByte が有効なことを指定します。

trCharOEM 作成元の DOS または OS/2 アプリケーションが、標準の IBM PC 文字セットを使用することを指定します。

第 6 章 定数 425

定数 説明

trUnicode 作成元の Windows アプリケーションが全角文字 UTF-8 を使用することを指定します。

xtrCubeConsolidate 値リスト現在のキューブについて集約の設定を決定します。

適用対象

Consolidate プロパティー

解説

この値リストの定数は、集約の方法を決定するために、Cube オブジェクト、ChildCube オブジェクト、および CubeGroup オブジェクトの Consolidate プロパティーとともに使用します。集約プロセスは、同一の非数値データ値の値を 1 つのレコードに自動集約し、数値データ値の値を集約します。

キューブ・グループの場合、Consolidate プロパティーは、グループの各キューブについてデフォルトの集約を設定します。DuplicateRollup プロパティーがtrDuplicateRollupNone 以外の値に設定されていれば、定数 trConsolidateNO が有効の場合でも集約が行われます。

定数 説明

trConsolidateDefault 有効と考えられる場合、またはデータが他の理由によりソートされている場合に、元レコードを集約します。

trConsolidateNO 集約しません。

trConsolidatePresorted 重複データを集約するが、ソース・ファイルはソートしません。

trConsolidateYES ソース・ファイルをソート、重複データを集約します。

xtrCubeCreation 値リストキューブを作成の対象として選択する方法を決定します。

適用対象

CubeCreation プロパティー

解説

この値リストの定数は、CreateMDCFile メソッドまたは CreateMDCFiles メソッドを実行するときに作成するキューブを決定するために、Cube オブジェクト、CubeGroup オブジェクト、ChildCube オブジェクトの CubeCreation プロパティーとともに使用します。これらの定数は、現在のモデルからキューブ作成の対象と

426 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

して選択する PowerCube を決定します。例えば、trCubeCreationOFF を使用すると、作成の対象が更新されたキューブのみに制限され、キューブの作成が最適化されます。

xtrCubeStatus 値リストにも、作成の対象として選択するキューブを制限する定数があります。

定数 説明

trCubeCreationDefault 最上位のキューブに親キューブの設定またはON を使用します。

trCubeCreationOFF 最後の更新以後にデータが変更されていない場合は、キューブを選択しません。

trCubeCreationON キューブを選択します。ChildCube オブジェクトには無効です。

xtrCubeOptimize 値リストキューブの最適化の設定を決定します。

適用対象

Optimize プロパティー

解説

この値リストの定数は、PowerCube および Transformer のパフォーマンスを向上させるために、Cube オブジェクト、CubeGroup オブジェクト、ChildCube オブジェクトの Optimize プロパティーとともに使用します。これらの定数は、最適化の設定を表します。

キューブ・サイズ、Transformer の処理時間、PowerPlay のアクセス時間は、すべて選択した最適化の設定に影響されます。使用するモデルおよびデータに最適な設定を選択します。

定数 説明

trOptimizeAutoPartition 自動パーティション機能が使用可能なことを指定します。この設定は、Transformer 6.0以降のバージョンで作成されたモデルのデフォルト設定です。

第 6 章 定数 427

定数 説明

trOptimizeCategories キューブのカテゴリー数を最小化する。データ・ソースで参照するカテゴリーまたは特に含めることを指定したカテゴリーのみを追加します。キューブごとに必要なカテゴリーを検索するための余分なデータ・パスがあります。これは、Transformer 6.0 より前のバージョンで作成されたモデルのデフォルトです。

trOptimizeDataPasses キューブ作成時の一時作業ファイルを使用するパス数を最適化します。全カテゴリーを結果のキューブに含めます。ただし、直接参照しないカテゴリーまたは先祖を介して間接的に参照するカテゴリーは、PowerPlay に表示されません。

trOptimizeDefault モデルの作成に使用した Transformer のバージョンに適用されるデフォルトを設定します。

trOptimizeDirectCreate データ・ソースを処理する前に、モデル内の全カテゴリーをキューブに追加する。新規カテゴリーの生成が少ないモデルや、全カテゴリーをキューブに追加する場合に最適です。キューブ・グループの各キューブには適用されません。

xtrCubeStatus 値リスト最後のキューブ作成ステータスを決定します。

適用対象

Status プロパティー

解説

この値リストの定数は、次に CreateMDCFile メソッドまたは CreateMDCFiles メソッドを実行するときに対象とするキューブを制限するために、Cube オブジェクト、CubeGroup オブジェクト、ChildCube オブジェクトの Status プロパティーとともに使用します。一般に、これらの定数は、正しく機能していないキューブを制限したり、過去に失敗したキューブを再作成の対象として選択します。

xtrCubeCreation 値リストにも、キューブを制限する定数があります。

定数 説明

trCubeStatusBUSY キューブが現在更新されていることを示します。

428 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

定数 説明

trCubeStatusFAILED 最後のキューブ更新時にキューブが正しく更新されなかったことを示します。

trCubeStatusINVALID キューブがモデルと矛盾していることを示します。

trCubeStatusMISSING キューブが存在していたが見つからない、または開けないことを示します。

trCubeStatusNEW キューブがモデルで定義されているが、作成されていないことを示します。

trCubeStatusOK キューブが存在し、エラーがないことを示します。

trCubeStatusWARNINGS キューブが存在するが、作成時または最後の更新時に警告が発行されたことを示します。

xtrCurrencyTableType 値リスト通貨表が基準通貨またはユーロに適用されるかどうかを決定します。

適用対象

CurrencyTableType プロパティー

解説

この値リストの定数は、使用する通貨表のタイプを決定するために、CurrencyTableオブジェクトの CurrencyTableType プロパティーとともに使用します。

定数 説明

trCurrencyTableBase 基準通貨レートに対して他の通貨を変換するテーブルを指定します。

trCurrencyTableEuro ユーロ通貨レートに対して他の通貨を変換するテーブルを指定します。

trCurrencyTableOther 使用している通貨表が基準またはユーロ以外であることを指定します。

xtrDataClass 値リスト列のデータ・クラスを決定します。

適用対象

DataClass プロパティー

解説

この値リストの定数は、データ・ソースに割り当てられたデータ値のタイプを決定するために、Column オブジェクトの DataClass プロパティーとともに使用します。

第 6 章 定数 429

定数 説明

trDataClassArrayMember データ・クラスに配列の各要素のデータが含まれることを指定します。

trDataClassDate xtrDateFormat 値リストに書式が定義されている日付の値がデータ・クラスに含まれることを指定します。

trDataClassDefault モデルのデータ・クラスを指定しません。Transformer では、データ・ソースにデータ型の定義がある場合、そのデータ型が使用されます。

trDataClassDescription データ・クラスにテキスト (ラベルなど) または英数字の値 (コードなど) が含まれることを指定します。

trDataClassIgnore ソースの内容を無視し、処理しないことを指定します。

trDataClassQuantity データ・クラスにパフォーマンス・インディケーターとして使用される数量を表す数値が含まれることを指定します。

xtrDateCategoriesGeneration 値リスト日付レベルに生成するカテゴリーを決定します。

適用対象

GenerateCategories プロパティー

解説

この値リストの定数は、DateLevel オブジェクトの GenerateDateCategories プロパティーとともに使用します。

定数 説明

trGenerateDatesAll 全カテゴリーを生成することを指定します。

trGenerateDatesDefault 各レベルのデフォルトを使用することを指定します。各ドリルダウン・パスの最上位レベルを除く全レベルに trGenerateDatesAll が適用されます。最上位レベルにはtrGenerateDatesNone が適用されます。

trGenerateDatesNeed キューブで必要なカテゴリーのみをデータ・ソースから生成することを指定します。

trGenerateDatesNone カテゴリーを生成しないことを指定します。

xtrDateFormat 値リスト列の日付入力書式を決定します。

430 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

適用対象

DateInputFormat プロパティー

解説

この値リストの定数は、データ・ソースに既定値の日付書式がないときにTransformer で使用するデフォルトの日付書式を決定するために、Column オブジェクトの DateInputFormat プロパティーとともに使用します。日付に月が含まれる場合、月の部分はデータ・ソースにより 2 桁の数値または 3 文字の省略形になります。

定数 説明

trPredefined (デフォルト) 日付書式にデータ・ソースの既定値を指定します。

trD 日付書式に日:DD を指定します。

trDMY 日付書式に日 - 月 - 年:DDMMYYYY を指定します。

trM 日付書式に月:MM を指定します。

trMDY 日付書式に月 - 日 - 年:MMDDYYYY を指定します。

trMY 日付書式に月 - 年:MMYYYY を指定します。

trQ 日付書式に第 1~4 四半期を示す 1 桁の数字 Q を指定します。

trW 日付書式に週を指定します。

trY 日付書式に年:YYYY を指定します。

trYM 日付書式に年 - 月:YYYYMM を指定します。

trYMD 日付書式に年 - 月 - 日:YYYYMMDD を指定します。

xtrDateLevel 値リスト日付レベルの詳細度を決定します。

適用対象

DateDegreeofDetail プロパティー

解説

この値リストの定数は、Column オブジェクトの DateDegreeofDetail プロパティーとともに使用します。

これらの定数は、数値データをレポートできる最小日付レベル (詳細度) を定義します。レベルを設定すると、ディメンションに含まれる数値データのレポートがそのレベルの詳細度までに制限されます。

第 6 章 定数 431

定数 説明

trDateLevelDay 詳細度が日であることを指定します。

trDateLevelMonth 詳細度が月であることを指定します。

trDateLevelQuarter 詳細度が四半期であることを指定します。

trDateLevelUnspecified 詳細度を指定しません。Transformer では、列の他の属性に基づいて詳細度が設定されます。

trDateLevelWeek 詳細度が週であることを指定します。

trDateLevelYear 詳細度が年であることを指定します。

xtrDeployType 値リスト配布のタイプを設定します。

適用対象

SetDeployType メソッド

解説

この値リストの定数は、配布のタイプを設定するために、Cube オブジェクトのSetDeployType メソッドとともに使用します。これらのタイプは、PowerCube の配布戦略に対応してます。trDeployType_SWAPSINGLE を使用する場合、ある場所への配布に失敗しても、他の場所への配布には影響を与えません。この操作は、ユーザー・インターフェースのコマンド「可能な場所にコピーしてから有効化」に対応しています。trDeployType_SWAPTOGETHER を使用する場合、ある場所への配布に失敗すると、他の場所への配布は、成功した場合でもロールバックされます。この操作は、ユーザー・インターフェースのコマンド「すべての場所にコピーしてから有効化」に対応しています。

定数 説明

trDeployType_DEFAULT デフォルトの配布タイプを指定します。

trDeployType_NONE 配布を指定しません。

trDeployType_NULL Null 配布タイプを指定します。

trDeployType_SWAPSINGLE 可能な場所にコピーしてから有効化するよう指定します。

trDeployType_SWAPTOGETHER すべての場所にコピーしてから有効化することを指定します。

xtrDuplicateRollup 値リストTransformer でデータ・ソースから返された重複レコードを集計する方法を決定します。

432 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

適用対象

DuplicateRollup プロパティー

解説

この値リストの定数は、集計オプションを設定するために、Measure オブジェクトの DuplicateRollup プロパティーとともに使用します。

定数 説明

trDuplicateRollupAverage 重複レコードの数値データについて、平均値を使用した集計を指定します。

RegularRollup プロパティーがtrRollupAverage に設定されている場合は、最初に重複データを集計します。

trDuplicateRollupFirst 重複レコードの数値データについて、最初の値 (データ・ソースのレコード順) を使用した集計を指定します。

trDuplicateRollupLast 重複レコードの数値データについて、最後の値 (データ・ソースのレコード順) を使用した集計を指定します。

trDuplicateRollupMaximum 重複レコードの数値データについて、最大値を使用した集計を指定します。

trDuplicateRollupMinimum 重複レコードの数値データについて、最小値を使用した集計を指定します。

trDuplicateRollupNone 重複データを集計しないことを指定します。代わりに RegularRollup プロパティーに指定されている xtrRollup の定数を使用します。

trDuplicateRollupSum 重複レコードの数値データ値について、合計値を使用した集計を指定します。

xtrGenerateOptions 値リスト時間ディメンションにおける、カテゴリーの生成オプションを決定します。

適用対象

GenerateTimePeriod プロパティー

解説

この値リストの定数は、ディメンションに生成するカテゴリーを決定するためにDateDimension オブジェクトの GenerateTimePeriod プロパティーとともに使用します。

定数 説明

trGenerateAll 全カテゴリーを生成することを指定します。

第 6 章 定数 433

定数 説明

trGenerateDefault 各レベルのデフォルトを使用することを指定します。各ドリルダウン・パスの最上位レベルを除く全レベルに trGenerateDatesAll が適用されます。最上位レベルにはtrGenerateDatesNone が適用されます。

trGenerateNeed キューブに必要なカテゴリーのみデータ・ソースから生成することを指定します。

trGenerateNone カテゴリーを生成しないことを指定します。

xtrInclusion 値リストカテゴリーをモデル、またはキューブに含めるかどうかを決定します。

適用対象

DrillInclusion プロパティー

Inclusion プロパティー

解説

この値リストの定数は、DrillDown オブジェクトおよび DateDrillDown オブジェクトの DrillInclusion プロパティーや Category オブジェクト、SpecialCategoryオブジェクト、DateLevel オブジェクト、Level オブジェクトの Inclusion プロパティーとともに使用します。これらの定数は、カテゴリーをモデルまたはキューブに含めるときの条件を決定します。

Category または SpecialCategory に xtrInclusion の定数を割り当てない場合、カテゴリーは関連する Level オブジェクトまたは DateLevel オブジェクトの設定を継承します。

Transformer は、キューブを完了する必要があるとき、Inclusion の設定にかかわらず、カテゴリーの先祖を含めます。

定数 説明

trInclusionDefault レベル:trInclusionWhenNeeded

カテゴリー: カテゴリーが属するレベルの設定を使用します。

trInclusionExclude キューブからカテゴリー、子孫、すべての関連データを除外します。

この定数を使用する場合、カテゴリーが別のカテゴリーの共有カテゴリーまたは特殊カテゴリーのリンクではないことが必要です。

trInclusionGenerate 常にカテゴリーを含めます。

434 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

定数 説明

trInclusionSuppress レベル: カテゴリーをモデルに保持するが、ソース値が空白のカテゴリーはキューブから除外します。

カテゴリー: キューブからカテゴリーを除外するが、すべての子孫と子孫の値は含めます。

この定数を使用する場合、カテゴリーが別のカテゴリーの共有カテゴリーまたは特殊カテゴリーのリンクではないことが必要です。

trInclusionWhenNeeded カテゴリーをモデルに含めるが、カテゴリーの値がゼロのときはキューブから省略します。

xtrMeasureType 値リストMeasure オブジェクトのタイプと使用を決定します。

適用対象

MeasureType プロパティー

解説

この値リストの定数は、作成した数値データのタイプを決定するために、Measureオブジェクトの MeasureType プロパティーとともに使用します。Measures オブジェクトの種類には、通常数値データ、算出数値データ、またはカテゴリー・カウント数値データが含まれます。

定数 説明

trCalculatedMeasure ExpressionText プロパティーから値を求める数値データであることを指定します。

trCountMeasure CategoryCountLevel プロパティーから値を求める数値データであることを指定します。

trRegularMeasure (デフォルト) 関連から値を求める標準数値データであることを指定します。

xtrMissingValue 値リストPowerPlay が欠落値を表示する方法を決定します。

適用対象

MissingValue プロパティー

第 6 章 定数 435

解説

この値リストの定数は、数値データの数値がデータ・ソースから欠落しているときに PowerPlay に表示する値を決定するために、Measure オブジェクトのMissingValue プロパティーとともに使用します。

定数 説明

trMissingValueNA 省略形「na」を使用することを指定します。この方法では、欠落値が誤って 0 値と解釈されることを防止できます。

trMissingValueZERO (デフォルト) 欠落値に 0 を使用することを指定します。

xtrObjectType 値リストオブジェクトのタイプを決定します。

適用対象

Add メソッド (オブジェクト)

解説

この値リストの定数は、Transformer オブジェクトの Type プロパティーや、Addメソッドおよび Item メソッドの Type パラメーターとともに使用します。例えば、xtrObjectType の定数を Add メソッドとともに使用して新規オブジェクトをコレクションに追加できます。

定数 説明

trApplication オブジェクトが Transformer アプリケーションであることを指定します。

trAssociation オブジェクトが Association であることを指定します。

trCalculationDefinition オブジェクトが CalculationDefinition であることを指定します。

trCategory オブジェクトが Category であることを指定します。

trCategorySet オブジェクトが CategorySet であることを指定します。

trChildCube オブジェクトが ChildCube であることを指定します。

trColumn オブジェクトが Column であることを指定します。

trCrossTabDataSource オブジェクトが CrossTabDataSource であることを指定します。

trCube オブジェクトが Cube であることを指定します。

436 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

定数 説明

trCubeGroup オブジェクトが CubeGroup であることを指定します。

trCurrencyRate オブジェクトが CurrencyRate であることを指定します。

trCurrencyRecord オブジェクトが CurrencyRecord であることを指定します。

trCurrencyTable オブジェクトが CurrencyTable であることを指定します。

trCustomView オブジェクトが CustomView であることを指定します。

trDateDimension オブジェクトが DateDimension であることを指定します。

trDateDrillDown オブジェクトが DateDrillDown であることを指定します。

trDateLevel オブジェクトが DateLevel であることを指定します。

trDateWizard オブジェクトが DateWizard であることを指定します。

trDbDataSource オブジェクトが DbDataSource であることを指定します。

trDimension オブジェクトが Dimension であることを指定します。

trDrillDown オブジェクトが DrillDown であることを指定します。

trDrillThroughTarget オブジェクトが DrillThroughTarget であることを指定します。

trFlatFileDataSource オブジェクトが FlatFileDataSource であることを指定します。

trFilter オブジェクトが Filter であることを指定します。

trIqdDataSource オブジェクトが IqdDataSource であることを指定します。

trLevel オブジェクトが Level であることを指定します。

trMeasure オブジェクトが Measure であることを指定します。

trModel オブジェクトが Model であることを指定します。

trName オブジェクトが Name であることを指定します。

trNamespace オブジェクトが Namespace であることを指定します。

trNoType オブジェクトが識別されないタイプであることを指定します。

第 6 章 定数 437

定数 説明

trPackage オブジェクトが Package であることを指定します。

trPrompt オブジェクトが Prompt であることを指定します。

trReport オブジェクトが Report であることを指定します。

trSecurityObject オブジェクトが SecurityObject であることを指定します。

trSignon オブジェクトが Signon であることを指定します。

trSpecialCategory オブジェクトが SpecialCategory であることを指定します。

trSuspendedModel オブジェクトが SuspendedModel であることを指定します。

trView オブジェクトが View であることを指定します。

xtrOrigin 値リスト列の原点を決定します。

適用対象

Origin プロパティー

解説

この値リストの定数は、列の原点 (データ・ソースや計算など) を決定するために、Column オブジェクトの Origin プロパティーとともに使用します。

定数 説明

trOriginCalculated 列が計算に基づくことを指定します。

trOriginGenerated 生成したカテゴリーを原点とする列であることを指定します。

trOriginManual 列が Transformer の手動作成を原点とすることを指定します。

trOriginSource 列が IQD データ・ソースを原点とすることを指定します。

trOriginUnspecified 原点が不明なことを指定します。

xtrPowerCubeGeneration 値リストモデルでデータ・ソースを参照する場合を決定します。

438 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

適用対象

GeneratePowerCube プロパティー

解説

この値リストの定数は、CrossTabDataSource オブジェクト、DataSource オブジェクト、DbDataSource オブジェクト、FlatFileDataSource オブジェクト、IqdDataSource オブジェクト、Query オブジェクトの GeneratePowerCube プロパティーとともに使用します。

xtrPowerCubeGeneration 定数は、カテゴリーの生成時、キューブの作成時、またはその両方の作業時にデータ・ソースを参照するか、それともまったく参照しないかを決定するために使用します。この値リストの定数は、複数のデータ・ソースが存在するモデルで不要な処理を省き、モデルの効率を最適化するために使用します。

定数 説明

trGenerationCreatePowerCubes Transformer でカテゴリー、キューブ、またはその両方を作成するために必要に応じてデータ・ソース (純粋に構造データ・ソースも)を参照することを指定します。

このオプションは、設計および開発環境で(またはレコード内の数値データ値ではなく、レコード数に基づく数値データ値でキューブを構築するために) 使用します。

trGenerationDefault Transformer でモデルのレベルに関連するデータ・ソースの列を参照し、数値データと関連付けられているか確認することを指定します。関連付けられている場合は、数値データ値の値を使用してキューブを作成または更新します。データ・ソースが純粋に構造的な場合、Transformer ではカテゴリーのみが生成されます。

このオプションは、動的データを含んでいるトランザクション・データ・ソースおよび構造データ・ソースに対して運用環境で使用します。

trGenerationGenerateCategories Transformer でカテゴリーを生成するために構造情報のみのデータ・ソースを参照することを指定します。

trGenerationNoCreatePowerCubes Transformer でカテゴリーおよびキューブを作成するときにデータ・ソースにアクセスしないことを指定します。

第 6 章 定数 439

xtrPreferences 値リストアプリケーションの日付書式、エラーのログ、ソートの設定を決定します。

適用対象

DefaultDateFormat プロパティー

LogErrorLevel プロパティー

SortComparisonRule プロパティー

解説

この値リストの定数は、Application オブジェクトの DefaultDateFormat プロパティー、LogErrorLevel プロパティー、SortComparisonRule プロパティーとともに使用します。

この値リストの定数は、3 種類のプロパティーすべてに適用されるものではありません。

定数 説明

trDateFormatFromControlPanel Windows のコントロール・パネルにある「地域」の設定で日付書式を定義することを指定します。DefaultDateFormat プロパティーに適用します。

trDateFormatPredefined データ・ソースで使用するモデルで日付書式を定義することを指定します。DefaultDateFormat プロパティーに適用します。

trLogErrorsAndAbove 重大なエラー・メッセージとエラー・メッセージをログ・ファイルに記録するかどうかを指定します。エラーは、トランザクション・レベルで発生し、キューブが無効としてマークされます。LogErrorLevel プロパティーに適用します。

trLogInformationAndAbove メッセージすべてをログ・ファイルに書き込むかどうかを指定します。LogErrorLevel プロパティーに適用します。

trLogSevereErrors 重大なエラー・メッセージのみをログ・ファイルに書き込むかどうかを指定します。重大なエラーは、CPU、ディスク、ファイル、トランザクション・リソースにおけるシステム管理上の制限、またはモデル、キューブ、テンポラリー・ファイルの破損によって発生します。LogErrorLevel プロパティーに適用します。

440 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

定数 説明

trLogWarningsAndAbove 重大なエラー・メッセージと警告メッセージをログ・ファイルに記録するかどうかを指定します。警告は、処理を中断するものではありませんが、潜在的な問題があることを示します。LogErrorLevel プロパティーに適用します。

trSortFromControlPanel アプリケーションで Windows のコントロール・パネルにある「地域」の設定と関連付けられた比較法を使用することを指定します。SortComparisonRule プロパティーに適用します。

trSortIgnoreControlPanel アプリケーションで Transformer の内部比較法 (各文字列のバイナリー表現をバイト単位で比較) を使用することを指定します。SortComparisonRule プロパティーに適用します。

xtrPromptValueType 値リストプロンプトのタイプを決定します。

適用対象

PromptValueType プロパティー

解説

この値リストの定数は、プロンプトのタイプを設定するために、Prompt オブジェクトの PromptValueType プロパティーとともに使用します。

定数 説明

trSingleValuePrompt プロンプトが単一の値のプロンプトであることを指定します。

trMultiValuePrompt プロンプトが複数の値のプロンプトであることを指定します。

trBoundedRangePrompt プロンプトが境界のあるプロンプトであることを指定します。

trUnboundedRangePrompt プロンプトが境界のないプロンプトであることを指定します。

xtrRollup 値リストTransformer で数値データ値の値を下位から上位のカテゴリー・レベルへ自動集計する方法を決定します。

第 6 章 定数 441

適用対象

RegularRollup プロパティー

解説

この値リストの定数は、集計オプションを設定するために、Measure オブジェクトの RegularRollup プロパティーとともに使用します。

定数 説明

trRollupAny カテゴリーの値が存在するかどうかを決定します。

PowerPlay で子孫カテゴリーのレコードに値がある場合は 1 を表示します。この数値データについてレコードが存在しない場合、またはこの数値データについて存在する全レコードの値が NULL の場合は 0 を表示します。

trRollupAverage 現在のカテゴリーに含まれる全子孫カテゴリー・レコードの平均値を生成します。

trRollupCount 現在のカテゴリーに含まれる全子孫カテゴリー中で、非 NULL 値を持つレコードの数を生成します。

trRollupCount All 現在のカテゴリーに含まれる全子孫カテゴリーのレコード数 (その数値データが NULL値のレコードも含む) を生成します。

trRollupDefault trRollupSum を使用することを指定します。

trRollupExternal 特定のデータ・レコードに直接割り当てられたソース値を生成します。

trRollupMaximum 現在のカテゴリーに含まれる全子孫カテゴリー中の最大データ値を生成します。

trRollupMinimum 現在のカテゴリーに含まれる全子孫カテゴリー中の最小データ値を生成します。

trRollupSum 現在のカテゴリーに含まれる全子孫カテゴリーの合計値を生成します。

xtrRollupTiming 値リスト算出数値データの計算をいつ実行するかを決定します。

442 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

適用対象

RollupTiming プロパティー

解説

この値リストの定数は、Measure オブジェクトの RollupTiming プロパティーとともに使用します。これらの定数は、数値データが含まれる計算を数値データの集計より前に実行するか後に実行するかを決定します。Measure オブジェクトのMeasureType プロパティーは trCalculatedMeasure に設定する必要があります。

定数 説明

trTimingAfterRollup 算出数値データが集計値に基づくことを指定します。計算は次の順番で行われます。

1 すべての数値データで標準集計が行われる

2 時状態データ集計が行われる

3 割り当てられた数値データが計算される

4 算出数値データが計算される

trTimingBeforeRollup 算出数値データがソース値に基づくことを指定します。計算は次の順番で行われます。

1 キューブ作成に伴い、計算が実行される

2 すべての数値データで標準集計が行われる

3 時状態データ集計が行われる

4 割り当てられた数値データが計算される

trTimingDefault trTimingAfterRollup を使用することを指定します。

xtrSecurityType 値リストセキュリティー・オブジェクトのタイプを決定します。

適用対象

Type プロパティー

解説

この値リストの定数は、セキュリティー・オブジェクトのタイプを設定するために、SecurityObject オブジェクトの Type プロパティーとともに使用します。

定数 説明

trSecurityType_User セキュリティー・オブジェクトがユーザーであることを指定します。

trSecurityType_Group セキュリティー・オブジェクトがグループであることを指定します。

第 6 章 定数 443

定数 説明

trSecurityType_Role セキュリティー・オブジェクトが役割であることを指定します。

xtrSourceType 値リストデータ・ソースのファイル・タイプを決定します。

適用対象

SourceType プロパティー

解説

この値リストの定数は、データの外部ソースとデータ定義を決定するために、CrossTabDataSource オブジェクト、DataSource オブジェクト、DbDataSource オブジェクト、FlatFileDataSource オブジェクト、IqdDataSource オブジェクトのSourceType プロパティーとともに使用します。

定数 説明

trAccess ソースが Access データベース・ファイルであることを指定します。

trAccessQuery データ・ソース表が Access クエリー・ファイル (.mdb) に記述されることを指定します。入力値は、Access Query ファイルに保存された SQL クエリーを実行することによって、ODBC をサポートするデータベースから検索されます。

trClipper ソースが Clipper ファイルであることを指定します。

trDBase ソースが dBase データベース・ファイルであることを指定します。

trDictionary ソースがデータ・ディクショナリーであることを指定します。

trExcelCrossTab ソースが Excel スプレッドシート・クロス集計ファイルであることを指定します。

trExcelDatabase ソースが Excel スプレッドシート・データベース・ファイルであることを指定します。

444 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

定数 説明

trFixedAscii ソースが 1 行 1 レコード形式のテキスト・ファイルであることを指定します。各フィールドは、指定したバイト数で占有されます。各レコードの末尾は、テキスト行区切り文字で終了します。

trFixedAsciiNoCRLF ソースが 1 行 1 レコード形式のテキスト・ファイルであることを指定します。各フィールドは、指定したバイト数で占有されます。各レコードの末尾は、テキスト行区切り文字でマークされません。

trFlatFile ソースが 1 行 1 レコード形式のテキスト・ファイルであることを指定します。各フィールドの間は、FieldSeparator プロパティーで指定された文字で区切られます。

trFlatFileColumnNames ソースが 1 行 1 レコード形式のテキスト・ファイルであることを指定します。1 行目は列名を表します。各フィールド (列の値) の間は、FieldSeparator プロパティーで指定された文字で区切られます。

trFoxPro ソースが FoxPro データベース・ファイルであることを指定します。

trLotus123CrossTab ソースが Lotus 1-2-3 スプレッドシート・クロス集計ファイルであることを指定します。

trLotus123Database ソースが Lotus 1-2-3 スプレッドシート・データベース・ファイルであることを指定します。

trParadox ソースが Paradox データベース・ファイルであることを指定します。

trPowerHousePortable ソースが PowerHouse ポータブル・サブファイルであることを指定します。

第 6 章 定数 445

定数 説明

trQuery ソースが Impromptu クエリー定義ファイル(.iqd) であることを指定します。入力値は、Impromptu で定義された SQL クエリーを実行することによって、サポートされているImpromptu データベースから検索されます。

Impromptu クエリー定義ファイルの内容はモデルに保存され、カテゴリーを生成したりキューブを作成するたびに、埋め込まれた内容が更新されます。

xtrSpecialFunction 値リスト日付に使用する暦のタイプを決定します。

適用対象

DateFunction プロパティー

MonthType プロパティー

QuarterType プロパティー

YearType プロパティー

解説

この値リストの定数は、DateLevel オブジェクトの DateFunction プロパティーや、DateWizard オブジェクトの MonthType プロパティー、QuarterType プロパティー、YearType プロパティーとともに使用します。これらの定数は、日付レベルに使用する暦 (標準暦または月暦) や日付に使用する書式を決定します。

月暦のセグメントは標準暦のセグメントより短いため、月暦の期間では年末に割り当てられない日が残ります。これは、WeekAdd プロパティーと xtrWeekAdd 値リストの定数を使用することにより調整できます。

定数 説明

trSpecialFunctionDay 書式 YYYY/MMM/DD またはYY/MMM/DD の標準日付であることを指定します。

trSpecialFunctionLunarMonth 4 週ちょうどからなる月暦に基づく月であることを指定します。

trSpecialFunctionLunarMonth445 4 週、4 週、5 週を 3 回繰り返す月暦に基づく月であることを指定します。

trSpecialFunctionLunarMonth454 4 週、5 週、4 週を 3 回繰り返す月暦に基づく月であることを指定します。

446 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

定数 説明

trSpecialFunctionLunarMonth544 5 週、4 週、4 週を 3 回繰り返す月暦に基づく月であることを指定します。

trSpecialFunctionLunarQuarter 13 週ちょうどからなる月暦に基づく四半期であることを指定します。

trSpecialFunctionLunarYear 52 週ちょうどからなる月暦に基づく年であることを指定します。

trSpecialFunctionMonth 書式が YYYY/MMM または YY/MMM の標準暦に基づく月を指定します。

trSpecialFunctionNone 日付がレベルのソース列に基づくことを指定します。

trSpecialFunctionNull 日付の設定がないことを指定します。

trSpecialFunctionQuarter 書式が YYYY Q または YY Q の標準暦に基づく四半期を指定します。Q には四半期番号 (1、2、3、4) が入ります。

trSpecialFunctionWeek 書式が YYYY/MMM/DD またはYY/MMM/DD の標準暦に基づく週であることを指定します。

trSpecialFunctionYear 書式が YYYY または YY の標準暦に基づく年であることを指定します。

xtrStorage 値リストレベルの数値ドリルダウン・パスをソートする方法および数値データを保存する方法を決定します。

適用対象

OrderByStorageType プロパティー

StorageType プロパティー

解説

この値リストの定数は、Transformer がキューブの構築に使用する作業ファイル内で数値データ値を保存する方法を決定するために、Measure オブジェクトのStorageType プロパティーとともに使用します。

これらの定数は、データ・クラスが数値タイプの列に基づくソートのときにカテゴリーのソートを定義するために、OrderByStorageType プロパティーとともに使用することもできます。例えば、販売数量に基づいて製品をソートする場合、"数量"列と関連付けられた"数量"という数値データの保存タイプは 16 ビット整数です。

定数 説明

trStorageBigFloat 数値を 64 ビット浮動小数点 (1.7E +/- 308)で保存します。

trStorageBigInt 数値を 32 ビット整数 (-2,147,483 648~+2,147,483,647) で保存します。

第 6 章 定数 447

定数 説明

trStorageDefault データ型に応じてデフォルトの形式で保存します。数値データのデフォルトはtrStorageBigInt です。

trStorageSmallInt 数値を 16 ビット整数 (-32,768~ +32,767)で保存します。

xtrTimeAggregate 値リスト相対時間期間のタイプを決定します。

適用対象

Aggregate プロパティー

解説

この値リストの定数は、相対時間の特殊カテゴリーをカスタマイズするために、SpecialCategory オブジェクトの Aggregate プロパティーとともに使用します。このようなカテゴリーは、現在期間を基準とする特定の期間の数値データを追跡します。また、これらの定数は、特殊カテゴリーの基礎になる相対時間期間のタイプを指定します。

カスタムの相対時間 SpecialCategory オブジェクトには、期間が適用されるレンジやコンテキストを指定する ContextOffset プロパティー、TargetOffset プロパティーなど、他のプロパティーの設定も必要です。

定数 説明

trAggregateNone 相対期間を定義しないことを指定します。

trAggregateRunning ContextOffset や TargetOffset などのプロパティーにより定義される特定の N 期で終了する複数の期間を表します。

trAggregateRunningGrouped N 期カテゴリーのレンジが作成されることを除いて trAggregateRunning と同じです。

trAggregateSingle ContextOffset や TargetOffset などのプロパティーにより定義される単一の期間を表します。

trAggregateTodate 期間の最初から開始し、別の特定の期間で終了する一連の期間を表します。期間は、ContextOffset や TargetOffset などのプロパティーにより定義されます。

trAggregateTodateGrouped 累計カテゴリーのレンジが作成されることを除いて trAggregateToDate と同じです。

xtrTimeArrayType 値リスト日付配列の設定を決定します。

448 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

適用対象

TimeArrayType プロパティー

解説

この値リストの定数は、日付配列の値 (四半期または月) を決定するために、Column オブジェクトの TimeArrayType プロパティーとともに使用します。

定数 説明

trTimeArrayMonth 月の配列を構成する 12 の連続した列の 1列目であることを指定します。

trTimeArrayNA オブジェクトに時間配列を関連付けないことを指定します。

trTimeArrayQuarter 四半期の配列を構成する 4 つの連続した列の 1 列目であることを指定します。

xtrTimeRollup 値リストTransformer で特定期間の数値データを自動集計する方法を決定します。

適用対象

TimeStateRollup プロパティー

解説

この値リストの定数は、日付値の集計オプションを設定するために、Measure オブジェクトの TimeStateRollup プロパティーとともに使用します。

定数 説明

trTimeRollupAverage 対象とする期間に属する全カテゴリーの数値データ値の平均値を使用します。

第 6 章 定数 449

定数 説明

trTimeRollupCurrentPeriod 時間ディメンションで現在期間に指定したカテゴリーの数値データ値を使用します。対象とする期間に現在期間が含まれていない場合は、結果は最終期間と同じになります。

例えば、時間ディメンションが年、四半期、月で構成され、第 1 四半期が 1 月に開始するとします。現在期間は 2000 年 4 月に設定されています。

PowerPlay には、年レベルで、2000 年 4 月の数値データ値が表示されます。四半期レベルでは、第 2 四半期に 4 月の数値データ値が表示され (4 月が現在期間であるため)、他の各四半期には最終月 (第 1 四半期は 3月、第 3 四半期は 9 月、第 4 四半期は 12月) の値が表示されます。

trTimeRollupEarlyPeriod 対象とする期間に属する開始期間の数値データ値を使用します。

例えば、時間ディメンションが年、四半期、月で構成され、四半期レベルでデータを調べる場合、PowerPlay の各四半期には各四半期に属する最初の月の数値データ値が表示されます。

年レベルでデータを調べる場合、PowerPlayには各年の第 1 四半期に属する最初の月の値が表示されます。

trTimeRollupLatePeriod 対象とする期間に属する最終期間の数値データ値を使用します。

例えば、時間ディメンションが年、四半期、月で構成され、四半期レベルでデータを調べる場合、PowerPlay の各四半期には各四半期に属する最後の月の数値データ値が表示されます。

年レベルでデータを調べる場合、PowerPlayには各年の第 4 四半期に属する最後の月の値が表示されます。

trTimeRollupMaximum 対象とする期間に属する全カテゴリーの数値データ値の最大値を使用します。

trTimeRollupMinimum 対象とする期間に属する全カテゴリーの数値データ値の最小値を使用します。

450 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

定数 説明

trTimeRollupNone 時状態データ集計を実行しないことを指定します。代わりに RegularRollup プロパティーに設定した値を使用します。

xtrTimeType 値リスト日付の詳細度の設定を決定します。

適用対象

EnableTimePeriod プロパティー

GenerateTimePeriod プロパティー

解説

この値リストの定数は、DateWizard オブジェクトの EnableTimePeriod プロパティーや、DateDimension オブジェクトの GenerateTimePeriod プロパティーとともに使用します。これらの定数は、データ・ソースの日付列から Transformer でレポートできるレベルを示します。例えば、年、四半期、月の値を持つ日付列に対して、四半期レベルのレポートのみを許可するように制限できます。DateInputFormatプロパティーにより設定された最小レベルに満たないレポート期間は指定できません。

定数 説明

trTimeTypeDay レポートの最小期間が日であることを指定します。

trTimeTypeMonth レポートの最小期間が月であることを指定します。

trTimeTypeQuarter レポートの最小期間が四半期であることを指定します。

trTimeTypeWeek レポートの最小期間が週であることを指定します。

trTimeTypeYear レポートの最小期間が年であることを指定します。

xtrViewStatus 値リストビューに含めるカテゴリーを決定します。

適用対象

GetViewStatus メソッド

SetViewStatus メソッド

第 6 章 定数 451

解説

この値リストの定数は、Category オブジェクトおよび SpecialCategory オブジェクトの SetViewStatus メソッドや、View オブジェクトの GetViewStatus メソッドとともに使用します。これらの定数は、PowerCube をビューから作成するときに含めるカテゴリーを示します。

定数 説明

trViewStatusApexAncestor 筆頭指定カテゴリーと直接の子孫のみを含めます。

trViewStatusClear 制限を設定しないことを指定します。

trViewStatusCloakMom カテゴリーと子孫すべてを省略するが、上位レベルのカテゴリーへのデータ集計のために値を保持することを指定します。

trViewStatusClipMom カテゴリーと子孫すべてを除外することを指定します。

trViewStatusInvisibleKid カテゴリーを Cloaked 先祖またはSummary 先祖から除外することを指定します。

trViewStatusRemoveKid カテゴリーを Excluded 先祖から除外することを指定します。

trViewStatusSummaryMom 子孫すべてのデータを集計したカテゴリーを含めます。

trViewStatusSuppressed そのカテゴリーは含めないが、親カテゴリーと子カテゴリーを含めることを指定します。

xtrViewType 値リストビューのタイプを決定します。

適用対象

DimensionInclude プロパティー

DimensionViewType プロパティー

ViewType プロパティー

解説

この値リストの定数は、Cube オブジェクトおよび CubeGroup オブジェクトのDimensionViewType プロパティー、View オブジェクトの ViewType プロパティー、および DimensionInclude プロパティーとともに使用します。

452 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

ディメンションを作成すると、関連するキューブにそのディメンションに属するカテゴリーのビューが保存されます。ビューには、カテゴリーの全部または一部を含めることも、まったく含めないこともできます。

定数 説明

trViewTypeAllCategories ビューにディメンションと全カテゴリーを含めることを指定します。

trViewTypeCustom ビューに選択したカテゴリーのみを含めることを指定します。

trViewTypeNone オブジェクトにビューを関連付けないことを指定します。

trViewTypeOmitDimension ディメンション全体を省略することを指定します。

xtrWeekAdd 値リスト暦年と一致させるために月暦年に追加する日数を決定します。

適用対象

WeekAdd プロパティー

解説

この値リストの定数は、月暦年と暦年を同期させるために、DateWizard オブジェクトまたは DateDrillDown オブジェクトの WeekAdd プロパティーとともに使用します。

月暦年は 364 日で、暦年に比べて通常 1 日、うるう年で 2 日短くなります。Transformer では、4 日から 7 日までの余分な週を月暦年に追加できます。この余分な週は、年の最後の月または四半期の末尾に追加されます。

定数 説明

trWeekAddNone (デフォルト) 余分な週または週の一部を追加しないことを指定します。

trWeekAddDays7 7 日追加します。

trWeekAddDays6 6 日追加します。

trWeekAddDays5 5 日追加します。

trWeekAddDays4 4 日追加します。

xtrWeekDay 値リスト各曜日が週日であるかどうかを決定します。

適用対象

WeekStart プロパティー

WorkingDay プロパティー

第 6 章 定数 453

WorkingDays プロパティー

解説

この値リストの定数は、DateWizard オブジェクトまたは DateDimension オブジェクトの WorkingDay プロパティーおよび WorkingDays プロパティーやDateDrillDown オブジェクトの WeekStart プロパティーとともに使用します。

時間ディメンションの場合、これらの定数は、各曜日が週日であるかどうかを示し、非標準の週日を作成するときに便利です。また、これらの定数は、Transformerがディメンションにカテゴリーを生成する曜日も指定します。

日付ドリルダウン・パスの場合、これらの定数は、上位レベルの期間にある週カテゴリーの開始日に当たる曜日を決定します。

定数 説明

trSunday 日曜日が週日であることを指定します。

trMonday 月曜日が週日であることを指定します。

trTuesday 火曜日が週日であることを指定します。

trWednesday 水曜日が週日であることを指定します。

trThursday 木曜日が週日であることを指定します。

trFriday 金曜日が週日であることを指定します。

trSaturday 土曜日が週日であることを指定します。

xtrWeekSpan 値リスト2 つの年にまたがる週を定義する方法を決定します。

適用対象

WeekSpan プロパティー

解説

この値リストの定数は、年の最後の週が属する年を決定するために、DateWizardオブジェクトまたは DateDrillDown オブジェクトの WeekSpan プロパティーとともに使用します。

時間ディメンションの暦年に週レベルがある場合、最後の週と年の最後の日が一致しないことがあります (月暦の年は、常に週の終わりが最終日になります)。Transformer では、WeekSpan プロパティーの設定に基づいて最後の週をシフトまたは分割できます。

定数 説明

trWeekSpanFirstPeriod 週の開始日が属する年にシフトします。

trWeekSpanLargerPeriod その週の日が多く属する方の年にシフトします。

trWeekSpanLastPeriod 週の最終日が属する年にシフトします。

454 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

定数 説明

trWeekSpanNone (デフォルト) 2 つの年にまたがる週を無視することを指定します。

trWeekSpanSplitAll 週を 2 つの部分に分割し、各年に適用します。

trWeekSpanSplitMost 年をまたがる週を 2 つの部分に分割し、どちらも 2 日以上であれば各年に適用します。しかし、いずれか一方が 2 日未満になる場合は、その週の日が多く属する方の年にシフトします。

第 6 章 定数 455

456 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

第 7 章 UI との対応

IBM Cognos Transformer OLE オートメーションは、プログラム言語インターフェースを使用して Transformer ユーザー・インターフェースに代わる機能を提供します。このドキュメントでは、作業を開始するときに役立つように、大部分のTransformer OLE メソッドおよびプロパティーについて対応する UI を説明していますが、バージョン 7.3 以降のリリースで追加された要素については、対応するUI がリストされていません。

OLE オートメーションでは、プロパティーで属性を変更し、メソッドで動作を制御するコレクションとオブジェクトのセットとして、Transformer モデルを表します。オートメーションは、ディメンション、レベル、データ・ソース、数値データ、カテゴリー、ドリルダウン・パスなどのモデル・オブジェクトを作成して管理し、PowerCube を作成するために使用します。

OLE でモデルを作成するときは、オブジェクトを階層の順に作成して値を割り当てる必要があります。例えば、レベルを作成するには、そのレベルが属するディメンションをあらかじめ作成しておく必要があります。オブジェクト階層の詳細については、Transformer オブジェクトの階層マップを参照してください。

コレクション次の表は、コレクションとそれに相当するユーザー・インターフェースの対応表です。

コレクション 対応するユーザー・インターフェース

Associations コレクション 「ディメンション」プロパティー・シート、「全般」タブ、「外部集計列」ボックス(「データ・ソース」プロパティー・シートの「全般」タブにある「外部集計数値データ値の値を含む」チェック・ボックスがオンのとき)

「レベル」プロパティー・シート、「ソース」タブ

「数値データ」プロパティー・シート、「タイプ」タブ (「タイプ」オプションが「列」に設定されているとき)

「通貨表」プロパティー・シート、「基準テーブル列」ボックス (「外部の通貨データ・ソースを使用」チェック・ボックスがオンのとき)

CalculationDefinitions コレクション 「ディメンション」プロパティー・シート、「計算」タブ

457

コレクション 対応するユーザー・インターフェース

Categories コレクション ディメンション・ダイアグラム、カテゴリーの表示

CategorySets コレクション 「ディメンション計算定義」ダイアログ・ボックス (「ディメンション」プロパティー・シートの「計算」タブからアクセスする)

ChildCubes コレクション PowerCube リスト

Columns コレクション データ・ソース・リスト

Cubes コレクション PowerCube リスト

CurrencyRates コレクション 「通貨表」プロパティー・シート

CurrencyRecords コレクション 「通貨表」プロパティー・シート

CurrencyTables コレクション 「通貨表」プロパティー・シート

DataSources コレクション データ・ソース・リスト

DimensionLevels コレクション ディメンション・マップ

Dimensions コレクション ディメンション・マップ

DrillDowns コレクション ディメンション・ダイアグラム、カテゴリーの表示

LevelDrillDowns コレクション ディメンション・マップ

Levels コレクション ディメンション・マップ

Measures コレクション 数値データ・リスト

Names コレクション オブジェクトを含む Transformer ウィンドウ

Signons コレクション 「サインオン」コマンド、サインオン・リスト (「表示」メニュー)

SuspendedModels コレクション 「中断モデルの表示」コマンド、「中断モデルを選択」ボックス (「ファイル」メニュー)

Views コレクション ディメンション・ダイアグラム、「ディメンション」タブ

458 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

オブジェクト次の表は、オブジェクトとそれに相当するユーザー・インターフェースの対応表です。

オブジェクト 対応する UI

アプリケーション 「IBM Cognos Transformer」ウィンドウ

Association 「ディメンション」プロパティー・シート、「全般」タブ、「外部集計列」ボックス(「データ・ソース」プロパティー・シートの「全般」タブにある「外部集計数値データ値の値を含む」チェック・ボックスがオンのとき)

「レベル」プロパティー・シート、「ソース」タブ

「通貨表」プロパティー・シート (「外部の通貨データ・ソースを使用」チェック・ボックスがオンのとき)

「数値データ」プロパティー・シート、「タイプ」タブ (「タイプ」が「列」に設定されているとき)

CalculationDefinition 「ディメンション」プロパティー・シート、「計算」タブ

「数値データ」プロパティー・シート、「タイプ」タブ、「計算」ボタン、「数値データ計算」ダイアログ・ボックス

Category カテゴリーの表示

CategorySet 「ディメンション」プロパティー・シート、「計算」タブ、「追加」または「変更」ボタン、「計算」ボタン、「ディメンション・カテゴリー計算」ダイアログ・ボックス、「利用可能なコンポーネント」ペイン

ChildCube PowerCube リスト (キューブ・グループ)

列 データ・ソース・リスト (データ・ソース・オブジェクトが展開されているとき)

CrossTabDataSource データ・ソース・リスト

Cube PowerCube リスト

CubeGroup PowerCube リスト

第 7 章 UI との対応 459

オブジェクト 対応する UI

CurrencyRate 「通貨表」プロパティー・シート

CurrencyRecord 「通貨表」プロパティー・シート

CurrencyTable 「通貨表」プロパティー・シート

CustomView 「カスタム・ビュー」リスト

DataSource データ・ソース・リスト

DateDimension ディメンション・マップ

DateDrillDown ディメンション・ダイアグラム

DateLevel ディメンション・マップ

DateWizard 「日付ウィザード」コマンド (「ツール」メニュー)

DbDataSource データ・ソース・リスト

ディメンション ディメンション・マップ

DrillDown ディメンション・ダイアグラム

Filters データ・ソース・リスト

FlatFileDataSource データ・ソース・リスト

IqdDataSource データ・ソース・リスト

レベル ディメンション・マップ

数値データ 数値データ・リスト

モデル 「モデル <モデルのファイル名>」コマンド(「ヘルプ」メニュー)

名前 「<オブジェクト>」プロパティー・シート、「名前」ボックス

パッケージ データ・ソース・リスト

Prompts データ・ソース・リスト

Query データ・ソース・リスト

レポート データ・ソース・リスト

DrillThroughTarget ドリルスルー・ターゲット

460 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

オブジェクト 対応する UI

SecurityObject 「セキュリティー」メニューの「セキュリティー・オブジェクトを表示」メニュー項目を選択して表示される「セキュリティー・オブジェクト管理」

Signon 「サインオン」コマンド、サインオン・リスト (「表示」メニュー)

SpecialCategory ディメンション・ダイアグラム

SuspendedModel 「中断モデルの表示」コマンド、「中断モデルを選択」ボックス (「ファイル」メニュー)

View ディメンション・ダイアグラム、「ディメンション」タブ

メソッド次の表は、メソッドとそれに相当するユーザー・インターフェースの対応表です。

メソッド 対応する UI

Add 「オブジェクトの挿入」コマンド (「編集」メニュー)

AssociateWith 「ディメンション」プロパティー・シート、「全般」タブ、「外部集計列」ボックス(「データ・ソース」プロパティー・シートの「全般」タブにある「外部集計数値データ値の値を含む」チェック・ボックスがオンのとき)

「レベル」プロパティー・シート、「ソース」タブまたは「ソート基準」タブ

「数値データ」プロパティー・シート、「タイプ」タブ (「タイプ」が「列」に設定されているとき)

「通貨表」プロパティー・シート、「基準テーブル列」ボックス (「外部の通貨データ・ソースを使用」チェック・ボックスがオンのとき)

CheckLocalPowerCubes 「ローカル PowerCube のチェック」コマンド (「ツール」メニュー)

第 7 章 UI との対応 461

メソッド 対応する UI

CheckModel 「モデルのチェック」コマンド (「ツール」メニュー)

CleanHouse 「不要カテゴリーの一掃」コマンド (「ツール」メニュー)

閉じる 「閉じる」コマンド (「ファイル」メニュー)

ConnectWithCategory ディメンション・ダイアグラム (カテゴリーを同じレベルの別の親へドラッグするとき)

CreateAlternateDrillDown 「ドリルダウンの作成」コマンド (レベルが選択されているとき) (「編集」メニュー)

CreateDateDimension 日付ウィザード、「完了」ボタン

CreateMDCFile 「選択された PowerCube の作成」コマンド(「実行」メニュー)

CreateMDCFiles 「PowerCube の作成」コマンド (「実行」メニュー)

削除 「<オブジェクト>の削除」コマンド (「編集」メニュー)

DimensionAssociateWith 日付ウィザード

DoAutoDesign 新規モデル・ウィザード、「AutoDesign を実行」チェック・ボックス

GenerateCategories 「カテゴリーの生成」コマンド (「実行」メニュー)

アイテム 選択したカテゴリー、キューブ、データ・ソース、またはディメンション

LoadCurrencyTable 「通貨表」プロパティー・シート、「テーブルをロードする」ボタン (「外部の通貨データ・ソースを使用」チェック・ボックスがオンのとき)

Logon 「セキュリティー」メニュー、「ログオン」コマンド

Move 適正なドラッグ・アンド・ドロップ操作

MoveToCategory ディメンション・ダイアグラム (カテゴリーを階層の別の位置へドラッグするとき)

462 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

メソッド 対応する UI

MoveToLevel ディメンション・ダイアグラム (カテゴリーを階層の別の位置へドラッグするとき)

NewModel 「新規作成」コマンド (「ファイル」メニュー)

OpenModel 「開く」コマンド (「ファイル」メニュー)

Remove 「<オブジェクト>の削除」コマンド (「編集」メニュー)

ResetPartitions 「パーティションのリセット」コマンド(「ツール」メニュー)

Save 「保存」コマンド (「ファイル」メニュー)

SaveAs 「名前を付けて保存」コマンド (「ファイル」メニュー)

SetAllocation 「オブジェクト」プロパティー・シート、「割り当て」タブ、「OK」ボタン (複数のデータ・ソースがあるとき)

TestBuild 「ビルド・テスト」コマンド (「実行」メニュー)

Update 「オブジェクト」プロパティー・シート、「OK」ボタン

プロパティー次の表は、プロパティーとそれに相当するユーザー・インターフェースの対応表です。

プロパティー 対応する UI

ActivityMeasure 「数値データ」プロパティー・シート、「集計」タブ、「アクティビティー数値データ」ボックス (数値データのタイプが「カテゴリー・カウント」のとき)

アクセス:Read/Write

Aggregate 「特殊カテゴリー」プロパティー・シート、「相対時間」タブ、「基本的アプローチ」ボックス

アクセス:Read/Write

第 7 章 UI との対応 463

プロパティー 対応する UI

AllocationMeasure 「ディメンション」、「レベル」、または「カテゴリー」プロパティー・シート、「割り当て」タブ

アクセス:Read

AllocationType 「ディメンション」、「レベル」、または「カテゴリー」プロパティー・シート、「割り当て」タブ

アクセス:Read

AllowCurrencyConversion 「数値データ」プロパティー・シート、「全般」タブ、「通貨変換を許可」チェック・ボックス

アクセス:Read/Write

AllowDrillThrough 「オブジェクト」プロパティー・シート、「ドリルスルー」タブ、「この数値データからのドリルスルーを許可」チェック・ボックス

アクセス:Read/Write

AlternateQueryPath 「PowerCube」プロパティー・シート、「全般」タブ、「元ファイル」ボックス

アクセス:Read/Write

Apex 「筆頭指定」コマンド (表示のカテゴリーが選択されているとき) (「ダイアグラム」メニュー)

アクセス:Read/Write

Application Transformer ユーザー・インターフェース

アクセス:Read

464 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

プロパティー 対応する UI

AssociationRole 「ディメンション」プロパティー・シート、「全般」タブ、「外部集計列」ボックス(「データ・ソース」プロパティー・シートの「全般」タブにある「外部集計数値データ値の値を含む」チェック・ボックスがオンのとき)

「レベル」プロパティー・シート、「ソース」タブ

「数値データ」プロパティー・シート、「タイプ」タブ (「タイプ」オプションが「列」に設定されているとき)

「通貨表」プロパティー・シート、「基準テーブル列」ボックス (「外部の通貨データ・ソースを使用」チェック・ボックスがオンのとき)

アクセス:Read/Write

Associations 「ディメンション」プロパティー・シート、「全般」タブ、「外部集計列」ボックス(「データ・ソース」プロパティー・シートの「全般」タブにある「外部集計数値データ値の値を含む」チェック・ボックスがオンのとき)

「レベル」プロパティー・シート、「ソース」タブ

「数値データ」プロパティー・シート、「タイプ」タブ (「タイプ」が「列」に設定されているとき)

「通貨表」プロパティー・シート、「基準テーブル列」ボックス (「外部の通貨データ・ソースを使用」チェック・ボックスがオンのとき)

アクセス:Read

第 7 章 UI との対応 465

プロパティー 対応する UI

AssociationType 「ディメンション」プロパティー・シート、「全般」タブ、「外部集計列」ボックス(「データ・ソース」プロパティー・シートの「全般」タブにある「外部集計数値データ値の値を含む」チェック・ボックスがオンのとき)

「レベル」プロパティー・シート、「ソース」タブ

「数値データ」プロパティー・シート、「タイプ」タブ (「タイプ」が「列」に設定されているとき)

「通貨表」プロパティー・シート、「基準テーブル列」ボックス (「外部の通貨データ・ソースを使用」チェック・ボックスがオンのとき)

アクセス:Read/Write

BlankSubstitute 「レベル」プロパティー・シート、「全般」タブ、「空白カテゴリー代用ラベル」ボックス

アクセス:Read/Write

BlockParentTotals 「PowerCube」プロパティー・シート、「処理」タブ、「除外された子を持つ親のブロック合計」チェック・ボックス

アクセス:Read/Write

CacheCrossTabs 「PowerCube」プロパティー・シート、「処理」タブ、「クロス集計キャッシュを使用可能にする」チェック・ボックス

アクセス:Read/Write

CalculationDefinitions 「ディメンション」プロパティー・シート、「計算」タブ

アクセス:Read

CanAllocate 「ディメンション」、「レベル」、「カテゴリー」プロパティー・シート (「割り当て」タブが表示されているとき)

アクセス:Read

466 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

プロパティー 対応する UI

CanAllocateByMeasure 「オブジェクト」プロパティー・シート、「割り当て」タブ、「数値データの選択」ボックス

アクセス:Read

CanAllocateMeasure 「ディメンション」、「レベル」、「カテゴリー」プロパティー・シート、「割り当て」タブ

アクセス:Read

Categories ディメンション・ダイアグラム、カテゴリーの表示

アクセス:Read

Category ディメンション・ダイアグラム、カテゴリーの表示

アクセス:Read/Write

CategoryCount 「カウントの表示」コマンド (「編集」メニュー)

アクセス:Read

CategoryCountLevel 「数値データ」プロパティー・シート、「タイプ」タブ、「ディメンション」ボックスおよび「レベル」ボックス (「カテゴリー・カウント」ボタンが選択されているとき)

アクセス:Read/Write

CategorySets 「ディメンション計算定義」ダイアログ・ボックス (「ディメンション」プロパティー・シートの「計算」タブからアクセスする)

アクセス:Read

CharacterType 「データ・ソース」プロパティー・シート、「ソース」タブ、「文字セット」ボックス

アクセス:Read/Write

ChildCategories ディメンション・ダイアグラム、カテゴリーの表示

アクセス:Read

第 7 章 UI との対応 467

プロパティー 対応する UI

ChildCubes PowerCube リスト

アクセス:Read

ChildCustomViews 「カスタム・ビュー」リストおよびカテゴリーの表示、「カスタム・ビュー」タブ

Code 「カテゴリー」プロパティー・シート、「全般」タブ、「カテゴリー・コード」ボックス

アクセス:Read/Write

Columns データ・ソース・リスト

アクセス:Read

ColumnsLoaded データ・ソース・リスト

アクセス:Read

Consolidate 「PowerCube」プロパティー・シート、「全般」タブ、「集約」ボックス

アクセス:Read/Write

Context 「レベル」プロパティー・シート、「ソート基準」タブ、ドリルダウン・リスト

アクセス:Read/Write

ContextLevel 「特殊カテゴリー」プロパティー・シート、「相対時間」タブ、「総括期間」ボックス

アクセス:Read/Write

ContextOffset 「特殊カテゴリー」プロパティー・シート、「相対時間」タブ、「総括期間オフセット」ボックス

アクセス:Read/Write

ConvergenceLevel ディメンション・マップで複数の代替ドリルダウン・パスが収束するレベル

アクセス:Read

Count なし

アクセス:Read

468 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

プロパティー 対応する UI

CountryCode 「通貨」プロパティー・シート、「国コード」役割、または「通貨レコード」ダイアログ・ボックス、「国コード」ボックス

アクセス:Read/Write

CubeCreation 「PowerCube」プロパティー・シート、「処理」タブ、「キューブの作成」ボックス、「使用可能」または「使用不可」

アクセス:Read/Write

Cubes PowerCube リスト

アクセス:Read

CubeStamp なし

CurrencyDecimals 「通貨」プロパティー・シート、「通貨レコード」ダイアログ・ボックス、「小数点」ボックス

アクセス:Read/Write

CurrencyFormatOverride 「通貨」プロパティー・シート、「通貨レコード」ダイアログ・ボックス、「国コードの上書き」チェック・ボックス

アクセス:Read/Write

CurrencyIsEMU 「通貨」プロパティー・シート、「通貨レコード」ダイアログ・ボックス、「経済通貨統合のメンバー (EMU)」チェック・ボックス

アクセス:Read/Write

CurrencyIsEuro なし

アクセス:Read/Write

CurrencyRates 「通貨表」プロパティー・シート

アクセス:Read

CurrencyRecord 「通貨」プロパティー・シート、「通貨レコード」ダイアログ・ボックス

アクセス:Read

CurrencyRecords 「通貨表」プロパティー・シート

アクセス:Read

第 7 章 UI との対応 469

プロパティー 対応する UI

CurrencySymbol 「通貨」プロパティー・シート、「通貨レコード」ダイアログ・ボックス、「通貨記号」ボックス

アクセス:Read/Write

CurrencyTable 「通貨表」コマンド、「通貨表」プロパティー・シート (「ファイル」メニュー)

アクセス:Read

CurrencyTables 「通貨表」コマンド、「通貨表」プロパティー・シート (「ファイル」メニュー)

アクセス:Read

CurrencyTableType 「通貨表」プロパティー・シート、「基準テーブル」または「ユーロ表」

アクセス:Read/Write

CurrentModel 「モデル <モデルのファイル名>」コマンド、「ファイル名」(「ヘルプ」メニュー)

アクセス:Read

CustomViews「カスタム・ビュー」リストおよびカテゴリーの表示、「カスタム・ビュー」タブ

DataCharacterSet 「設定」プロパティー・シート、「全般」タブ、「データ文字セット」ボックス

アクセス:Read/Write

DataClass 「オブジェクト」プロパティー・シート、「全般」タブ、「データ・クラス」ボックス

アクセス:Read/Write

DataRange 新規データ・ソース・ウィザードまたは新規モデル・ウィザード、「テーブルあるいは範囲」ボックス

「データ・ソース」プロパティー・シート、「ソース」タブ、「テーブルあるいは範囲」ボックス

アクセス:Read/Write

DataSourcePath 「設定」プロパティー・シート、「ディレクトリー」タブ、「データ・ソース」ボックス

アクセス:Read/Write

470 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

プロパティー 対応する UI

DataSources データ・ソース・リスト

アクセス:Read

DataTemporaryFilesPath 「設定」プロパティー・シート、「ディレクトリー」タブ、「データ・テンポラリー・ファイル (dir1;dir2)」ボックス

アクセス:Read/Write

DateDegreeofDetail 「列」プロパティー・シート、「時間」タブ、「詳細度」ボックス

アクセス:Read/Write

DateDegreeofDetailLevelName 「列」プロパティー・シート、「全般」タブ、「詳細度」ボックス (「データ・ソース」プロパティー・シートの「全般」タブにある「外部自動集計数値データ値の値を含む」チェック・ボックスがオンのとき)

アクセス:Read/Write

DateFormat 「レベル」プロパティー・シート (日付)、「時間」タブ、「日付書式」ボックス

アクセス:Read/Write

DateFunction 「レベル」プロパティー・シート (日付)、「時間」タブ、「日付変換」ボックス

アクセス:Read/Write

DateInputFormat 「列」プロパティー・シート、「時間」タブ、「日付入力書式」ボックス

アクセス:Read/Write

DateLevel 「通貨表」プロパティー・シート、「通貨レコード」ダイアログ・ボックス、「日付レベル」ボックス

アクセス:Read/Write

DateWizard 「日付ウィザード」コマンド (「ツール」メニュー)

アクセス:Read

第 7 章 UI との対応 471

プロパティー 対応する UI

DecimalPoint 「データ・ソース」プロパティー・シート(フラット・ファイルのデータ・ソース・タイプ)、「全般」タブ、「小数点区切り」ボックス

アクセス:Read/Write

Decimals Column オブジェクト: なし

アクセス:Read

DefaultDateFormat 「設定」プロパティー・シート、「全般」タブ、「標準日付書式」ボックス

アクセス:Read/Write

説明 「オブジェクト」プロパティー・シート、「説明」タブ

アクセス:Read/Write

DesiredPartitionSize 「PowerCube」プロパティー・シート、「自動パーティション」タブ、「希望するパーティション・サイズ」ボックス

アクセス:Read/Write

DetachDataSource 「設定」プロパティー・シート、「ファイル」タブ、「カテゴリーを生成した後に、データ・ソースを分離する」チェック・ボックス

アクセス:Read/Write

DetailLevel 「PowerCube」プロパティー・シート (キューブ・グループ)、「キューブ・グループ」タブ、「レベルにある最下位のカテゴリーに関する詳細」ボックス

アクセス:Read/Write

DimensionInclude ディメンション・ダイアグラム、左側のウィンドウ、「ユーザー・クラス」タブ

アクセス:Read/Write

DimensionLevels ディメンション・マップ

アクセス:Read

472 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

プロパティー 対応する UI

DimensionName 日付ウィザード

アクセス:Write

Dimensions ディメンション・マップ

アクセス:Read

DimensionView ディメンション・ダイアグラム、「ユーザー・クラス」タブ

アクセス:Read

DimensionViewType 「PowerCube」プロパティー・シート、「ディメンション」タブ (ディメンションを右クリックしたとき)

アクセス:Read/Write

DrillCode 「ドリル・カテゴリー」プロパティー・シート、「カテゴリー・コード」ボックス

アクセス:Read/Write

DrillDowns ディメンション・マップ

アクセス:Read

DrillInclusion 「ドリル・カテゴリー」プロパティー・シート、「全般」タブ、「生成条件」ボックス

アクセス:Read/Write

DrillThroughTargets 「PowerCube」プロパティー・シート、「ドリルスルー」タブ、「カスタム・レポート」ボックス

アクセス:Read

DuplicateRollup 「数値データ」プロパティー・シート、「集計」タブ、「重複データ集計」ボックス

アクセス:Read/Write

DuplicateWeight 「数値データ」プロパティー・シート、「集計」タブ、「重複データ加重平均」ボックス

アクセス:Read/Write

第 7 章 UI との対応 473

プロパティー 対応する UI

EarliestDate 日付ウィザード

「ディメンション」プロパティー・シート(日付)、「時間」タブ、「期間開始日」ボックス

「日付カテゴリーの生成」コマンド、「開始」ボックス (「実行」メニュー)

アクセス:Write (DateWizard) Read/Write(DateDimension)

EMUEntryDate 「通貨表」プロパティー・シート、「通貨レコード」ダイアログ・ボックス、「EMU の加入日 (YYYYMMDD)」ボックス

アクセス:Read/Write

EnableMessageLogging 「設定」プロパティー・シート、「ロギング」タブ、「記録するメッセージ」チェック・ボックス

アクセス:Read/Write

EnableTimePeriod 日付ウィザード

アクセス:Write

EstimatedRows 「PowerCube」プロパティー・シート、「自動パーティション」タブ、「推定集約レコード数」ボックス

アクセス:Read/Write

ExcludeAutoPartition 「ディメンション」プロパティー・シート、「全般」タブ、「自動パーティションからディメンションを除外」チェック・ボックス

アクセス:Read/Write

474 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

プロパティー 対応する UI

ExpressionText 「列」プロパティー・シート、「全般」タブ、「算出」オプション、「計算」ボタン、「列計算」ボックス

「ディメンション」プロパティー・シート、「計算」タブ、「追加」ボタン、「計算」ボタン、「ディメンション 計算定義」ボックス

「数値データ」プロパティー・シート、「タイプ」タブ、「算出」オプション、「計算」ボタン、「数値データ計算」ボックス

アクセス:Read/Write

External 「データ・ソース」プロパティー・シート、「全般」タブ、「外部自動集計数値データ値の値を含む」チェック・ボックス

アクセス:Read/Write

FieldSeparator 「データ・ソース」プロパティー・シート(フラット・ファイルのデータ・ソース・タイプ)、「ソース」タブ、「フィールド区切り」ボックス

アクセス:Read/Write

FileName Windows Explorer

アクセス:Read/Write

Format 「オブジェクト」プロパティー・シート、「書式」タブ

アクセス:Read/Write

FormatDecimals 「数値データ」プロパティー・シート、「書式」タブ、「小数桁数」ボックス

アクセス:Read/Write

FullName Windows Explorer

アクセス:Read

GenerateCategories 「データ・ソース」プロパティー・シート、「全般」タブ、「カテゴリー生成」チェック・ボックス

アクセス:Read/Write

第 7 章 UI との対応 475

プロパティー 対応する UI

GenerateDateCategories 「レベル・プロパティー・シート (日付)「時間」タブ、「期間内のカテゴリーすべてを生成」チェック・ボックス(trGenerateDatesAll に設定されているとき使用可能)

アクセス:Read/Write

GeneratePowerCube 「データ・ソース」プロパティー・シート、「全般」タブ、「PowerCube 作成」チェック・ボックス

アクセス:Read/Write

GenerateTimePeriod 「実行」メニュー、日付カテゴリーの生成(時間ディメンションが選択されているとき)

アクセス:Read/Write

Group 「計算定義」ボックス、「算出カテゴリーをグループ化」チェック・ボックス

アクセス:Read/Write

GroupLevel 「PowerCube」プロパティー・シート、「キューブ・グループ」タブ、「レベル」ボックス

アクセス:Read/Write

HasSubdimension ディメンション・マップでは、サブディメンションを含むレベル名の横に省略記号 (...)が表示される

アクセス:Read

Inclusion 「オブジェクト」プロパティー・シート、「全般」タブ、「生成条件」ボックス

アクセス:Read/Write

IncrementalUpdate 「PowerCube」プロパティー・シート、「処理」タブ、「このキューブをインクリメンタルに更新」チェック・ボックス

アクセス:Read/Write

InputScale 「列」プロパティー・シート、「全般」タブ、「入力スケール」ボックス

アクセス:Read/Write

476 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

プロパティー 対応する UI

IsAnyColumnMismatched 「列のチェック」コマンド (「ツール」メニュー)

アクセス:Read

IsBad 「中断モデルの表示」コマンド (「ファイル」メニュー)

アクセス:Read

IsExpressionValid 次の「OK」ボタン。

「ディメンション」プロパティー・シート、「計算」タブ、「追加」または「変更」ボタン、「ディメンション・カテゴリー計算」ダイアログ・ボックス

「列」プロパティー・シート、「全般」タブ、「計算」ボタン、「列計算」ダイアログ・ボックス (「列タイプ」が「算出」に設定されているとき)

「数値データ」プロパティー・シート、「タイプ」タブ、「計算」ボタン、「数値データ計算」ダイアログ・ボックス (数値データのタイプが「算出」のとき)

アクセス:Read

IsManual ディメンション・マップの手動レベルには、手のアイコンが表示される

アクセス:Read

IsolationLevel 「データ・ソース」プロパティー・シート、「ソース」タブ、「分離レベル」ボックス(データ・ソースが IQD のとき)

新規モデル・ウィザード

アクセス:Read/Write

IsPrimary 「オブジェクト」プロパティー・シート、「全般」タブ、「主ドリル・カテゴリー」チェック・ボックス

アクセス:Read/Write (DateDrillDown とDrillDown)Read (Category)

第 7 章 UI との対応 477

プロパティー 対応する UI

KeyName 「カテゴリー」プロパティー・シート、「全般」タブ、「ソース値」ボックス

アクセス:Read/Write

ラベル 「オブジェクト」プロパティー・シート、「全般」タブ、「<オブジェクト>ラベル」ボックス

アクセス:Read/Write

LastUseDate 「オブジェクト」プロパティー・シート、「全般」タブ、「最終使用日」ボックス

アクセス:Read

LatestDate 日付ウィザード

「日付ディメンション」プロパティー・シート、「時間」タブ、「期間終了日」ボックス

「日付カテゴリーの生成」コマンド、「終了」ボックス (「実行」メニュー)

アクセス:Write (DateWizard) Read/Write(DateDimension)

LevelDrillDowns ディメンション・マップ、代替ドリルダウン・パスの表示

アクセス:Read

Levels ディメンション・マップ、ディメンション内のレベルの表示

アクセス:Read

LocalPath 「データ・ソース」プロパティー・シート、「ソース」タブ、「ローカル・データ・ファイル」ボックス

アクセス:Read/Write

LogErrorLevel 「設定」プロパティー・シート、「ロギング」タブ、「重大なエラー」、「エラーと上記」、警告と上記」、または「情報上記」

アクセス:Read/Write

478 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

プロパティー 対応する UI

LogFileAppend 「設定」プロパティー・シート、「ロギング」タブ、「ロギング情報を追加する」チェック・ボックス

アクセス:Read/Write

LogFileName 「設定」プロパティー・シート、「ロギング」タブ、「ログ・ファイル名」ボックス

アクセス:Read/Write

LogFilesPath 「設定」プロパティー・シート、「ディレクトリー」タブ、「ログ・ファイル」ボックス

アクセス:Read/Write

Lunar なし (「レベル」プロパティー・シート、「時間」タブ、「日付変換」ボックスを使用して値を決定する)

アクセス:Read/Write

ManualCurrentPeriod 「ディメンション」プロパティー・シート、「時間」タブ、「現在期間の自動設定」チェック・ボックス

アクセス:Read/Write

MaximizeSpeed 「データ・ソース」プロパティー・シート、「全般」タブ、「唯一性の検証」ボックス

アクセス:Read/Write

MaxNumPartLevels 「PowerCube」プロパティー・シート、「自動パーティション」タブ、「パス数の最大限」ボックス

アクセス:Read/Write

MaxTransactionNumber 「設定」プロパティー・シート、「全般」タブ、「コミット当たりの最大トランザクション数」ボックス

アクセス:Read/Write

MDCFile 「PowerCube」プロパティー・シート、「出力」タブ、「PowerCube ファイル名」ボックス

アクセス:Read/Write

第 7 章 UI との対応 479

プロパティー 対応する UI

MeasureInclude 「PowerCube」プロパティー・シート、「数値データ」タブ

アクセス:Read/Write

MeasureName 「PowerCube」プロパティー・シート、「全般」タブ、「数値データ名」ボックス

アクセス:Read/Write

Measures 数値データ・リスト

アクセス:Read

MeasureType 「数値データ」プロパティー・シート、「タイプ」タブ、「列」、「算出」、または「カテゴリー・カウント」

アクセス:Read

MissingValue 「数値データ」プロパティー・シート、「全般」タブ、「欠落値」ボックス

アクセス:Read/Write

ModelName 「中断モデルの表示」コマンド、「中断モデルを選択」ボックス (「ファイル」メニュー)

アクセス:Read/Write

ModelsPath 「設定」プロパティー・シート、「ディレクトリー」タブ、「レベル」ボックス

アクセス:Read/Write

ModelTemporaryFilesPath 「設定」プロパティー・シート、「ディレクトリー」タブ、「モデル・テンポラリー・ファイル」ボックス

アクセス:Read/Write

ModelType Windows Explorer

アクセス:Read

MonthType 日付ウィザード

「レベル」プロパティー・シート (日付)、「時間」タブ、「日付変換」ボックス

アクセス:Write

480 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

プロパティー 対応する UI

名前 「オブジェクト」プロパティー・シート、「<オブジェクト>名」ボックス。「オブジェクト」プロパティー・シート、「<オブジェクト> ラベル」ボックス

アクセス:Read/Write Read(Application、Name、Report)

NewCatsLocked 「オブジェクト」プロパティー・シート、「全般」タブ、「新カテゴリーの自動作成を禁止」チェック・ボックス

アクセス:Read/Write

Optimize 「PowerCube」プロパティー・シート、「処理」タブ、「最適化」ボックス

アクセス:Read/Write

OrderByDescending 「レベル」プロパティー・シート、「ソート基準」タブ、「ソート順」ボックス

アクセス:Read/Write

OrderByStorageType 「レベル」プロパティー・シート、「ソート基準」タブ、「ソート法」ボックス

アクセス:Read/Write

Origin なし

アクセス:Read

OriginalName 「オブジェクト」プロパティー・シート、「全般」タブ、「オリジナル名」ボックス

アクセス:Read

Orphanage 「カテゴリー」プロパティー・シート、「孤児カテゴリー」チェック・ボックス

アクセス:Read/Write

OutputScale 「数値データ」プロパティー・シート、「全般」タブ、「出力スケール」ボックス

アクセス:Read/Write

Parent Transformer の階層表示

アクセス:Read

第 7 章 UI との対応 481

プロパティー 対応する UI

ParentCategories ディメンション・ダイアグラム、カテゴリーの表示

アクセス:Read

Partition 「オブジェクト」プロパティー・シート、「全般」タブ、「パーティション番号」ボックス

アクセス:Read/Write

Password 「PowerCube」プロパティー・シート、「出力」タブ、「パスワード」ボックス

「サインオン」プロパティー・シート、「全般」タブ、「パスワード」ボックス

アクセス:Write

Path Windows Explorer

アクセス:Read

PopulateByDataSource なし

アクセス:Read/Write

Position 「列」プロパティー・シート、「全般」タブ、「位置」ボックス

アクセス:Read/Write

PowerCubesPath 「設定」プロパティー・シート、「ディレクトリー」タブ、「PowerCube」ボックス

アクセス:Read/Write

Precision 「数値データ」プロパティー・シート、「書式」タブ、「精度」ボックス

アクセス:Read/Write

QualifiedName ディメンション・マップ

アクセス:Read

QuarterType 日付ウィザード

「レベル」プロパティー・シート (日付)、「時間」タブ、「日付変換」ボックス

アクセス:Write

482 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

プロパティー 対応する UI

QyPath 「設定」プロパティー・シート、「ディレクトリー」タブ、「モデル・テンポラリー・ファイル」ボックス

アクセス:Read

Rate 「通貨表」プロパティー・シート

アクセス:Read/Write

RefreshDescription 「レベル」プロパティー・シート、「ソース」タブ、「最新の情報に更新」ボックスの「説明」チェック・ボックス

アクセス:Read/Write

RefreshLabel 「レベル」プロパティー・シート、「ソース」タブ、「最新の情報に更新」ボックスの「ラベル」チェック・ボックス

アクセス:Read/Write

RefreshShortName 「レベル」プロパティー・シート、「ソース」タブ、「最新の情報に更新」ボックスの「短縮名」チェック・ボックス

アクセス:Read/Write

RegularRollup 「数値データ」プロパティー・シート、「集計」タブ

アクセス:Read/Write

RegularWeight 「数値データ」プロパティー・シート、「集計」タブ、「加重平均」ボックス

アクセス:Read/Write

ReverseSign 「オブジェクト」プロパティー・シート、「全般」タブ、「正負記号を逆転」チェック・ボックス

アクセス:Read/Write

Rollup 「特殊カテゴリー」プロパティー・シート、「全般」タブ、「カテゴリーの集計」チェック・ボックス

アクセス:Read/Write

第 7 章 UI との対応 483

プロパティー 対応する UI

RollupTiming 「数値データ」プロパティー・シート、「集計」タブ、「計算タイミング」ボックス (算出数値データ)

アクセス:Read/Write

RowsAsSample 「設定」プロパティー・シート、「AutoDesign」タブ、「サンプルとして使用する行数」ボックス

アクセス:Read/Write

RowsChecked 「設定」プロパティー・シート、「AutoDesign」タブ、「検定行数」ボックス

アクセス:Read/Write

RunningPeriods 「特殊カテゴリー」プロパティー・シート、「相対時間」タブ、「期間数」ボックス(「相対時間」が「カスタム」に設定され、「基本的アプローチ」が「累計」に設定されているとき)

アクセス:Read/Write

サーバー 「PowerCube」プロパティー・シート、「処理」タブ、「処理」ボックス

アクセス:Read/Write

ServerModelPath 「モデル」プロパティー・シート、「サーバー」タブ、「モデルのパス」ボックス

アクセス:Read/Write

ServerPath 「データ・ソース」プロパティー・シート、「ソース」タブ、「サーバー・データ・ファイル」ボックス (「データ・ソースの場所」が「サーバー」に設定されているとき)

アクセス:Read/Write

ServerQuery 「データ・ソース」プロパティー・シート、「ソース」タブ、「データ・ソースの場所」ボックス

アクセス:Read/Write

ServicesBuildNumber 「バージョン情報」ボックス

アクセス:Read

484 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

プロパティー 対応する UI

ServicesVersionText 「バージョン情報」ボックス

アクセス:Read

SetsCurrentPeriod 「データ・ソース」プロパティー・シート、「全般」タブ、「現在期間を設定」チェック・ボックス

アクセス:Read/Write

ShortName 「オブジェクト」プロパティー・シート、「全般」タブ、「短縮名」ボックス

アクセス:Read/Write

Signon 「PowerCube」プロパティー・シート、「出力」タブ、「サインオン」ボックス (データベース・タイプが「ローカル」以外の値に設定されているとき)

アクセス:Read/Write

Signons サインオン・リスト

アクセス:Read

Size 「列」プロパティー・シート、「全般」タブ、「サイズ」ボックス

アクセス:Read/Write

Size (Model) Windows Explorer

アクセス:Read

SortComparisonRule 「設定」プロパティー・シート、「全般」タブ、「ソート比較法」ボックス

アクセス:Read/Write

SourceType 「データ・ソース」プロパティー・シート、「ソース」タブ、「ソース・タイプ」ボックス

アクセス:Read/Write

SpecialCategoryCount ディメンション・マップ (ディメンション名の下にある 2 番目の括弧内の数値)

アクセス:Read

第 7 章 UI との対応 485

プロパティー 対応する UI

SQLExpression 「データ・ソース」プロパティー・シート、「SQL 表示」タブ

アクセス:Read

ステータス 「PowerCube」プロパティー・シート、「処理」タブ、「状態」ボックス

アクセス:Read

StorageType 「数値データ」プロパティー・シート、「全般」タブ、「保管タイプ」ボックス

アクセス:Read/Write

SummaryLevel 「PowerCube」プロパティー・シート、「キューブ・グループ」タブ、「レベル内の全外部カテゴリーを要約する」ボックス

アクセス:Read/Write

SuspendedModels 「中断モデルの表示」コマンド、「中断モデルを選択」ボックス (「ファイル」メニュー)

アクセス:Read

TargetLevel 「特殊カテゴリー」プロパティー・シート、「相対時間」タブ、「目標オフセット」ボックス (「相対時間」が「カスタム」に設定されているとき)

アクセス:Read/Write

TargetOffset 「特殊カテゴリー」プロパティー・シート、「相対時間」タブ、「目標オフセット」ボックス (「相対時間」が「カスタム」に設定されているとき)

アクセス:Read/Write

ThousandPoint 「データ・ソース」プロパティー・シート、「全般」タブ、「1000 の区切り」ボックス(フラット・ファイルのデータ・ソース)

アクセス:Read/Write

Time Windows Explorer

アクセス:Read

486 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

プロパティー 対応する UI

TimeArrayColumn 「列」プロパティー・シート、「列名」ボックス

アクセス:Read/Write

TimeArrayStartMonth 「列」プロパティー・シート、「配列」タブ、「開始月」ボックス

アクセス:Read/Write

TimeArrayType 「列」プロパティー・シート、「配列」タブ、「配列タイプ」ボックス

アクセス:Read/Write

TimeRank 「レベル」プロパティー・シート (日付)、「時間」タブ、「日付レベルのランク」ボックス

アクセス:Read/Write

TimeStateRollup 「数値データ」プロパティー・シート、「集計」タブ、「時状態データ集計」ボックス

アクセス:Read/Write

TimeStateWeight 「数値データ」プロパティー・シート、「集計」タブ、「時状態加重平均」ボックス

アクセス:Read/Write

ToDateLevel 「特殊カテゴリー」プロパティー・シート、「相対時間」タブ、「累計期間」ボックス(「相対時間」が「カスタム」に設定されているとき)

アクセス:Read/Write

Type なし

アクセス:Read

Unique 「レベル」プロパティー・シート、「ソース」タブ、「ユニーク」チェック・ボックス

アクセス:Read/Write

UniqueMove 「レベル」プロパティー・シート、「ソース」タブ、「移動」チェック・ボックス

アクセス:Read/Write

第 7 章 UI との対応 487

プロパティー 対応する UI

UserID 「サインオン」プロパティー・シート、「全般」タブ、「ユーザー ID」ボックス

アクセス:Read/Write

Version ヘルプ・メニュー、「IBM CognosPowerPlay Transformer について」コマンド、「Transformer について」ボックス

アクセス:Read

Views ディメンション・ダイアグラム、「ディメンション」タブまたは「ユーザー・クラス」タブ

アクセス:Read

ViewStatus 「除外」、「非表示」、「消去」、「集計」または「筆頭指定」コマンド (表示のカテゴリーが選択されているとき) (「ダイアグラム」メニュー)

アクセス:Read/Write

ViewType 「PowerCube」プロパティー・シート、「ディメンション」タブ (選択した項目を右クリックしたとき)

アクセス:Read/Write

WeekAdd 日付ウィザード

「ドリル・カテゴリー」プロパティー・シート (日付)、「時間」タブ、「余分な週を追加」ボックス

アクセス:Write (DateWizard) Read/Write(DateDrillDown)

WeekSpan 日付ウィザード

「ドリル・カテゴリー」プロパティー・シート (日付)、「時間」タブ、「週分割法」ボックス

アクセス:Write (DateWizard) Read/Write(DateDrillDown)

488 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

プロパティー 対応する UI

WeekStart 「ドリル・カテゴリー」プロパティー・シート (日付)、「時間」タブ、「週開始日」ボックス

アクセス:Read/Write

WeekStartDay 日付ウィザード

アクセス:Write

WorkingDay 日付ウィザード

「ディメンション」プロパティー・シート(日付)、「時間」タブ、「曜日」ボックス

アクセス:Write (DateWizard) Read/Write(DateDimension)

WorkingDays 日付ウィザード

「ディメンション」プロパティー・シート(日付)、「時間」タブ、「曜日」ボックス

アクセス:Write (DateWizard) Read/Write(DateDimension)

YearStartDay 日付ウィザード

「ドリル・カテゴリー」プロパティー・シート (日付)、「時間」タブ、「年開始日付」ボックス

アクセス:Write (DateWizard) Read/Write(DateDrillDown)

YearType 日付ウィザード

「レベル」プロパティー・シート (日付)、「時間」タブ、「日付変換」ボックス

アクセス:Write

第 7 章 UI との対応 489

値リストと定数次の表は、値リストおよび定数と、それに相当するユーザー・インターフェースの対応表です。

定数 対応する UI

xtrAllocationType 「レベル」プロパティー・シート、「割り当て」タブ、ショートカット・メニュー (選択した数値データを右クリックしたとき)

xtrAssociationRole 「ディメンション」プロパティー・シート、「全般」タブ、「外部集計列」ボックス(「データ・ソース」プロパティー・シートの「全般」タブにある「外部集計数値データ値の値を含む」チェック・ボックスがオンのとき)

「レベル」プロパティー・シート、「ソース」タブまたは「ソート基準」タブ

「数値データ」プロパティー・シート、「タイプ」タブ (「タイプ」が「列」に設定されているとき)

「通貨表」プロパティー・シート、「基準テーブル列」ボックス (「外部の通貨データ・ソースを使用」チェック・ボックスがオンのとき)

xtrAssociationType 「ディメンション」プロパティー・シート、「全般」タブ、「外部集計列」ボックス(「データ・ソース」プロパティー・シートの「全般」タブにある「外部集計数値データ値の値を含む」チェック・ボックスがオンのとき)

「レベル」プロパティー・シート、「ソース」タブ、または

「数値データ」プロパティー・シート、「タイプ」タブ (「タイプ」が「列」に設定されているとき)、または

「通貨表」プロパティー・シート、「基準テーブル列」ボックス (「外部の通貨データ・ソースを使用」チェック・ボックスがオンのとき)

xtrCharacterType 「データ・ソース」プロパティー・シート(フラット・ファイルのデータ・ソース)、「文字セット」ボックス

490 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

定数 対応する UI

xtrCubeConsolidate 「PowerCube」プロパティー・シート、「全般」タブ、「集約」ボックス

xtrCubeCreation 「PowerCube」プロパティー・シート、「処理」タブ、「キューブの作成」ボックス

xtrCubeOptimize 「PowerCube」プロパティー・シート、「処理」タブ、「最適化」ボックス

xtrCubeStatus 「PowerCube」プロパティー・シート、「処理」タブ、「状態」ボックス

xtrCurrencyTableType 「通貨表」プロパティー・シート

xtrDataClass 「オブジェクト」プロパティー・シート、「全般」タブ、「データ・クラス」ボックス

xtrDateCategoriesGeneration 「レベル」プロパティー・シート (日付)、「時間」タブ、「期間内のカテゴリーすべてを生成」チェック・ボックス

xtrDateFormat 「列」プロパティー・シート、「時間」タブ、「日付入力書式」ボックス

xtrDateLevel 「列」プロパティー・シート、「時間」タブ、「詳細度」ボックス

xtrDuplicateRollup 「数値データ」プロパティー・シート、「集計」タブ、「重複データ集計」ボックス

xtrGenerateOptions 「レベル」プロパティー・シート (日付)、「全般」タブ、「生成条件」ボックス

xtrInclusion 「オブジェクト」プロパティー・シート、「全般」タブ、「生成条件」ボックス

xtrMeasureType 「数値データ」プロパティー・シート、「タイプ」タブ

xtrMissingValue 「数値データ」プロパティー・シート、「全般」タブ、「欠落値」ボックス

xtrObjectType Transformer OLE オブジェクトを参照するUI の項目

xtrOrigin なし

第 7 章 UI との対応 491

定数 対応する UI

xtrPowerCubeGeneration 「データ・ソース」プロパティー・シート、「全般」タブ、「タイミング」ボックス、「PowerCube 作成」チェック・ボックス(オプション・ボタン)

xtrPreferences 「設定」コマンド、「設定」プロパティー・シート (「ファイル」メニュー)

xtrRollup 「数値データ」プロパティー・シート、「集計」タブ、「標準集計」ボックス

xtrRollupTiming 「数値データ」プロパティー・シート、「集計」タブ、「計算タイミング」ボックス (算出数値データ)

xtrSourceType 「データ・ソース」プロパティー・シート、「ソース」タブ、「ソース・タイプ」ボックス

xtrSpecialFunction 「日付レベル」プロパティー・シート、「時間」タブ、「日付変換」ボックス

xtrStorage 「数値データ」プロパティー・シート、「全般」タブ、「保管タイプ」ボックス

xtrTimeAggregate 「特殊カテゴリー」プロパティー・シート、「相対時間」タブ、「基本的アプローチ」ボックス (「相対時間」が「カスタム」に設定されているとき)

xtrTimeArrayType 「列」プロパティー・シート、「配列」タブ、「配列タイプ」ボックス

xtrTimeRollup 「数値データ」プロパティー・シート、「集計」タブ、「時状態データ集計」ボックス

xtrTimeType 日付ウィザード

xtrViewStatus 「除外」、「非表示」、「消去」、「集計」または「筆頭指定」コマンド (表示のカテゴリーが選択されているとき) (「ダイアグラム」メニュー)

xtrViewType 「PowerCube」プロパティー・シート、「ディメンション」タブ、ショートカット・メニュー (選択したディメンションを右クリックしたとき)

492 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

定数 対応する UI

xtrWeekAdd 「ドリル・カテゴリー」プロパティー・シート (日付)、「時間」タブ、「余分な週を追加」ボックス

xtrWeekDay 「ディメンション」プロパティー・シート(日付)、「時間」タブ、「曜日」ボックス

「ドリル・カテゴリー」プロパティー・シート (日付)、「時間」タブ、「週開始日」ボックス

xtrWeekSpan 「ドリル・カテゴリー」プロパティー・シート (日付)、「時間」タブ、「週分割法」ボックス

第 7 章 UI との対応 493

494 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

第 8 章 サンプルと例

このセクションでは、OLE オートメーションの特定の概念を例示するさまざまなVisual Basic コードの例について説明します。これらのコード例は、Visual Basic2008 でテスト済みです。

注: このセクションで説明に使用されている例は再利用することができます。再利用にあたっては、コード例をコピーして貼り付ける以上の作業が必要になる場合があります。例えば、開発環境によっては改行の処理が異なる可能性があります。

製品に付属するサンプルを使用することもできます。IBM_Cognos_Samples.zip ファイルには、サンプルの「GO データ・ウェアハウス (分析)」パッケージと「GOデータ・ウェアハウス (クエリー)」パッケージが入っています。このファイルは、インストール場所¥webcontent¥samples¥content¥ ディレクトリーにあります。

IBM Cognos サンプルのインストールと設定については、「インストールおよび設定ガイド」を参照してください。

モデルを開き、関連付けによる並べ替えを指定する例次の例は、モデルを開き、収束レベルのドリルダウン・パスの 1 つに並べ替えの関連付けを指定します。

Sub Example1()Dim objTransApp As ObjectDim objModel As ObjectDim objDrill As ObjectDim objAssociation As ObjectDim objColumn As ObjectDim strIBMCognos10Location As StringDim strModelPath As StringDim strModelSource As String'Change these paths to match your installationstrIBMCognos10Location = "C:\Program Files\IBM\Cognos\c10\"strModelSource = "Great outdoors 8.mdl"strModelPath = strIBMCognos10Location & _

"webcontent\samples\models\Transformer8\EN\" & strModelSourceobjTransApp = CreateObject("IBMCognosTransformer.ApplicationCtrl.1")With objTransApp

.DataSourcePath = strIBMCognos10Location & "bin"

.TransdaPath = strIBMCognos10Location & "CS7Gateways\bin\TransDa.exe"End WithobjModel = objTransApp.OpenModel(strModelPath)objDrill = objModel.Dimensions("Retailers").DrillDowns(2)'Create an OrderBy association for the convergence level.objAssociation = objDrill.ConvergenceLevel.Associations.Add()'Select the drill-down path to which the sort applies.objAssociation.Context = objDrill'Select the data source column, RetailerName, on which to base

the sort.objColumn = objModel.DataSources("Retailer site (csv)").Columns("Retailer name")With objAssociation

.AssociationRole = xtrAssociationRole.trAssociationOrderBy

.AssociationType = xtrAssociationType.trAssociationQuery

.Label = objColumn.Name

.Update()

495

End WithobjDrill.Levels("Retailer site").OrderByDescending(objAssociation.Context) =

FalseWith objModel

.GenerateCategories()

.Update()

.SaveAs("Great outdoors 8X.mdl")

.Close()End WithobjColumn = NothingobjAssociation = NothingobjDrill = NothingobjModel = NothingobjTransApp = Nothing

End Sub

モデルを開き、計算を追加する例次の例は、モデルを開き、"Products"ディメンションに計算の定義を追加します。数式には share 関数を使用し、カテゴリー・セットから 2 つの算出カテゴリーを作成します。

注:場合によっては、マクロを使用してカテゴリー・オブジェクトのプロパティーを設定できないことがあります。マクロが有効に見えても、"parentCategory ="または"childCategory ="の部分を実行すると、「このコレクションはこのコンテキストでは読み取り専用です」というメッセージが表示されます。代わりにユーザー・インターフェースを使用することを推奨します。

Sub Example2()Dim objTransApp As ObjectDim model As ModelDim dimension As DimensionDim calcDef As CalculationDefinitionDim catSet As CategorySetDim drillDown As DrillDownDim parentCategory As CategoryDim childCategory As CategoryDim strIBMCognos10Location As StringDim strModelPath As StringDim strModelSource As String'Change these paths to match your installationstrIBMCognos10Location = "C:\Program Files\IBM\Cognos\c10\"strModelSource = "great outdoors sales.mdl"strModelPath = strIBMCognos10Location & _

"webcontent\samples\models\Transformer8\EN\" & strModelSourceobjTransApp = CreateObject("IBMCognosTransformer.ApplicationCtrl.1")With objTransApp

.DataSourcePath = strIBMCognos10Location & "bin"

.TransdaPath = strIBMCognos10Location & "CS7Gateways\bin\TransDa.exe"End Withmodel = objTransApp.OpenModel(strModelPath)dimension = model.Dimensions.Item("Products")calcDef = dimension.CalculationDefinitions.Add()catSet = calcDef.CategorySets.Add()

drillDown = dimension.DrillDowns.Item(1)parentCategory = drillDown.Categories.Item(1) 'select "Camping

Equipment"For child_category_index = 1 To parentCategory.ChildCategories.Count

childCategory = parentCategory.ChildCategories.Item(child_category_index)If childCategory.Name = "Cooking Gear" Or childCategory.Name

= "Tents" ThencatSet.Categories.Add(childCategory)

End If

496 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

NextcatSet.Label = "Set 1"With calcDef

.ExpressionText = "share ( catset ( ""Set 1"" ) , """ &_

parentCategory.Code & """)".Group = False.Name = "share(""Set 1"", ""Camping Equipment"")".Update()

End WithWith model

.SaveAs("great outdoors salesX.mdl")

.Close()End With

End Sub

相対時間カテゴリーを作成する例次の例は、SpecialCategory オブジェクトを使用して相対時間カテゴリーを作成し、適用されるプロパティーを設定します。

Sub Example3()Dim objTransApp As ObjectDim objModel As ObjectDim objSpecCategory As ObjectDim strIBMCognos10Location As StringDim strModelPath As StringDim strModelSource As String'Change these paths to match your installationstrIBMCognos10Location = "C:\Program Files\IBM\Cognos\c10\"strModelSource = "Sales and Marketing.mdl"strModelPath = strIBMCognos10Location & _

"webcontent\samples\models\Transformer8\EN\" & strModelSourceobjTransApp = CreateObject("IBMCognosTransformer.ApplicationCtrl.1")With objTransApp

.DataSourcePath = strIBMCognos10Location & "bin"

.TransdaPath = strIBMCognos10Location & "CS7Gateways\bin\TransDa.exe"End WithobjModel = objTransApp.OpenModel(strModelPath)'Create a relative time special category in a time dimension.objSpecCategory = _

objModel.Dimensions("Time").Categories.Add(xtrObjectType.trSpecialCategory)With objSpecCategory

.Aggregate = xtrTimeAggregate.trAggregateRunning

.Code = "Five Month Period"

.ContextLevel = "Quarter"

.ContextOffset = -3

.Name = "Five Month Period"

.Rollup = True

.RunningPeriods = 5

.TargetLevel = "Month"

.TargetOffset = -1

.Update()End WithWith objModel

.SaveAs("Sales and MarketingX.mdl")

.Close()End WithobjSpecCategory = NothingobjModel = NothingobjTransApp = Nothing

End Sub

第 8 章 サンプルと例 497

キューブ・グループを追加する例このマクロは、"Sales region"ディメンションを基礎として、既存のモデルにキューブ・グループを追加します。グループの 1 つの子キューブは作成されません。

Sub Example4()Dim objTransApp As ObjectDim objModel As ObjectDim objDimRegion As ObjectDim objCubesByRegion As ObjectDim strCategoryCode As StringDim objChildCube As ObjectDim strIBMCognos10Location As StringDim strModelPath As StringDim strModelSource As String'Change these paths to match your installationstrIBMCognos10Location = "C:\Program Files\IBM\Cognos\c10\"strModelSource = "great outdoors sales.mdl"

strModelPath = strIBMCognos10Location & _"webcontent\samples\models\Transformer8\EN\" & strModelSource

objTransApp = CreateObject("IBMCognosTransformer.ApplicationCtrl.1")With objTransApp

.DataSourcePath = strIBMCognos10Location & "bin"

.TransdaPath = strIBMCognos10Location & "CS7Gateways\bin\TransDa.exe"End WithobjModel = objTransApp.OpenModel(strModelPath)objDimRegion = objModel.Dimensions("Sales region")objCubesByRegion = objModel.Cubes.Add(xtrObjectType.trCubeGroup)With objCubesByRegion

'Specify the category levels on which to base the cubesin the group.

.GroupDimension = objDimRegion

.GroupLevel = objDimRegion.DrillDowns(1).Levels("Sales region")'Specify the level of detail and summary level..DetailLevel = objDimRegion.DrillDowns(1).Levels("Country").SummaryLevel = objDimRegion.DrillDowns(1).Levels("Sales

region").Name = "Regions".MDCFile = "".CubeCreation = xtrCubeCreation.trCubeCreationON.Optimize = xtrCubeOptimize.trOptimizeDefault.CompressMDC = False.CacheCrossTabs = False.MeasureInclude(objModel.Measures("Unit cost")) = False.MeasureName = "Revenue Made".Update()

End With'Name each cube in the group after its category nameFor index = 1 To objCubesByRegion.GroupLevel.CategoryCount

strCategoryCode = objCubesByRegion.GroupLevel.LevelCategories(index).CodeobjChildCube = objCubesByRegion.ChildCubes(strCategoryCode)With objChildCube

.Name = objCubesByRegion.GroupLevel.LevelCategories(index).Name

.Update()End With

Next'Do not generate a child cube for Central Europe.objChildCube = objCubesByRegion.ChildCubes("Central Europe")With objChildCube

.CubeCreation = xtrCubeCreation.trCubeCreationOFF

.Update()End With'Generate the cubes (this may take a few minutes)objCubesByRegion.CreateMDCFile()With objModel

.SaveAs("great outdoors salesX.mdl")

498 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

.Close()End WithobjChildCube = NothingobjDimRegion = NothingobjCubesByRegion = NothingobjModel = NothingobjTransApp = Nothing

End Sub

追加のデータ・ソースをモデルに追加する例次の例は、モデルに別のデータ・ソースを追加し、新しいデータ・ソースを使用して割り当てを設定します。Forecast 数値データを作成し、Revenue 数値データを加重係数として使用して比例配分します。

Sub Example5()Dim objTransApp As ObjectDim objModel As ObjectDim objDataSource As ObjectDim objDimension As ObjectDim objColumn As ObjectDim objLevel As ObjectDim objMeasure As ObjectDim objByMeasure As ObjectDim strIBMCognos10Location As StringDim strModelPath As StringDim strModelSource As StringDim strDataSource As StringDim strDataPath As String'Change these paths to match your installationstrIBMCognos10Location = "C:\Program Files\IBM\Cognos\c10\"strModelSource = "great outdoors sales.mdl"strDataSource = "prod_plan.csv"strModelPath = strIBMCognos10Location & _

"webcontent\samples\models\Transformer8\EN\" & strModelSourcestrDataPath = strIBMCognos10Location & _

"webcontent\samples\datasources\cubes\PowerCubes\EN\greatoutdoors sales\" & _

strDataSourceobjTransApp = CreateObject("IBMCognosTransformer.ApplicationCtrl.1")With objTransApp

.DataSourcePath = strIBMCognos10Location & "bin"

.TransdaPath = strIBMCognos10Location & "CS7Gateways\bin\TransDa.exe"End WithobjModel = objTransApp.OpenModel(strModelPath)'Add and define a second datasource.objDataSource = objModel.DataSources.Add(xtrObjectType.trFlatFileDataSource)With objDataSource

.CharacterType = xtrCharacterType.trCharAnsiSingleByte

.External = False

.FieldSeparator = ","

.LocalPath = strDataPath.MaximizeSpeed = True.Name = "Product Plan (csv)".SourceType = xtrSourceType.trFlatFileColumnNames.Update()

End With'Specify data classes and rename columns.objColumn = objDataSource.Columns(1)With objColumn

.DataClass = xtrDataClass.trDataClassDate

.Name = "Order Date"

.Update()End WithobjColumn = objDataSource.Columns(3)

第 8 章 サンプルと例 499

With objColumn.DataClass = xtrDataClass.trDataClassDescription.Name = "Product line code".Update()

End With'Add a measure.objColumn = objDataSource.Columns("EXPECTED_VOLUME")With objColumn

.DataClass = xtrDataClass.trDataClassQuantity

.InputScale = 0

.Name = "Forecast"

.Update()End WithobjMeasure = objModel.Measures.Add()With objMeasure

.AssociateWith(objColumn, xtrAssociationRole.trAssociationSource)

.Description = "Forcasted volume for product line."

.AllowDrillThrough = False

.Update()End With'Test whether allocation is possible.objLevel = objModel.Dimensions("Products").DimensionLevels(1)If objLevel.CanAllocate = True Then

objMeasure = objModel.Measures("Forecast")'Test whether the specified measure can be allocated.If objLevel.CanAllocateMeasure(objMeasure) = True Then

'Test whether allocation by proportion is already set.If objLevel.AllocationType(objMeasure) <> _xtrAllocationType.trAllocationByAnotherMeasure Then

objByMeasure = objModel.Measures("Revenue")'Test whether the specified measure can be used

as a weighting factor.If objLevel.CanAllocateByMeasure(objByMeasure) = TrueThen

objLevel.SetAllocation(objMeasure, _xtrAllocationType.trAllocationByAnotherMeasure,objByMeasure)

End IfEnd If

End IfEnd If'Suppress allocation to the Margin range dimension.objDimension = objModel.Dimensions("Margin range")If objDimension.CanAllocate = True Then

objDimension.SetAllocation(objMeasure, xtrAllocationType.trAllocationNA)End IfWith objModel

.SaveAs("great outdoors salesX.mdl")

.Close()End With

objByMeasure = NothingobjMeasure = NothingobjLevel = NothingobjColumn = Nothing

6

モデルを開き、キューブのプロパティーを変更する例次の例は、モデルを開き、キューブのプロパティーを変更します。

Sub Example6()Dim objTransApp As ObjectDim objModel As ObjectDim objCube As ObjectDim strIBMCognos10Location As String

500 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

Dim strModelPath As StringDim strModelSource As String'Change these paths to match your installationstrIBMCognos10Location = "C:\Program Files\IBM\Cognos\c10\"strModelSource = "great outdoors sales.mdl"strModelPath = strIBMCognos10Location & _

"webcontent\samples\models\Transformer8\EN\" & strModelSourceobjTransApp = CreateObject("IBMCognosTransformer.ApplicationCtrl.1")With objTransApp

.DataSourcePath = strIBMCognos10Location & "bin"

.TransdaPath = strIBMCognos10Location & "CS7Gateways\bin\TransDa.exe"End WithobjModel = objTransApp.OpenModel(strModelPath)objCube = objModel.Cubes.Item(1)With objCube

.BlockParentTotals = True

.CacheCrossTabs = True

.CompressMDC = False

.Consolidate = xtrCubeConsolidate.trConsolidateDefault

.CubeCreation = xtrCubeCreation.trCubeCreationON

.DesiredPartitionSize = 500000

.EstimatedRows = 10000000

.IncrementalUpdate = False

.MaxNumPartLevels = 5.MDCFile = "GoCube".Optimize = xtrCubeOptimize.trOptimizeAutoPartition.Name = "Great Outdoors Sales (Optimized)".Update().CreateMDCFile()

End WithobjModel.SaveAs("great outdoors salesX.mdl")objModel.Close()objCube = NothingobjModel = NothingobjTransApp = Nothing

End Sub

カスタム・ビューを作成する例この例では、カスタム・ビューを作成します。次に、カスタム・ビューをキューブに関連付けます。

注:場合によっては、マクロを使用してカテゴリー・オブジェクトのプロパティーを設定できないことがあります。マクロが有効に見えても、"objCategory ="部分を実行すると、「このコレクションはこのコンテキストでは読み取り専用です」というメッセージが表示されます。代わりにユーザー・インターフェースを使用することを推奨します。

Sub Example7()Dim objTransApp As ObjectDim model As ModelDim dimension As DimensionDim measure As MeasureDim custom_view As CustomViewDim view As TransformerSDKLib.ViewDim category As CategoryDim cube As CubeDim intX As IntegerDim strIBMCognos10Location As StringDim strModelPath As StringDim strModelSource As String'Change these paths to match your installationstrIBMCognos10Location = "C:\Program Files\IBM\Cognos\c10\"

第 8 章 サンプルと例 501

strModelSource = "Sales and Marketing.mdl"strModelPath = strIBMCognos10Location & _

"webcontent\samples\models\Transformer8\EN\" & strModelSourceobjTransApp = CreateObject("IBMCognosTransformer.ApplicationCtrl.1")With objTransApp

.DataSourcePath = strIBMCognos10Location & "bin"

.TransdaPath = strIBMCognos10Location & "CS7Gateways\bin\TransDa.exe"End Withmodel = objTransApp.OpenModel(strModelPath)'Set a custom view for a dimension.dimension = model.Dimensions.Item("Retailers")'Exclude the "Planned revenue" measuremeasure = model.Measures.Item("Planned revenue")'Create custom viewcustom_view = model.CustomViews.Add()With custom_view

.Name = "Central Europe"

.DimensionInclude(dimension) = xtrViewType.trViewTypeCustom

.MeasureInclude(measure) = False

.Update()End With'Get associated View objectview = custom_view.DimensionView(dimension)'Set a view for each category in the top level of the collection.For intX = 1 To dimension.DrillDowns.Item(1).Categories.Count

category = dimension.DrillDowns.Item(1).Categories(intX)If category.Name <> "Central Europe" Then

view.SetViewStatus(category, xtrViewStatus.trViewStatusSummaryMom)

End IfNext intX'Associate a custom view with a cubecube = model.Cubes.Item("Sales and Marketing")cube.CubeCustomViews.Add(custom_view)With model

.SaveAs("Sales and MarketingX.mdl")

.Close()End WithobjTransApp = Nothing

End Sub

モデルを開き、通貨レコードを追加する例次の例は、モデルを開き、既存の通貨表に通貨レコードを追加します。また、新規レコードの通貨レートも設定します。

Sub Example8()Dim objTransApp As ObjectDim objModel As ObjectDim objBaseTable As ObjectDim objCurrencyRecord As ObjectDim objCurrencyRate As ObjectDim objDateDrillDown As ObjectDim objLevel As ObjectDim intX As IntegerDim strIBMCognos10Location As StringDim strModelPath As StringDim strModelSource As String'Change these paths to match your installationstrIBMCognos10Location = "C:\Program Files\IBM\Cognos\c10\"strModelSource = "Great outdoors 8.mdl"strModelPath = strIBMCognos10Location & _

"webcontent\samples\models\Transformer8\EN\" & strModelSourceobjTransApp = CreateObject("IBMCognosTransformer.ApplicationCtrl.1")With objTransApp

.DataSourcePath = strIBMCognos10Location & "bin"

502 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

.TransdaPath = strIBMCognos10Location & "CS7Gateways\bin\TransDa.exe"End WithobjModel = objTransApp.OpenModel(strModelPath)objBaseTable = objModel.CurrencyTables.Add()With objBaseTable

.CurrencyTableType = xtrCurrencyTableType.trCurrencyTableBase

.Update()End WithobjDateDrillDown = objModel.Dimensions("Years").DrillDowns(1)objCurrencyRecord = objModel.CurrencyRecords.Add()objLevel = objDateDrillDown.Levels("Year")objCurrencyRecord.DateLevel = objLevelWith objCurrencyRecord

.CountryCode = "AUS"

.Label = "Australian Dollar"

.CurrencyDecimals = 2

.CurrencyFormatOverride = True

.CurrencyIsEMU = False

.CurrencyIsEuro = False

.CurrencySymbol = "$"

.Update()End WithFor intX = 1 To objLevel.CategoryCount

objCurrencyRate = objCurrencyRecord.CurrencyRates(intX)If objCurrencyRate.PopulateByDataSource = False Then

Select Case objLevel.LevelDrillDowns(1).Categories(intX).KeyNameCase "2004"

objCurrencyRate.Rate = 1.54Case "2005"

objCurrencyRate.Rate = 1.55Case Else

'End SelectSelect Case objCurrencyRate.Category.KeyName

Case "2006"objCurrencyRate.Rate = 1.56

Case "2007"objCurrencyRate.Rate = 1.57

Case Else'

End SelectobjCurrencyRate.Update()

End IfNext intXWith objModel

.SaveAs("Great outdoors 8X.mdl")

.Close()End WithobjLevel = NothingobjDateDrillDown = NothingobjCurrencyRate = NothingobjCurrencyRecord = NothingobjModel = NothingobjTransApp = Nothing

End Sub

DoAutoDesign メソッドと TestBuild メソッドを使用してキューブを作成する例

次の例は、モデルを作成し、データ・ソースを追加します。次に、DoAutoDesignメソッドと TestBuild メソッドを使用して小さいキューブを作成します。

第 8 章 サンプルと例 503

Sub Example9()Dim objTransApp As ObjectDim objModel As ObjectDim objDataSource As ObjectDim strIBMCognos10Location As StringDim strDataSource As StringDim strDataPath As String'Change these paths to match your installationstrIBMCognos10Location = "C:\Program Files\IBM\Cognos\c10\"strDataSource = "NATIONAL.ASC"strDataPath = strIBMCognos10Location & _

"webcontent\samples\datasources\cubes\PowerCubes\EN\National\"& _

strDataSourceobjTransApp = CreateObject("IBMCognosTransformer.ApplicationCtrl.1")objModel = objTransApp.NewModelobjDataSource = objModel.DataSources.Add(xtrObjectType.trFlatFileDataSource)With objDataSource

.GenerateCategories = True

.GeneratePowerCube = xtrPowerCubeGeneration.trGenerationDefault

.CharacterType = xtrCharacterType.trCharAnsiSingleByte

.FieldSeparator = ","

.LocalPath = strDataPath

.MaximizeSpeed = True

.Name = "National"

.SetsCurrentPeriod = True

.SourceType = xtrSourceType.trFlatFileColumnNames

.Update()End WithWith objModel

.Name = "National"

.DoAutoDesign()

.TestBuild(20, True)

.Update()

.SaveAs("NationalX.mdl")

.Close()End WithobjDataSource = NothingobjModel = NothingobjTransApp = Nothing

End Sub

ディメンションを選択、変更、更新する例次の例は、Dimensions コレクションから Dimension オブジェクトを選択し、1 つのプロパティーを変更して、ディメンションを更新します。

Sub Example10()Dim objTransApp As ObjectDim objModel As ObjectDim objDimensions As ObjectDim objLocationsDim As ObjectDim strIBMCognos10Location As StringDim strModelPath As StringDim strModelSource As String'Change these paths to match your installationstrIBMCognos10Location = "C:\Program Files\IBM\Cognos\c10\"strModelSource = "great outdoors sales.mdl"strModelPath = strIBMCognos10Location & _

"webcontent\samples\models\Transformer8\EN\" & strModelSourceobjTransApp = CreateObject("IBMCognosTransformer.ApplicationCtrl.1")With objTransApp

.DataSourcePath = strIBMCognos10Location & "bin"

.TransdaPath = strIBMCognos10Location & "CS7Gateways\bin\TransDa.exe"End WithobjModel = objTransApp.OpenModel(strModelPath)

504 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

objDimensions = objModel.DimensionsobjLocationsDim = objDimensions.Item(3)With objLocationsDim

.ExcludeAutoPartition = True

.Update()End WithobjModel.SaveAs("great outdoors salesX.mdl")objModel.Close()objLocationsDim = NothingobjDimensions = NothingobjModel = NothingobjTransApp = Nothing

End Sub

Level コレクションから 1 つのレベルを削除する例次の例は、Levels コレクションから 1 つのレベルを削除します。

Sub Example11()Dim objTransApp As ObjectDim objModel As ObjectDim objTimeDimension As ObjectDim objLevel As ObjectDim strIBMCognos10Location As StringDim strModelPath As StringDim strModelSource As String'Change these paths to match your installationstrIBMCognos10Location = "C:\Program Files\IBM\Cognos\c10\"strModelSource = "Sales and Marketing.mdl"strModelPath = strIBMCognos10Location & _

"webcontent\samples\models\Transformer8\EN\" & strModelSourceobjTransApp = CreateObject("IBMCognosTransformer.ApplicationCtrl.1")With objTransApp

.DataSourcePath = strIBMCognos10Location & "bin"

.TransdaPath = strIBMCognos10Location & "CS7Gateways\bin\TransDa.exe"End WithobjModel = objTransApp.OpenModel(strModelPath)objTimeDimension = objModel.Dimensions.Item("Time")objLevel = objTimeDimension.DrillDowns.Item(1).Levels.Item("Month")objLevel.Delete()objTimeDimension.Update()objModel.SaveAs("Sales and MarketingX.mdl")objModel.Close()objLevel = NothingobjTimeDimension = NothingobjModel = NothingobjTransApp = Nothing

End Sub

Measure オブジェクトを移動し、Revenue 数値データの集計を変更する例次の例は、Measure オブジェクトを Measures コレクションの最上位に移動します。Revenue 数値データの集計を重複データ集計に変更します。Revenue 数値データは、Quantity 数値データを使用して加重平均を作成します。

Sub Example12()Dim objTransApp As ObjectDim objModel As ObjectDim objMeasures As ObjectDim currentMeasure As MeasureDim strIBMCognos10Location As StringDim strModelPath As StringDim strModelSource As String'Change these paths to match your installation

第 8 章 サンプルと例 505

strIBMCognos10Location = "C:\Program Files\IBM\Cognos\c10\"strModelSource = "great outdoors sales.mdl"strModelPath = strIBMCognos10Location & _

"webcontent\samples\models\Transformer8\EN\" & strModelSourceobjTransApp = CreateObject("IBMCognosTransformer.ApplicationCtrl.1")With objTransApp

.DataSourcePath = strIBMCognos10Location & "bin"

.TransdaPath = strIBMCognos10Location & "CS7Gateways\bin\TransDa.exe"End WithobjModel = objTransApp.OpenModel(strModelPath)objMeasures = objModel.MeasuresobjMeasures.Item(2).Move(1)currentMeasure = objMeasures("Revenue")With currentMeasure

.RegularRollup = xtrRollup.trRollupAverage

.RegularWeight = objModel.Measures("Quantity").Name

.RollupTiming = xtrRollupTiming.trTimingDefault

.DuplicateRollup = xtrDuplicateRollup.trDuplicateRollupAverage

.DuplicateWeight = objModel.Measures("Quantity").Name

.Format = "$#,##0"

.FormatDecimals = 2

.IgnoreMissingValue = False

.MissingValue = xtrMissingValue.trMissingValueZERO

.ReverseSign = False

.ShortName = "Revenue"

.Update()End WithobjModel.SaveAs("great outdoors salesX.mdl")objModel.Close()objMeasures = NothingobjModel = Nothing

パーティションを作成し、モデルをチェックする例次の例は、モデルを開き、"Central Europe"および子孫カテゴリーのパーティションを作成して、モデルをチェックします。

注:場合によっては、マクロを使用してカテゴリー・オブジェクトのプロパティーを設定できないことがあります。マクロが有効に見えても、"objCategory ="部分を実行すると、「このコレクションはこのコンテキストでは読み取り専用です」というメッセージが表示されます。代わりにユーザー・インターフェースを使用することを推奨します。

Sub Example13()Dim objTransApp As ObjectDim objModel As ObjectDim objCategory As ObjectDim intX As IntegerDim strIBMCognos10Location As StringDim strModelPath As StringDim strModelSource As String'Change these paths to match your installationstrIBMCognos10Location = "C:\Program Files\IBM\Cognos\c10\"strModelSource = "great outdoors sales.mdl"strModelPath = strIBMCognos10Location & _

"webcontent\samples\models\Transformer8\EN\" & strModelSourceobjTransApp = CreateObject("IBMCognosTransformer.ApplicationCtrl.1")With objTransApp

.DataSourcePath = strIBMCognos10Location & "bin"

.TransdaPath = strIBMCognos10Location & "CS7Gateways\bin\TransDa.exe"End WithobjModel = objTransApp.OpenModel(strModelPath)objModel.ResetPartitions()objCategory = objModel.Dimensions("Sales region").Drilldowns(1).Categories(2)

506 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

objCategory.Partition = 1objCategory.Update()For intX = 1 To objModel.CheckModel.Count

MsgBox(objModel.CheckModel(intX).Name)Next intXWith objModel

.SaveAs("great outdoors salesX.mdl")

.Close()End WithobjCategory = NothingobjModel = NothingobjTransApp = Nothing

End Sub

モデルを開き、PowerCube にドリルスルーする例次の例は、モデルを開き、Quantity 数値データを使用して PowerCube へのドリルスルーを設定します。

Sub Example14()Dim objTransApp As ObjectDim objModel As ObjectDim objMeasure As ObjectDim objReport As ObjectDim strIBMCognos10Location As StringDim strModelPath As StringDim strModelSource As StringDim strReportPath As StringDim strReportSource As String'Change these paths to match your installationstrIBMCognos10Location = "C:\Program Files\IBM\Cognos\c10\"strModelSource = "great outdoors sales.mdl"strReportSource = "drill_through_to_cube_7.mdc"strModelPath = strIBMCognos10Location & _

"webcontent\samples\models\Transformer8\EN\" & strModelSourcestrReportPath = strIBMCognos10Location & _

"webcontent\samples\datasources\cubes\PowerCubes\EN\" &strReportSource

objTransApp = CreateObject("IBMCognosTransformer.ApplicationCtrl.1")With objTransApp

.DataSourcePath = strIBMCognos10Location & "bin"

.TransdaPath = strIBMCognos10Location & "CS7Gateways\bin\TransDa.exe"End WithobjModel = objTransApp.OpenModel(strModelPath)objMeasure = objModel.Measures.Item("Quantity")With objMeasure

.AllowDrillThrough = True

.Update()End WithobjReport = objMeasure.DrillThroughTargets.Add(strReportPath,

"Default Report")objModel.SaveAs("great outdoors salesX.mdl")objModel.Close()objReport = NothingobjMeasure = NothingobjModel = Nothing

作成者の役割をカスタム・ビューに追加する例この例では、「Cognos」ネームスペースを使用して作成者の役割をカスタム・ビューに追加します。

第 8 章 サンプルと例 507

Sub Example15()Dim objTransApp As ObjectDim model As ModelDim new_namespace As TransformerSDKLib.NamespaceDim securityObject As SecurityObjectDim customView As CustomViewDim CAMID_of_Namespace As StringDim CAMID_of_User As StringDim CAMID_of_Object As StringDim Name_of_Namespace As StringDim Name_of_User As StringDim Name_of_Object As StringDim ID_of_Namespace As StringDim strIBMCognos10Location As StringDim strModelPath As StringDim strModelSource As String'Change these paths to match your installationstrIBMCognos10Location = "C:\Program Files\IBM\Cognos\c10\"strModelSource = "great outdoors sales.mdl"strModelPath = strIBMCognos10Location & _

"webcontent\samples\models\Transformer8\EN\" & strModelSourceName_of_Namespace = "Cognos"ID_of_Namespace = ""Name_of_User = ""Name_of_Object = "Authors"objTransApp = CreateObject("IBMCognosTransformer.ApplicationCtrl.1")With objTransApp

.DataSourcePath = strIBMCognos10Location &"bin"

.TransdaPath = strIBMCognos10Location & "CS7Gateways\bin\TransDa.exe"End Withmodel = objTransApp.OpenModel(strModelPath)'Provide namespace, username, and password in that orderobjTransApp.Logon("Cognos", "", "") 'Log into the Cognos namespace

using Anonymous usernew_namespace = model.Namespaces.Add()'Provide: Namespace and Object names'Receive: Both Namespace's and Object's CAMIDsWith new_namespace

.Name = Name_of_Namespace

.ObjectName = Name_of_Object 'Authors is a group

.Update()CAMID_of_Namespace = .CAMIDCAMID_of_Object = .ObjectCAMIDCAMID_of_User = ""

End With'Another way to get CAMIDs below (Commented Out)'The code below can be adapted to use any Namespace and User'Provide: Namespace ID and user'Receive: Namespace and User CAMIDs and Namespace name'With new_namespace' .ID = ID_of_Namespace' .User = Name_of_User' .Update()' CAMID_of_Namespace = .CAMID' CAMID_of_User = .UserCAMID' Name_of_Namespace = .Name'End With'Create custom viewcustomView = model.CustomViews.Add()With customView

.Name = Name_of_Object

.Update()End With'Create and add security object to custom viewsecurityObject = new_namespace.SecurityObjects.Add()With securityObject

508 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

.Name = CAMID_of_Object 'provide the User or Object CAMIDhere

.DisplayName = Name_of_Object

.Type = xtrSecurityType.trSecurityType_Role

.AddToCustomView(customView)

.Update()End WithWith model

.SaveAs("great outdoors salesX.mdl")

.Close()End WithobjTransApp.Logoff()objTransApp = Nothing

End Sub

中断モデルをチェックする例この例では、中断モデルの存在をチェックし、見つかった場合、モデルが壊れていればメッセージを表示します。次に、RemoveSuspendedModel メソッドを使用して、SuspendedModels コレクションから中断モデルを削除します。

Sub Example16()Dim objTransApp As ObjectDim objSuspendedModel As ObjectDim intX As IntegerobjTransApp = CreateObject("IBMCognosTransformer.ApplicationCtrl.1")If objTransApp.SuspendedModels.Count = 0 Then

MsgBox("There are no suspended models")Else

For intX = objTransApp.SuspendedModels.Count To 1 Step -1objSuspendedModel = objTransApp.SuspendedModels(intX)If objSuspendedModel.IsBad = True Then

MsgBox("Model: " + objSuspendedModel.ModelName +_

", located at " + objSuspendedModel.QyPath + " iscorrupt")

End IfobjTransApp.RemoveSuspendedModel(objSuspendedModel)

Next intXEnd IfobjSuspendedModel = NothingobjTransApp = Nothing

End Sub

モデルを開き、ディメンション・ビューを作成する例次の例は、モデルを開き、"Retailers"ディメンションのディメンション・ビューを作成します。このビューでは、"Central Europe"についてはドリルダウン・パス全体を表示し、他の地域については要約レベルのみを表示します。次に、ディメンション・ビューをキューブに関連付けます。

注:場合によっては、マクロを使用してカテゴリー・オブジェクトのプロパティーを設定できないことがあります。マクロが有効に見えても、"objCategory ="部分を実行すると、「このコレクションはこのコンテキストでは読み取り専用です」というメッセージが表示されます。代わりにユーザー・インターフェースを使用することを推奨します。

Sub Example17()Dim objTransApp As ObjectDim objModel As ObjectDim objDimension As Object

第 8 章 サンプルと例 509

Dim objView As ObjectDim objCategory As ObjectDim objCube As ObjectDim intX As IntegerDim strIBMCognos10Location As StringDim strModelPath As StringDim strModelSource As String'Change these paths to match your installationstrIBMCognos10Location = "C:\Program Files\IBM\Cognos\c10\"strModelSource = "Sales and Marketing.mdl"strModelPath = strIBMCognos10Location & _

"webcontent\samples\models\Transformer8\EN\" & strModelSourceobjTransApp = CreateObject("IBMCognosTransformer.ApplicationCtrl.1")With objTransApp

.DataSourcePath = strIBMCognos10Location & "bin"

.TransdaPath = strIBMCognos10Location & "CS7Gateways\bin\TransDa.exe"End WithobjModel = objTransApp.OpenModel(strModelPath)objDimension = objModel.Dimensions("Retailers")objCube = objModel.Cubes("Sales and Marketing")If objCube.DimensionViewType(objDimension) = _xtrViewType.trViewTypeAllCategories Then

objView = objDimension.Views.Add()With objView

.Name = "Central Europe"

.ViewType = xtrViewType.trViewTypeCustom

.Update()

.Parent.Update()End WithFor intX = 1 To objDimension.DrillDowns(1).Categories.Count

objCategory = objDimension.DrillDowns(1).Categories(intX)If objCategory.Name <> "Central Europe" Then

objView.SetViewStatus(objCategory,xtrViewStatus.trViewStatusSummaryMom)

If objView.GetViewStatus(objCategory) <> _xtrViewStatus.trViewStatusSummaryMom Then

MsgBox("Failed to set ViewStatus!")End If

End IfNext intXobjCube.DimensionView(objDimension) = objViewobjCube.Update()

End IfWith objModel

.SaveAs("Sales and MarketingX.mdl")

.Close()End WithobjCube = NothingobjCategory = NothingobjView = NothingobjDimension = NothingobjModel = NothingobjTransApp = Nothing

End Sub

キューブ・グループをモデルに追加する例このマクロは、既存のモデルにキューブ・グループを追加します。"Sales region"ディメンションがグループの基礎になります。

Sub Example18()Dim objTransApp As ObjectDim objModel As ObjectDim objDataSource As ObjectDim objRegionsDrill As Object

510 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

Dim objCubesByRegion As ObjectDim objChildCube As ObjectDim strCategoryCode As StringDim strIBMCognos10Location As StringDim strModelPath As StringDim strModelSource As String'Change these paths to match your installationstrIBMCognos10Location = "C:\Program Files\IBM\Cognos\c10\"strModelSource = "great outdoors sales.mdl"strModelPath = strIBMCognos10Location & _

"webcontent\samples\models\Transformer8\EN\" & strModelSourceobjTransApp = CreateObject("IBMCognosTransformer.ApplicationCtrl.1")With objTransApp

.DataSourcePath = strIBMCognos10Location & "bin"

.TransdaPath = strIBMCognos10Location & "CS7Gateways\bin\TransDa.exe"End WithobjModel = objTransApp.OpenModel(strModelPath)objRegionsDrill = objModel.Dimensions("Sales region").DrillDowns(1)objCubesByRegion = objModel.Cubes.Add(xtrObjectType.trCubeGroup)With objCubesByRegion

.GroupDimension = objModel.Dimensions("Sales region")

.GroupLevel = objRegionsDrill.Levels("Sales region")

.DetailLevel = objRegionsDrill.Levels("Branch")

.SummaryLevel = objRegionsDrill.Levels("Sales region")

.CacheCrossTabs = False

.CompressMDC = False

.CubeCreation = xtrCubeCreation.trCubeCreationON

.MeasureInclude(objModel.Measures("Product cost")) = False

.Name = "Sales Regions"

.Optimize = xtrCubeOptimize.trOptimizeDefault

.Update()End With'Name each cube in the group after its category nameFor index = 1 To objCubesByRegion.GroupLevel.CategoryCount

strCategoryCode = objCubesByRegion.GroupLevel.LevelCategories(index).CodeobjChildCube = objCubesByRegion.ChildCubes(strCategoryCode)With objChildCube

.Name = objCubesByRegion.GroupLevel.LevelCategories(index).Name

.Update()End With

NextWith objModel

.SaveAs("great outdoors salesX.mdl")

.Close()End WithobjChildCube = NothingobjCubesByRegion = NothingobjRegionsDrill = NothingobjDataSource = NothingobjModel = NothingobjTransApp = Nothing

End Sub

モデルを作成し、日付ディメンションのプロパティーを更新する例このマクロの例は、モデルを作成し、日付ディメンションに関連付けられたいくつかのプロパティーを更新します。

Sub Example19()Dim objTransApp As ObjectDim objModel As ObjectDim objDataSource As ObjectDim objDateDim As ObjectDim objDateLevel As ObjectDim strIBMCognos10Location As StringDim strDataSource As String

第 8 章 サンプルと例 511

Dim strDataPath As String'Change these paths to match your installationstrIBMCognos10Location = "C:\Program Files\IBM\Cognos\c10\"strDataSource = "NATIONAL.ASC"strDataPath = strIBMCognos10Location & _

"webcontent\samples\datasources\cubes\PowerCubes\EN\National\"& _

strDataSourceobjTransApp = CreateObject("IBMCognosTransformer.ApplicationCtrl.1")objModel = objTransApp.NewModelobjDataSource = objModel.DataSources.Add(xtrObjectType.trFlatFileDataSource)With objDataSource

.LocalPath = strDataPath

.Name = "National"

.SetsCurrentPeriod = True

.SourceType = xtrSourceType.trFlatFileColumnNames

.Update()End WithWith objModel

.Name = "National"

.DoAutoDesign()

.Update()End WithobjDateDim = objModel.Dimensions("Date")With objDateDim

.EarliestDate = 19900101

.GenerateTimePeriod(xtrTimeType.trTimeTypeMonth) = _xtrGenerateOptions.trGenerateAll

.LatestDate = 20101231

.GenerateDateCategories(19990101, 20101231)

.WorkingDay(xtrWeekDay.trSunday) = False

.ManualCurrentPeriod = False

.Update()End WithobjDateLevel = objDateDim.DimensionLevels("Month")With objDateLevel

.DateFormat = "MMMM, yyyy"

.GenerateDateCategories = xtrDateCategoriesGeneration.trGenerateDatesAll

.Update()End WithWith objModel

.TestBuild(20, True)

.GenerateCategories()MsgBox("Current Period:" + objDateDim.CurrentPeriod.Name).SaveAs("NationalX.mdl").Close()

End WithobjDateLevel = NothingobjDateDim = NothingobjDataSource = NothingobjModel = NothingobjTransApp = Nothing

End Sub

代替ドリルダウン・パスを作成する例次の例は、ディメンションの代替ドリルダウン・パスを作成します。

Sub Example20()Dim objTransApp As ObjectDim objModel As ObjectDim objLocationsDim As ObjectDim objLevel As ObjectDim objAltDrill As ObjectDim objNewLevel As Object

512 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

Dim objRefSource As ObjectDim objRefLabel As ObjectDim strIBMCognos10Location As StringDim strModelPath As StringDim strModelSource As String'Change these paths to match your installationstrIBMCognos10Location = "C:\Program Files\IBM\Cognos\c10\"strModelSource = "Great outdoors 8.mdl"strModelPath = strIBMCognos10Location & _

"webcontent\samples\models\Transformer8\EN\" & strModelSourceobjTransApp = CreateObject("IBMCognosTransformer.ApplicationCtrl.1")With objTransApp

.DataSourcePath = strIBMCognos10Location & "bin"

.TransdaPath = strIBMCognos10Location & "CS7Gateways\bin\TransDa.exe"End WithobjModel = objTransApp.OpenModel(strModelPath)objLocationsDim = objModel.Dimensions("Sales regions")'Remove the Branch Code level and then use it in an alternate

drill-down path.objLocationsDim.DrillDowns(1).Levels("Branch").Delete()'Obtain the convergence level and create the alternate drill-down

path.objLevel = objLocationsDim.DrillDowns(1).Levels("Employee")With objLevel

.Unique = True

.UniqueMove = True

.Update()End WithobjAltDrill = objLevel.CreateAlternateDrillDown'Add a new level to the Levels collection of the alternate drill-down

path.objNewLevel = objAltDrill.Levels.Add(xtrObjectType.trLevel)'Associate the new level with columns in the data source.objRefSource = objModel.DataSources("Sales region (csv)").Columns("Branch code")objRefLabel = objModel.DataSources("Sales region (csv)").Columns("Branch city")With objNewLevel

.AssociateWith(objRefSource, xtrAssociationRole.trAssociationSource)

.AssociateWith(objRefLabel, xtrAssociationRole.trAssociationLabel)

.BlankSubstitute = "No Value"

.Inclusion = xtrInclusion.trInclusionGenerate

.NewCatsLocked = False

.Name = "Branch"

.RefreshDescription = True

.RefreshLabel = True

.RefreshShortName = True

.Update()End With'Move the level and then set the primary drill down.With objAltDrill

.Levels("Branch").Move(1)

.IsPrimary = True

.Name = "By Branch"

.Update()End WithWith objModel

.GenerateCategories()

.Update()

.SaveAs("Great outdoors 8X.mdl")

.Close()End WithobjRefLabel = NothingobjRefSource = NothingobjNewLevel = NothingobjAltDrill = NothingobjLevel = Nothing

第 8 章 サンプルと例 513

objLocationsDim = NothingobjModel = NothingobjTransApp = Nothing

End Sub

DateWizard を使用して時間ディメンションを作成する例次の例は、新規のモデルを作成し、データ・ソースを追加し、DateWizard オブジェクトを使用して時間ディメンションを作成します。

Sub Example21()Dim objTransApp As ObjectDim objModel As ObjectDim objDataSource As ObjectDim objColumn As ObjectDim objDateWizard As ObjectDim objDateDim As ObjectDim objDrillDown As ObjectDim strIBMCognos10Location As StringDim strDataSource As StringDim strDataPath As String'Change these paths to match your installationstrIBMCognos10Location = "C:\Program Files\IBM\Cognos\c10\"strDataSource = "NATIONAL.ASC"strDataPath = strIBMCognos10Location & _

"webcontent\samples\datasources\cubes\PowerCubes\EN\National\"& _

strDataSourceobjTransApp = CreateObject("IBMCognosTransformer.ApplicationCtrl.1")objModel = objTransApp.NewModelobjDataSource = objModel.DataSources.Add(xtrObjectType.trFlatFileDataSource)With objDataSource

.DecimalPoint = "."

.LocalPath = strDataPath

.Name = "National"

.SourceType = xtrSourceType.trFlatFileColumnNames

.Update()End WithobjColumn = objDataSource.Columns.Item("Date")objDateWizard = objModel.DateWizardWith objDateWizard

.DimensionName = "Dates"

.DimensionAssociateWith(objColumn, xtrAssociationRole.trAssociationSource)

.EarliestDate = 19930101

.EnableTimePeriod(xtrTimeType.trTimeTypeYear) = True

.EnableTimePeriod(xtrTimeType.trTimeTypeQuarter) = True

.EnableTimePeriod(xtrTimeType.trTimeTypeMonth) = True

.EnableTimePeriod(xtrTimeType.trTimeTypeWeek) = False

.EnableTimePeriod(xtrTimeType.trTimeTypeDay) = False

.GenerateDates = False

.LatestDate = 19941231

.MonthType = xtrSpecialFunction.trSpecialFunctionMonth

.QuarterType = xtrSpecialFunction.trSpecialFunctionQuarter

.WeekAdd = xtrWeekAdd.trWeekAddNone

.WeekSpan = xtrWeekSpan.trWeekSpanNone

.WeekStartDay = xtrWeekDay.trMonday

.WorkingDays(127)

.WorkingDay(xtrWeekDay.trSunday) = False

.YearType = xtrSpecialFunction.trSpecialFunctionYearEnd WithobjDateDim = objDateWizard.CreateDateDimension()objDateDim.Update()objDrillDown = objDateDim.DrillDowns(1)With objDrillDown

.DrillCode = "By Dates"

.DrillInclusion = xtrInclusion.trInclusionSuppress

514 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

.WeekSpan = xtrWeekSpan.trWeekSpanSplitMost

.WeekStart = xtrWeekDay.trMonday

.Update()End WithWith objModel

.GenerateCategories()

.SaveAs("NationalX.mdl")MsgBox(.FileName & " " & .Size & " " & .Time).Close()

End WithobjDrillDown = NothingobjDateDim = NothingobjDateWizard = NothingobjColumn = NothingobjDataSource = NothingobjModel = NothingobjTransApp = Nothing

End Sub

カテゴリー・カウントの数値データを作成し、モデルに追加する例次の例は、カテゴリー・カウントの数値データを作成して、既存のモデルに追加します。

Sub Example22()Dim objTransApp As ObjectDim objModel As ObjectDim objMeasure As ObjectDim objLevel As ObjectDim objActMeasure As ObjectDim strIBMCognos10Location As StringDim strModelPath As StringDim strModelSource As String

'Change these paths to match your installationstrIBMCognos10Location = "C:\Program Files\IBM\Cognos\c10\"strModelSource = "great outdoors sales.mdl"strModelPath = strIBMCognos10Location & _

"webcontent\samples\models\Transformer8\EN\" & strModelSourceobjTransApp = CreateObject("IBMCognosTransformer.ApplicationCtrl.1")With objTransApp

.DataSourcePath = strIBMCognos10Location & "bin"

.TransdaPath = strIBMCognos10Location & "CS7Gateways\bin\TransDa.exe"End WithobjModel = objTransApp.OpenModel(strModelPath)objMeasure = objModel.Measures.Add()objLevel = objModel.Dimensions("Sales region").DrillDowns(1).Levels("Branch")With objLevel

.Unique = True

.Update()End WithobjActMeasure = objModel.Measures("Quantity")objMeasure.ActivityMeasure = objActMeasureobjMeasure.CategoryCountLevel = objLevelWith objMeasure

.AllowCurrencyConversion = False

.AllowDrillThrough = False

.Name = "Sales branch count"

.OutputScale = 0

.Precision = 0

.ReverseSign = False

.StorageType = xtrStorage.trStorageDefault

.Update()End WithobjModel.SaveAs("great outdoors salesX.mdl")objModel.Close()

第 8 章 サンプルと例 515

objActMeasure = NothingobjLevel = NothingobjMeasure = NothingobjModel = NothingobjTransApp = Nothing

End Sub

ディメンション・ビューをモデルに追加する例次の例は、既存のモデルにディメンション・ビューを追加します。

Sub Example23()Dim objTransApp As ObjectDim objModel As ObjectDim objProductsDim As ObjectDim objViewItem As ObjectDim objCube As ObjectDim strIBMCognos10Location As StringDim strModelPath As StringDim strModelSource As String'Change these paths to match your installationstrIBMCognos10Location = "C:\Program Files\IBM\Cognos\c10\"strModelSource = "great outdoors sales.mdl"strModelPath = strIBMCognos10Location & _

"webcontent\samples\models\Transformer8\EN\" & strModelSourceobjTransApp = CreateObject("IBMCognosTransformer.ApplicationCtrl.1")With objTransApp

.DataSourcePath = strIBMCognos10Location & "bin"

.TransdaPath = strIBMCognos10Location & "CS7Gateways\bin\TransDa.exe"End WithobjModel = objTransApp.OpenModel(strModelPath)objProductsDim = objModel.Dimensions.Item("Products")objViewItem = objProductsDim.Views.Add()objViewItem.Apex = objProductsDim.Drilldowns(1).Categories(1)With objViewItem

.Name = "OutDoor Products"

.ViewType = xtrViewType.trViewTypeCustom

.Update()End WithobjProductsDim.Update()objCube = objModel.Cubes(1)objCube.DimensionView(objProductsDim) = objViewItemobjCube.Update()With objModel

.SaveAs("great outdoors salesX.mdl")

.Close()End WithobjCube = NothingobjViewItem = NothingobjProductsDim = NothingobjModel = NothingobjTransApp = Nothing

End Sub

子カテゴリーを別の親に移動する例次の例は、子カテゴリーを別の親へ移動し、1 つの国または地域を別の地域へ再割り当てします。

注:場合によっては、マクロを使用してカテゴリー・オブジェクトのプロパティーを設定できないことがあります。マクロが有効に見えても、"objCategory ="部分を実

516 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

行すると、「このコレクションはこのコンテキストでは読み取り専用です」というメッセージが表示されます。代わりにユーザー・インターフェースを使用することを推奨します。

Sub Example24()Dim objTransApp As ObjectDim objModel As ObjectDim objCategory As ObjectDim objCatToMove As ObjectDim objCatToReceive As ObjectDim strIBMCognos10Location As StringDim strModelPath As StringDim strModelSource As String'Change these paths to match your installationstrIBMCognos10Location = "C:\Program Files\IBM\Cognos\c10\"strModelSource = "Sales and Marketing.mdl"strModelPath = strIBMCognos10Location & _

"webcontent\samples\models\Transformer8\EN\" & strModelSourceobjTransApp = CreateObject("IBMCognosTransformer.ApplicationCtrl.1")With objTransApp

.DataSourcePath = strIBMCognos10Location & "bin"

.TransdaPath = strIBMCognos10Location & "CS7Gateways\bin\TransDa.exe"End WithobjModel = objTransApp.OpenModel(strModelPath)'Get the Asia Pacific region category.objCategory = objModel.Dimensions("Retailers").DrillDowns(1).Categories(2)'Get the Australia category.objCatToMove = objCategory.ChildCategories(5)'Get the Americas region category.objCatToReceive = objModel.Dimensions("Retailers").DrillDowns(1).Categories(1)'Move Australia to a new region.objCatToMove.MoveToCategory(objCatToReceive)objModel.SaveAs("Sales and MarketingX.mdl")objModel.Close()objCatToReceive = NothingobjCatToMove = NothingobjCategory = NothingobjModel = NothingobjTransApp = Nothing

End Sub

ファイルにテーブルを追加し、データをロードする例次の例は、欧州通貨統合 (EMU) の複数の通貨レートを含む小さなサンプル・ファイル"EurosX.csv"を作成します。これには、基準通貨とユーロ通貨変換に使用する基準通貨レートも含まれます。次に、ユーロ表を追加し、"EurosX.csv"を使用してテーブルにデータをロードします。

Sub Example25()Dim objTransApp As ObjectDim objModel As ObjectDim objDataSource As ObjectDim objEuroTable As ObjectDim objColumn As ObjectDim objCurrencyRec As ObjectDim intX As IntegerDim FileNumber As IntegerDim strIBMCognos10Location As StringDim strModelPath As StringDim strModelSource As StringDim strDataPath As StringDim strDataSource As StringDim strDataSourceName As String'Change these paths to match your installation

第 8 章 サンプルと例 517

strIBMCognos10Location = "C:\Program Files\IBM\Cognos\c10\"strModelSource = "great outdoors sales.mdl"strModelPath = strIBMCognos10Location & _

"webcontent\samples\models\Transformer8\EN\" & strModelSourcestrDataSource = "Euro CurrencyX.csv"strDataPath = System.IO.Directory.GetCurrentDirectory() &

_"\..\..\..\" & strDataSource

strDataSourceName = "Euro Currency"'Create EurofileFileNumber = FreeFile()FileOpen(FileNumber, strDataPath, OpenMode.Output)PrintLine(FileNumber, "EuroDate,EuroCurrency,EuroCode,EuroConRate")PrintLine(FileNumber, "0,Austrian Schilling,AUT,13.7603")PrintLine(FileNumber, "0,French Franc,FRA,6.55957")PrintLine(FileNumber, "20040101,U.S. Dollar,USA,1.2597")PrintLine(FileNumber, "20040201,U.S. Dollar,USA,1.2452")FileClose(FileNumber)objTransApp = CreateObject("IBMCognosTransformer.ApplicationCtrl.1")With objTransApp

.DataSourcePath = strIBMCognos10Location & "bin"

.TransdaPath = strIBMCognos10Location & "CS7Gateways\bin\TransDa.exe"End WithobjModel = objTransApp.OpenModel(strModelPath)objDataSource = objModel.DataSources.Add(xtrObjectType.trFlatFileDataSource)With objDataSource

.GenerateCategories = False

.GeneratePowerCube = xtrPowerCubeGeneration.trGenerationNoCreatePowerCubes

.LocalPath = strDataPath

.Name = strDataSourceName

.SourceType = xtrSourceType.trFlatFileColumnNames

.SetsCurrentPeriod = False

.Update()

.Columns("EuroDate").DataClass = xtrDataClass.trDataClassDate

.Columns("EuroDate").DateDegreeofDetail = xtrDateLevel.trDateLevelMonth

.Columns("EuroDate").DateInputFormat = xtrDateFormat.trMDY

.Columns("EuroDate").Update()End WithobjEuroTable = objModel.CurrencyTables.Add()

With objEuroTable.CurrencyTableType = xtrCurrencyTableType.trCurrencyTableEuro.Update()

End WithobjColumn = _

objModel.DataSources(strDataSourceName).Columns("EuroCurrency")objEuroTable.AssociateWith(objColumn, xtrAssociationRole.trAssociationLabel)objColumn = _

objModel.DataSources(strDataSourceName).Columns("EuroConRate")objEuroTable.AssociateWith(objColumn, xtrAssociationRole.trAssociationRate)objColumn = _

objModel.DataSources(strDataSourceName).Columns("EuroCode")objEuroTable.AssociateWith(objColumn,

xtrAssociationRole.trAssociationCountryCode)objColumn = _

objModel.DataSources(strDataSourceName).Columns("EuroDate")objEuroTable.AssociateWith(objColumn,

xtrAssociationRole.trAssociationCurrencyDate)objEuroTable.Update()objModel.LoadCurrencyTable()For intX = 1 To objModel.CurrencyRecords.Count

objCurrencyRec = objModel.CurrencyRecords(intX)Select Case objCurrencyRec.CountryCode

Case "AUT", "FIN", "FRA"With objCurrencyRec

.CurrencyIsEMU = True

.EMUEntryDate = "19990101"

.Update()

518 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

End WithCase Else

'End Select

Next intXWith objModel

.LoadCurrencyTable()

.SaveAs("great outdoors salesX.mdl")

.Close()End WithobjCurrencyRec = NothingobjColumn = NothingobjEuroTable = NothingobjDataSource = NothingobjModel = NothingobjTransApp = Nothing

End Sub

月暦年に基づいて時間ディメンションを生成する例次の例は、新規のモデルを作成してデータ・ソースを追加し、月暦年に基づいて時間ディメンションを生成します。

Sub Example26()Dim objTransApp As ObjectDim objModel As ObjectDim objDataSource As ObjectDim objColumn As ObjectDim objDateWizard As ObjectDim objDateDim As ObjectDim objDrillDown As ObjectDim objDateLevel As ObjectDim strIBMCognos10Location As StringDim strDataSource As StringDim strDataPath As String'Change these paths to match your installationstrIBMCognos10Location = "C:\Program Files\IBM\Cognos\c10\"strDataSource = "NATIONAL.ASC"strDataPath = strIBMCognos10Location & _

"webcontent\samples\datasources\cubes\PowerCubes\EN\National\"& _

strDataSourceobjTransApp = CreateObject("IBMCognosTransformer.ApplicationCtrl.1")objModel = objTransApp.NewModelobjDataSource = objModel.DataSources.Add()With objDataSource

.LocalPath = strDataPath

.Name = "National"

.SourceType = xtrSourceType.trFlatFileColumnNames

.Update()End WithobjColumn = objDataSource.Columns.Item("Date")objDateWizard = objModel.DateWizardWith objDateWizard

.DimensionName = "Dates"

.DimensionAssociateWith(objColumn, xtrAssociationRole.trAssociationSource)

.EarliestDate = 19900101

.EnableTimePeriod(xtrTimeType.trTimeTypeMonth) = True

.EnableTimePeriod(xtrTimeType.trTimeTypeQuarter) = True

.EnableTimePeriod(xtrTimeType.trTimeTypeYear) = True

.LatestDate = 20101231

.WorkingDays = xtrWeekDay.trMonday + xtrWeekDay.trTuesday+ _

xtrWeekDay.trWednesday + xtrWeekDay.trThursday+ _

xtrWeekDay.trFriday

第 8 章 サンプルと例 519

End WithobjDateDim = objDateWizard.CreateDateDimension()objDateDim.Update()objDrillDown = objDateDim.DrillDowns(1)With objDrillDown

.DrillCode = "By Order Date"

.DrillInclusion = xtrInclusion.trInclusionSuppress

.Lunar = True

.WeekAdd = xtrWeekAdd.trWeekAddDays4

.WeekStart = xtrWeekDay.trMonday

.YearStartDay = 19900101

.Update()End WithobjDateLevel = objDateDim.DimensionLevels(1)objDateLevel.DateFunction = xtrSpecialFunction.trSpecialFunctionLunarYearobjDateLevel.Update()objDateLevel = objModel.Dimensions("Dates").DimensionLevels(2)objDateLevel.DateFunction = xtrSpecialFunction.trSpecialFunctionLunarQuarterobjDateLevel.Update()

objDateLevel = objModel.Dimensions("Dates").DimensionLevels(3)objDateLevel.DateFunction = xtrSpecialFunction.trSpecialFunctionLunarMonth445objDateLevel.Update()With objModel

.GenerateCategories()

.SaveAs("NationalX.mdl")

.Close()End WithobjDateLevel = NothingobjDrillDown = NothingobjDateDim = NothingobjDateWizard = NothingobjColumn = NothingobjDataSource = NothingobjModel = NothingobjTransApp = Nothing

End Sub

子カテゴリーを別の親カテゴリーに移動する例次の例は、子カテゴリーを同じレベルにある別の親カテゴリーに移動します。

注:場合によっては、マクロを使用してカテゴリー・オブジェクトのプロパティーを設定できないことがあります。マクロが有効に見えても、"objCategory ="部分を実行すると、「このコレクションはこのコンテキストでは読み取り専用です」というメッセージが表示されます。代わりにユーザー・インターフェースを使用することを推奨します。

Sub Example27()Dim objTransApp As ObjectDim objModel As ObjectDim objDimension As ObjectDim objCategories As ObjectDim objCategory As ObjectDim objChildCategory As ObjectDim objParentCategory As ObjectDim strIBMCognos10Location As StringDim strModelPath As StringDim strModelSource As String'Change these paths to match your installationstrIBMCognos10Location = "C:\Program Files\IBM\Cognos\c10\"strModelSource = "Sales and Marketing.mdl"

520 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

strModelPath = strIBMCognos10Location & _"webcontent\samples\models\Transformer8\EN\" & strModelSource

objTransApp = CreateObject("IBMCognosTransformer.ApplicationCtrl.1")With objTransApp

.DataSourcePath = strIBMCognos10Location & "bin"

.TransdaPath = strIBMCognos10Location & "CS7Gateways\bin\TransDa.exe"End WithobjModel = objTransApp.OpenModel(strModelPath)'Get a dimensionobjDimension = objModel.Dimensions("Retailers")'Get a collection of categoriesobjCategories = objDimension.DrillDowns(1).Categories'Get the 5th categoryobjCategory = objCategories(5)'Find the Spain child categoryFor child_category_index = 1 To objCategory.ChildCategories.Count

objChildCategory = objCategory.ChildCategories(child_category_index)If objChildCategory.Name = "Spain" Then

'Find the Americas category and move the Spain childcategory to it

For parent_category_index = 1 To objCategories.CountobjParentCategory = objCategories(parent_category_index)If objParentCategory.Name = "Americas" Then

objChildCategory.ConnectWithCategory(objParentCategory)Exit For

End IfNextExit For

End IfNextWith objModel

.SaveAs("Sales and MarketingX.mdl")

.Close()End WithobjParentCategory = NothingobjChildCategory = NothingobjCategory = NothingobjCategories = NothingobjDimension = NothingobjModel = NothingobjTransApp = Nothing

End Sub

アプリケーションに属性を設定する例この例では、Application オブジェクトにさまざまな属性を設定する方法を示します。

Sub Example28()Dim objTransApp As ObjectDim strStartLocation As StringstrStartLocation = System.IO.Directory.GetCurrentDirectory()

objTransApp = CreateObject("IBMCognosTransformer.ApplicationCtrl.1")With objTransApp

.DataCharacterSet = xtrCharacterType.trCharDefault

.DataSourcePath = strStartLocation

.DataTemporaryFilesPath = strStartLocation

.DefaultDateFormat = xtrPreferences.trDateFormatFromControlPanel

.DetachDataSource = True

.EnableMessageLogging = True

.LogErrorLevel = xtrPreferences.trLogErrorsAndAbove

.LogFileAppend = True

.LogFileName = "TrModelsLog.log"

.LogFilesPath = strStartLocation

.MaxTransactionNumber = 500000

第 8 章 サンプルと例 521

.ModelsPath = strStartLocation

.ModelTemporaryFilesPath = strStartLocation

.PowerCubesPath = strStartLocation

.RowsAsSample = 600

.RowsChecked = 600

.SortComparisonRule = xtrPreferences.trSortIgnoreControlPanelEnd WithobjTransApp = Nothing

End Sub

パッケージを追加および削除する例この例では、既存のモデルを開き、いくつかのパッケージを追加して、各パッケージの情報を表示し、そのうちの 1 つのパッケージを削除して、モデルを新しいファイルに保存します。

Sub Example29()Dim objTransApp As ObjectDim model As ModelDim packages As PackagesDim package As PackageDim new_package As PackageDim temp_package As PackageDim path As StringDim timestamp As StringDim name As StringDim index As IntegerDim strIBMCognos10Location As StringDim strModelPath As StringDim strModelSource As String'Change these paths to match your installationstrIBMCognos10Location = "C:\Program Files\IBM\Cognos\c10\"strModelSource = "Sales and Marketing.mdl"strModelPath = strIBMCognos10Location & _

"webcontent\samples\models\Transformer8\EN\" & strModelSourceobjTransApp = CreateObject("IBMCognosTransformer.ApplicationCtrl.1")With objTransApp

.DataSourcePath = strIBMCognos10Location & "bin"

.TransdaPath = strIBMCognos10Location & "CS7Gateways\bin\TransDa.exe"End With'Open a package based modelmodel = objTransApp.OpenModel(strModelPath)'Create a new package and add it to the modeltimestamp = Format(Now, "yyyy-MM-ddTHH:mm:ss.fffZ")

new_package = model.Packages.Add()new_package.Name = "GO Data Warehouse (analysis)"new_package.Path = "/content/package[@name='GO Data Warehouse

(analysis)']"new_package.TimeStamp = "/content/package[@name='GO Data Warehouse (analysis)']"

_& "/model[@name='" & timestamp & "']"

new_package.Update()'Create a second package and add it to the modeltimestamp = Format(Now, "yyyy-MM-ddTHH:mm:ss.fffZ")temp_package = model.Packages.Add()temp_package.Name = "Temporary Package"temp_package.Path = "/content/package[@name='Temporary Package']"temp_package.TimeStamp = "/content/package[@name='Temporary

Package']" _& "/model[@name='" & timestamp & "']"

temp_package.Update()'Iterate through all packages and display informationpackages = model.PackagesFor index = 1 To packages.Count

package = packages.Item(index)

522 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

name = package.Namepath = package.Pathtimestamp = package.TimeStampMsgBox("Package name: " & name & Chr(13) & _

"Package path: " & path & Chr(13) & _"Package time stamp: " & timestamp)

Next'Delete second packagepackages.Remove(temp_package)model.Update()'Save the model under a different locationmodel.SaveAs("Sales and MarketingX.mdl")model.Close()objTransApp = Nothing

End Sub

レポートを追加および削除する例この例では、既存のモデルを開き、いくつかのレポートを追加して各レポートの情報を表示し、そのうちの 1 つのレポートを削除して、モデルを新しいファイルに保存します。

Sub Example30()Dim objTransApp As ObjectDim model As ModelDim reports As ReportsDim report As ReportDim new_report As ReportDim temp_report As ReportDim path As StringDim timestamp As StringDim name As StringDim index As IntegerDim strIBMCognos10Location As StringDim strModelPath As StringDim strModelSource As String'Change these paths to match your installationstrIBMCognos10Location = "C:\Program Files\IBM\Cognos\c10\"strModelSource = "Employee expenses.mdl"strModelPath = strIBMCognos10Location & _

"webcontent\samples\models\Transformer8\EN\" & strModelSourceobjTransApp = CreateObject("IBMCognosTransformer.ApplicationCtrl.1")With objTransApp

.DataSourcePath = strIBMCognos10Location & "bin"

.TransdaPath = strIBMCognos10Location & "CS7Gateways\bin\TransDa.exe"End With'Open a report based modelmodel = objTransApp.OpenModel(strModelPath)'Create a new report and add it to the modeltimestamp = Format(Now, "yyyy-MM-ddTHH:mm:ss.fffZ")new_report = model.Reports.Add()new_report.Name = "TOC report"new_report.Path = "/content/package[@name='GO Data Warehouse

(query)']" _& "/folder[@name='Reporting Report Samples']" _& "/report[@name='TOC report']"

new_report.TimeStamp = timestampnew_report.Update()'Create a second report and add it to the modeltimestamp = Format(Now, "yyyy-MM-ddTHH:mm:ss.fffZ")temp_report = model.Reports.Add()temp_report.Name = "Temporary Report"temp_report.Path = "/content/package[@name='Temporary Package']"

_& "/report[@name='Temporary Report']"

第 8 章 サンプルと例 523

temp_report.TimeStamp = timestamptemp_report.Update()'Iterate through all reports and display informationreports = model.ReportsFor index = 1 To reports.Count

report = reports.Item(index)name = report.Name

path = report.Pathtimestamp = report.TimeStampMsgBox("Report name: " & name & Chr(13) & _

"Report path: " & path & Chr(13) & _"Report time stamp: " & timestamp)

Next'Delete second packagereports.Remove(temp_report)model.Update()'Save the model under a different locationmodel.SaveAs("Employee expensesX.mdl")model.Close()objTransApp = Nothing

End Sub

クエリーを作成する例この例では、小さなモデルを作成する中でクエリーを作成する方法を示します。

Sub Example31()Dim objTransApp As ObjectDim model As ModelDim new_package As PackageDim new_query As QueryDim new_column1 As ColumnDim new_column2 As ColumnDim new_column3 As ColumnDim measure As MeasureobjTransApp = CreateObject("IBMCognosTransformer.ApplicationCtrl.1")'Create a new modelmodel = objTransApp.NewModel'Create a new package and add it to the modelnew_package = model.Packages.Add()With new_package

.Name = "GO Data Warehouse (query)"

.Path = "/content/package[@name='GO Data Warehouse (query)']"

.Update()End With'Create a new query and add it to the packagenew_query = new_package.Queries.Add()

With new_query.Name = "Sales Revenue".AutoSummary = True.MaximizeSpeed = True.SetsCurrentPeriod = True.Update()

End With'Create 3 new columns and add them to the querynew_column1 = new_query.Columns.Add()With new_column1

.Name = "Date"

.OriginalName = "[Sales (query)].[Time dimension].[Date]"

.Update()End Withnew_column2 = new_query.Columns.Add()With new_column2

.Name = "Region"

.OriginalName = "[Sales (query)].[Retailer site].[Region]"

524 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

.Update()End Withnew_column3 = new_query.Columns.Add()With new_column3

.Name = "Revenue"

.OriginalName = "[Sales (query)].[Sales fact].[Revenue]"

.Update()End With'Add Revenue column as a measuremeasure = model.Measures.Add()With measure

.AssociateWith(new_column3, xtrAssociationRole.trAssociationSource)

.Update()End Withmodel.DoAutoDesign()' See if there is any columns that are mismatchedIf new_query.IsAnyColumnMismatched = True Then

MsgBox("There is at least one column that is mismatched.")For index = 1 To model.CheckModel.Count

MsgBox(model.CheckModel.Item(index).Name)Next index

End If'Save the modelWith model

.SaveAs("GO Data Warehouse (query)X.mdl")

.Close()End WithobjTransApp = Nothing

End Sub

モデルのフィルターを作成および削除する例この例では、小さなモデルを作成する中でフィルターを作成および削除する方法を示します。

Sub Example32()Dim objTransApp As ObjectDim model As ModelDim new_package As PackageDim new_query As QueryDim new_column As ColumnDim new_filter As FilterDim filters As FiltersDim current_filter As FilterDim measure As MeasureobjTransApp = CreateObject("IBMCognosTransformer.ApplicationCtrl.1")'Create a new modelmodel = objTransApp.NewModel'Create a new package and add it to the modelnew_package = model.Packages.Add()With new_package

.Name = "GO Data Warehouse (query)"

.Path = "/content/package[@name='GO Data Warehouse (query)']"

.Update()End With'Create a new query and add it to the packagenew_query = new_package.Queries.Add()With new_query

.Name = "Sales Revenue"

.AutoSummary = True

.MaximizeSpeed = True

.SetsCurrentPeriod = True

.Update()End With'Create 3 new columns and add them to the querynew_column = new_query.Columns.Add()

第 8 章 サンプルと例 525

With new_column.Name = "Date".OriginalName = "[Sales (query)].[Time dimension].[Date]".Update()

End Withnew_column = new_query.Columns.Add()With new_column

.Name = "Region"

.OriginalName = "[Sales (query)].[Retailer site].[Region]"

.Update()End Withnew_column = new_query.Columns.Add()With new_column

.Name = "Revenue"

.OriginalName = "[Sales (query)].[Sales fact].[Revenue]"

.Update()End With'Create 3 new filtersnew_filter = new_query.Filters.Add()With new_filter

.Name = "2004"

.RefName = "[go_data_warehouse].[2004]"

.Update()End Withnew_filter = new_query.Filters.Add()With new_filter

.Name = "2005"

.RefName = "[go_data_warehouse].[2005]"

.Update()End Withnew_filter = new_query.Filters.Add()With new_filter

.Name = "GO Asia Pacific"

.RefName = "[go_data_warehouse].[GO Asia Pacific]"

.Update()End With'Add Revenue column as a measuremeasure = model.Measures.Add()With measure

.AssociateWith(new_column, xtrAssociationRole.trAssociationSource)

.Update()End With'Delete the 2005 filterfilters = new_query.FiltersFor index = 1 To filters.Count

current_filter = filters.Item(index)If current_filter.Name = "2005" Then

current_filter.Delete()Exit For

End IfNextmodel.DoAutoDesign()'Save the modelWith model

.SaveAs("GO Data Warehouse (query)X.mdl")

.Close()End WithobjTransApp = Nothing

End Sub

単一値のプロンプトを作成する例この例では、小さなモデルを作成する中で単一値のプロンプトを作成する方法を示します。

526 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

Sub Example33()Dim objTransApp As ObjectDim model As ModelDim new_report As ReportDim new_query As QueryDim new_column As ColumnDim new_prompt As PromptobjTransApp = CreateObject("IBMCognosTransformer.ApplicationCtrl.1")'Create a new modelmodel = objTransApp.NewModel'Create a new report and add it to the modelnew_report = model.Reports.Add()new_report.Name = "Date Between List"new_report.Path = "/content/package[@name='GO Data Warehouse

(query)']" _& "/folder[@name='SDK Report Samples']" _& "/report[@name='Date Between List']"

new_report.Update()'Create a new query and add it to the reportnew_query = new_report.Queries.Add()With new_query

.Name = "Date Between List (Has Prompt)"

.AutoSummary = False

.MaximizeSpeed = True

.SetsCurrentPeriod = True

.Update()End With'Create 3 new columns and add them to the querynew_column = new_query.Columns.Add()With new_column

.Name = "Date"

.OriginalName = "[Report].[Query1.0].[Date]"

.Update()End Withnew_column = new_query.Columns.Add()With new_column

.Name = "Order number"

.OriginalName = "[Report].[Query1.0].[Order number]"

.Update()End Withnew_column = new_query.Columns.Add()With new_column

.Name = "Order method"

.OriginalName = "[Report].[Query1.0].[Order method]"

.Update()

End With'Create 2 new Single-valued prompts and add them to the querynew_prompt = new_query.Prompts.Add()With new_prompt

.PromptValueType = xtrPromptValueType.trSingleValuePrompt

.Name = "StartDate"

.Type = "Date Time (1999-01-31 18:30:00)"

.Value = "2005-01-01"

.Update()End Withnew_prompt = new_query.Prompts.Add()With new_prompt

.PromptValueType = xtrPromptValueType.trSingleValuePrompt

.Name = "EndDate"

.Type = "Date Time (1999-01-31 18:30:00)"

.Value = "2006-12-31"

.Update()End With'Save the modelWith model

.SaveAs("GO Data Warehouse (query)X.mdl")

第 8 章 サンプルと例 527

.Close()End WithobjTransApp = Nothing

End Sub

複数値プロンプトを作成する例この例では、小さなモデルを作成する中で複数値プロンプトを作成する方法を示します。

Sub Example34()Dim objTransApp As ObjectDim model As Model

Dim new_report As ReportDim new_query As QueryDim new_column As ColumnDim new_prompt As PromptDim list_of_values As String = ""objTransApp = CreateObject("IBMCognosTransformer.ApplicationCtrl.1")'Create a new modelmodel = objTransApp.NewModel'Create a new report and add it to the modelnew_report = model.Reports.Add()new_report.Name = "Product Method Date List"new_report.Path = "/content/package[@name='GO Data Warehouse

(query)']" _& "/folder[@name='SDK Report Samples']" _& "/report[@name='Product Method Date List']"

new_report.Update()'Create a new query and add it to the reportnew_query = new_report.Queries.Add()With new_query

.Name = "Product Method Date List (Has Prompt)"

.AutoSummary = False

.MaximizeSpeed = True

.SetsCurrentPeriod = True

.Update()End With

'Create 3 new columns and add them to the querynew_column = new_query.Columns.Add()With new_column

.Name = "Date"

.OriginalName = "[Report].[Query1.0].[Date]"

.Update()End Withnew_column = new_query.Columns.Add()With new_column

.Name = "Product Name"

.OriginalName = "[Report].[Query1.0].[Product name]"

.Update()End Withnew_column = new_query.Columns.Add()With new_column

.Name = "Order method"

.OriginalName = "[Report].[Query1.0].[Order method]"

.Update()End With'Create a new Multi-valued prompt and add it to the querynew_prompt = new_query.Prompts.Add()With new_prompt

.PromptValueType = xtrPromptValueType.trMultiValuePrompt

.Name = "MP"

.Type = "String"

.Value = "Fax"

528 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

.Value = "Mail"

.Value = "Telephone"

.Value = "Web"

.Update()End With'List all the prompt valuesFor index = 1 To new_prompt.ValuesCount

new_prompt.CurrentValueIndex = indexIf list_of_values <> "" Then

list_of_values = list_of_values & ", " & new_prompt.ValueElse

list_of_values = new_prompt.ValueEnd If

Next

MsgBox("These are the prompt values: " & list_of_values)'Save the modelWith model

.SaveAs("GO Data Warehouse (query)X.mdl")

.Close()End WithobjTransApp = Nothing

End Sub

新しいモデルを開き、PowerCube を発行する例この例では"NATIONAL.ASC"データ・ソースを使用して新しいモデルを作成し、サーバーに PowerCube を発行します。

Sub Example35()Dim objTransApp As ObjectDim model As ModelDim cube As CubeDim dataSource As FlatFileDataSourceDim strIBMCognos10Location As StringDim strDataSource As StringDim strDataPath As String'Change these paths to match your installationstrIBMCognos10Location = "C:\Program Files\IBM\Cognos\c10\"strDataSource = "NATIONAL.ASC"strDataPath = strIBMCognos10Location & _

"webcontent\samples\datasources\cubes\PowerCubes\EN\National\"& _

strDataSourceobjTransApp = CreateObject("IBMCognosTransformer.ApplicationCtrl.1")objTransApp.Logon("Cognos", "", "")'Create new model and add flat file data sourcemodel = objTransApp.NewModeldataSource = model.DataSources.Add(xtrObjectType.trFlatFileDataSource)With dataSource

.GenerateCategories = True

.GeneratePowerCube = xtrPowerCubeGeneration.trGenerationDefault

.CharacterType = xtrCharacterType.trCharAnsiSingleByte

.External = False

.FieldSeparator = ","

.LocalPath = strDataPath

.MaximizeSpeed = True

.Name = "National"

.SourceType = xtrSourceType.trFlatFileColumnNames

.SetsCurrentPeriod = True

.Update()End With'Do Autodesign and make National cube

第 8 章 サンプルと例 529

With model.Name = "National".DoAutoDesign().TestBuild(20, True)

.Update()End With'Publish the National Cubecube = model.Cubes.Item("National")With cube

.MDCFile = "c:\National.mdc"

.Update()

.CreateMDCFile()

.PublishPackage(True, True) 'Re-publish both Datasource& Package

End With'Save modelWith model

.SaveAs("NationalX.mdl")

.Close()End WithobjTransApp.Logoff()objTransApp = Nothing

End Sub

PowerCube をコピーし、有効化する例この例では、コピー機能と有効化機能の使用方法を示します。

Sub Example36()Dim objTransApp As ObjectDim model As ModelDim cube As CubeDim dataSource As FlatFileDataSourceDim strIBMCognos10Location As StringDim strDataSource As StringDim strDataPath As String'Change these paths to match your installationstrIBMCognos10Location = "C:\Program Files\IBM\Cognos\c10\"strDataSource = "NATIONAL.ASC"strDataPath = strIBMCognos10Location & _

"webcontent\samples\datasources\cubes\PowerCubes\EN\National\"& _

strDataSourceobjTransApp = CreateObject("IBMCognosTransformer.ApplicationCtrl.1")objTransApp.Logon("Cognos", "", "")'Create new model and add flat file data sourcemodel = objTransApp.NewModeldataSource = model.DataSources.Add(xtrObjectType.trFlatFileDataSource)With dataSource

.GenerateCategories = True

.GeneratePowerCube = xtrPowerCubeGeneration.trGenerationDefault

.CharacterType = xtrCharacterType.trCharAnsiSingleByte

.External = False

.FieldSeparator = ","

.LocalPath = strDataPath

.MaximizeSpeed = True

.Name = "National"

.SourceType = xtrSourceType.trFlatFileColumnNames

.SetsCurrentPeriod = True

.Update()End With

'Do Autodesign and make National cubeWith model

.Name = "National"

.DoAutoDesign()

530 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

.TestBuild(20, True)

.Update()End With'Copy on Activate the National cubecube = model.Cubes.Item("National")With cube

.MDCFile = "c:\National.mdc"

.Update()

.CreateMDCFile()

.SetDeployType(xtrDeployType.trDeployType_SWAPSINGLE)

.AddDeployLocation("c:\NATIONAL\Deployment1")

.AddDeployLocation("c:\NATIONAL\Deployment2")

.AddDeployLocation("c:\NATIONAL\Deployment3")

.DataSourceWindowsLocation = "c:\NATIONAL\Deployment1\National.mdc"

.Update()

.DeployCube()

.PublishDatasource(True) 'Republish PowerCube if it alreadyexists

.ClearDeployLocations() 'Remove the deployment locationsfrom the model

.Update()End With'Save modelWith model

.SaveAs("NationalX.mdl")

.Close()End WithobjTransApp.Logoff()objTransApp = Nothing

End Sub

サインオンと IQD データ・ソースを使用してモデルを作成する例この例では、サインオンと IQD データ・ソースを使用してモデルを作成する方法を示します。

Sub Example37()Dim objTransApp As ObjectDim model As ModelDim datasource As IqdDataSourceDim signon As SignonDim strIBMCognos10Location As StringDim strDataSource As StringDim strDataPath As String'Change these paths to match your installationstrIBMCognos10Location = "C:\Program Files\IBM\Cognos\c10\"strDataSource = "prod.iqd"strDataPath = strIBMCognos10Location & _

"webcontent\samples\datasources\cubes\PowerCubes\EN\greatoutdoors sales\" & _

strDataSourceobjTransApp = CreateObject("IBMCognosTransformer.ApplicationCtrl.1")With objTransApp

.DataSourcePath = strIBMCognos10Location & "bin"

.TransdaPath = strIBMCognos10Location & "CS7Gateways\bin\TransDa.exe"End Withmodel = objTransApp.NewModel'Create signon before adding the data sourcesignon = model.Signons.Add()With signon

.Name = "great_outdoors_warehouse"

.Description = "Signon used for prod.iqd data source"

.UserID = "sa"

.Password = "sa"

第 8 章 サンプルと例 531

.PromptForPassword = False

.SignonType = xtrSignonType.trDataSourceSignon

.Update()End With

'Add IQD data sourcedatasource = model.DataSources.Add(xtrObjectType.trIqdDataSource)With datasource

.GenerateCategories = True

.GeneratePowerCube = xtrPowerCubeGeneration.trGenerationDefault

.IsolationLevel = 0

.LocalPath = strDataPath

.Name = "Products"

.SetsCurrentPeriod = True

.SourceType = xtrSourceType.trQuery

.Update()End With'Auto Design, build cube, and save modelWith model

.Name = "Products"

.DoAutoDesign()

.TestBuild(20, True)

.Update()

.SaveAs("ProductsX.mdl")

.Close()End WithobjTransApp = Nothing

End Sub

サインオンとパッケージ・データ・ソースを使用してモデルを作成する例この例では、サインオンとパッケージ・データ・ソースを使用してモデルを作成する方法を示します。

Sub Example38()Dim objTransApp As ObjectDim model As ModelDim package As PackageDim query As QueryDim column As ColumnDim signon As SignonDim connection As PackageDatasourceConnectionDim measure As MeasureobjTransApp = CreateObject("IBMCognosTransformer.ApplicationCtrl.1")'Create a new modelmodel = objTransApp.NewModel'Create a new package and add it to the modelpackage = model.Packages.Add()With package

.Name = "GO Data Warehouse (query)"

.Path = "/content/package[@name='GO Data Warehouse (query)']"

.Update()End With

'Create signon before adding the PackageDatasourceConnectionsignon = model.Signons.Add()With signon

.Name = "great_outdoors_warehouse"

.Description = "Signon used for package data source"

.SignOnNamespace = "Cognos"

.UserID = "sa"

.Password = "sa"

.SignonType = xtrSignonType.trCognosSignon

.AutoLogon = True

.Update()End With

532 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

'Add PackageDatasourceConnectionconnection = package.PackageDatasourceConnections.Add()With connection

.DataSource = "great_outdoors_warehouse"

.Connection = "great_outdoors_warehouse"

.Signon = "great_outdoors_warehouse"

.TransformerSignon = "great_outdoors_warehouse"

.AlwaysUseTransformerSignon = True

.Update()End With'Create a new query and add it to the packagequery = package.Queries.Add()With query

.Name = "Sales Revenue"

.AutoSummary = True

.MaximizeSpeed = True

.SetsCurrentPeriod = True

.Update()End With

'Create 3 new columns and add them to the querycolumn = query.Columns.Add()With column

.Name = "Date"

.OriginalName = "[Sales (query)].[Time dimension].[Date]"

.Update()End Withcolumn = query.Columns.Add()With column

.Name = "Region"

.OriginalName = "[Sales (query)].[Retailer site].[Region]"

.Update()End Withcolumn = query.Columns.Add()With column

.Name = "Revenue"

.OriginalName = "[Sales (query)].[Sales fact].[Revenue]"

.Update()End With'Add Revenue column as a measuremeasure = model.Measures.Add()With Measure

.AssociateWith(column, xtrAssociationRole.trAssociationSource)

.Update()End With'Auto Design, build cube, and save modelWith model

.Name = "Sales Revenue"

.DoAutoDesign()

.TestBuild(20, True)

.Update()

.SaveAs("GO Data Warehouse (query)X.mdl")

.Close()End With

objTransApp = NothingEnd Sub

第 8 章 サンプルと例 533

534 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

はじめに

この資料は、IBM Cognos Analytics に付属する OLAP モデル作成コンポーネントである IBM Cognos Transformer の使用にあたって参照してください。

情報の入手方法

翻訳されたすべての資料を含む、製品資料を Web で検索するには、IBMKnowledge Center (http://www.ibm.com/support/knowledgecenter) にアクセスしてください。

ユーザー補助機能

IBM Cognos Analytics には、動作が制限されている方、視力の限られた方など、身体の不自由な方に情報技術製品をご使用いただけるように支援するユーザー補助機能が用意されています。しかし、ユーザー補助機能の可用性は、ユーザー補助をサポートしない他のページやコンポーネントが IBM Cognos Analyticsユーザー・インターフェースに追加された場合には、変動する可能性があります。

IBM Cognos の HTML 文書は、ユーザー補助機能を備えています。PDF 文書は補助的なものであるため、追加のユーザー補助機能はありません。

将来の見通しに関する記述

このドキュメントには製品の現在の機能が記載されています。現在利用できない項目への言及が含まれる場合もありますが、将来的に使用可能になることを示唆するものではありません。このような言及は、なんらかの資料、規約、または機能を提供するという誓約、保証、または法的義務ではありません。特性や機能の開発、公開、およびその時期に関しては、引き続き IBM が単独裁量権を有します。

535

536 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

特記事項

本書は IBM が世界各国で提供する製品およびサービスについて作成したものです。

この記述は、IBM から他の言語で提供されている場合があります。ただし、これを入手するには、本製品または当該言語版製品を所有している必要がある場合があります。

本書に記載の製品、サービス、または機能が日本においては提供されていない場合があります。日本で利用可能な製品、サービス、および機能については、日本 IBMの営業担当員にお尋ねください。本書で IBM 製品、プログラム、またはサービスに言及していても、その IBM 製品、プログラム、またはサービスのみが使用可能であることを意味するものではありません。これらに代えて、IBM の知的所有権を侵害することのない、機能的に同等の製品、プログラム、またはサービスを使用することができます。ただし、IBM 以外の製品とプログラムの操作またはサービスの評価および検証は、お客様の責任で行っていただきます。本書には、お客様が購入されたプログラムまたはライセンス資格に含まれない製品、サービス、または機能に関する説明が含まれる場合があります。

IBM は、本書に記載されている内容に関して特許権 (特許出願中のものを含む) を保有している場合があります。本書の提供は、お客様にこれらの特許権について実施権を許諾することを意味するものではありません。実施権についてのお問い合わせは、書面にて下記宛先にお送りください。

〒103-8510東京都中央区日本橋箱崎町19番21号日本アイ・ビー・エム株式会社法務・知的財産知的財産権ライセンス渉外

以下の保証は、国または地域の法律に沿わない場合は、適用されません。 IBM およびその直接または間接の子会社は、本書を特定物として現存するままの状態で提供し、商品性の保証、特定目的適合性の保証および法律上の瑕疵担保責任を含むすべての明示もしくは黙示の保証責任を負わないものとします。国または地域によっては、法律の強行規定により、保証責任の制限が禁じられる場合、強行規定の制限を受けるものとします。

この情報には、技術的に不適切な記述や誤植を含む場合があります。本書は定期的に見直され、必要な変更は本書の次版に組み込まれます。 IBM は予告なしに、随時、この文書に記載されている製品またはプログラムに対して、改良または変更を行うことがあります。

本書において IBM 以外の Web サイトに言及している場合がありますが、便宜のため記載しただけであり、決してそれらの Web サイトを推奨するものではありません。それらの Web サイトにある資料は、この IBM 製品の資料の一部ではありません。それらの Web サイトは、お客様の責任でご使用ください。

537

IBM は、お客様が提供するいかなる情報も、お客様に対してなんら義務も負うことのない、自ら適切と信ずる方法で、使用もしくは配布することができるものとします。

本プログラムのライセンス保持者で、(i) 独自に作成したプログラムとその他のプログラム (本プログラムを含む) との間での情報交換、および (ii) 交換された情報の相互利用を可能にすることを目的として、本プログラムに関する情報を必要とする方は、下記に連絡してください。

IBM Software GroupAttention: Licensing3755 Riverside Dr.Ottawa, ONK1V 1B7Canada

本プログラムに関する上記の情報は、適切な使用条件の下で使用することができますが、有償の場合もあります。

本書で説明されているライセンス・プログラムまたはその他のライセンス資料は、IBM 所定のプログラム契約の契約条項、IBM プログラムのご使用条件、またはそれと同等の条項に基づいて、IBM より提供されます。

この文書に含まれるいかなるパフォーマンス・データも、管理環境下で決定されたものです。そのため、他の操作環境で得られた結果は、異なる可能性があります。一部の測定が、開発レベルのシステムで行われた可能性がありますが、その測定値が、一般に利用可能なシステムのものと同じである保証はありません。さらに、一部の測定値が、推定値である可能性があります。実際の結果は、異なる可能性があります。お客様は、お客様の特定の環境に適したデータを確かめる必要があります。

IBM 以外の製品に関する情報は、その製品の供給者、出版物、もしくはその他の公に利用可能なソースから入手したものです。IBM は、それらの製品のテストは行っておりません。したがって、他社製品に関する実行性、互換性、またはその他の要求については確証できません。 IBM 以外の製品の性能に関する質問は、それらの製品の供給者にお願いします。

IBM の将来の方向または意向に関する記述については、予告なしに変更または撤回される場合があり、単に目標を示しているものです。

本書には、日常の業務処理で用いられるデータや報告書の例が含まれています。より具体性を与えるために、それらの例には、個人、企業、ブランド、あるいは製品などの名前が含まれている場合があります。これらの名称はすべて架空のものであり、名称や住所が類似する企業が実在しているとしても、それは偶然にすぎません。

この情報をソフトコピーでご覧になっている場合は、写真やカラーの図表は表示されない場合があります。

538 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

このソフトウェア・オファリングは、展開される構成に応じて、 セッションごとのCookie および持続的な Cookie を使用して、それぞれのお客様に関する以下の情報を収集する場合があります。

v 名前

v ユーザー名

v パスワード

目的は、以下のとおりです。

v セッション管理

v 認証

v お客様の利便性の向上

v シングル・サインオン構成

v セッション管理、認証、お客様の利便性の向上およびシングル・サインオン構成以外の利用の追跡または機能上の目的

これらの Cookie を 無効にすることはできません。

この「ソフトウェア・オファリング」が Cookie およびさまざまなテクノロジーを使用してエンド・ユーザーから個人を特定できる情報を収集する機能を提供する場合、 お客様は、このような情報を収集するにあたって適用される法律、ガイドライン等を遵守する必要があります。これには、エンドユーザーへの通知や同意の要求も含まれますがそれらには限られません。

このような目的での Cookie を含む様々なテクノロジーの使用の詳細については、IBM の『IBM オンラインでのプライバシー・ステートメントのハイライト』(https://www.ibm.com/privacy/jp/ja/ ) および『IBM Software Products andSoftware-as-a-Service Privacy Statement』(http://www.ibm.com/software/info/product-privacy) を参照してください。

特記事項 539

540 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

索引

日本語, 数字, 英字, 特殊文字の順に配列されています。なお, 濁音と半濁音は清音と同等に扱われています。

[ア行]値リスト

概要 5値リストと定数

UI 対応表 490オブジェクト

カウントする 244更新する 186コレクションから削除する 172削除 148説明する 274命名する 341UI 対応表 459

オブジェクト作成

概要 1オブジェクトの階層マップ 6オブジェクトを説明する 274

[カ行]階層マップ

オブジェクト 6ディメンション 8レポート 10DataSources 8DateDimension 9Query 10

外部で集計された数値データ

作成する 295カウントする

オブジェクト 244カテゴリー

移動 167, 168接続する 144

カテゴリーを移動する 167, 168カテゴリーを接続する 144環境変数

設定する 10キューブ

キューブを 1 つ作成する 147キューブ・グループのキューブを作成する 147すべてのキューブを作成する 147小さなキューブをテストする 185

キューブを最適化する 223

欠落値

数値データ・プロパティーを無視するように設定する 310コレクション

オブジェクトを削除する 172オブジェクトを追加する 133, 134, 137ドリルスルー・ターゲットを追加する 136UI 対応表 457

[サ行]作成する

モデル 169サブディメンション 308時間ディメンション

ウィザード (Transformer OLE オートメーション) 86作成する 146

式をテストする 315自動設計 153資料の網羅範囲

サポートされている機能 535数値データ

割り当てる 178数値データを割り当てる 178セキュリティー

OLE オートメーション 169設計する

DoAutoDesign メソッド 153設定 440

設定する 10相対時間カテゴリー

Transformer OLE オートメーション 395

[タ行]タイプ・ライブラリー

TransformerSDK 4Visual Basic 2Visual C++ および C# 3

追加する

コレクション 133, 134, 136, 137データ・ソースを参照する 140定数

概要 5UI 対応表 490

特殊カテゴリー

Transformer OLE オートメーション 395ドリルダウン

代替ドリルダウン・パスを作成する 145

541

[ハ行]バージョン

このドキュメントでサポートされているバージョン 535開く

モデル 169プロパティー

UI 対応表 463

[マ行]メソッド

概要 5メソッドのリスト 129UI 対応表 461

モデル

作成する 169名前を付けて保存 177配置する 154開く 169保存する 176

モデル設定 440

AActivityMeasure プロパティー 207Add メソッド 133, 134, 137

drillthroughtargets 136Add メソッド (Custom Views) 135AddDeployLocation メソッド 138AddToCustomView メソッド 138AddToFolder メソッド 139Aggregate プロパティー 208AllocationMeasure プロパティー 209AllocationType プロパティー 210AllowCurrencyConversion プロパティー 211AllowDrillThrough プロパティー 212AlternateQueryPath プロパティー 212AltMDCFile プロパティー 213AlwaysUseTransformerSignon プロパティー 214Apex プロパティー 215Application オブジェクト 45Application プロパティー 215AssociateWith メソッド 140Association オブジェクト 48AssociationRole プロパティー 218Associations コレクション 12Associations プロパティー 219AssociationType プロパティー 220AutoLogon プロパティー 221

BBlankSubstitute プロパティー 222BlockParentTotals プロパティー 223

CCacheCrossTabs プロパティー 223CalculationDefinition オブジェクト 49CalculationDefinitions コレクション 13CalculationDefinitions プロパティー 224CAMID プロパティー 225CanAllocate プロパティー 225CanAllocateByMeasure プロパティー 226CanAllocateMeasure プロパティー 228Categories コレクション 14Categories プロパティー 229Category オブジェクト 51Category プロパティー 230CategoryCount プロパティー 230CategoryCountLevel プロパティー 231CategorySet オブジェクト 54CategorySets コレクション 15CategorySets プロパティー 232CharacterType プロパティー 233CheckLocalPowerCubes メソッド 141CheckModel メソッド 142ChildCategories プロパティー 233ChildCube オブジェクト 55ChildCubes コレクション 16ChildCubes プロパティー 234ChildCustomViews プロパティー 235ChildMeasures プロパティー 235CleanHouse メソッド 142ClearDeployLocations メソッド 143Close メソッド 144Code プロパティー 236Column オブジェクト 57Columns コレクション 17Columns プロパティー 237ColumnsLoaded プロパティー 238CompressMDC プロパティー 238Connection プロパティー 239ConnectWithCategory メソッド 144Consolidate プロパティー 240Context プロパティー 241ContextLevel プロパティー 242ContextOffset プロパティー 242ConvergenceLevel プロパティー 243Count プロパティー 244CountryCode プロパティー 246CreateAlternateDrillDown メソッド 145CreateDateDimension メソッド 146CreateMDCFile メソッド 147CreateMDCFiles メソッド 147CrossTabDataSource オブジェクト 59Cube オブジェクト 61CubeCodePage プロパティー 246CubeCreation プロパティー 248CubeCustomViews コレクション 17CubeCustomViews プロパティー 249

542 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

CubeGroup オブジェクト 65Cubes コレクション 18Cubes プロパティー 250CubeStamp プロパティー 250CurrencyCountryLabel プロパティー 251CurrencyDecimals プロパティー 251CurrencyFormatOverride プロパティー 252CurrencyIsEMU プロパティー 253CurrencyIsEuro プロパティー 254CurrencyRate オブジェクト 69CurrencyRates コレクション 19CurrencyRates プロパティー 254CurrencyRecord オブジェクト 70CurrencyRecord プロパティー 255CurrencyRecords コレクション 20CurrencyRecords プロパティー 256CurrencySymbol プロパティー 256CurrencyTable オブジェクト 71CurrencyTable プロパティー 257CurrencyTables コレクション 20CurrencyTables プロパティー 258CurrencyTableType プロパティー 258CurrentModel プロパティー 259CurrentValueIndex プロパティー 260CustomView オブジェクト 73CustomView プロパティー 260CustomViews コレクション 22CustomViews プロパティー 261

DDataCharacterSet プロパティー 262DataClass プロパティー 262DataRange プロパティー 263DataSource オブジェクト 75DataSource プロパティー 264DataSourcePath プロパティー 264DataSources 階層のマップ 8DataSources コレクション 22DataSources プロパティー 265DataSourceWindowsLocation プロパティー 265DataTemporaryFilesPath プロパティー 266DateDegreeofDetail プロパティー 267DateDegreeofDetailLevelName プロパティー 268DateDimension オブジェクト 77DateDimension 階層のマップ 9DateDrillDown オブジェクト 80DateFormat プロパティー 268DateFunction プロパティー 269DateInputFormat プロパティー 270DateLevel オブジェクト 82DateLevel プロパティー 271DateWizard オブジェクト 86DateWizard プロパティー 271DbDataSource オブジェクト 87DecimalPoint プロパティー 272

Decimals プロパティー 273DefaultCategoryOrderBy プロパティー 273DefaultDateFormat プロパティー 274Delete メソッド 148DeleteAllCustomViews メソッド 150DeleteAllSecurityObjects メソッド 150DeployCube メソッド 151DeployCubes メソッド 151Description プロパティー 274DesiredPartitionSize プロパティー 276DetachDataSource プロパティー 277DetailLevel プロパティー 277Dimension オブジェクト 90Dimension 階層のマップ 8Dimension プロパティー 278DimensionAssociateWith メソッド 152DimensionInclude プロパティー 279DimensionLevels コレクション 23DimensionLevels プロパティー 280DimensionName プロパティー 281Dimensions コレクション 24Dimensions プロパティー 281DimensionView プロパティー 282DimensionViewType プロパティー 283DisplayName プロパティー 284DoAutoDesign メソッド 153DrillCode プロパティー 285DrillDown オブジェクト 92DrillDowns コレクション 25DrillDowns プロパティー 285DrillInclusion プロパティー 286DrillThroughTarget オブジェクト 94DrillThroughTargets コレクション 26DrillThroughTargets プロパティー 287DuplicateRollup プロパティー 288DuplicateWeight プロパティー 289

EEarliestDate プロパティー 289EMUEntryDate プロパティー 290EnableMessageLogging プロパティー 291EnableTimePeriod プロパティー 292EstimatedRows プロパティー 292ExcludeAutoPartition プロパティー 293External プロパティー 295

FFieldSeparator プロパティー 296FileName プロパティー 297Filter オブジェクト 95Filters コレクション 27FindCategoryByCatCode プロパティー 298FindCategoryByCatCode メソッド 154

索引 543

FlatFileDataSource オブジェクト 96Format プロパティー 299FormatDecimals プロパティー 301FullName プロパティー 301

GGenerateCategories プロパティー 302GenerateCategories メソッド 154GenerateDateCategories プロパティー 303GenerateDateCategories メソッド 155GenerateDates プロパティー 303GeneratePowerCube プロパティー 304GenerateTimePeriod プロパティー 305GetDefaultCategory メソッド 156GetViewStatus メソッド 156Group プロパティー 306GroupDimension プロパティー 306GroupLevel プロパティー 307

HHasSubdimension プロパティー 308

IIBM Cognos Series 7 モデル

使用する 10ID プロパティー 309IgnoreMissingValue プロパティー 310Inclusion プロパティー 311IncrementalUpdate プロパティー 311InputScale プロパティー 312IqdDataSource オブジェクト 98IsAnyColumnMismatched プロパティー 313IsBad プロパティー 314IsExcludeDateDimension メソッド 157isExcludeDateLevel メソッド 158isExcludeDimension メソッド 158isExcludeLevel メソッド 159IsExpressionValid プロパティー 315IsManual プロパティー 316IsolationLevel プロパティー 318IsPrimary プロパティー 319IsTimeBasedPartitionedCube プロパティー 320Item メソッド 160Item メソッド () 161, 163

KKeyName プロパティー 321

LLabel プロパティー 321LastUseDate プロパティー 322LatestDate プロパティー 323Level オブジェクト 100Level プロパティー 324LevelCategories コレクション 28LevelCategories プロパティー 324LevelDrillDowns コレクション 28LevelDrillDowns プロパティー 325Levels コレクション 29Levels プロパティー 326LoadCurrencyTable メソッド 164LocalPath プロパティー 326LogErrorLevel プロパティー 327LogFileAppend プロパティー 328LogFileName プロパティー 329LogFilesPath プロパティー 329Logoff メソッド 164Logon メソッド 165Lunar プロパティー 330

MManualCurrentPeriod プロパティー 330MaximizeSpeed プロパティー 331MaxNumPartLevels プロパティー 332MaxTransactionNumber プロパティー 333MDCFile プロパティー 334Measure オブジェクト 103MeasureInclude プロパティー 334MeasureName プロパティー 335Measures コレクション 30Measures プロパティー 336MeasureType プロパティー 337MissingValue プロパティー 337ModelName プロパティー 338ModelsPath プロパティー 339ModelTemporaryFilesPath プロパティー 339ModelType プロパティー 340MonthType プロパティー 340Move メソッド 166MoveToCategory メソッド 167MoveToLevel メソッド 168

NName オブジェクト 110Name プロパティー 341Names コレクション 31Namespace オブジェクト 111Namespaces コレクション 32Namespaces プロパティー 343NewCatsLocked プロパティー 344NewModel メソッド 169

544 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド

OObjectCAMID プロパティー 344ObjectName プロパティー 345OpenModel メソッド 169OpenSuspendedModel メソッド 170Optimize プロパティー 346OrderByDescending プロパティー 346OrderByStorageType プロパティー 347Origin プロパティー 348OriginalName プロパティー 349Orphanage プロパティー 350OutputScale プロパティー 351

PPackage オブジェクト 112PackageDatasourceConnection オブジェクト 113PackageDatasourceConnections コレクション 33Packages コレクション 34Parent プロパティー 353ParentCategories プロパティー 356Partition プロパティー 357Password プロパティー 358PatFile プロパティー 359Path プロパティー 359PopulateByDataSource プロパティー 360Position プロパティー 361PowerCube

BlockParentTotals 223PowerCubesPath プロパティー 362PowerPlayPath プロパティー 362Precision プロパティー 363Prompt オブジェクト 114PromptForPassword プロパティー 363Prompts コレクション 35PromptValueType プロパティー 365PublishDatasource メソッド 171PublishPackage メソッド 171

QQualifiedName プロパティー 365QuarterType プロパティー 366Query オブジェクト 115Query 階層のマップ 10QyPath プロパティー 367

RRate プロパティー 368RefName プロパティー 369RefreshDescription プロパティー 369RefreshLabel プロパティー 370RefreshShortName プロパティー 371

RegularRollup プロパティー 372RegularWeight プロパティー 373Remove メソッド 172RemoveCubeCustomView メソッド 174RemoveFromFolder メソッド 175RemoveSuspendedModel メソッド 175Report オブジェクト 117Report 階層のマップ 10Reports コレクション (Transformer) 37Reports プロパティー 373ResetPartitions メソッド 176ReverseSign プロパティー 374Rollup プロパティー 375RollupTiming プロパティー 375RowsAsSample プロパティー 376RowsChecked プロパティー 377RunningPeriods プロパティー 378

SSave メソッド 176SaveAs メソッド 177SecurityObject オブジェクト 118SecurityObjects コレクション 38SecurityObjects プロパティー 379Server プロパティー 379ServerModelPath プロパティー 380ServerPath プロパティー 380ServerQuery プロパティー 381ServicesBuildNumber プロパティー 382ServicesVersionText プロパティー 382SetAllocation メソッド 178SetDefaultCategory メソッド 179SetDeployType メソッド 180SetExcludeDateDimension メソッド 181SetExcludeDateLevel メソッド 182SetExcludeDimension メソッド 183SetExcludeLevel メソッド 183SetsCurrentPeriod プロパティー 383SetViewStatus メソッド 184ShortName プロパティー 384Signon オブジェクト 119Signon プロパティー 385SignOnNamespace プロパティー 386Signons コレクション 39Signons プロパティー 386SignonType プロパティー 387Size プロパティー 387SortComparisonRule プロパティー 388SourceType プロパティー 389SpecialCategory オブジェクト 121SpecialCategoryCount プロパティー 390SQLExpression プロパティー 390Status プロパティー 391StorageType プロパティー 392SummaryLevel プロパティー 393

索引 545

SuspendedModel オブジェクト 124SuspendedModels コレクション 40SuspendedModels プロパティー 395

TTargetLevel プロパティー 395TargetOffset プロパティー 396TestBuild メソッド 185ThousandPoint プロパティー 397Time プロパティー 398TimeArrayColumn プロパティー 398TimeArrayStartMonth プロパティー 399TimeArrayType プロパティー 400TimeRank プロパティー 400TimeStateRollup プロパティー 402TimeStateWeight プロパティー 403ToDateLevel プロパティー 403TransdaPath プロパティー 404Transformer OLE オートメーション

メソッドのリスト 129TransformerSignon プロパティー 405Type プロパティー 405

UUI 対応表

値リストと定数 490オブジェクト 459コレクション 457プロパティー 463メソッド 461

Unique プロパティー 407UniqueMove プロパティー 409Update メソッド 186UseAltMDCFile プロパティー 409User プロパティー 410UserCAMID プロパティー (Transformer) 411UserID プロパティー 411

VValue プロパティー 412ValuesCount プロパティー 412Verify メソッド 188Version プロパティー 413View オブジェクト 125Views コレクション 40Views プロパティー 414ViewType プロパティー 414

WWeekAdd プロパティー 415WeekSpan プロパティー 416

WeekStart プロパティー 417WeekStartDay プロパティー 418WorkingDay プロパティー 418WorkingDays プロパティー 419

XxtrAllocationType 値リスト 423xtrAssociationRole 値リスト 424xtrAssociationType 値リスト 425xtrCharacterType 値リスト 425xtrCubeConsolidate 値リスト 426xtrCubeCreation 値リスト 426xtrCubeOptimize 値リスト 427xtrCubeStatus 値リスト 428xtrCurrencyTableType 値リスト 429xtrDataClass 値リスト 429xtrDateCategoriesGeneration 値リスト 430xtrDateFormat 値リスト 431xtrDateLevel 値リスト 431xtrDeployType 値リスト 432xtrDuplicateRollup 値リスト 433xtrGenerateOptions 値リスト 433xtrInclusion 値リスト 434xtrMeasureType 値リスト 435xtrMissingValue 値リスト 435xtrObjectType 値リスト 436xtrOrigin 値リスト 438xtrPowerCubeGeneration 値リスト 439xtrPreferences 値リスト 440xtrPromptValueType 値リスト 441xtrRollup 値リスト 442xtrRollupTiming 値リスト 443xtrSecurityType 値リスト 443xtrSourceType 値リスト 444xtrSpecialFunction 値リスト 446xtrStorage 値リスト 447xtrTimeAggregate 値リスト 448xtrTimeArrayType 値リスト 449xtrTimeRollup 値リスト 449xtrTimeType 値リスト 451xtrViewStatus 値リスト 451xtrViewType 値リスト 452xtrWeekAdd 値リスト 453xtrWeekDay 値リスト 453xtrWeekspan 値リスト 454

YYearStartDay プロパティー 421YearType プロパティー 422

546 IBM Cognos Analytics バージョン 11.0: Transformer オートメーション・ガイド