© copyright ibm corp. 2005, 2017....le present document est livre en l'et a t sans aucune garantie...

IBM Cognos PowerPlay ClientVersion 11.0

Guide de référence des macros

IBM

LE PRESENT DOCUMENT EST LIVRE EN L'ETAT SANS AUCUNE GARANTIE EXPLICITE OU IMPLICITE. IBMDECLINE NOTAMMENT TOUTE RESPONSABILITE RELATIVE A CES INFORMATIONS EN CAS DECONTREFACON AINSI QU'EN CAS DE DEFAUT D'APTITUDE A L'EXECUTION D'UN TRAVAIL DONNE.

Ce document est mis à jour périodiquement. Chaque nouvelle édition inclut les mises à jour. Les informations qui ysont fournies sont susceptibles d'être modifiées avant que les produits décrits ne deviennent eux-mêmesdisponibles. En outre, il peut contenir des informations ou des références concernant certains produits, logiciels ouservices non annoncés dans ce pays. Cela ne signifie cependant pas qu'ils y seront annoncés.

Pour plus de détails, pour toute demande d'ordre technique, ou pour obtenir des exemplaires de documents IBM,référez-vous aux documents d'annonce disponibles dans votre pays, ou adressez-vous à votre partenairecommercial.

Vous pouvez également consulter les serveurs Internet suivants :v http://www.fr.ibm.com (serveur IBM en France)v http://www.ibm.com/ca/fr (serveur IBM au Canada)v http://www.ibm.com (serveur IBM aux Etats-Unis)

Compagnie IBM FranceDirection Qualité17, avenue de l'Europe92275 Bois-Colombes Cedex

Le présent document s'applique à IBM Cognos Analytics version 11.0.0 et peut aussi s'appliquer aux éditionsultérieures.

Licensed Materials - Property of IBM. Eléments sous licence - Propriété d'IBM.

© Copyright IBM Corp. 2005, 2017.

US Government Users Restricted Rights - Use, duplication or disclosure restricted by GSA ADP Schedule Contractwith IBM Corp.

Les captures d'écran du produit Microsoft ont été utilisées avec l'autorisation de Microsoft.

http://www.fr.ibm.comhttp://www.ibm.com/ca/frhttp://www.ibm.com

Table des matières

Avis aux lecteurs canadiens. . . . . . . . . . . . . . . . . . . . . . . . . . . ix

Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xi

Chapitre 1. Automatisation OLE de PowerPlay . . . . . . . . . . . . . . . . . . . 1Conception de scripts de macros. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2Comparaison du langage CognosScript avec d'autres versions de Basic . . . . . . . . . . . . . . . . 3

Différences entre le langage CognosScript et Visual Basic . . . . . . . . . . . . . . . . . . . 4Différences entre le langage CognosScript et Microsoft Visual Basic for Applications . . . . . . . . . . 4

Chapitre 2. Objets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7Objet AdvancedQuery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8Objet Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11Objet CategoryList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13Objet Child . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15Objet Column . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16Objet Dimension. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19Objet DimensionLine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21Objet Exception . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22Objet FindQuery. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24Objet Graph . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26Objet Layer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29Objet Level . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32Objet ParentageQuery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33Objet Print. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35Objet Range . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37Objet Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38Objet Row . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43Objet SaveAsPDF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46Objet ValueRestriction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48

Chapitre 3. Collections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51Children . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51Columns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54Exceptions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57Graphs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58Layers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61Levels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64Ranges . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65ReportQueries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67Rows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69

Chapitre 4. Méthodes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73Méthode Accumulation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81Méthode Activate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83Méthode Active . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84Méthode ActiveReport. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85Méthode Add (CategoryList) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86Méthode Add (Columns, Layers, Rows) . . . . . . . . . . . . . . . . . . . . . . . . . . 88Méthode Add (Exceptions) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89Méthode Add (Graphs) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90Méthode Add (Ranges) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92Méthode Add (ReportQueries) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93

iii

Méthode Add (Reports) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95Méthode AddBlanks (Reporter) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96Méthode Addition (Collections). . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98Méthode Addition (Objets) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100Méthode AddLevel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101Méthode AddLowestLevelCategories (Reporter) . . . . . . . . . . . . . . . . . . . . . . . 103Méthode AddToReport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104Méthode AddToReportAtSpecificNestingLevel . . . . . . . . . . . . . . . . . . . . . . . 107Méthode Average (Collections) (Reporter) . . . . . . . . . . . . . . . . . . . . . . . . . 110Méthode Average (Objets) (Reporter) . . . . . . . . . . . . . . . . . . . . . . . . . . 111Méthode CanDrillDown . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113Méthode CanDrillUp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114Méthode Category. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115Méthode CategoryList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116Méthode CellValue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118Méthode Change . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119Méthode ChangeToParent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120Méthode ChangeToTop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121Méthode Children . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122Méthode Close . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123Méthode Columns. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125Méthode Copy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125Méthode CumPercentOfBase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126Méthode Cut (Reporter) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128Méthode DeleteExplorerRank . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129Méthode DeleteAllDataSourceInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . 130Méthode DeleteAllMDCAccessInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . 131Méthode DeleteDataSourceInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132Méthode DeleteMDCAccessInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133Méthode DeleteSelected . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135Méthode DeploymentOptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136Méthode Depth. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137Méthode DimensionFilter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138Méthode DimensionLine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139Méthode Division . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140Méthode DrillDown . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142Méthode DrillUp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143Méthode Exceptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145Méthode Exclude . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145Méthode Execute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147Méthode Exponentiation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149Méthode Find . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151Méthode FindNext . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152Méthode FindPrevious . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156Méthode Forecast (Explorer) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160Méthode GetDataNow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162Méthode Graphs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163Méthode HasParent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164Méthode Hide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165Méthode HideSelected . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166Méthode HideUnselected . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167Méthode Include . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168Méthode Item . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170Méthode ItemAtLevel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172Méthode Layers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173Méthode Level . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174Méthode Levels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176Méthode Logon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177Méthode Logoff . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179Méthode Maximize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180Méthode Maximum (Collections) (Reporter) . . . . . . . . . . . . . . . . . . . . . . . . 180

iv IBM Cognos PowerPlay Client Version 11.0 - Guide de référence des macros

Méthode Maximum (Objets) (Reporter) . . . . . . . . . . . . . . . . . . . . . . . . . . 182Méthode Minimize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183Méthode Minimum (Collections) (Reporter) . . . . . . . . . . . . . . . . . . . . . . . . 184Méthode Minimum (Objects) (Reporter) . . . . . . . . . . . . . . . . . . . . . . . . . 186Méthode Multiplication (Collections) . . . . . . . . . . . . . . . . . . . . . . . . . . 187Méthode Multiplication (Objets) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188Méthode New . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190Méthode Open (Reports) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192Méthode Open (Report) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193Méthode OpenRemoteReport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195Méthode Parent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197Méthode Paste (Reporter) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198Méthode PDFFile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199Méthode Percent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201Méthode PercentGrowth. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202Méthode PercentOfBase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204Méthode Print . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205Méthode PrintOut . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206Méthode PublishToPortal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208Méthode Quit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209Méthode Ranges . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210Méthode Rank2. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211Méthode Remove . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213Méthode Remove (ReportQueries) . . . . . . . . . . . . . . . . . . . . . . . . . . . 215Méthode RemoveLevel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216Méthode ReportQueries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218Méthode Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219Méthode ResetPrintOptionsToDefault . . . . . . . . . . . . . . . . . . . . . . . . . . 220Méthode Restore . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221Méthode Rollup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222Méthode Rows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223Méthode Save . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224Méthode SaveAs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226Méthode Select . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228Méthode SelectAllDimensions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229Méthode SelectBlank . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230Méthode SetChartToPrint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231Méthode SetChartToSave . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232Méthode SetDataSourceInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234Méthode SetDrivingCategory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236Méthode SetListOfLayersToPrint . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237Méthode SetListOfLayersToSave . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239Méthode SetListOfRowsToPrint . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240Méthode SetListOfRowsToSave . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241Méthode SetMacro . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242Méthode SetMDCAccessInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244Méthode SetType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245Méthode SizeSelected. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247Méthode Sort . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 248Méthode StyleSelected . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250Méthode Subset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251Méthode Subtraction (Collections) . . . . . . . . . . . . . . . . . . . . . . . . . . . 252Méthode Subtraction (Objects) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254Méthode SwapColumnsAndLayers . . . . . . . . . . . . . . . . . . . . . . . . . . . 255Méthode SwapRowsAndColumns . . . . . . . . . . . . . . . . . . . . . . . . . . . 256Méthode SwapRowsAndLayers . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257Méthode UnhideAllCategories. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258Méthode Unselect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259Méthode UnselectAllDimensions . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260Méthode UnselectBlank . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261Méthode UpdatePublishedReport. . . . . . . . . . . . . . . . . . . . . . . . . . . . 262

