https://github.com/williamsmithedward/andromedatm1sharp
AndromedaTM1Sharp is a .Net API interface for IBM's TM1 and Planning Analytics with Watson OData v4 REST APIs.
https://github.com/williamsmithedward/andromedatm1sharp
ibm mdx olap paw planning-analytics rest-api tm1 turbo-integrator
Last synced: about 1 month ago
JSON representation
AndromedaTM1Sharp is a .Net API interface for IBM's TM1 and Planning Analytics with Watson OData v4 REST APIs.
- Host: GitHub
- URL: https://github.com/williamsmithedward/andromedatm1sharp
- Owner: WilliamSmithEdward
- License: mit
- Created: 2023-07-12T14:32:17.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2025-02-11T11:50:37.000Z (3 months ago)
- Last Synced: 2025-04-09T21:48:58.229Z (about 1 month ago)
- Topics: ibm, mdx, olap, paw, planning-analytics, rest-api, tm1, turbo-integrator
- Language: C#
- Homepage: https://www.nuget.org/packages/AndromedaTM1Sharp
- Size: 94.7 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# AndromedaTM1Sharp
Author: William Smith
E-Mail: [email protected]
## Version 1.0.18 Update
* Increased number of dimension+element parameters to 20 for QueryCellAsync method.
* Methods that create a cellset on the TM1 server will now send a cellset delete API call to clear the cellset from memory after the data has been read.
## Reading a value from a single cube cell
Example of reading the value of a single cell from a cube.
```csharp
using AndromedaTM1Sharp;
var tm1Config = new TM1SharpConfig("https://YourTM1Server:YourPort", "tm1UserName", "tm1Password", "YourEnvName");
List lookupValues = new List()
{
"Lookup_Value_01",
"Lookup_Value_02",
"Lookup_Value_03"
};
lookupValues.ForEach(async x =>
{
var result = await TM1RestAPI.QueryCellAsync(tm1Config, "Cube_Name", "Dimension_01", x, "Dimension_02", "Element_02");
Console.WriteLine(result);
});
```
## Reading from an MDX query
Example of running an MDX query to return data. Escape double quote with \\\\\\\"VALUE\\\\\\\" (send literal \\\"VALUE\\\").
See https://www.ibm.com/docs/en/planning-analytics/2.0.0?topic=data-cellsets for details on JSON structure.
```csharp
using AndromedaTM1Sharp;
var tm1Config = new TM1SharpConfig("https://YourTM1Server:YourPort", "tm1UserName", "tm1Password", "YourEnvName");
string mdx = "SELECT {[DIMENSION1].[HIERARCHY].[ELEMENT]} ON 0, {[DIMENSION2].[HIERARCHY].[ELEMENT]} ON 1 FROM [YourCube]";
var content = await TM1RestAPI.QueryMDXAsync(tm1Config, mdx);
Console.WriteLine(content);
```
## Reading from a cube view
Example of reading a cellset from a cube view.
See https://www.ibm.com/docs/en/planning-analytics/2.0.0?topic=data-cellsets for details on JSON structure.
```csharp
using AndromedaTM1Sharp;
var tm1Config = new TM1SharpConfig("https://YourTM1Server:YourPort", "tm1UserName", "tm1Password", "YourEnvName");
var content = await TM1RestAPI.QueryViewAsync(tm1Config, "YourCube", "YourView");
Console.WriteLine(content);
```
## Converting cellset JSON to System.Data.DataTable
Example of deserializing and converting the JSON return from a View / MDX query to a DataTable.
Currently supports multiple hierarchy levels on rows.
```csharp
using AndromedaTM1Sharp;
using System.Data;
var tm1Config = new TM1SharpConfig("https://YourTM1Server:YourPort", "tm1UserName", "tm1Password", "YourEnvName");
string mdx = @"Your_MDX_Statement";
var content = await TM1RestAPI.QueryMDXAsync(tm1Config, mdx);
var model = CellsetJSONParser.ParseIntoObject(content);
var dt = model?.ToDataTable();
foreach (DataRow row in dt.Rows)
{
foreach (DataColumn column in dt.Columns)
{
Console.WriteLine(column.ColumnName + ": " + row[column]);
}
Console.WriteLine();
}
```
## Writing to a cube
Example of writing a list of values to a cube, while iterating through one dimension and keeping other dimensions constant.
```csharp
using AndromedaTM1Sharp;
var tm1Config = new TM1SharpConfig("https://YourTM1Server:YourPort", "tm1UserName", "tm1Password", "YourEnvName");
var cubeUpdateKVPList = new List>()
{
new KeyValuePair("9208", "value1"),
new KeyValuePair("9209", "value2"),
new KeyValuePair("9210", "value3"),
new KeyValuePair("9211", "value4"),
new KeyValuePair("9212", "value5")
};
var cellReferenceList = new List();
cubeUpdateKVPList.ForEach(x =>
{
cellReferenceList.Add(
new CellReference(new List()
{
new ElementReference("REGION", "REGION", "Massachusets"),
new ElementReference("MONTH", "MONTH", x.Key),
new ElementReference("PROJECT", "PROJECT", "PROJECT NAME")
}, x.Value
));
});
await TM1RestAPI.WriteCubeCellValueAsync(tm1Config, "YourCube", cellReferenceList);
```
## Querying a list of cubes
Example of reading a list of cubes from the TM1 server.
```csharp
using AndromedaTM1Sharp;
var tm1Config = new TM1SharpConfig("https://YourTM1Server:YourPort", "tm1UserName", "tm1Password", "YourEnvName");
var content = await TM1RestAPI.QueryCubeListAsync(tm1Config);
Console.WriteLine(content);
```
## Querying the dimensions of a cube
Example of querying the dimensions of a cube.
```csharp
using AndromedaTM1Sharp;
var tm1Config = new TM1SharpConfig("https://YourTM1Server:YourPort", "tm1UserName", "tm1Password", "YourEnvName");
var content = await TM1RestAPI.QueryCubeDimensionsAsync(tm1Config, "YourCube");
Console.WriteLine(content);
```
## Running a Turbo Integrator process
Example of running a TI process on the TM1 server. Expected return payload is:
{"@odata.context":"../$metadata#ibm.tm1.api.v1.ProcessExecuteResult","ProcessExecuteStatusCode":"CompletedSuccessfully"}
```csharp
using AndromedaTM1Sharp;
var tm1Config = new TM1SharpConfig("https://YourTM1Server:YourPort", "tm1UserName", "tm1Password", "YourEnvName");
var content = await TM1RestAPI.RunProcessAsync(tm1Config, "_CreateCubeProcess", new Dictionary() { { "CubeName", "_NewCubeCreatedbyRestAPI" } });
Console.WriteLine(content);
```
# Attributions
NuGet icon "AndromedaTM1Sharp.png" designed by Freepik Company S.L.