Version 11 Release 0 IBM Cognos TM1 Cognos TM1 objects.....23 IBM Cognos TM1 objects overview

  • View
    303

  • Download
    29

Embed Size (px)

Text of Version 11 Release 0 IBM Cognos TM1 Cognos TM1 objects.....23 IBM Cognos TM1 objects overview

  • IBM Cognos TM1Version 11 Release 0

    API

    IBM

  • Note

    Before you use this information and the product it supports, read the information in Notices.

    Product Information

    This document applies to IBM Planning Analytics Version 2.0 and might also apply to subsequent releases.

    Licensed Materials - Property of IBM Copyright International Business Machines Corporation 2007, 2017.US Government Users Restricted Rights Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.

  • Contents

    Introduction........................................................................................................................ 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..........................................................................................................................................................1Servers................................................................................................................................................................................2

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

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

    IBM Cognos TM1 server performance......................................................................................................................... 3Sample 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......................................................................................................................................... 7Managing server connections.......................................................................................................................................8Setting the admin host server...................................................................................................................................... 8Progress callback functions......................................................................................................................................... 8Requesting the version of the system..........................................................................................................................8Thread safety................................................................................................................................................................ 8

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

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

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

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

    Backup and recovery....................................................................................................................................................... 16The transaction log file...............................................................................................................................................16Treatment of time.......................................................................................................................................................16Naming conventions...................................................................................................................................................16

    iii

  • Log file structure.........................................................................................................................................................17Automatic recovery.................................................................................................................................................... 17Accessing the log files................................................................................................................................................ 17Logging changes to dimensions ................................................................................................................................ 17

    Creating an IBM Cognos TM1 project in C or C++...........................................................................................................18Generating a console project..................................................................................................................................... 18Se