Das TM1-Object dient als wohlstrukturierte Schnittstelle zwischen einer Programmiersprache wie VB, VBA, C++ und der TM1API. Es kapselt die API-Aufrufe in einer Klassenbibliothek (COM-Objekt als DLL) und sorgt so für erheblich leichtere TM1-Zugriffe.
Darüberhinaus werden potentielle Fehlerquellen, wie fehlende oder falsche API-Handles von vornherein ausgeschlossen. Sämtliche Objekt-Handles werden allerdings auch herausgeführt, sodass ein Mischbetrieb von dem TM1-Object und der originären TM1API.DLL möglich ist.
TM1-Object bietet für einige Anforderungen sowohl direkten Zugriff auf die Informationen des Servers als auch eine Variante mit lokalem Zwischenspeicher. Beispiel: das Vorhandensein eines Dimensionselementes kann sowohl vom Server beantwortet werden, als auch über die Collection, die dazu allerdings einmalig alle Dimensionselemente vom Server herunterlädt und danach überhaupt keinen Netzwerk-Traffic mehr verursacht und schneller antwortet.
Leseoperationen auf einer View können ebenfalls lokal zwischen gespeichert werden, um die Netzwerklast zu minimieren. Dabei wird angenommen, dass Zellen in der Umgebung einer gelesenen Zelle danach auch gelesen werden sollen. Schreiboperationen auf dem Würfel können zu diesem Zweck gebündelt übertragen werden.
Übersicht über die Klassen:
TM1API (Root-Objekt): Setzen von Admin-Host, Abfrage von deskriptiven Fehlermeldungen
TM1Server: Eigenschaften des Servers (Name, Attribute, Connect-Status etc.), Logon, Logoff, Anlegen/Löschen von Dimension/Cube/User/Usergruppe, Reservierungs-/Sperrstatus
TM1Servers: Collection von TM1Server-Objekten, enthält die dem Admin-Host bekannten TM1-Server
TM1Cube: Eigenschaften des Cubes (Name, Anzahl Dimensionen, Protokollierung etc.), Rules erstellen/bearbeiten/löschen, Datenzellen lesen/schreiben, Reservierungs-/Sperrstatus, Views erstellen/löschen
TM1Cubes: Collection von TM1Cube-Objekten, enthält alle auf einem Server befindlichen Cubes
TM1Rules: Repräsentation der Rules eines Würfels mit der Möglichkeit, diese zu erweitern oder zu bearbeiten
TM1Dimension: Eigenschaften der Dimension (Name, Anzahl Elemente etc), Anlegen/Löschen von Elementen, Import/Export der Dimension als XML-Datei, Reservierungs-/Sperrstatus, Subsets erstellen/löschen
TM1Dimensions: Collection von TM1Dimension-Objekten, enthält alle auf einem Server befindlichen Dimensionen
TM1Element: Eigenschaften des Elements (Name, Typ, Index etc.), Anlegen/Löschen von Komponenten bei konsolidierten Elementen
TM1Elements: Collection von TM1Element-Objekten, enthält alle in einer Dimension enthaltenen Dimensionselemente
TM1ElementComponent: Eigenschaften der Komponenten (Objektverweis auf das eigentliche Element, Gewichtung)
TM1ElementComponents: Collection von TM1ElementComponent-Objekten, enthält alle Komponenten eines konsolidierten Elementes
TM1Subset: Eigenschaften eines Subsets (Name, Sichtbarkeit etc.), Hinzufügen/Löschen von Elementen, Manipulation der Reihenfolge
TM1Subsets: Collection von TM1Subset-Objekten, enthält alle zu einer Dimension gehörenden Subsets (privat/öffentlich)
TM1View: Eigenschaften eines Views (Name, Sichtbarkeit etc.), Auslesen von Werten aus dem View
TM1Views: Collection von TM1View-Objekten, enthält alle zu einem Cube gehörenden Views (privat/öffentlich)
TM1User: Eigenschaften eines Users (Name, Rechte auf das Objekt etc.), Paßwortänderung, Gruppenzugehörigkeit, Reservierungs-/Sperrstatus des Objektes
TM1Users: Collection von TM1User-Objekten, enthält alle auf einem Server existierenden User
TM1Group: Eigenschaften einer Benutzergruppe (Name, Rechte auf das Objekt), Gruppenmitglieder
TM1Groups: Collection von TM1Group-Objekten, enthält alle auf einem Server existierenden Usergruppen
TM1Job: Repräsentation eines serverseitigen Jobs (Chore) mit der Möglichkeit, diesen auszuführen.
TM1Jobs: Collection von TM1Job-Objekten, enthält alle zu einem Server gehörenden Jobs
TM1Process: Repräsentation eines serverseitigen Prozesses mit der Möglichkeitm diesen auszuführen
TM1Processes: Collection von TM1Process-Objekten, enthält alle zu einem Server gehörenden Prozesse
TM1ErrorHandler: Wenn ein Fehler beim Zugriff auf TM1-Objekte auftritt, werden alle Informationen darüber im TM1ErrorHandler-Objekt gespeichert und zur Verfügung gestellt.
TM1Version: Bietet Versionsinformationen über das zugrunde liegende IBM Cognos TM1
TM1ObjectVersion: Versionsinformationen über diese Bibliothek und die originäre API
TM1ServerLog: Lesender Zugriff auf das TM1-Server-Log
TM1NativeAPI: Zugriff auf Funktionen der originären TM1API.dll
Weitere Objekte werden folgen, sobald sie von Cognos, an IBM Company über die TM1API.DLL zugänglich gemacht werden.
Wir bieten Ihnen als zusätzliche Informationen über das TM1Object-Klassenmodul den Download eines Coding-Beispiels sowie der Online-Hilfe des TM1Objects an: