tm1_connection: TM1 Connection

Description Usage Arguments Examples

View source: R/tm1_connection.R

Description

Creates and returns a connection object to connect to TM1 via REST API.

Usage

1
2
3
tm1_connection(adminhost = "localhost", httpport = "",
username = "admin", password = "apple",
namespace="", ssl=TRUE, base_url="")

Arguments

adminhost

adminhost of tm1 model

httpport

httpport of tm1 model

username

username to connect to tm1 model

password

password of the username

namespace

ID of namespace should be specified if there is CAM security. Should be blank for native security

ssl

If UseSSL parameter is T in tm1s.cfg file, then TRUE. Else FALSE. Default is TRUE

base_url

when connecting to cloud, this option can be used instead of adminhost and httpport

Examples

1
2
3
4
5
6
## Not run: 
tm1_connection("localhost", "8881", "admin", "apple")
tm1_connection(username="admin", password="apple",
base_url = "https://[Customer_Name].planning-analytics.ibmcloud.com/tm1/api/[Server Name]/")

## End(Not run)

tm1r documentation built on Dec. 15, 2020, 5:36 p.m.