TM1 VBA Documentation

Post Reply
TrevorGoss
Community Contributor
Posts: 217
Joined: Thu Aug 15, 2013 9:05 am
OLAP Product: TM1
Version: 10.2.1.1
Excel Version: 14.0.6129.5000

TM1 VBA Documentation

Post by TrevorGoss »

Hello to all,

I would like to know if there is any VBA documentation for working with TM1?

I have the TM1 add-in but I am yet to find out how to use VBA to connect to a TM1 server.

Is there any documentation on how to do this? Is there a list of functions or somthing of that nature that can help me say, call a TI or delete an element.

Any information would be great, thanks.

Trevor.
BariAbdul
Regular Participant
Posts: 424
Joined: Sat Mar 10, 2012 1:03 pm
OLAP Product: IBM TM1, Planning Analytics, P
Version: PAW 2.0.8
Excel Version: 2019

Re: TM1 VBA Documentation

Post by BariAbdul »

Is this what you looking for,Apologies if off the mark!
http://www.tm1forum.com/viewtopic.php?f=3&t=1217
http://www.tm1forum.com/viewtopic.php?f=3&t=1097 Thanks
"You Never Fail Until You Stop Trying......"
TrevorGoss
Community Contributor
Posts: 217
Joined: Thu Aug 15, 2013 9:05 am
OLAP Product: TM1
Version: 10.2.1.1
Excel Version: 14.0.6129.5000

Re: TM1 VBA Documentation

Post by TrevorGoss »

Hello Bari,
Is this what you looking for,Apologies if off the mark!
viewtopic.php?f=3&t=1217
viewtopic.php?f=3&t=1097 Thanks
This is somewhat helpful, as it gives an indictation of what can be done so thanks.

I am still yet to find how to begin, for example, to run a TI in VBA, I can find no documentation nor any demonstration of how this can be done.

The closest thing I have found is calling the shell which calls the TM1RunTI tool, which is a workaround rather than a solution.

Do you use VBA with TM1 at all?

Thanks.

Trevor.
Alan Kirk
Site Admin
Posts: 6667
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: TM1 VBA Documentation

Post by Alan Kirk »

TrevorGoss wrote: I am still yet to find how to begin, for example, to run a TI in VBA, I can find no documentation nor any demonstration of how this can be done.

The closest thing I have found is calling the shell which calls the TM1RunTI tool, which is a workaround rather than a solution.

Do you use VBA with TM1 at all?
There are a bunch of things that you can do with TM1 using VBA macros and the Application.Run command, details of which you can find here. And of course you can call any worksheet functions as well.

It's just that running a TI process using basic VBA code isn't one of those things and, with the advent of Action Buttons, probably never will be.

However it can be done via the TM1 API. You don't necessarily have to know the API itself, because in TM1 Tools we've included a wrapper function that you can call from your own VBA code. Instructions will be found in the documentation.
"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.
TrevorGoss
Community Contributor
Posts: 217
Joined: Thu Aug 15, 2013 9:05 am
OLAP Product: TM1
Version: 10.2.1.1
Excel Version: 14.0.6129.5000

Re: TM1 VBA Documentation

Post by TrevorGoss »

Hello Alan,

thanks for the reply.
There are a bunch of things that you can do with TM1 using VBA macros and the Application.Run command, details of which you can find here. And of course you can call any worksheet functions as well.
Excellent, thanks for those.
It's just that running a TI process using basic VBA code isn't one of those things and, with the advent of Action Buttons, probably never will be.
Fair enough, the desire to run a TI from VBA was more of an example of wanting to know what to do, how to connect et....
However it can be done via the TM1 API. You don't necessarily have to know the API itself, because in TM1 Tools we've included a wrapper function that you can call from your own VBA code. Instructions will be found in the documentation
Thank you, I will go through that post and the documentation.
tomok
MVP
Posts: 2836
Joined: Tue Feb 16, 2010 2:39 pm
OLAP Product: TM1, Palo
Version: Beginning of time thru 10.2
Excel Version: 2003-2007-2010-2013
Location: Atlanta, GA
Contact:

Re: TM1 VBA Documentation

Post by tomok »

Just so you know, anything you do in VBA will not work in TM1 Web. If you have any plans for sharing those workbooks with your TM1 Web users then you are going to be severely disappointed. That's basically why action buttons were created, to get around the need for VBA in order to run a TI. I never use VBA for anything anymore and whenever I encounter it I convert whatever it's doing into an action button. if possible.
Tom O'Kelley - Manager Finance Systems
American Tower
http://www.onlinecourtreservations.com/
TrevorGoss
Community Contributor
Posts: 217
Joined: Thu Aug 15, 2013 9:05 am
OLAP Product: TM1
Version: 10.2.1.1
Excel Version: 14.0.6129.5000

Re: TM1 VBA Documentation

Post by TrevorGoss »

Hello Tom, thanks for the reply.
Just so you know, anything you do in VBA will not work in TM1 Web. If you have any plans for sharing those workbooks with your TM1 Web users then you are going to be severely disappointed.
We do not use TM1 web, luckily. Some of our users do have Perspectives, so VBA will come into play.

Thanks.

Trevor.
Post Reply