Table des matières v

Méthode ValueRestriction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 263Méthode Vertical . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265

Chapitre 5. Propriétés . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267Propriété Application. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 276Propriété AutomaticExceptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . 278Propriété AutomaticExceptionSensitivity . . . . . . . . . . . . . . . . . . . . . . . . . 279Propriété Average . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 280Propriété AxisOnAllPages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281Propriété BlankWhenDividedByZero . . . . . . . . . . . . . . . . . . . . . . . . . . 283Propriété BlankWhenMissing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284Propriété BlankWhenZero . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 285Propriété CalculatedCategories . . . . . . . . . . . . . . . . . . . . . . . . . . . . 286Propriété Caption . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 287Propriété CellText . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 288Propriété CellValueAlignment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 289Propriété CellValueFontColor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 291Propriété CellValueFontName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 293Propriété CellValueFontSize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 294Propriété ChartTitleOnAllPages . . . . . . . . . . . . . . . . . . . . . . . . . . . . 296Propriété Collate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297Propriété Copies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 298Propriété Count . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 299Propriété CubeName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 301Propriété DataGridlines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 302Propriété DefaultAlternateDirectory . . . . . . . . . . . . . . . . . . . . . . . . . . . 303Propriété DefaultCubeDirectory . . . . . . . . . . . . . . . . . . . . . . . . . . . . 304Propriété DefaultMacroDirectory . . . . . . . . . . . . . . . . . . . . . . . . . . . . 305Propriété DefaultReportDirectory . . . . . . . . . . . . . . . . . . . . . . . . . . . . 306Propriété Dimension . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 306Propriété DimensionLineIndex . . . . . . . . . . . . . . . . . . . . . . . . . . . . 308Propriété DimensionSettings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 309Propriété DrivingCategory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 310Propriété DrivingDimension . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 311Propriété Each . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 312Propriété EnableUserColumnSummaryLabel . . . . . . . . . . . . . . . . . . . . . . . . 313Propriété EnableUserRowSummaryLabel . . . . . . . . . . . . . . . . . . . . . . . . . 315Propriété Exception . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 316Propriété ExplorerMode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 317Propriété FitToPage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 318Propriété FooterText . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 319Propriété FullName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 322Propriété GetDataAutomatically . . . . . . . . . . . . . . . . . . . . . . . . . . . . 323Propriété HeaderText . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 323Propriété HideRankCategory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 326Propriété IncludeLegend . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 327Propriété IndentTotalsLevel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 328Propriété Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 329Propriété Intersect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 330Propriété IsAlternate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 332Propriété IsCalculatedCategory . . . . . . . . . . . . . . . . . . . . . . . . . . . . 333Propriété KeepSummaryVisible . . . . . . . . . . . . . . . . . . . . . . . . . . . . 334Propriété LabelAlignment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 335Propriété LabelFontColor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 336Propriété LabelFontName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 338Propriété LabelFontSize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 339Propriété LabelGridlines. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 341Propriété Layout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 342Propriété Level . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 343Propriété LevelList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 344Propriété LevelsDown . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 346

vi IBM Cognos PowerPlay Client Version 11.0 - Guide de référence des macros

Propriété LogonPrompt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 347Propriété LowerBoundary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 348Propriété LowestLevel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 349Propriété MacroName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 351Propriété MacroStyle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 351Propriété MaximumNumberOfRanges . . . . . . . . . . . . . . . . . . . . . . . . . . 352Propriété MaxPrintedBars . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 353Propriété MaxVisibleBars . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 354Propriété Measure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 355Propriété MeasureCurrency. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 357Propriété Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 358Propriété NamesShown . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 360Propriété NestedCharts (Explorer) . . . . . . . . . . . . . . . . . . . . . . . . . . . 361Propriété NestedName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 363Propriété Operand1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 364Propriété Operand2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 365Propriété Operator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 367Propriété ParentCategory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 369Propriété Path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 370Propriété Pattern . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 371Propriété Precedence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 374Propriété PrintAllCharts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 376Propriété PrintColorsAsPatterns . . . . . . . . . . . . . . . . . . . . . . . . . . . . 378Propriété PrintEntireReport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 379Propriété PrintPageLayout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 380Propriété PrintSelectedDisplay. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 381Propriété PromptForCurrency . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 382Propriété PromptForDimension . . . . . . . . . . . . . . . . . . . . . . . . . . . . 383Propriété PromptForLongShortNames . . . . . . . . . . . . . . . . . . . . . . . . . . 384Propriété PromptForSwapRowsAndColumns . . . . . . . . . . . . . . . . . . . . . . . . 386Propriété PromptForZeroSuppression . . . . . . . . . . . . . . . . . . . . . . . . . . 387Propriété RefreshSubCube . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 388Propriété SaveAllCharts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 389Propriété Saved . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 390Propriété SaveEntireReport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 391Propriété SearchDescription . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 393Propriété SearchShortName. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 394Propriété SearchText . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 395Propriété ShareDimensionLine. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 397Propriété ShareOf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 398Propriété ShowSummaryBreakdown (Explorer) . . . . . . . . . . . . . . . . . . . . . . . 399Propriété ShowSummaryColumn (Explorer) . . . . . . . . . . . . . . . . . . . . . . . . 400Propriété ShowSummaryRow (Explorer) . . . . . . . . . . . . . . . . . . . . . . . . . 401Propriété ShowTies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 402Propriété ShowValuesAs (Explorer) . . . . . . . . . . . . . . . . . . . . . . . . . . . 404Propriété StatsLineCaption . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 405Propriété StatsLineColor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 406Propriété StatsLineOn . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 408Propriété StatsLineStyle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 409Propriété StatsLineUserValue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 411Propriété Style . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 412Propriété Sum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 413Propriété SummariesOnAllPages . . . . . . . . . . . . . . . . . . . . . . . . . . . . 414Propriété SummaryColumnOnAllPages. . . . . . . . . . . . . . . . . . . . . . . . . . 416Propriété SummaryRowOnAllPages . . . . . . . . . . . . . . . . . . . . . . . . . . . 417Propriété Suppress8020 (Explorer) . . . . . . . . . . . . . . . . . . . . . . . . . . . 418Propriété SuppressZeros . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 420Propriété Threshold . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 421Propriété TitleText . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 422Propriété TopLevelCategory (Explorer) . . . . . . . . . . . . . . . . . . . . . . . . . . 424Propriété TopLevelParentCategory . . . . . . . . . . . . . . . . . . . . . . . . . . . 425

Table des matières vii

Propriété Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 426Propriété UpperBoundary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 428Propriété UseFontSubstitution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 429Propriété UserControl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 430Propriété UserColumnSummaryLabel . . . . . . . . . . . . . . . . . . . . . . . . . . 431Propriété UserRowSummaryLabel . . . . . . . . . . . . . . . . . . . . . . . . . . . 432Propriété UseScrolling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 433Propriété ValuesAutoFit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 434Propriété ValuesFontColor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 435Propriété ValuesFontName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 437Propriété ValuesFontSize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 438Propriété ValuesFontStyle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 440Propriété ValuesPosition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 441Propriété ValuesShown . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 442Propriété Version . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 443Propriété Visible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 444

Chapitre 6. Macros d'administration. . . . . . . . . . . . . . . . . . . . . . . 447Création de macros d'administration . . . . . . . . . . . . . . . . . . . . . . . . . . 447Macro After Doc Open . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 448Macro AppClose . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 449Macro AppOpen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 450Macro DocClose . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 452Macro DocOpen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 453Macro Highlight Exceptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 454

Remarques . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 457

Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 461

viii IBM Cognos PowerPlay Client Version 11.0 - Guide de référence des macros

Avis aux lecteurs canadiens

Le présent document a été traduit en France. Voici les principales différences etparticularités dont vous devez tenir compte.

Illustrations

Les illustrations sont fournies à titre d'exemple. Certaines peuvent contenir desdonnées propres à la France.

Terminologie

La terminologie des titres IBM peut différer d'un pays à l'autre. Reportez-vous autableau ci-dessous, au besoin.

IBM France IBM Canada

ingénieur commercial représentant

agence commerciale succursale

ingénieur technico-commercial informaticien

inspecteur technicien du matériel

Claviers

Les lettres sont disposées différemment : le clavier français est de type AZERTY, etle clavier français-canadien de type QWERTY.

OS/2 et Windows - Paramètres canadiens

Au Canada, on utilise :v les pages de codes 850 (multilingue) et 863 (français-canadien),v le code pays 002,v le code clavier CF.

Nomenclature

