Skip to content

ConfigurationService

ConfigurationService(rest)

Bases: ObjectService

Source code in TM1py/Services/ConfigurationService.py 
13
14
def __init__(self, rest: RestService):
    super().__init__(rest)

get_active(**kwargs)

Read effective(!) TM1 config settings as dictionary from TM1 Server

Returns:

Type Description
Dict

config as dictionary
Source code in TM1py/Services/ConfigurationService.py 
61
62
63
64
65
66
67
68
69
70
@require_ops_admin
def get_active(self, **kwargs) -> Dict:
    """Read effective(!) TM1 config settings as dictionary from TM1 Server

    :return: config as dictionary
    """
    url = "/ActiveConfiguration"
    config = self._rest.GET(url, **kwargs).json()
    del config["@odata.context"]
    return config

get_admin_host(**kwargs)

Source code in TM1py/Services/ConfigurationService.py 
40
41
42
43
@deprecated_in_version(version="12.0.0")
def get_admin_host(self, **kwargs) -> str:
    url = "/Configuration/AdminHost/$value"
    return self._rest.GET(url, **kwargs).text

get_all(**kwargs)

Source code in TM1py/Services/ConfigurationService.py 
16
17
18
19
20
def get_all(self, **kwargs) -> Dict:
    url = "/Configuration"
    config = self._rest.GET(url, **kwargs).json()
    del config["@odata.context"]
    return config

get_data_directory(**kwargs)

Source code in TM1py/Services/ConfigurationService.py 
45
46
47
48
@deprecated_in_version(version="12.0.0")
def get_data_directory(self, **kwargs) -> str:
    url = "/Configuration/DataBaseDirectory/$value"
    return self._rest.GET(url, **kwargs).text

get_product_version(**kwargs)

Ask TM1 Server for its version

:Returns: String, the version

Source code in TM1py/Services/ConfigurationService.py 
31
32
33
34
35
36
37
38
def get_product_version(self, **kwargs) -> str:
    """Ask TM1 Server for its version

    :Returns:
        String, the version
    """
    url = "/Configuration/ProductVersion/$value"
    return self._rest.GET(url, **kwargs).text

get_server_name(**kwargs)

Ask TM1 Server for its name

:Returns: String, the server name

Source code in TM1py/Services/ConfigurationService.py 
22
23
24
25
26
27
28
29
def get_server_name(self, **kwargs) -> str:
    """Ask TM1 Server for its name

    :Returns:
        String, the server name
    """
    url = "/Configuration/ServerName/$value"
    return self._rest.GET(url, **kwargs).text

get_static(**kwargs)

Read TM1 config settings as dictionary from TM1 Server

Returns:

Type Description
Dict

config as dictionary
Source code in TM1py/Services/ConfigurationService.py 
50
51
52
53
54
55
56
57
58
59
@require_ops_admin
def get_static(self, **kwargs) -> Dict:
    """Read TM1 config settings as dictionary from TM1 Server

    :return: config as dictionary
    """
    url = "/StaticConfiguration"
    config = self._rest.GET(url, **kwargs).json()
    del config["@odata.context"]
    return config

update_static(configuration)

Update the .cfg file and triggers TM1 to re-read the file.

Parameters:

Name Type Description Default
configuration Dict
required

Returns:

Type Description
Response

Response
Source code in TM1py/Services/ConfigurationService.py 
72
73
74
75
76
77
78
79
80
@require_ops_admin
def update_static(self, configuration: Dict) -> Response:
    """Update the .cfg file and triggers TM1 to re-read the file.

    :param configuration:
    :return: Response
    """
    url = "/StaticConfiguration"
    return self._rest.PATCH(url, json.dumps(configuration))