How to Buid a TM1 API utility?

Post Reply
Luke Noah
Posts: 4
Joined: Tue Feb 16, 2016 12:52 pm
OLAP Product: IBM Cognos TM1
Version: 10.2.2
Excel Version: 2013

How to Buid a TM1 API utility?

Post by Luke Noah »

Hi,
I am new to TM1 and I have to build a API utility.I have installed TM1 Client 10.2.2 64 bit and when I read the manual there are mentions about the tm1s.cfg and tm1.ini files. If I am not wrong those files will be Present only when we Install a TM1 Server. But the Software I am using is a TM1 Client and when I open the architect it doesn't show me any available servers. Can anyone help me about what are the main differences in these two softwares and How do I to connect to a Server from this TM1 Client . Or is it necessary that I need to install TM1 server also on My machine?

As I am Planning to Build an API,I need to have a Clear understanding of the whole software setup. Can anyone Help?


Thanks,
Luke.
Alan Kirk
Site Admin
Posts: 6647
Joined: Sun May 11, 2008 2:30 am
OLAP Product: TM1
Version: PA2.0.9.18 Classic NO PAW!
Excel Version: 2013 and Office 365
Location: Sydney, Australia
Contact:

Re: How to Buid a TM1 API utility?

Post by Alan Kirk »

Luke Noah wrote:Hi,
I am new to TM1 and I have to build a API utility.I have installed TM1 Client 10.2.2 64 bit and when I read the manual there are mentions about the tm1s.cfg and tm1.ini files. If I am not wrong those files will be Present only when we Install a TM1 Server. But the Software I am using is a TM1 Client and when I open the architect it doesn't show me any available servers. Can anyone help me about what are the main differences in these two softwares and How do I to connect to a Server from this TM1 Client . Or is it necessary that I need to install TM1 server also on My machine?

As I am Planning to Build an API,I need to have a Clear understanding of the whole software setup. Can anyone Help?
You see your cart? That one over there?

And you see your horse? The one that's about 5km behind the cart?

Yes, you are correct. Before you even attempt to do anything with the TM1 API you need to have a very clear, and very detailed understanding of how the software works. Which, from the questions above, you appear to be a very, very long way from, and I say that as a statement of fact rather than a put-down. Also, you don't seem to have read the responses that you got to your last question, or you certainly didn't reply to or acknowledge any of them.

The exact wrong way to go about any software development is to wake up one morning and think "Hey, I know, I 'have to' build a utility!" Rather, you identify what specific need you have that the existing software tools and utilities do not provide. And to identify such a need you would need to understand how the software works and what is already there in terms of functionality, otherwise you're just reinventing the wheel.

To answer the questions above you really need to begin by reading through the Installation and Configuration Guide cover to cover, with special emphasis on the TM1 Architecture section. That will get you about 1% of the way to being ready to take on the API. Maybe 2 at a push. Then you need to identify why you "need" to build this API utility... and whether you actually do.
"To them, equipment failure is terrifying. To me, it’s 'Tuesday.' "
-----------
Before posting, please check the documentation, the FAQ, the Search function and FOR THE LOVE OF GLUB the Request Guidelines.
babytiger
Posts: 78
Joined: Wed Jul 31, 2013 4:32 am
OLAP Product: Cognos TM1, EP, Analyst
Version: 10.2.2
Excel Version: 2013
Location: Sydney AU

Re: How to Buid a TM1 API utility?

Post by babytiger »

Firstly, I am really interested at what is the api utility is going to do? Without an understanding of what a tm1 server is, this is going to be interesting.
MK
Alan Kirk
Site Admin
Posts: 6647
Joined: Sun May 11, 2008 2:30 am
OLAP Product: TM1
Version: PA2.0.9.18 Classic NO PAW!
Excel Version: 2013 and Office 365
Location: Sydney, Australia
Contact:

Re: How to Buid a TM1 API utility?

Post by Alan Kirk »