Les touches présentées dans le tableau d'équivalence suivant sont libelléesdifféremment selon qu'il s'agit du clavier de la France, du clavier du Canada ou duclavier des États-Unis. Reportez-vous à ce tableau pour faire correspondre lestouches françaises figurant dans le présent document aux touches de votre clavier.

ix

Brevets

Il est possible qu'IBM détienne des brevets ou qu'elle ait déposé des demandes debrevets portant sur certains sujets abordés dans ce document. Le fait qu'IBM vousfournisse le présent document ne signifie pas qu'elle vous accorde un permisd'utilisation de ces brevets. Vous pouvez envoyer, par écrit, vos demandes derenseignements relatives aux permis d'utilisation au directeur général des relationscommerciales d'IBM, 3600 Steeles Avenue East, Markham, Ontario, L3R 9Z7.

Assistance téléphonique

Si vous avez besoin d'assistance ou si vous voulez commander du matériel, deslogiciels et des publications IBM, contactez IBM direct au 1 800 465-1234.

x IBM Cognos PowerPlay Client Version 11.0 - Guide de référence des macros

Introduction

Ce document contient des informations sur l'utilisation de l'automatisation OLE envue d'exécuter des tâches sous IBM® Cognos PowerPlay Client.

Recherche d'informations

Pour rechercher la documentation sur le web, y compris tous les documentstraduits, accédez à la page IBM Knowledge Center (http://www.ibm.com/support/knowledgecenter).

Fonctions d'accessibilité

IBM Cognos PowerPlay Client ne prend pas en charge les fonctions d'accessibilitépermettant aux utilisateurs souffrant d'un handicap physique, comme une mobilitéréduite ou une vision limitée, d'utiliser le produit.

Déclarations préliminaires

La présente documentation décrit les fonctionnalités actuelles du produit. Desréférences à des éléments non encore disponibles peuvent être incluses. Aucuneimplication de disponibilité future ne doit en être déduite. Aucune de cesréférences n'est constitutive d'un engagement, d'une promesse ou d'une obligationlégale de fournir des matériels, codes ou fonctionnalités d'aucune sorte. Ledéveloppement, la diffusion et la planification des caractéristiques oufonctionnalités restent à la totale discrétion d'IBM.

Clause de décharge relative aux exemples

La société Vacances et Aventure, Ventes VA, ou toute variation du nom Vacances etAventure, ainsi que les exemples de planification, illustrent des opérationscommerciales fictives, avec des exemples de données utilisées pour développer desexemples d'applications, destinées à IBM et à ses clients. Les exemples de donnéescontenus dans ces enregistrements fictifs sont utilisés pour représenter destransactions de vente, la distribution de produits, des données financières et desressources humaines. Toute ressemblance avec des noms de personnes, de sociétésou des données réelles serait purement fortuite. D'autres fichiers d'exemplepeuvent contenir des données fictives générées manuellement ou par une machine,des données factuelles compilées à partir de sources académiques ou publiques, oudes données utilisées avec l'autorisation du détenteur des droits d'auteur, à utilisercomme exemple de données pour développer des exemples d'application. Lesnoms de produit référencés peuvent être les marques de leurs propriétairesrespectifs. Toute reproduction sans autorisation est interdite.

xi

http://www.ibm.com/support/knowledgecenter

xii IBM Cognos PowerPlay Client Version 11.0 - Guide de référence des macros

Chapitre 1. Automatisation OLE de PowerPlay

Vous pouvez utiliser l'automatisation OLE pour automatiser les tâches dans IBMCognos PowerPlay en créant des macros à l'aide du langage IBM CognosScript.

Vous pouvez écrire des macros avec :v IBM Cognos Series 7 CognosScript Editor

IBM Cognos PowerPlay n'inclut pas CognosScript Editor. Vous pouvez utiliserIBM Cognos Series 7 CognosScript Editor pour créer et exécuter des macrospour IBM Cognos PowerPlay. Pour plus d'informations, voir le manuel IBMCognos Series 7 CognosScript Editor Reference Guide.

v Microsoft Visual BasicPour plus d'informations, voir «Comparaison du langage CognosScript avecd'autres versions de Basic», à la page 3

v Un éditeur de texte tel que le Bloc-Notes.v Lorsque vous créez une macro à l'aide d'un éditeur de texte, vous ne pouvez pas

la compiler ou l'exécuter à partir de cet éditeur. Vous devez la compiler etl'exécuter dans IBM Cognos Series 7 CognosScript Editor ou dans un éditeur demacros compatible tel que Microsoft Visual Basic for Applications.

Hiérarchie de l'application PowerPlay

La hiérarchie de l'application PowerPlay présente une structure arborescentelogique, organisée en objets et collections qui interagissent pour pouvoirfonctionner. La structure indique les objets qui doivent exister préalablement àl'utilisation des propriétés ou des méthodes destinées à contrôler le comportementet les caractéristiques d'un objet.

Le diagramme suivant illustre les relations qui existent entre les collections et lesobjets, ainsi que la place qu'ils occupent dans la hiérarchie.

1

Rubriques connexesv «Conception de scripts de macros»v Chapitre 4, «Méthodes», à la page 73v Chapitre 5, «Propriétés», à la page 267v Chapitre 6, «Macros d'administration», à la page 447

Conception de scripts de macrosLorsque vous créez des scripts de macros, tenez compte de la gestion des erreurs,de la programmation et de la diffusion.

Gestion des erreurs

Un script peut être parfaitement débogué et néanmoins rencontrer des conditionsentraînant des erreurs, telles que le lancement d'un script essayant d'ouvrir unfichier qui n'existe pas ou qui n'est pas disponible. Lorsqu'un utilisateur IBMCognos PowerPlay rencontre des erreurs, il peut les résoudre et continuer àtravailler. Cependant, lorsqu'une macro rencontre une erreur, elle s'interrompt. Lesinstructions restantes de la macro ne sont pas exécutées, à moins que la macron'inclue des instructions sur la gestion des erreurs.

2 IBM Cognos PowerPlay Client Version 11.0 - Guide de référence des macros

Lorsque vous créez une macro, l'objectif est de concevoir une macro dépendant lemoins possible d'un ensemble de conditions. Par exemple, ne créez pas une macronécessitant des entrées précises et correctes de la part de l'utilisateur. Enstructurant vos macros de façon à ce qu'elles contiennent des instructions IF, vouspouvez essayer d'anticiper les réponses des utilisateurs.

Lorsqu'elle fonctionne correctement, une macro doit :v fermer tous les documents qu'elle a ouverts et dont l'utilisateur n'a plus besoin,v enregistrer le fichier ou inviter l'utilisateur à le faire, au besoin,v restaurer les paramètres de toutes les options qu'elle a modifiées,v supprimer tous les fichiers temporaires.

Programmation

Si vous utilisez IBM Cognos Series 7 Scheduler pour exécuter une macro,assurez-vous de bien estimer le temps requis pour l'exécution de celle-ci. Dans lecas d'activités impliquant le traitement de volumes importants, vous pouvezprogrammer l'exécution de la macro pendant les heures creuses afin de réduirel'activité du réseau. Cependant, de trop nombreuses macros de grande taille,associées aux autres activités de routine du réseau, risquent également d'affecterl'exécution des macros.

Distribution

Pour diffuser des modèles, des cubes, des rapports et des macros, il est possibled'utiliser les méthodes de diffusion de fichiers disponibles.

Lorsque vous définissez des stratégies dans PowerPlay pour automatiser ladiffusion d'un modèle, d'un cube ou d'un rapport, vous devez :v identifier les tâches répétitives, telles que l'identification des modèles, des vues,

des cubes et des rapports afin d'effectuer des modifications ou des mises à jourrégulièrement,

v répertorier les utilisateurs ou les groupes d'utilisateurs qui ont besoin desfichiers,

v indiquer de quelle manière et à quel moment chaque utilisateur ou grouped'utilisateurs recevra les mises à jour.

Comparaison du langage CognosScript avec d'autres versions deBasic

Les informations suivantes expliquent les différences entre CognosScript et d'autresversions de Microsoft Basic. Vous devez prendre en compte ces différences si vousenvisagez d'utiliser Microsoft Basic à la place de l'Editeur CognosScript d'IBMCognos Series 7 pour créer et exécuter des macros.

Vous connaissez sans doute plusieurs versions de Basic, les plus courantes étantMicrosoft Visual Basic et Word Basic. Un grand nombre de fonctions etd'instructions sont communes au langage CognosScript et à ces versions de Basic ;néanmoins, chaque version propose des fonctionnalités particulières.

Chapitre 1. Automatisation OLE de PowerPlay 3

Différences entre le langage CognosScript et Visual BasicLe langage CognosScript est très similaire à Microsoft Visual Basic avec, cependant,quelques différences importantes. Les rubriques qui suivent décrivent certaines deces différences.

Fonctions et instructions propres au langage CognosScript

Le langage CognosScript dispose de quelques instructions et fonctions qui nefigurent pas dans la version standard de Visual Basic.

En voici quelques exemples :v Métacommande $CStringsv Métacommande $Includev Métacommande $NoCStringsv Fonction GetField$v Fonction SetFields$v Instruction Assert

Objets basés sur des contrôles

Le langage CognosScript ne comporte pas d'objets basés sur des contrôlessemblables à ceux de Visual Basic. Il s'ensuit que certaines des propriétés deVisual Basic, par exemple "BorderStyle", ne font pas partie intégrante dulangage CognosScript. Cela ne signifie pas pour autant que vous ne pouvez pasdéfinir un objet dans le langage CognosScript dont la propriété serait BorderStyle.En fait, vous définirez probablement de nombreux objets intrinsèques à votreapplication pendant le processus d'intégration.

Différences entre le langage CognosScript et Microsoft VisualBasic for Applications

Microsoft propose une version modifiée de Visual Basic pour certains de cesproduits : Visual Basic for Applications. Outre les fonctions et instructions propresau langage CognosScript, certaines différences peuvent être notées entre le langageCognosScript et Microsoft Visual Basic for Applications.

Dans Microsoft Visual Basic for Applicationsv Une instruction Global Const est traitée comme une instruction Const ; Public

Const pourrait être un équivalent.v Des différences de comportement existent au niveau de l'instruction Declare :

– Les pré-déclarations (Forward) vers les fonctions ne sont pas disponibles.– L'attribut BasicLib n'est pas reconnu et doit être converti en Lib.– L'attribut Ordinal ne sera traité comme un nombre ordinal d'une procédure

de dll externe uniquement s'il a le préfixe #.v La saisie de données utilisateur via des invites sous la forme d'instructions Input

ou Line Input n'est pas disponible.v L'instruction Print, lorsqu'elle est utilisée sans un numéro de fichier, doit être

changée en l'équivalent de l'instruction Debug.Print.v Les objets du Presse-papiers sont inaccessibles.v La fonction Erl n'est pas reconnue.


Fonctions des boîtes de dialogue et Microsoft Visual Basic forApplications

Microsoft Visual Basic for Applications ne dispose d'aucune syntaxe pour créer ouexécuter des boîtes de dialogue. Pour y remédier, le langage CognosScript disposed'un ensemble de fonctions et d'instructions permettant l'utilisation de boîtes dedialogue (similaires à celles de Word).

Microsoft Visual Basic for Applications fournit, en revanche, des fonctions et desinstructions permettant de prendre en charge les boîtes de dialogue. Toutefois, lesfonctions et instructions de boîte de dialogue CognosScript ne fonctionneront pasdirectement avec Visual Basic for Applications. Vous devez transposer les scriptsdes boîtes de dialogue sous des formes utilisateur personnalisées.

Différences entre le langage CognosScript et Word Basic

Word Basic est une version de Visual Basic qui figurait dans les versionsantérieures de Microsoft Word. Word Basic prend en charge les boîtes de dialogue,mais pas les objets. Les rubriques qui suivent décrivent certaines des différencesque vous remarquerez entre le langage CognosScript et Word Basic.

Fonctions des boîtes de dialogue

Les fonctions de boîtes de dialogue du langage CognosScript et de Word sont trèssimilaires. Word dispose de certaines instructions et fonctions dont le langageCognosScript ne dispose pas, comme DlgFilePreview.

A l'inverse, le langage CognosScript dispose de certaines caractéristiques dontWord ne dispose pas :v Buttonv Button Groupv Captionv DropComboBoxv StaticComboBox

Pour répondre aux besoins de certains types de support de boîte de dialogue, lelangage CognosScript a proposé, avant Word Basic, certaines options de boîte dedialogue. Ultérieurement, Word Basic a intégré sa propre syntaxe pour ces options.Il s'ensuit qu'il existe certaines différences dans la manière dont les deux langagesmanipulent les boîtes de dialogue.

Fonctions Button et PushButton

Button constitue la syntaxe d'origine du langage CognosScript, tandis quePushButton est celle de Word Basic. Les deux sont interchangeables, et l'EditeurCognosScript reconnaît les deux. Toutefois, PushButton est privilégiée.

Unités de mesure des boîtes de dialogue

Les unités de mesure ne sont pas les mêmes dans les deux syntaxes de boîte dedialogue. Vous pouvez choisir l'une ou l'autre, l'Editeur CognosScript les reconnaîttoutes les deux.

Etant donné que beaucoup de nos clients ont créé des procédures basées sur lesunités CognosScript d'origine, celles-ci sont utilisées dans les exemples. Il en

Chapitre 1. Automatisation OLE de PowerPlay 5

résulte que si vous utilisez les unités de Word, certaines boîtes de dialogue crééesdans les exemples ne présenteront pas l'aspect escompté.

Mécanismes de saisie de données

Il existe de légères différences dans certains mécanismes de saisie de données.

Le tableau suivant répertorie ces différences.

Langage CognosScript Word Basic

StaticComboBox ou ComboBox (dans lelangage CognosScript, ces deux instructionssont interchangeables)

ComboBox (Word Basic ne reconnaît quecette syntaxe)

DropComboBox N/A


Chapitre 2. Objets

Vous travaillez avec les objets suivants pour l'automatisation OLE d'IBM CognosPowerPlay.

Nom Description

Objet AdvancedQuery Représente une requête évoluée qui contientdes catégories basées sur des critèresprécisés dans la définition de sous-ensemble.

Objet Application Objet Application principal de PowerPlay.

Objet CategoryList Effectue la maintenance d'une liste decatégories provenant d'un cube.

Objet Child Se rapporte à un objet Child spécifique dansune collection.

Objet Column Permet de manipuler une colonne dans unrapport.

Objet Dimension Contient une dimension dans l'objetDimensionLine d'un PowerCube.

Objet DimensionLine Effectue la maintenance d'une liste d'objetsDimension.

Objet Exception Définit une nouvelle exception pour unrapport.

Objet FindQuery Recherche les catégories d'une chaînespécifique.

Objet Graph Permet de manipuler des graphiques dansun rapport PowerPlay.

Objet Layer Permet de manipuler une couche dans unrapport.

Objet Level Permet de retourner un niveau dans unrapport.

Objet ParentageQuery Effectue une requête basée sur les niveauxd'un rapport.

Objet Print Permet de manipuler les paramètresd'impression d'un rapport PowerPlay etd'initialiser une tâche d'impression.

Objet Range Permet de spécifier les plages numériquesdes exceptions dans les rapports PowerPlay.

7

Nom Description

Objet Report Contient des données issues d'un ou deplusieurs cubes.

Objet Row Permet de manipuler une ligne dans unrapport.

Objet SaveAsPDF Enregistre un rapport dans un fichier deformat PDF (Portable Document Format).

Objet ValueRestriction Permet d'appliquer des restrictions auxrésultats de AdvancedQuery en fonction devaleurs supérieures ou inférieures à unnombre ou à une valeur déterminéeappartenant à une plage précisée.

Objet AdvancedQueryReprésente une requête évoluée qui contient des catégories basées sur des critèresprécisés dans la définition de sous-ensemble.

Explication

Utilisez l'objet AdvancedQuery pour spécifier les catégories à afficher dans unrapport en utilisant un ou plusieurs des critères suivants :v une dimension,v une branche de niveaux,v un ou plusieurs niveaux,v un ou plusieurs qualificatifs (facultatif),v une ou plusieurs requêtes (facultatif).

La combinaison des critères est connue en tant que requête. Lorsqu'une requête estplacée dans un rapport, les catégories spécifiées par les critères sont ajoutées aurapport. La requête est réexécutée automatiquement à l'ouverture du rapport.Toutes les nouvelles catégories correspondant aux critères spécifiés apparaissentdans le rapport, tandis que les catégories ne correspondant plus aux critères ensont retirées.

Pour optimiser les possibilités de requête, vous pouvez utiliser les résultats dusous-ensemble FindQuery dans l'objet AdvancedQuery. Créez d'abord l'objetFindQuery, puis utilisez les données de sous-ensemble dans l'objetAdvancedQuery.

L'index Item des objets AdvancedQuery et FindQuery commence à 1.

Les requêtes de recherche sont uniquement appliquées au niveau le plus fin.

Lorsqu'un objet AdvancedQuery comporte plusieurs niveaux et contient unerequête ValueRestriction, la restriction de valeur s'applique uniquement au niveaule plus fin. Il ne peut exister qu'une seule restriction de valeur par objetAdvancedQuery.


Pour un objet AdvancedQuery, ne changez pas la dimension lorsque la requête estvalide (une telle modification annulerait la validité de tous les niveaux).

Pour un objet AdvancedQuery, l'ordre et la structure de la définition dusous-ensemble sont :

Name

Dimension

Level

Find

Include

Exclude

ValueRestriction

Execute

AddToReport

Nom Description

Méthode AddToReport Ajoute les résultats d'une requête à unrapport.

Méthode Exclude Définit les catégories à exclure de la requête.

Méthode Execute Exécute une opération de requête évoluéesur un cube.

Méthode Find Spécifie le nom de l'objet FindQuery àinclure dans un objet AdvancedQuery.

Méthode Include Définit les catégories à inclure dans larequête.

Méthode Item Retourne une catégorie de l'objetAvancedQuery.

Méthode Level Définit le niveau utilisé par l'objetAdvancedQuery afin d'extraire descatégories pour la requête.

Méthode Remove Supprime l'objet AdvancedQuery de lacollection ReportQueries.

Méthode ValueRestriction Retourne la restriction de valeur pour unobjet AdvancedQuery.

Chapitre 2. Objets 9

Nom Description

Propriété Application Renvoie l'objet Application.

Propriété Count Retourne une valeur indiquant le nombre decatégories correspondant au sous-ensemble.

Propriété Dimension Définit ou retourne la dimension d'où sontretournées les catégories.

Propriété LevelList Renvoie la liste des niveaux d'une branchede niveaux spécifique.

Propriété Name Définit ou retourne le nom dusous-ensemble.

Propriété Type Retourne un type d'objet de requête.

Exemple

Cet exemple crée une définition de sous-ensemble FindQuery (type 1) quirecherche tous les produits commençant par le nom "Star". Une définition desous-ensemble AdvancedQuery (type 3) est ensuite créée à l'aide des résultats de ladéfinition de sous-ensemble FindQuery. Le sous-ensemble de "Products"commençant par le nom "Star" est ensuite ajouté au rapport sous forme decolonnes.Sub Main()

Dim strCubePath As String

Dim objPPRep As Object

Dim objFind As Object

Dim objAdvanced As Object

strCubePath = "C:\Cubes and Reports\Great Outdoors.mdc"

Set objPPRep = CreateObject("CognosPowerPlay.Report")

objPPRep.New strCubePath, 1

objPPRep.ExplorerMode = False

objPPRep.Visible = True

Set objFind = objPPRep.ReportQueries.Add(1)

With objFind

.Name = "Find Star"

.Dimension = "Products"

.SearchShortName = False

.SearchText = "Star"

.Pattern = 2

End With

Set objAdvanced = objPPRep.ReportQueries.Add(3)

With objAdvanced

.Name = "Star Products"


.Level "Product Id"

.Find objFind.Name


.Execute

.AddToReport 1,1,3

End With

Set objAdvanced = Nothing

Set objFind = Nothing

Set objPPRep = Nothing

End Sub

Rubriques connexesv «Objet FindQuery», à la page 24v «Objet ParentageQuery», à la page 33v «Objet Report», à la page 38v «ReportQueries», à la page 66v «Méthode ReportQueries», à la page 218

Objet ApplicationObjet Application principal d'IBM Cognos PowerPlay.

Explication

L'objet Application vous permet d'obtenir le contrôle de l'application et de lancerPowerPlay à partir d'un script d'automatisation OLE. Vous pouvez déclarer unevariable objet et utiliser ensuite la méthode CreateObject pour créer un objetApplication PowerPlay.

Vous pouvez sélectionner un objet Application à l'aide des méthodes suivantes :v CreateObject("CognosPowerPlay.Application") lance une autre instance de

PowerPlay.v GetObject (, "CognosPowerPlay.Application" ) sélectionne l'application active,v Utilisez la méthode Application avec n'importe quel autre objet.

Nom Description

Méthode Activate Met en évidence l'objet Application.

Méthode Active Retourne l'objet Report actif.

«Méthode DeleteAllDataSourceInfo», à lapage 130

Méthode supprimant de la mémoire lesinformations de sécurité d'accès concernanttous les PowerCubes.

Méthode DeleteAllMDCAccessInfo Supprime de la mémoire les informations desécurité d'accès concernant tous lesPowerCubes.

Méthode DeleteMDCAccessInfo Supprime de la mémoire les informations desécurité d'accès pour le PowerCube spécifié.

Méthode Maximize Agrandit la fenêtre de l'objet Application.


Nom Description

Méthode Minimize Réduit la fenêtre de l'objet Application.

Méthode Quit Quitte PowerPlay.

Méthode Reports Retourne un seul objet Report ou la totalitéde la collection.

Méthode Restore Restaure la taille et l'emplacement d'originede la fenêtre de l'objet Application.

Méthode SetDataSourceInfo Stocke les informations de sécurité d'unesource de données en mémoire.

Nom Description


Propriété Caption Retourne le titre de la fenêtre de l'objetApplication.

Propriété DefaultAlternateDirectory Définit ou retourne le répertoire pourenregistrer les mises à jour dans un rapporten lecture seule.

Propriété DefaultCubeDirectory Définit ou retourne le chemin d'accès pardéfaut des fichiers de cubes (.mdc).

Propriété DefaultMacroDirectory Définit ou retourne le chemin d'accès pardéfaut des fichiers de macro.

Propriété DefaultReportDirectory Définit ou retourne le chemin d'accès pardéfaut des fichiers de rapports PowerPlay.

Propriété FullName Retourne le nom complet de l'objetApplication, y compris son emplacement.

Propriété LogonPrompt Définit ou retourne une valeur indiquant sil'application demande une connexion ou desinformations sur la sécurité.

Propriété Name Retourne le nom de l'objet Application.

Propriété Path Retourne le chemin d'accès de l'objetApplication.

Propriété RefreshSubCube Définit ou retourne une valeur indiquant sile sous-cube est mis à jourautomatiquement.


Nom Description

Propriété ShareDimensionLine Définit ou retourne une valeur indiquant siles rapports ouverts partagent une ligne desdimensions.

Propriété UserControl Définit ou retourne une valeur indiquant sil'objet Application est sous le contrôle del'utilisateur.

Propriété Version Retourne le numéro de version dePowerPlay.

Propriété Visible Définit ou retourne une valeur indiquant sil'objet Application est visible à l'utilisateurou non.

Exemple

Cet exemple crée une instance de l'objet Application PowerPlay et montrequelques-unes de ses propriétés à l'utilisateur. Pour effectuer le lien avec uneapplication PowerPlay en cours d'exécution, remplacez la fonction CreateObject parla fonction GetObject.Sub Main()

Dim objPPlayApp as Object

Set objPPlayApp = CreateObject("CognosPowerPlay.Application")

objPPlayApp.Visible = 1

MsgBox "The name of the Application is " &objPPLayApp.Name

MsgBox "The location of the Application is " _

&objPPLayApp.Path

MsgBox "The Application version is " &objPPLayApp.Version

Set objPPlayApp = Nothing

End Sub

Objet CategoryListEffectue la maintenance d'une liste de catégories provenant d'un cube.

Explication

Cet objet permet de sélectionner les catégories d'un cube ou d'en créer, puisd'ajouter toutes ces catégories ou certaines d'entre elles dans un rapport.

Pour ajouter des catégories dans un rapport, créez un objet CategoryList enappelant la méthode CategoryList, qui est une méthode Report, puis utilisez cetobjet pour identifier les catégories requises.

Ces catégories peuvent correspondre à celles trouvées dans un cube, ou auxcatégories créées lors de la transmission de l'objet CategoryList au rapport.Sélectionnez les catégories du fichier .mdc à l'aide de la méthode Add ou créez descatégories en attribuant la valeur True à une ou plusieurs des propriétéssuivantes : Average, Intersection et Sum.


Nom Description

Méthode Add (CategoryList) Ajoute une ou plusieurs catégories à unobjet CategoryList.

Méthode Remove Supprime toutes les catégories de l'objetCategoryList.

Nom Description


Propriété Average Définit ou retourne une valeur indiquant s'ilfaut calculer la moyenne des catégoriessélectionnées dans l'objet CategoryList.

Propriété Count Retourne le nombre de catégories de l'objetCategoryList.

Propriété Each Définit ou retourne une valeur indiquant sil'objet Report affiche toutes les catégories,tant sélectionnées que nouvelles, ouuniquement les nouvelles catégories.

Propriété Intersect Définit ou retourne une valeur indiquant s'ilfaut déterminer les valeurs à l'intersectiondes catégories sélectionnées issues dedifférentes dimensions.

Propriété ShareOf Définit ou retourne une valeur indiquant siles valeurs des catégories sélectionnéesdoivent être affichées sous forme depourcentage de leur catégorie de niveausupérieur.

Propriété Sum Définit ou retourne une valeur indiquant sila somme des catégories sélectionnées doitêtre calculée.

Exemple

Cet exemple ajoute des catégories aux colonnes et aux lignes du rapport.Sub Main()

Dim objPPRep as Object

Dim objCatList as Object


objPPRep.New "C:\Cubes and Reports\Great " & _

"Outdoors.mdc", False

Set objCatList = objPPRep.CategoryList


objCatList.Add 1, "Products", "Outdoor Products"

objPPRep.Columns.Add objCatList


objCatList.Add 1, "Locations", "Far East"

objPPRep.Rows.Add objCatList

Set objCatList = Nothing


End Sub

Rubriques connexesv Chapitre 4, «Méthodes», à la page 73v Chapitre 5, «Propriétés», à la page 267

Objet ChildSe rapporte à un objet Child spécifique dans une collection.

Explication

Utilisez cet objet lorsque vous voulez obtenir le nom d'une catégorie enfant à partirde la collection. L'objet enfant vous permet d'isoler les catégories se trouvant auniveau immédiatement inférieur à une autre catégorie de la branche de niveaux,sans devoir connaître le nom de la catégorie enfant.

Vous pouvez également utiliser la méthode Item à partir de la collection Childrenpour obtenir le nom d'un objet Child.

Nom Description

Propriété Name Définit ou retourne le nom de l'objet Child.

Exemple

Cet exemple extrait le nom du descendant de la première catégorie de la collectionRows, puis l'affiche.Sub Main


Dim objFirstRow As Object

Dim strChild As String

Set objPPRep = GetObject(,"CognosPowerPlay.Report")

Set objFirstRow = objPPRep.Rows.Item(1)

strChild = objFirstRow.Children.Item(1).Name

MsgBox strChild & " is a child of the " &_

objFirstRow.Name & " category.", , "ChildObject"

Set objFirstRow = Nothing


End Sub

Rubriques connexesv «Children», à la page 51v «Méthode Children», à la page 122


Objet ColumnPermet de manipuler une colonne dans un rapport.

Explication

Pour utiliser cet objet, ajoutez des catégories au rapport à partir de l'objetCategoryList ou ouvrez un rapport.

Vous pouvez effectuer des calculs, passer aux niveaux supérieurs ou inférieurs,masquer, classer et supprimer des objets Column. Utilisez un index pour indiquerl'emplacement d'un objet Column dans la collection Columns.

Certaines méthodes ne sont disponibles qu'en mode Reporter.

Nom Description

Méthode Accumulation Cumule toutes les valeurs des catégories del'objet Column.

Méthode Activate Met en évidence l'objet Column.

Méthode Addition (Objects) Ajoute une valeur constante ou unecatégorie à l'objet Column.

Méthode AddLowestLevelCategories(Reporter)

Méthode ajoutant les catégories de niveau leplus fin au rapport.

Méthode Average (Objects) (Reporter) Détermine la moyenne entre une valeurconstante, ou une autre catégorie, et l'objetColumn.

Méthode CanDrillDown Retourne une valeur indiquant si vouspouvez passer au niveau inférieur de l'objetColumn.

Méthode CanDrillUp Retourne une valeur indiquant si vouspouvez passer au niveau supérieur de l'objetColumn.

Méthode Children Retourne la catégorie fille suivante dans lahiérarchie de l'objet Column.

Méthode CumPercentOfBase Ajoute au moins une catégorie CumulativePercent of Base en utilisant comme base unecatégorie d'une autre dimension.

Méthode Division Divise l'objet Column par une valeurconstante ou une autre catégorie.

Méthode DrillDown Passe au niveau inférieur de l'objet Column.

Méthode DrillUp Passe au niveau supérieur de l'objetColumn.


Nom Description

Méthode Exponentiation Elève l'objet Column à la puissance d'uneautre catégorie ou d'une valeur constante.

Méthode Hide Masque l'objet Column.

Méthode Maximum (Objects) (Reporter) Détermine la valeur maximale entre l'objetColumn et une valeur constante ou uneautre catégorie.

Méthode Minimum (Objects) (Reporter) Détermine la valeur minimale entre l'objetColumn et une valeur constante ou uneautre catégorie.

Méthode Multiplication (Objects) Multiplie une valeur constante ou une autrecatégorie par l'objet Column.

Méthode Percent Ajoute un pourcentage d'objet Column basésur une autre catégorie ou sur une valeurconstante.

Méthode PercentGrowth Calcule la différence en pourcentage entredeux catégories ou mesures.

Méthode PercentOfBase Ajoute une catégorie Percent of Base enutilisant comme base une catégorie d'uneautre dimension.

Méthode Rank2 Classe et trie les objets Row basés sur l'objetColumn.

Méthode Remove Supprime l'objet Column du rapport.

Méthode Rollup Regroupe les catégories contenant desvaleurs calculées pour créer un calculdynamique.

Méthode Select Sélectionne l'objet Column.

Méthode SelectBlank Sélectionne une colonne vide spécifique.

Méthode Subtraction (Objects) Soustrait une valeur constante ou une autrecatégorie de l'objet Column, ou soustraitl'objet Column d'une catégorie ou d'unevaleur constante.

Méthode Unselect Annule la sélection de l'objet Column.

Méthode UnselectBlank Annule la sélection d'une colonne videspécifique.


Nom Description


Propriété CellText Retourne le texte d'une cellule.

Propriété CellValueAlignment Retourne l'alignement appliqué à la valeurd'une cellule d'un rapport.

Propriété CellValueFontColor Retourne la couleur de la police appliquée àla valeur d'une cellule d'un rapport.

Propriété CellValueFontName Retourne le nom de la police appliquée à lavaleur d'une cellule d'un rapport.

Propriété CellValueFontSize Retourne la taille de la police appliquée à lavaleur d'une cellule d'un rapport.

Propriété Exception Définit ou retourne l'exception de l'objetColumn.

Propriété Index Retourne la position de l'objet Columns dansla collection Columns.

Propriété IsAlternate Retourne une valeur indiquant si la branchede niveaux est principale ou secondaire.

Propriété IsCalculatedCategory Retourne une valeur indiquant si lacatégorie est calculée.

Propriété LabelAlignment Retourne l'alignement appliqué à un libelléde catégorie d'un rapport.

Propriété LabelFontColor Retourne la couleur de la police appliquée àun libellé de catégorie d'un rapport.

Propriété LabelFontName Retourne le nom de la police appliquée aulibellé d'une catégorie d'un rapport.

Propriété LabelFontSize Retourne la taille de la police appliquée à unlibellé de catégorie d'un rapport.

Propriété Level Retourne le niveau de la catégorie dans unedimension.

Propriété Name Définit ou retourne le nom de l'objetColumn.

Propriété NestedName Retourne le nom imbriqué d'une catégorie.

Propriété ParentCategory Retourne le nom de la catégorie parent del'objet.


Nom Description

Propriété Precedence Définit ou retourne la priorité utilisée dansles calculs complexes.

Propriété Style Définit ou retourne le style utilisé pourl'objet Column.

Propriété TopLevelParentCategory Retourne le nom de la dimension de l'objet.

Exemple

Cet exemple ouvre un rapport, recherche l'objet Column Tents dans la collectionColumns, remplace le nom de la colonne par Old Tents et enregistre le rapport.Sub Main()


Dim objPPCol as Object

Set objPPRep = CreateObject ("CognosPowerPlay.Report")

objPPRep.Open "C:\Cubes and Reports\sample1.ppr"

Set objPPCol = objPPRep.Columns.Item("Tents")

objPPCol.Name = "Old Tents"

objPPRep.Save

Set objPPCol = Nothing


End Sub

Rubriques connexesv «Objet CategoryList», à la page 13

Objet DimensionContient une dimension dans l'objet DimensionLine d'un PowerCube.

Explication

Utilisez cet objet pour modifier les paramètres par défaut des dimensions de l'objetDimensionLine et déterminer les propriétés de la dimension. Chaque objetDimension comprend différents niveaux de catégories. Vous aurez recours à cetobjet pour faire référence à un élément d'une ligne, d'une colonne ou d'une couche.

Les catégories spéciales et les branches secondaires de niveaux sont aussireconnues par l'automatisation OLE. Par exemple, une dimension "Years" peutcomporter deux catégories ordinaires "1995" et "1996" et trois autres catégoriesdénommées "Current Month", "QTD" et "Last Month" qui représentent descatégories spéciales et des branches secondaires de niveaux.

La définition du nombre de Dimension "Years"Msgbox Report.DimensionLine.Item("Years").Count

retournera la valeur "5" car les catégories ordinaires et spéciales sont toutes visiblesdans l'automatisation OLE.


Il est possible de filtrer une catégorie spéciale en la nommant de la façonsuivante :Report.DimensionLine.Item("Years").Change("Current Month")

Nom Description

Méthode Change Change la catégorie en cours de l'objetDimension.

Méthode ChangeToParent Remplace la catégorie en cours de l'objetDimension par la catégorie de niveauimmédiatement supérieur.

Méthode ChangeToTop Remplace la catégorie en cours de l'objetDimension par la catégorie de niveau le plusélevé.

Méthode Children Retourne la catégorie enfant suivante dans lahiérarchie de la dimension en cours.

Méthode HasParent Retourne une valeur indiquant si lacatégorie en cours a une catégorie parent ounon.

Méthode Levels Retourne tous les niveaux disponibles dansla dimension pour une catégorie.

Méthode Parent Retourne le nom de la catégorie parent.

Nom Description


Propriété BlankWhenDividedByZero Définit ou retourne une valeur indiquant siune valeur numérique divisée par zéroapparaît sous forme de zéro ou en blanc.

Propriété BlankWhenMissing Définit ou retourne une valeur indiquant siles valeurs numériques manquantesapparaissent sous la forme de zéros ou deblancs.

Propriété BlankWhenZero Définit ou retourne une valeur indiquant siles valeurs numériques nulles apparaissentsous forme de zéro ou en blanc.

Propriété Count Retourne le nombre de catégories de niveauimmédiatement inférieur à la catégorie encours.

Propriété Index Retourne la position de l'objet Dimensiondans l'objet DimensionLine.


Nom Description



Propriété Level Retourne le niveau de la catégorie dans unedimension.

Propriété Measure Définit ou retourne la valeur et le symboled'une devise déterminée.

Propriété Name Définit ou retourne le nom de l'objetDimension.

Propriété Visible Définit ou retourne une valeur indiquant sil'objet DimensionLine est visible pourl'utilisateur.

Exemple

Cet exemple modifie deux des catégories en cours (une de la dimension Year,l'autre de la dimension Product) de l'objet DimensionLine dans le rapport actif.Sub Main()


Dim objPPDim1 as Object

Dim objPPDim2 as Object

Set objPPRep = GetObject("c:\cognos\change.ppr")

Set objPPDim1 = objPPRep.DimensionLine.Item("Years")

Set objPPDim2 = objPPRep.DimensionLine.Item("Products")

objPPDim1.Change ("1996")

objPPDim2.Change ("Outdoor Products")

Set objPPDim2 = Nothing

Set objPPDim1 = Nothing


End Sub

Rubriques connexesv «Objet DimensionLine»

Objet DimensionLineEffectue la maintenance d'une liste d'objets Dimension.

Explication

L'objet DimensionLine comprend les catégories utilisées pour filtrer les donnéesissues de chaque dimension du cube. L'objet DimensionLine contient les objetsDimension.


Il est possible d'automatiser les modifications apportées à l'aspect de la ligne desdimensions d'un rapport. Vous pouvez rendre l'objet DimensionLine invisible pourl'utilisateur à l'ouverture ou après l'ouverture d'un rapport.

Nom Description

Méthode Item Retourne un objet Dimension provenant del'objet DimensionLine.

Nom Description


Propriété Count Retourne le nombre d'objets Dimension del'objet DimensionLine.

Propriété Visible Définit ou retourne une valeur indiquant sil'objet DimensionLine est visible àl'utilisateur ou non.

Exemple

Cet exemple modifie deux des catégories en cours de l'objet DimensionLine dans lerapport actif.Sub Main()


Set objPPRep = GetObject("C:\Cubes and Reports\Sample.ppr")

objPPRep.DimensionLine.Item("Years").Change ("1995")

objPPRep.DimensionLine.Item("Products").Change _

("Go Sport Line")


End Sub

Rubriques connexesv «Objet Dimension», à la page 19

Objet ExceptionDéfinit une nouvelle exception pour un rapport.

Explication

Cet objet est à la base de l'identification des exceptions dans les données derapports. Une exception vous permet de mettre en évidence les informations d'unrapport qui remplissent un critère déterminé. Vous devez définir une plage ainsique le style auxquels s'applique l'exception. Utilisez les méthodes UpperBoundaryet LowerBoundary pour déterminer la plage à formater lorsque les informations durapport remplissent les conditions définies par la plage d'exceptions. L'objetException défini peut ensuite être appliqué aux catégories.


Nom Description

Méthode Ranges Retourne un objet Range ou la totalité de lacollection.

Méthode Remove Supprime l'objet Exception de l'objet Report.

Méthode SetDrivingCategory Définit la catégorie directrice de l'objetException.

Méthode SetMacro Définit le nom et le style de la macro utilisésdans l'objet Exception.

Nom Description


Propriété DrivingCategory Retourne la catégorie directrice de l'objetException.

Propriété DrivingDimension Retourne la dimension directrice de l'objetException.

Propriété MacroName Définit ou retourne le nom de la macroassociée à un objet Exception.

Propriété MacroStyle Définit ou retourne le nom du style associé àla macro.

Propriété Name Définit ou retourne le nom de l'objetException.

Exemple

Cet exemple ouvre un rapport et affiche les zones directrices du premier objetException.Sub Main()



objPPRep.Open "C:\Cubes and Reports\Exception.ppr"

MsgBox "Driving Category:" & _

objPPRep.Exceptions.Item(1).DrivingCategory

MsgBox "Driving Dimension:" & _

objPPRep.Exceptions.Item(1).DrivingDimension


End Sub



Objet FindQueryRecherche les catégories d'une chaîne spécifique.

Explication

Cet objet permet de localiser une catégorie individuelle ou toutes les catégoriescorrespondant à une chaîne SearchText spécifiée. Lors de la spécification d'unechaîne SearchText dans la définition de sous-ensemble, vous pouvez égalementspécifier des motifs évolués à l'aide de la propriété Patterns.

Lorsque vous utilisez la fonction FindQuery pour rechercher des données au seind'un rapport, vous pouvez rechercher la catégorie correspondant à vos critères derecherche. Si vous utilisez l'objet FindQuery pour rechercher des données au seind'un cube, il crée une requête qui vous permet de localiser toutes les catégoriescorrespondant à vos critères de recherche. Vous pouvez utiliser ces résultats deFindQuery au sein d'un objet AdvancedQuery.

Une recherche FindQuery n'inclut pas les catégories masquées dans le rapport.

L'index Item de l'objet FindQuery commence à 1.

Pour un objet FindQuery, l'ordre et la structure de la définition de sous-ensemble(les composants de l'objet FindQuery) sont :v Namev Dimensionv SearchShortNamev SearchDescriptionv SearchTextv Patternv Executev AddToReport

Si vous souhaitez utiliser l'objet FindQuery en conjonction avec un objetAdvancedQuery, commencez par définir l'objet FindQuery.

Nom Description

Méthode AddToReport Ajoute les résultats d'une requête à unrapport.

Méthode Execute Exécute l'opération de recherche sur uncube.

Méthode Item Retourne l'objet FindQuery de la collectionReportQueries.

Méthode Remove Supprime l'objet FindQuery de la collectionReportQueries.


Nom Description


Propriété Count Retourne une valeur indiquant le nombre decatégories correspondant au sous-ensemble.

Propriété Dimension Définit ou retourne la dimension d'où sontretournées les catégories.

Propriété Name Définit ou retourne le nom dusous-ensemble.

Propriété Pattern Définit les critères de recherche d'unedéfinition de sous-ensemble.

Propriété SearchDescription Définit ou retourne une valeur indiquant sil'objet FindQuery recherche les descriptionsde catégories dans un cube.

Propriété SearchShortName Définit ou retourne une valeur indiquant sil'objet FindQuery recherche des noms decatégories abrégés ou longs.

Propriété SearchText Définit ou retourne la chaîne de rechercheutilisée dans la définition de sous-ensembled'une requête FindQuery.

Propriété Type Retourne un type d'objet de requête.

Exemple

Cet exemple permet de créer une définition de sous-ensemble FindQueryrecherchant tous les produits qui commencent par le nom "Star".Sub Main()

Dim strCubePath As String


Dim objFind As Object

strCubePath = "C:\Cubes and Reports\Great Outdoors.mdc"


objPPRep.New strCubePath, 1

objPPRep.ExplorerMode = False


Set objFind = objPPRep.ReportQueries.Add(1)

With objFind

.Name = "Find Star"


.SearchShortName = False

.SearchText = "Star"

.Pattern = 2

End With


Set objFind = Nothing


End Sub

Rubriques connexesv «Objet AdvancedQuery», à la page 8v «Objet ParentageQuery», à la page 33v «Méthode ReportQueries», à la page 218v «Reports», à la page 67

Objet GraphPermet de manipuler des graphiques dans un rapport IBM Cognos PowerPlay.

Explication

Les objets graphiques permettent d'établir des comparaisons, des relations et destendances. Lorsqu'un rapport contient une grande quantité d'informations, vousavez la possibilité de recourir à un objet Graph comme autre moyen dereprésentation des données. Vous pouvez également exploiter les attributs del'objet Graph pour présenter plus efficacement les données, par exemple enutilisant les méthodes de permutation pour les couches, les lignes et les colonnesd'un rapport. Vous pouvez ajouter et supprimer des objets Graph et déterminer letype de graphique sélectionné.

Nom Description

Méthode Activate Met en évidence l'objet Graph.

Méthode Depth Retourne une valeur indiquant si l'objetGraph est en trois dimensions (3D).

Méthode Remove Supprime l'objet Graph du rapport.

Méthode SetType Définit le type de l'objet Graph.

Méthode Vertical Retourne une valeur indiquant si l'objetGraph est un graphique vertical.

Nom Description


Propriété DataGridlines Définit ou retourne une valeur indiquant siles paramètres de lignes de quadrillage dansun tableau sont activés ou désactivés.

Propriété EnableUserColumnSummaryLabel Définit ou retourne une valeur indiquant siun libellé personnalisé est employé pour lacolonne récapitulative qui se trouve le plus àl'intérieur dans un tableau imbriqué.


Nom Description

Propriété EnableUserRowSummaryLabel Définit ou retourne une valeur indiquant siun libellé personnalisé est employé pour laligne récapitulative qui se trouve le plus àl'intérieur dans tableau un imbriqué.

Propriété HideRankCategory Définit ou retourne une valeur indiquant sila catégorie de rang est masquée.

Propriété IndentTotalsLevel Définit ou retourne le niveau en cours demise en retrait des cellules récapitulativesdans un tableau imbriqué.

Propriété Index Retourne la position de l'objet Graph dans lacollection Graphs.

Propriété KeepSummaryVisible Définit ou retourne une valeur indiquant sila catégorie récapitulative est mentionnéesur toutes les pages parcourues.

Propriété LabelGridlines Définit ou retourne une valeur indiquant siles lignes de quadrillage sont activées oudésactivées pour les libellés de catégoriesdans un tableau imbriqué.

Propriété Layout Définit ou retourne le style de présentationen cours dans un tableau imbriqué.

Propriété MaxPrintedBars Définit ou retourne le nombre maximal debarres sur une seule page imprimée.

Propriété MaxVisibleBars Définit ou retourne le nombre maximal debarres visibles sur une page de donnéesparcourue.

Propriété NamesShown Définit ou retourne une valeur indiquant siles noms de catégories apparaissent à côtédes tranches des graphiques circulaires.

Propriété NestedCharts (Explorer) Définit ou retourne une valeur indiquant siplusieurs diagrammes représentant desdonnées récapitulatives apparaissent dansun même graphique.

Propriété ShowSummaryBreakdown(Explorer)

Définit ou retourne une valeur indiquant sila répartition des lignes et des colonnesrécapitulatives est affichée dans un tableau.

Propriété ShowSummaryColumn (Explorer) Définit ou retourne une valeur indiquant sila colonne récapitulative doit être visible.

Propriété ShowSummaryRow (Explorer) Définit ou retourne une valeur indiquant sila ligne récapitulative doit être visible.


Nom Description

Propriété ShowTies Définit ou retourne une valeur indiquant siles liens des libellés sont visibles.

Propriété StatsLineCaption Définit ou retourne la légende d'une courbestatistique donnée sur un graphique.

Propriété StatsLineColor Définit ou retourne la couleur d'une courbestatistique donnée sur un graphique.

Propriété StatsLineOn Définit ou retourne une courbe statistiquesur un graphique.

Propriété StatsLineStyle Définit ou retourne le style d'une courbestatistique donnée sur un graphique.

Propriété StatsLineUserValue Définit une valeur personnalisée pour unecourbe statistique sur un graphique.

Propriété Type Retourne le type de l'objet Graph.

Propriété UserColumnSummaryLabel Définit ou retourne le libellé personnalisé dela colonne récapitulative qui se trouve leplus à l'intérieur dans un tableau imbriqué.

Propriété UserRowSummaryLabel Définit ou retourne le libellé personnalisé dela ligne récapitulative qui se trouve le plus àl'intérieur dans un tableau imbriqué.

Propriété UseScrolling Définit ou retourne une valeur indiquant sile défilement est activé.

Propriété ValuesAutoFit Définit ou retourne une valeur indiquant siles libellés de valeurs s'intègrent dans lesbarres de graphiques et les segments degraphiques circulaires.

Propriété ValuesFontColor Définit ou retourne la couleur de la policeutilisée pour les libellés de valeursgraphiques.

Propriété ValuesFontName Définit ou retourne le nom de la policeutilisée pour les libellés de valeurs.

Propriété ValuesFontSize Définit ou retourne la taille de la policeutilisée pour les libellés des valeursgraphiques.

Propriété ValuesFontStyle Définit ou retourne le style de la policeutilisée pour les libellés de valeursgraphiques.

Propriété ValuesPosition Définit ou retourne la position des libellésde valeurs sur certains types de graphiques.


Nom Description

Propriété ValuesShown Définit ou retourne une valeur indiquant siles libellés de valeurs apparaissent à côtédes tranches des graphiques circulaires.

Exemple

Cet exemple ouvre un rapport et affiche le type du premier graphique du rapport.Sub Main()



objPPRep.Open "C:\Cubes and Reports\Graph.ppr"

MsgBox "The type of graph is" & _

objPPRep.Graphs.Item(1).Type & "."


End Sub


Objet LayerPermet de manipuler une couche dans un rapport.

Explication

Avec les colonnes et les lignes, l'objet Layer représente le troisième ensemble decatégories que vous pouvez ajouter à un rapport. Vous pouvez effectuer descalculs, passer aux niveaux supérieurs ou inférieurs, masquer, classer et supprimerdes objets Layer. Utilisez un index pour indiquer l'emplacement d'un objet Layerdans la collection Layers.

Pour utiliser cet objet, ajoutez des catégories au rapport à partir de l'objetCategoryList ou ouvrez un rapport.

Certaines méthodes ne sont disponibles qu'en mode Reporter.

Nom Description

Méthode Activate Met en évidence l'objet Layer.

Méthode Addition (Objects) Ajoute une valeur constante ou unecatégorie à l'objet Layer.

Méthode AddLowestLevelCategories(Reporter)

Méthode ajoutant les catégories de niveau leplus fin au rapport.


Nom Description

Méthode Average (Objects) (Reporter) Détermine la moyenne entre une valeurconstante ou une autre catégorie et l'objetLayer.

Méthode CanDrillDown Retourne une valeur indiquant si vouspouvez passer au niveau inférieur de l'objetLayer.

Méthode CanDrillUp Retourne une valeur indiquant si vouspouvez passer au niveau supérieur de l'objetLayer.

Méthode Children Retourne la catégorie enfant suivante dans lahiérarchie de l'objet Layer.

Méthode Division Divise l'objet Layer par une valeur constanteou une autre catégorie.

Méthode DrillDown Permet de passer au niveau inférieur del'objet Layer.

Méthode DrillUp Permet de passer au niveau supérieur del'objet Layer.

Méthode Exponentiation Elève l'objet Layer à la puissance d'une autrecatégorie ou d'une valeur constante.

Méthode Maximum (Objects) (Reporter) Détermine la valeur maximale entre l'objetLayer et une valeur constante ou une autrecatégorie.

Méthode Minimum (Objects) (Reporter) Détermine la valeur minimale entre l'objetLayer et une valeur constante ou une autrecatégorie.

Méthode Multiplication (Objects) Multiplie une valeur constante ou une autrecatégorie par l'objet Layer.

Méthode Percent Ajoute un pourcentage d'objet Layer basésur une autre catégorie ou sur une valeurconstante.

Méthode Remove Supprime l'objet Layer de l'objet Report.

Méthode Rollup Regroupe les catégories contenant desvaleurs calculées pour créer un calculdynamique.

Méthode Select Sélectionne l'objet Layer.

Méthode Subtraction (Objects) Soustrait une valeur constante ou une autrecatégorie de l'objet Layer et inversement.


Nom Description

Méthode Unselect Annule la sélection de l'objet Layer.

Nom Description


Propriété Index Retourne la position de l'objet Layer dans lacollection Layers.



Pr

© copyright ibm corp. 2005, 2017....le present document est livre en l'et a t sans aucune garantie...

Documents