IBM Cognos TM1 Version 10.1.0: API Guide

447 Pages·2011·2.13 MB·English

IBM Cognos TM1
Version 10.1.0
API Guide
(cid:1)(cid:2)(cid:3)
Note
Beforeusingthisinformationandtheproductitsupports,readtheinformationin“Notices”onpage415.
Product Information
ThisdocumentappliestoIBMCognosTM1Version10.1.0andmayalsoapplytosubsequentreleases.Tocheckfor
newerversionsofthisdocument,visittheIBMCognosInformationCenters(http://publib.boulder.ibm.com/
infocenter/cogic/v1r0m0/index.jsp).
Microsoftproductscreenshot(s)usedwithpermissionfromMicrosoft.
LicensedMaterials-PropertyofIBM
©CopyrightIBMCorporation2007,2012.
USGovernmentUsersRestrictedRights–Use,duplicationordisclosurerestrictedbyGSAADPScheduleContract
withIBMCorp.
Contents
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xv
Chapter 1. The IBM Cognos TM1 programming environment . . . . . . . . . . . . . 1
LocationoftheIBMCognosTM1APIDLLs. . . . . . . . . . . . . . . . . . . . . . . . . 1
SettingapathtotheDLLs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
Supportedcompilers. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Localservers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Remoteservers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Theadminhostandadminserver . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
TheroleofanIBMCognosTM1server . . . . . . . . . . . . . . . . . . . . . . . . . . 3
Multitaskingandsymmetricmultiprocessorsupport . . . . . . . . . . . . . . . . . . . . . . 4
IBMCognosTM1serverperformance . . . . . . . . . . . . . . . . . . . . . . . . . . 4
SamplecodefortheIBMCognosTM1API . . . . . . . . . . . . . . . . . . . . . . . . . 4
Chapter 2. IBM Cognos TM1 programming concepts . . . . . . . . . . . . . . . . 5
Systemfunctions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
ConnectingtotheAPI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
DisconnectingfromtheAPI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Managingserverconnections. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Settingtheadminhostserver. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Progresscallbackfunctions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Requestingtheversionofthesystem . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Threadsafety . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Handles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
SimpleIBMCognosTM1datatypes . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Valuehandlingfunctions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Stringhandling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Objecthandling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Arrayhandling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Updatingvaluecapsules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Pendingvalues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Managingvaluepools. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Objectattributes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Securitylevels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Groups. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Clients . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Assigningclientstogroups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Assigningrightstoobjectsandgroups . . . . . . . . . . . . . . . . . . . . . . . . . 16
Metasecurity. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Managinglocksandreservations . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Determiningaccessrightsforaclient. . . . . . . . . . . . . . . . . . . . . . . . . . 16
Errorhandling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Examiningerrorvalues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Errorcodes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
APIerrorcodesfordatareservations. . . . . . . . . . . . . . . . . . . . . . . . . . 17
Backupandrecovery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Thetransactionlogfile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Treatmentoftime . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Namingconventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Logfilestructure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Automaticrecovery. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Accessingthelogfiles. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
©CopyrightIBMCorp.2007,2012 iii
Loggingchangestodimensions. . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
CreatinganIBMCognosTM1projectinCorC++ . . . . . . . . . . . . . . . . . . . . . . 20
Generatingaconsoleproject. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Settingpaths . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Addingtestcode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Buildingandrunningtheprogram . . . . . . . . . . . . . . . . . . . . . . . . . . 22
CreatinganIBMCognosTM1projectinMicrosoftVisualBasic . . . . . . . . . . . . . . . . . . 22
AddingcodetoyourMicrosoftVisualBasicProject . . . . . . . . . . . . . . . . . . . . . 23
LoggingintoanIBMCognosTM1Server . . . . . . . . . . . . . . . . . . . . . . . . 24
LoggingoutofIBMCognosTM1 . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Chapter 3. IBM Cognos TM1 objects . . . . . . . . . . . . . . . . . . . . . . . 27
IBMCognosTM1objectsoverview . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Objecthandles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Objectproperties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Listsofobjects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Creatingandregisteringobjects . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Registrationfunctions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Public,private,andunregisteredobjects. . . . . . . . . . . . . . . . . . . . . . . . . 31
Accessingparentobjects-security. . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Objectnames. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Loadingobjects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Deletingobjects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Savingobjectstodisk . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Copyingobjects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Serverobject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Serverproperties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Serverfunctions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Dimensionandelementobjects. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Parentobject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Childobjects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Registration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Creatingadimension . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Updatingadimension. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Deletingadimension . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Dimensionproperties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Dimensionfunctions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Cubeobjects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Parentobject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Childobjects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Registration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Creatingacube . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
Retrievingandupdatingcubecells . . . . . . . . . . . . . . . . . . . . . . . . . . 40
Deletingacube . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
Cubeproperties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
Cubefunctions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Cubeperspectives . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Ruleobjects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
Ruleproperties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
Rulefunctions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
Creatinganewrule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Updatinganexistingrule. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Subsetobjects. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Parentobject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Registration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
Creatingasubset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
Deletingasubset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
Updatingasubset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
Subsetobjectproperties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
Subsetfunctions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
iv IBMCognosTM1Version10.1.0: APIGuide
Subsetelementdisplayfunctions . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
Viewobjects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Parentobject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Registration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Creatingaview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Deletingaview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Viewobjectproperties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
Viewfunctions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
BLOBobjects. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
Propertyobject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
Childobject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
Registration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
CreatingaBLOB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
UpdatingaBLOB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
DeletingaBLOB. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
Filestorage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
BLOBobjectproperties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
Blobfunctions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
Chapter 4. IBM Cognos TM1 functions for C . . . . . . . . . . . . . . . . . . . 53
Functiontypesandnamingconventions. . . . . . . . . . . . . . . . . . . . . . . . . . 53
ConfiguringtheIBMCognosTM1CAPItouseSSL. . . . . . . . . . . . . . . . . . . . . . 53
TM1SystemSetAdminSSLCertAuthority . . . . . . . . . . . . . . . . . . . . . . . . . 53
TM1SystemGetAdminSSLCertAuthority. . . . . . . . . . . . . . . . . . . . . . . . . 53
TM1SystemSetAdminSSLCertRevList. . . . . . . . . . . . . . . . . . . . . . . . . . 54
TM1SystemGetAdminSSLCertRevList. . . . . . . . . . . . . . . . . . . . . . . . . . 54
TM1SystemSetAdminSSLCertID . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
TM1SystemGetAdminSSLCertID . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
TM1SystemSetExportAdminSvrSSLCertFlag . . . . . . . . . . . . . . . . . . . . . . . 54
TM1SystemSetAdminSvrExportKeyID . . . . . . . . . . . . . . . . . . . . . . . . . 54
TM1APIInitialize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
TM1APIFinalize. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
TM1BlobClose . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
TM1BlobCreate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
TM1BlobGet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
TM1BlobOpen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
TM1BlobPut . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
TM1CancelClientJob . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
TM1ChangeSetBegin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
TM1ChangeSetEnd. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
TM1ChangeSetUndo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
TM1ChoreExecute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
TM1ClientAdd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
TM1ClientGroupAssign . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
TM1ClientGroupIsAssigned . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
TM1ClientGroupRemove . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
TM1ClientHasHolds . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
TM1ClientPasswordAssign . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
TM1ConnectionCheck . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
TM1ConnectionCreate. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
TM1ConnectionDelete. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
TM1ConnectionSynchronize. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
TM1CubeCellDrillListGet. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
TM1CubeCellDrillObjectBuild . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
TM1CubeCellPickListGet. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
TM1CubeCellsPickListGet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
TM1CubeCellPickListExists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
TM1CubeCellSpreadViewArray. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
TM1CubeCellSpread . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
TM1CubeCellSpreadStatusGet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
TM1CubeCellValueGet. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
Contents v
TM1CubeCellsValueGet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
TM1CubeCellValueSet. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
TM1CubeCellsValueSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
TM1CubeCreate. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
TM1CubeDimensionListGet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
TM1CubeListByNamesGet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
TM1CubeListGet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
TM1CubePerspectiveCreate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
TM1CubePerspectiveDestroy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
TM1CubeShowsNulls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
TM1CubeTimeLastInvalidated . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
TM1DataReservationAcquire . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
TM1DataReservationGetAll . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
TM1DataReservationGetConflicts . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
TM1DataReservationRelease. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
TM1DataReservationReleaseAll. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
TM1DataReservationValidate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
TM1DimensionAttributesGet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
TM1DimensionCreateEmpty. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
TM1DimensionCheck . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
TM1DimensionElementComponentAdd . . . . . . . . . . . . . . . . . . . . . . . . . . 98
TM1DimensionElementComponentDelete . . . . . . . . . . . . . . . . . . . . . . . . . 99
TM1DimensionElementComponentWeightGet . . . . . . . . . . . . . . . . . . . . . . . 100
TM1DimensionElementDelete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
TM1DimensionElementInsert . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
TM1DimensionElementListByIndexGet. . . . . . . . . . . . . . . . . . . . . . . . . . 107
TM1DimensionElementListByNamesGet . . . . . . . . . . . . . . . . . . . . . . . . . 107
TM1DimensionUpdate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
TM1ElementCompomentsGet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
TM1GetSubsetByHandle. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110
TM1GetViewByName. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110
TM1GetViewByHandle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
TM1GroupAdd. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
TM1ObjectAttributeDelete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114
TM1ObjectAttributeInsert . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
TM1ObjectAttributeValueGet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116
TM1ObjectAttributeValueSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116
TM1ObjectCopy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
TM1ObjectDelete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
TM1ObjectDestroy. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
TM1ObjectDuplicate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119
TM1ObjectFileDelete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120
TM1ObjectFileLoad . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120
TM1ObjectFileSave . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121
TM1ObjectListCountGet. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122
TM1ObjectListHandleByIndexGet. . . . . . . . . . . . . . . . . . . . . . . . . . . . 122
TM1ObjectListHandleByNameGet . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
TM1ObjectPrivateDelete. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124
TM1ObjectPrivateListCountGet . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124
TM1ObjectPrivateListHandleByIndexGet . . . . . . . . . . . . . . . . . . . . . . . . . 125
TM1ObjectPrivateListHandleByNameGet . . . . . . . . . . . . . . . . . . . . . . . . . 126
TM1ObjectPrivatePublish . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
TM1ObjectPrivateRegister . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
TM1ObjectPropertyGet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
TM1ObjectPropertySet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129
TM1ObjectRegister . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
TM1ObjectReplicate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
TM1ObjectSecurityLock . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131
TM1ObjectSecurityRelease . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132
TM1ObjectSecurityReserve . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132
TM1ObjectSecurityRightGet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133
vi IBMCognosTM1Version10.1.0: APIGuide
TM1ObjectSecurityRightSet. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134
TM1ObjectSecurityUnLock . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135
TM1ProcessExecute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135
TM1ProcessExecuteEx . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137
TM1ProcessExecuteSQLQuery. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138
TM1ProcessVariableNameIsValid. . . . . . . . . . . . . . . . . . . . . . . . . . . . 138
TM1RuleAttach. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139
TM1RuleCheck. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139
TM1RuleCreateEmpty . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140
TM1RuleDetach . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141
TM1RuleLineGet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141
TM1RuleLineInsert . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142
TM1ServerBatchUpdateFinish . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143
TM1ServerBatchUpdateIsActive . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143
TM1ServerBatchUpdateStart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144
TM1ServerDimensionListGet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145
TM1ServerDimensionListByNamesGet . . . . . . . . . . . . . . . . . . . . . . . . . . 145
TM1ServerDisableBulkLoadMode . . . . . . . . . . . . . . . . . . . . . . . . . . . 146
TM1ServerEnableBulkLoadMode. . . . . . . . . . . . . . . . . . . . . . . . . . . . 146
TM1ServerLogClose . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147
TM1ServerLogNext . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147
TM1ServerLogOpen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148
TM1ServerOpenSQLQuery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149
TM1ServerPasswordChange . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150
TM1ServerSandboxesDelete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151
TM1ServerSecurityRefresh . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154
TM1SQLTableGetNextRows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155
TM1SubsetAll . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155
TM1SubsetCreateByExpression . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156
TM1SubsetCreateEmpty. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157
TM1SubsetElementDisplay . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157
TM1SubsetElementDisplayEll . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158
TM1SubsetElementDisplayLevel . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159
TM1SubsetElementDisplayLine . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159
TM1SubsetElementDisplayMinus. . . . . . . . . . . . . . . . . . . . . . . . . . . . 160
TM1SubsetElementDisplayPlus . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
TM1SubsetElementDisplaySelection . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
TM1SubsetElementDisplayTee. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162
TM1SubsetElementDisplayWeight . . . . . . . . . . . . . . . . . . . . . . . . . . . 162
TM1SubsetElementListByIndexGet . . . . . . . . . . . . . . . . . . . . . . . . . . . 163
TM1SubsetElementListByIndexGetEx . . . . . . . . . . . . . . . . . . . . . . . . . . 163
TM1SubsetElementListByNamesGet. . . . . . . . . . . . . . . . . . . . . . . . . . . 164
TM1SubsetInsertElement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165
TM1SubsetInsertSubset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165
TM1SubsetListGet. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166
TM1SubsetListByNamesGet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167
TM1SubsetSelectByAttribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168
TM1SubsetSelectByIndex . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169
TM1SubsetSelectByLevel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170
TM1SubsetSelectByPattern . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170
TM1SubsetSelectionDelete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171
TM1SubsetSelectionInsertChildren . . . . . . . . . . . . . . . . . . . . . . . . . . . 172
TM1SubsetSelectionInsertParents. . . . . . . . . . . . . . . . . . . . . . . . . . . . 173
TM1SubsetSelectionKeep . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173
TM1SubsetSelectNone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174
TM1SubsetSort. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174
TM1SubsetSortByHierarchy. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175
TM1SubsetSubtract . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176
TM1SubsetUpdate. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176
TM1SystemAdminHostGet. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177
TM1SystemAdminHostSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177
Contents vii
TM1SystemBuildNumber . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178
TM1SystemClose . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178
TM1SystemGetServerConfig . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179
TM1SystemOpen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180
TM1SystemProgressHookSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180
TM1SystemServerClientName. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181
TM1SystemServerConnect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182
TM1SystemServerConnectIntegratedLogin. . . . . . . . . . . . . . . . . . . . . . . . . 183
TM1SystemServerDisconnect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183
TM1SystemServerHandle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184
TM1SystemServerName. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185
TM1SystemServerNof . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185
TM1SystemServerReload . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186
TM1SystemServerStart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186
TM1SystemServerStartEx . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187
TM1SystemServerStop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188
TM1SystemVersionGet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189
TM1UserKill. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189
TM1ValArray . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189
TM1ValArrayGet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190
TM1ValArrayMaxSize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191
TM1ValArraySet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191
TM1ValArraySetSize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192
TM1ValBool. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192
TM1ValBoolGet. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193
TM1ValBoolSet. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193
TM1ValErrorCode. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194
TM1ValErrorString . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194
TM1ValIndex . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195
TM1ValIndexGet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195
TM1ValIndexSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196
TM1ValIsUndefined . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196
TM1ValIsChanged. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196
TM1ValIsUpdatable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197
TM1ValObject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198
TM1ValObjectCanRead . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198
TM1ValObjectCanWrite . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199
TM1ValObjectGet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199
TM1ValObjectSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200
TM1ValObjectType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200
TM1ValPoolCount. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201
TM1ValPoolCreate. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201
TM1ValPoolDestroy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201
TM1ValPoolGet. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202
TM1ValPoolMemory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203
TM1ValReal. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203
TM1ValRealGet. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204
TM1ValRealSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204
TM1ValString . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204
TM1ValStringEncrypt. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205
TM1ValStringGet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206
TM1ValStringMaxSize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206
TM1ValStringWMaxSize. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207
TM1ValStringSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207
TM1ValStringSetW . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208
TM1ValStringSetUTF8 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208
TM1ValStringUTF8MaxSize. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209
TM1ValType. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210
TM1ValTypeEx . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211
TM1ValTypeIsString . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211
TM1ValTypeIsBinary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211
viii IBMCognosTM1Version10.1.0: APIGuide
TM1ViewArrayColumnsNof . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211
TM1ViewArrayConstruct . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212
TM1ViewArrayDestroy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213
TM1ViewArrayRowsNof . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213
TM1ViewArrayValueByRangeGet. . . . . . . . . . . . . . . . . . . . . . . . . . . . 214
TM1ViewArrayValueGet. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214
TM1ViewArrayValuePickListGet . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215
TM1ViewArrayValuePickListByRangeGet . . . . . . . . . . . . . . . . . . . . . . . . . 216
TM1ViewArrayValuePickListExists . . . . . . . . . . . . . . . . . . . . . . . . . . . 217
TM1ViewCellValueGet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217
TM1ViewCellsValueGet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218
TM1ViewCreate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218
TM1ViewExtractCreate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219
TM1ViewExtractDestroy. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220
TM1ViewExtractGetNext . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220
TM1ViewListByNamesGet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221
TM1ViewListGet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222
DataSpreadingSyntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222
Chapter 5. IBM Cognos TM1 functions for Microsoft Visual Basic . . . . . . . . . . 225
Functiontypesandnamingconventions . . . . . . . . . . . . . . . . . . . . . . . . . 225
TM1APIInitialize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225
TM1APIFinalize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226
TM1BlobClose . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227
TM1BlobCreate. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227
TM1BlobGet. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228
TM1BlobOpen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229
TM1BlobPut. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229
TM1ChoreExecute. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230
TM1ClientAdd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230
TM1ClientGroupAssign . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231
TM1ClientGroupIsAssigned . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232
TM1ClientGroupRemove . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233
TM1ClientHasHolds . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233
TM1ClientPasswordAssign. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234
TM1ConnectionCheck . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235
TM1ConnectionCreate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235
TM1ConnectionDelete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236
TM1ConnectionSynchronize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237
TM1CubeCellDrillListGet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237
TM1CubeCellDrillObjectBuild. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238
TM1CubeCellSpread . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239
TM1CubeCellSpreadStatusGet. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241
TM1CubeCellSpreadViewArray . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244
TM1CubeCellValueGet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245
TM1CubeCellValueSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245
TM1CubeCreate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246
TM1CubePerspectiveCreate. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247
TM1CubePerspectiveDestroy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 248
TM1CubeShowsNulls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249
TM1DimensionCheck. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250
TM1DimensionCreateEmpty . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250
TM1DimensionElementComponentAdd . . . . . . . . . . . . . . . . . . . . . . . . . 251
TM1DimensionElementComponentDelete . . . . . . . . . . . . . . . . . . . . . . . . . 252
TM1DimensionElementComponentWeightGet . . . . . . . . . . . . . . . . . . . . . . . 253
TM1DimensionElementDelete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253
TM1DimensionElementInsert . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254
TM1DimensionUpdate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256
TM1GroupAdd. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257
TM1ObjectAttributeDelete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257
TM1ObjectAttributeInsert . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258
Contents ix
TM1ObjectAttributeValueGet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259
TM1ObjectAttributeValueSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260
TM1ObjectAttributeValuesSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261
TM1ObjectCopy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262
TM1ObjectDelete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 263
TM1ObjectDestroy. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 263
TM1ObjectDuplicate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264
TM1ObjectFileDelete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265
TM1ObjectFileLoad . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265
TM1ObjectFileSave . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 266
TM1ObjectListCountGet. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267
TM1ObjectListHandleByIndexGet. . . . . . . . . . . . . . . . . . . . . . . . . . . . 268
TM1ObjectListHandleByNameGet . . . . . . . . . . . . . . . . . . . . . . . . . . . 269
TM1ObjectPrivateDelete. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 270
TM1ObjectPrivateListCountGet . . . . . . . . . . . . . . . . . . . . . . . . . . . . 270
TM1ObjectPrivateListHandleByIndexGet . . . . . . . . . . . . . . . . . . . . . . . . . 271
TM1ObjectPrivateListHandleByNameGet . . . . . . . . . . . . . . . . . . . . . . . . . 272
TM1ObjectPrivatePublish . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 273
TM1ObjectPrivateRegister . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 273
TM1ObjectPropertyGet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 274
TM1ObjectPropertySet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275
TM1ObjectRegister . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 276
TM1ObjectReplicate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 277
TM1ObjectSecurityLock . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 278
TM1ObjectSecurityRelease . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 279
TM1ObjectSecurityReserve . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 279
TM1ObjectSecurityRightGet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 280
TM1ObjectSecurityRightSet. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281
TM1ObjectSecurityUnLock . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 282
TM1ProcessExecute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 283
TM1ProcessExecuteEx . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284
TM1ProcessExecuteSQLQuery. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 285
TM1ProcessVariableNameIsValid. . . . . . . . . . . . . . . . . . . . . . . . . . . . 286
TM1RuleAttach. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 286
TM1RuleCheck. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 287
TM1RuleCreateEmpty . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 288
TM1RuleDetach . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 288
TM1RuleLineGet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 289
TM1RuleLineInsert . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 290
TM1ServerBatchUpdateFinish . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 291
TM1ServerBatchUpdateIsActive . . . . . . . . . . . . . . . . . . . . . . . . . . . . 292
TM1ServerBatchUpdateStart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 292
TM1ServerLogClose . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 293
TM1ServerLogNext . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 294
TM1ServerLogOpen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 295
TM1ServerOpenSQLQuery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 296
TM1ServerPasswordChange . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297
TM1ServerSecurityRefresh . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 298
TM1SQLTableGetNextRows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 298
TM1SubsetAll . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 299
TM1SubsetCreateByExpression . . . . . . . . . . . . . . . . . . . . . . . . . . . . 300
TM1SubsetCreateEmpty. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 301
TM1SubsetElementDisplay . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 301
TM1SubsetElementDisplayEll . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 302
TM1SubsetElementDisplayLevel . . . . . . . . . . . . . . . . . . . . . . . . . . . . 303
TM1SubsetElementDisplayLine . . . . . . . . . . . . . . . . . . . . . . . . . . . . 304
TM1SubsetElementDisplayMinus. . . . . . . . . . . . . . . . . . . . . . . . . . . . 304
TM1SubsetElementDisplayPlus . . . . . . . . . . . . . . . . . . . . . . . . . . . . 305
TM1SubsetElementDisplaySelection . . . . . . . . . . . . . . . . . . . . . . . . . . . 306
TM1SubsetElementDisplayTee. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 306
TM1SubsetElementDisplayWeight . . . . . . . . . . . . . . . . . . . . . . . . . . . 307
x IBMCognosTM1Version10.1.0: APIGuide