Building Applications with Rest API and TM1WebBy Ambrus Vancso

Contains material sourced from Hubert Heijkers.

TM1

Goals of this session• This is Developer Stream: • We will zoom into practical examples – due to time constraints not full cycle

• Give you the heads-up on: • TM1 and TM1Web can do out of box• What Rest API is

• Where is it going• How can you make use of it• How development compares to traiditonal TM1/Web

• How can you combine your existing TM1Web assets and add a Rest API based menu system / planning portal

Rest API and TM1Web can be combined

Traditional TM1Web can do a lot as well

Introducing TM1’s RESTful API• Introduced in TM1 10.2 RP2• HTTP and JSON based, making it easy to interact with TM1 from within any environment• Following the Open Data (OData) standard, an open protocol for the creation and

consumption of query-able and interoperable RESTful API• The OData protocol, an OASIS standard, which defines the best practices for building and

consuming RESTful APIS in a simple and standard way, defines:• Machine readable description of the API, the Metadata• URL conventions• Format specification, JSON

• Native support build into the TM1 server

7

What makes this API different• Standards based• Cloud ready• Language independent• Support by a broad community• Overall easy of use• Better performance, especially over a WAN• Easing the integration of TM1 Server

GOAL: Everything you can do with TM1 Server you can do through this API

8

Let’s have a look!• Set up tm1s.cfg and restart to take affect:• HTTPPortNumber = 8000 (or your preference)• UseSSL = F

• Use a browser to make a query• Use a tool – Postman, a Chrome add-on in our example• Read more and find examples at:• IBM DeveloperWorks – TM1 Rest API website• Odata specification for URL syntax - odata.org

• Keep experimenting!

What is the REST API being used for?

• Traditional ‘consumers’• Applications consuming TM1 models

• Modelers/Modeling tools• Creating and maintaining models

• Applications/Application builders• Purpose build applications using TM1

‘under the covers’

• Processes/automation• Development tool integration

Technologies used• Web development

• HTML – setup webpage• Javascript – control events• CSS – web formatting

• Javascript UI Framework – simplified web building for data manipulation• Rest API – interface to TM1

• MDX – query cubes• OData – way of consuming Rest API (e.g. XML or JSON) retrieve information from

TM1

• TM1Web API / websheet

CUBEAC – an admin console to TM1An exercise in learning TM1Rest API based development.

An application built on top of TM1 but only using web technologies on the front end and Rest API to connect to TM1.

Short to medium term REST API roadmap

• In the current code stream:• Transaction log support• Message log support• Support for deltas (read: change tracking in the server)

• In future major/minor version(s):• Alternate Hierarchy support• Server Settings (Configured and Active)• Logger Settings• Cover remaining TM1 functionality currently lacking• Adding support for faster data loads and extracts• TI Process input and output redirection• Everything else required to implement “TI as a service”

13

The future is brightI like to think that we are influencing the future, and only just started

Thank youlinkedin.com/in/ambrusvancso

@ambrusvancso