babytiger wrote:Firstly, I am really interested at what is the api utility is going to do? Without an understanding of what a tm1 server is, this is going to be interesting.
Agreed. In the "May You Live In Interesting Times" sense.
"To them, equipment failure is terrifying. To me, it’s 'Tuesday.' "
-----------
Before posting, please check the documentation, the FAQ, the Search function and FOR THE LOVE OF GLUB the Request Guidelines.
Wim Gielis
MVP
Posts: 3234
Joined: Mon Dec 29, 2008 6:26 pm
OLAP Product: TM1, Jedox
Version: PAL 2.1.5
Excel Version: Microsoft 365
Location: Brussels, Belgium
Contact:

Re: How to Buid a TM1 API utility?

Post by Wim Gielis »

Luke Noah wrote:Hi,
I am new to TM1 and I have to build a API utility.I have installed TM1 Client 10.2.2 64 bit and when I read the manual there are mentions about the tm1s.cfg and tm1.ini files. If I am not wrong those files will be Present only when we Install a TM1 Server. But the Software I am using is a TM1 Client and when I open the architect it doesn't show me any available servers. Can anyone help me about what are the main differences in these two softwares and How do I to connect to a Server from this TM1 Client . Or is it necessary that I need to install TM1 server also on My machine?

As I am Planning to Build an API,I need to have a Clear understanding of the whole software setup. Can anyone Help?

Thanks,
Luke.
Luke, reading something like this is a real nightmare.
You don't have the faintest clue what you are talking about, and then you need to / "are asked to" create something meaningful with the TM1 API.
Remove that idea from your mind and begin with the basics. Only after some time you will be able to do some stuff with TM1 and its API.
Unless you just want to copy/paste code from the internet, change it and see what happens, the trail-and-error kind of way.
Be realistic, this isn't someting that will work out fine.
Best regards,

Wim Gielis

IBM Champion 2024-2025
Excel Most Valuable Professional, 2011-2014
https://www.wimgielis.com ==> 121 TM1 articles and a lot of custom code
Newest blog article: Deleting elements quickly
Luke Noah
Posts: 4
Joined: Tue Feb 16, 2016 12:52 pm
OLAP Product: IBM Cognos TM1
Version: 10.2.2
Excel Version: 2013

Re: How to Buid a TM1 API utility?

Post by Luke Noah »

Yeah Alan,I know that I am very new to TM1 and I have a basic knowledge about TM1, Servers and the Admin Host and how the stuff works around. I haven't worked on this before and I am actually in a learning stage. Definitely I would read the documentation again. Will get back if I have any queries .I haven't seen the replies to my previous question. Really Thank you for your replies. :)

Win Gielis, thank you for the suggestion. Yeah I really haven't expected these kind of replies :D .I have a basic knowledge about TM1 and which I think is not sufficient to work on but I am trying to learn while working on it. I agree that there would be no learning if I just copy/paste the code,though there are no plans of doing that. I am just in a learning phase.

Thanks,
Luke
Alan Kirk
Site Admin
Posts: 6647
Joined: Sun May 11, 2008 2:30 am
OLAP Product: TM1
Version: PA2.0.9.18 Classic NO PAW!
Excel Version: 2013 and Office 365
Location: Sydney, Australia
Contact:

Re: How to Buid a TM1 API utility?

Post by Alan Kirk »

Luke Noah wrote:Yeah Alan,I know that I am very new to TM1 and I have a basic knowledge about TM1, Servers and the Admin Host and how the stuff works around. I haven't worked on this before and I am actually in a learning stage. Definitely I would read the documentation again. Will get back if I have any queries .I haven't seen the replies to my previous question. Really Thank you for your replies. :)

Win Gielis, thank you for the suggestion. Yeah I really haven't expected these kind of replies :D
The fact that you're getting these kinds of replies should give you some impression of how bad an idea this is. You still haven't answered the key question though, which is why on Earth are you doing this? There are quite capable, highly skilled TM1 admins who can go their entire careers without ever touching the API manual. Especially since the advent of action buttons which allow TI processes to be run, there's barely any need for doing so any longer except for the most obscure or technically involved reasons. Without a specific reason, it's a pointless exercise. The API (at least the classic one) would be one of the last skill sets that you learn (if there's any need to learn it at all), not the first.
"To them, equipment failure is terrifying. To me, it’s 'Tuesday.' "
-----------
Before posting, please check the documentation, the FAQ, the Search function and FOR THE LOVE OF GLUB the Request Guidelines.
Post Reply