PlanningAnalytics

<div id="top"></div> <!-- *** Thanks for checking out the Best-README-Template. If you have a suggestion *** that would make this better, please fork the repo and create a pull request *** or simply open an issue with the tag "enhancement". *** Don't forget to give the project a star! *** Thanks again! Now go create something AMAZING! :D --> <!-- PROJECT SHIELDS --> <!-- *** I'm using markdown "reference style" links for readability. *** Reference links are enclosed in brackets [ ] instead of parentheses ( ). *** See the bottom of this document for the declaration of the reference variables *** for contributors-url, forks-url, etc. This is an optional, concise syntax you may use. *** https://www.markdownguide.org/basic-syntax/#reference-style-links -->

<!-- PROJECT LOGO --> <br /> <div align="center"> <a href="https://github.com/olapline/PlanningAnalytics"> <img src="https://www.olapline.de/files/olapline-theme/img/brand-olapline-subline.svg" alt="Logo" width="300"> </a> <h3 align="center">PlanningAnalytics.NET</h3> <p align="center"> This Interface wraps the odata Rest Interface of TM1 in a workable Project in C#.NET. <br /> <a href="https://github.com/olapline/PlanningAnalytics"><strong>Explore the docs »</strong></a> <br /> <br /> <a href="https://github.com/olapline/PlanningAnalytics">View Demo</a> · <a href="https://github.com/olapline/PlanningAnalytics/issues">Report Bug</a> · <a href="https://github.com/olapline/PlanningAnalytics/issues">Request Feature</a> </p> </div> <!-- TABLE OF CONTENTS --> <details> <summary>Table of Contents</summary> <ol> <li> <a href="#about-the-project">About The Project</a> <ul> <li><a href="#built-with">Built With</a></li> </ul> </li> <li> <a href="#getting-started">Getting Started</a> <ul> <li><a href="#prerequisites">Prerequisites</a></li> <li><a href="#installation">Installation</a></li> </ul> </li> <li><a href="#usage">Usage</a></li> <li><a href="#roadmap">Roadmap</a></li> <li><a href="#contributing">Contributing</a></li> <li><a href="#license">License</a></li> <li><a href="#contact">Contact</a></li> <li><a href="#acknowledgments">Acknowledgments</a></li> </ol> </details> <!-- ABOUT THE PROJECT -->

Built With

• Newtonsoft JSON
• Log4Net

<p align="right">(<a href="#top">back to top</a>)</p> <!-- GETTING STARTED -->

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

         string BaseUrl = "http://localhost:8091/api/v1/";
         string UserName = "XXX";
         string Password = "XXX";


         using (PlanningAnalyticsConnection Connection = new PlanningAnalyticsConnection(BaseUrl))
         {

             if (Connection.Authenticate(UserName, Password))
             {

                 Console.WriteLine("Instance Name:" + Connection.InstanceName);

                 // Iterate over Processes
                 foreach (var process in Connection.Processes)
                 {
                     // The Names will be fetched by the iterator, the object by the getter
                     Console.WriteLine(process.Name);
                     PlanningAnalytics.Model.PlanningAnalyticsProcess Process = Connection.Processes[process.Name];
                     Console.WriteLine(Process.DataSource.Type);

                 }

                 // get a specific Dimension
                 PlanningAnalytics.Model.PlanningAnalyticsDimension Dimension = Connection.Dimensions["Projects"];
                 var Hier = Dimension.Hierarchies.ElementAt(0);
                 foreach (var attr in Hier.ElementAttributes)
                 {
                     Console.WriteLine(attr.Name);
                 }

                 foreach (var level in Hier.Levels)
                 {
                     Console.WriteLine(level.Name);
                 }
                 Console.WriteLine(Dimension.Hierarchies.ElementAt(0).UniqueName + " Number of Elements:" + Hier.Cardinality);



             }

         }

Prerequisites

• .net 4.7.2

Installation

1. Clone the repo

   git clone https://github.com/olapline/PlanningAnalytics.git
   

2. Create your own Project
3. Integrate PlanningAnalytics.NET into your Solution

<p align="right">(<a href="#top">back to top</a>)</p> <!-- USAGE EXAMPLES -->

Usage

• C# WebApi Middleware
• C# Deployment Tool
• C# Monitoring Tool

For more examples, please refer to the Documentation

<p align="right">(<a href="#top">back to top</a>)</p> <!-- ROADMAP -->

Roadmap

• [ ] Upload Blob File Content
• [ ] Bulk Update Hierarchies

See the open issues for a full list of proposed features (and known issues).

<p align="right">(<a href="#top">back to top</a>)</p> <!-- CONTRIBUTING -->

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

<p align="right">(<a href="#top">back to top</a>)</p> <!-- LICENSE -->

License

Distributed under the MIT License. See LICENSE.txt for more information.

<p align="right">(<a href="#top">back to top</a>)</p> <!-- CONTACT -->

Contact

Your Name - @twitter_handle - info@olapline.de@info@olapline.de_client.com

Project Link: https://github.com/olapline/PlanningAnalytics

<p align="right">(<a href="#top">back to top</a>)</p> <!-- ACKNOWLEDGMENTS -->

Acknowledgments

<p align="right">(<a href="#top">back to top</a>)</p> <!-- MARKDOWN LINKS & IMAGES --> <!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->