Home >Documents >Tm1 API Guide

Tm1 API Guide

Date post:09-Dec-2015
Category:
View:165 times
Download:10 times
Share this document with a friend
Description:
Tm1 API Guide
Transcript:
  • IBM Cognos TM1Version 10.2.0

    API Guide

  • NoteBefore using this information and the product it supports, read the information in Notices on page 421.

    Product InformationThis document applies to IBM Cognos TM1 Version 10.2.0 and may also apply to subsequent releases.

    Licensed Materials - Property of IBM

    Copyright IBM Corporation 2007, 2013.US Government Users Restricted Rights Use, duplication or disclosure restricted by GSA ADP Schedule Contractwith IBM Corp.

  • ContentsIntroduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xv

    Chapter 1. The IBM Cognos TM1 programming environment . . . . . . . . . . . . . 1Location of the IBM Cognos TM1 API DLLs . . . . . . . . . . . . . . . . . . . . . . . . . 1

    Setting a path to the DLLs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1Supported compilers. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

    Local servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2Remote servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

    The admin host and admin server . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3The role of an IBM Cognos TM1 server . . . . . . . . . . . . . . . . . . . . . . . . . . 3Multitasking and symmetric multiprocessor support . . . . . . . . . . . . . . . . . . . . . . 4

    IBM Cognos TM1 server performance . . . . . . . . . . . . . . . . . . . . . . . . . . 4Sample code for the IBM Cognos TM1 API . . . . . . . . . . . . . . . . . . . . . . . . . 4

    Chapter 2. IBM Cognos TM1 programming concepts . . . . . . . . . . . . . . . . 5System functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

    Connecting to the API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5Disconnecting from the API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8Managing server connections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8Setting the admin host server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8Progress callback functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8Requesting the version of the system . . . . . . . . . . . . . . . . . . . . . . . . . . 9Thread safety . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

    Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9Handles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

    Simple IBM Cognos TM1 data types . . . . . . . . . . . . . . . . . . . . . . . . . . . 10Value handling functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10String handling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11Object handling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12Array handling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12Updating value capsules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12Pending values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13Managing value pools . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13Object attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

    Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14Security levels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15Clients . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15Assigning clients to groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16Assigning rights to objects and groups . . . . . . . . . . . . . . . . . . . . . . . . . 16Meta security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16Managing locks and reservations . . . . . . . . . . . . . . . . . . . . . . . . . . . 16Determining access rights for a client . . . . . . . . . . . . . . . . . . . . . . . . . . 16

    Error handling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17Examining error values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17Error codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17API error codes for data reservations . . . . . . . . . . . . . . . . . . . . . . . . . . 17

    Backup and recovery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18The transaction log file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18Treatment of time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19Naming conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19Log file structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19Automatic recovery. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19Accessing the log files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

    Copyright IBM Corp. 2007, 2013 iii

  • Logging changes to dimensions. . . . . . . . . . . . . . . . . . . . . . . . . . . . 20Creating an IBM Cognos TM1 project in C or C++ . . . . . . . . . . . . . . . . . . . . . . 20

    Generating a console project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21Setting paths . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21Adding test code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22Building and running the program . . . . . . . . . . . . . . . . . . . . . . . . . . 22

    Creating an IBM Cognos TM1 project in Microsoft Visual Basic . . . . . . . . . . . . . . . . . . 22Adding code to your Microsoft Visual Basic Project . . . . . . . . . . . . . . . . . . . . . 23Logging in to an IBM Cognos TM1 Server . . . . . . . . . . . . . . . . . . . . . . . . 24Logging out of IBM Cognos TM1 . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

    Chapter 3. IBM Cognos TM1 objects . . . . . . . . . . . . . . . . . . . . . . . 27IBM Cognos TM1 objects overview . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

    Object handles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27Object properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28Lists of objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29Creating and registering objects . . . . . . . . . . . . . . . . . . . . . . . . . . . 30Registration functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30Public, private, and unregistered objects . . . . . . . . . . . . . . . . . . . . . . . . . 30Accessing parent objects - security . . . . . . . . . . . . . . . . . . . . . . . . . . . 32Object names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32Loading objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33Deleting objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33Saving objects to disk . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33Copying objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

    Server object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34Server properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34Server functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34

    Dimension and element objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35Parent object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36Child objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36Registration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36Creating a dimension . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36Updating a dimension . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36Deleting a dimension . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37Dimension properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37Dimension functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38

    Cube objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39Parent object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39Child objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39Registration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39Creating a cube . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39Retrieving and updating cube cells . . . . . . . . . . . . . . . . . . . . . . . . . . 39Deleting a cube . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40Cube properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40Cube functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40Cube perspectives . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41

    Rule objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42Rule properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42Rule functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42Creating a new rule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43Updating an existing rule. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43

    Subset objects. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43Parent object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43Registration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Popular Tags:

Click here to load reader

Reader Image
Embed Size (px)
Recommended