TM1INFO returns information about the current TM1 or Planning Analytics for Microsoft Excel version or client.
Note: This function is valid only in Planning Analytics for Microsoft Excel and in
Planning Analytics websheets. It is not supported in
IBM®
TM1® Perspectives.
Syntax
TM1INFO("Property Name")
|
Argument
|
Description
|
Required/Optional |
|
Property Name
|
The property name can be one of the following:
- clientversion
- Returns the full TM1 client version number. For example, 10.2.10000
- clientversionmajor
- Returns the TM1 major client version number.
- clientversionminor
- Returns the TM1 minor client version number.
- clientversionpatch
- Returns the TM1 fix pack and hotfix number.
- client
- Returns the name of the client. For example, cor or websheet.
- screlease
Note: For screlease, screleasefull, and
uagent, the Planning Analytics for Excel add-in must be initiated to
successfully return a value. If the add-in is not initiated, the functions returns
#VALUE!
Returns the short cadence and short cadence build number of the
current Planning Analytics for Excel add-in.- Planning Analytics for Excel versions use the format mj.mn.sc.b.
-
- mj = major version
- mn = minor version
- sc = short cadence (monthly) version
- b = short cadence build number
- screleasefull
- Returns the full version of the current Planning Analytics for Excel add-in. For example,
2.0.67.2.
- uagent
- Returns details for the Planning Analytics for Excel user agent.
- The information returned may vary depending on whether or not you are currently connected to the
agent. Before connecting to the agent, you'll see something like this:
PAfE/2.0.67.2
(1048576); Excel/16.0.14131.
- After connecting to the agent, the function returns more detail:
PAfE/2.0.67.2
(1048576); Excel/16.0.14131(x86, MyBookName.xlsm, Sheet1).
|
Required |
Example
TM1INFO("clientversion")