Add Excel Add-in University content. (rtdip#802)

Signed-off-by: Ummer Taahir <[email protected]>

docs/assets/extra.css

@@ -52,4 +52,17 @@
 
 .mermaid {
   text-align: center;
+}
+
+.curved-button {
+  color: rgb(66, 66, 66) !important;
+  border-radius: 20px;
+  padding: 10px 20px;
+  background-color: #E9ECF1;
+}
+
+
+.curved-button:hover {
+  background-color: #D3D9E2;
+  color: black !important;
 }

docs/overrides/essentials.css

@@ -354,7 +354,7 @@ body {
     font-weight: 300;
     font-size: 0.8rem;
     line-height: 1.5rem;
-    width: 85%;
+    width: 100%;
     margin-bottom: 1rem;
     list-style: none;
 }

docs/overrides/essentials.html

@@ -189,6 +189,18 @@ <h3 class="clickable-subtitle">Queries</h3>
                         <li>
                             <a href="../../essentials/excel-connector/overview">Overview</a>
                         </li>
+                        <li>
+                            <a href="../../essentials/excel-connector/getting-started">Getting Started</a>
+                        </li>
+                        <li>
+                            <a href="../../essentials/excel-connector/taskpane">Exercise: Exploring the Taskpane</a>
+                        </li>
+                        <li>
+                            <a href="../../essentials/excel-connector/functions">Exercise: Exploring the Functions</a>
+                        </li>
+                        <li>
+                            <a href="../../essentials/excel-connector/dashboard">Exercise: Creating a Simple Dashboard with Live Data</a>
+                        </li>
                     </ul>
                     <hr>
                 </div>
@@ -217,8 +229,7 @@ <h3>Skills you'll gain in this course</h3>
             </div>
         </div>
     </section>
-
-    <script>
+    <script> //NOSONAR
         function toggleDetails(clickedItem) {
             // Close all other details and reset indicators
             document.querySelectorAll('.clickable-list-item').forEach(function(item) {

docs/overrides/university.css

@@ -116,11 +116,11 @@ body {
 .content-section {
     display: grid;
     grid-template-columns: 1fr 1fr;
-    gap: 16px;
+    gap: 50px;
     margin-bottom: 50px;
     margin-left: 50px;
     margin-right: 50px;
-    max-width: 50rem;
+    max-width: 45rem;
 }
 
 /* Make columns collapse into single column when screen too small*/

docs/overrides/university.html

@@ -42,7 +42,7 @@ <h3 class="linkcard-title">RTDIP Pipelines</h3>
     </section>
 
 
-    <script>
+    <script> //NOSONAR
         function toggleDetails(clickedItem) {
             // Close all other details and reset indicators
             document.querySelectorAll('.clickable-list-item').forEach(function(item) {

docs/university/essentials/excel-connector/dashboard.md

@@ -0,0 +1,44 @@
+
+# Creating a Simple Dashboard with Live Data
+
+>
+All the functions (except Metadata) are capable of refreshing at a set interval with the `refreshIntervalSeconds` parameter.
+>
+
+For our final exercise, we will put everything together and create a simple dashboard.
+
+**Here are the steps:**
+
+1. Create a query for a tag that has live updating data and put the end date as the future (or now via `*`).
+2. Create a scatter or line chart with your data.
+3. Either with the taskpane `Advanced Parameters` or by editing your formula, set `refreshIntervalSeconds` to a number (min value `10`).
+4. Watch your chart update with live data.
+
+<center> ![Excel](assets/plot.gif){width=100%} </center>
+
+>
+Note: Currently, if you require excel to recognise dates on plots you will need to do `=VALUE(your_date_cell)`.
+>
+
+**Optional:**
+Look at the dashboard and you will see which functions are streaming and which are not - it is always a good idea to check this in case you have any stray functions running.
+
+
+That's the end of this lesson - if you have any feedback about the Excel Add-in we'd love to hear it!
+
+[← Previous](./functions.md){ .curved-button }
+
+>
+Congratulations on finishing RTDIP Essentials!
+>
+
+## Course Progress
+-   [X] Overview
+-   [X] SDK
+-   [X] APIs
+-   [X] Excel Connector
+    *   [X] Overview
+    *   [X] Getting Started
+    *   [X] Exercise: Exploring the Taskpane
+    *   [X] Exercise: Exploring the Functions
+    *   [X] Exercise: Creating a Simple Dashboard with Live Data

docs/university/essentials/excel-connector/functions.md

@@ -0,0 +1,31 @@
+# Exercise: Exploring the Functions
+
+As you will have seen in the previous execise, the Excel Add-in gets data from the RTDIP API with custom functions. In fact, each api route has it's own custom function in Excel.
+
+**Try these exercises to get familiar with the functions:**
+
+1. Write a function directly by referencing parameter values to cells. First, place your parameters in cells (e.g. In cell `B2` put your tagname). Then, in the cell where you want your data, write `=RTDIP.` and you will see the various functions available. Excel will hint which parameters go where.
+2. Refactor a formula in your sheet from a previous exercise and change the inputs to reference cells.
+
+A function may look like: 
+`=RTDIP.RAW("apiUrl", "region", etc...)`
+
+**Optional:**
+
+1. Try removing optional parameters. These are shown with square brackets around them, for example `[includeBadData]`. If not input, the defaults will be input behind the scenes.
+
+Let's continue to the final section:
+
+[← Previous](./taskpane.md){ .curved-button }
+[Next →](./dashboard.md){ .curved-button }
+
+## Course Progress
+-   [X] Overview
+-   [X] SDK
+-   [X] APIs
+-   [ ] Excel Connector
+    *   [X] Overview
+    *   [X] Getting Started
+    *   [X] Exercise: Exploring the Taskpane
+    *   [X] Exercise: Exploring the Functions
+    *   [ ] Exercise: Creating a Simple Dashboard with Live Data

docs/university/essentials/excel-connector/getting-started.md

@@ -0,0 +1,32 @@
+# Getting Started
+
+>
+> Note: Although the images reference windows, all the functionality will work on mac.
+>
+
+
+To get started, open up Microsoft Excel and go to the `Home` tab. On the right you should see the RTDIP Taskpane like this (if not, you may need to click `Add-ins`):
+
+<center> ![Excel](assets/home-tab.png){width=200px} </center>
+
+
+Once opened, the set-up screen will show and will ask for your API URL. This will be the same URL as in the previous lessons in the format `https://YOUR_ORGANISATION_DOMAIN/api/v1`
+
+After this, you should see our friendly taskpane (you are now completely set-up and ready to make some queries!):
+<center> ![Excel](assets/taskpane.png){width=40%} </center>
+
+Let's move onto the next section:
+
+[← Previous](./overview.md){ .curved-button }
+[Next →](./taskpane.md){ .curved-button }
+
+## Course Progress
+-   [X] Overview
+-   [X] SDK
+-   [X] APIs
+-   [ ] Excel Connector
+    *   [X] Overview
+    *   [X] Getting Started
+    *   [ ] Exercise: Exploring the Taskpane
+    *   [ ] Exercise: Exploring the Functions
+    *   [ ] Exercise: Creating a Simple Dashboard with Live Data

docs/university/essentials/excel-connector/overview.md

@@ -1,5 +1,33 @@
+
+# RTDIP Excel Add-in
+
+>
+> Note: This course assumes you already have the RTDIP Add-in installed by your organisation.
+>
+
+<center> ![Excel](assets/Excel-Logo.png){width=40%} </center>
+
+The RTDIP Excel Add-in is one of the simplest ways to get timeseries data from databricks to Microsoft Excel.
+
+Behind the scenes the add-in sends requests to the RTDIP API, but as you'll see in this lesson, the entryway is simplified including authentication via SSO, date parsing and more!
+
+
+For now, here's a sneak peak of the task pane:
+<center> ![Excel](assets/taskpane.png){width=40%} </center>
+
+>
+> If your course is facillitated, your facilitator will have a completed Excel workbook specific to your organisation
+>
+
+[Next →](./getting-started.md){ .curved-button }
+
 ## Course Progress
 -   [X] Overview
 -   [X] SDK
 -   [X] APIs
--   [ ] Excel Connector
+-   [ ] Excel Connector
+    *   [X] Overview
+    *   [ ] Getting started fetching your first data
+    *   [ ] Exercise: Exploring the Taskpane
+    *   [ ] Exercise: Exploring the Functions
+    *   [ ] Exercise: Creating a Simple Dashboard with Live Data

docs/university/essentials/excel-connector/taskpane.md

@@ -0,0 +1,40 @@
+# Exercise: Exploring the Taskpane
+
+The taskpane is the UI that guides you through and manages queries to the RTDIP API via your Excel sheet. All the API query types are supported, and can be accessed via the dropdown menu.
+
+>
+When you click run on the task pane, it inserts a formula with the specified parameters into a cell. We'll dive deeper into these custom functions in the next exercise.
+>
+
+**Try these exercises to get familiar with the taskpane:**
+
+1. Run a `Raw` query by filling in the parameters as you did in the API lesson.
+2. Run an `Interpolate` query in the same way.
+3. Try the shorthand parameters, for example rather than `todays date` you can do `*`, and `yesterdays date` you can do `*-1d`.
+4. Search for a different tag with the tag explorer ![tagsearch](assets/tagsearch-icon.png){width=30px} and add one to your query.
+5. Explore the dashboard ![tagsearch](assets/dashboard-icon.png){width=30px} and `edit`, `delete` or `refresh` one of your queries.
+
+**Optional:**
+
+1. Swtich to the `SQL` form and write a SQL query (note: these do not have to be timeseries tables)
+2. Open up the settings and change the look of the headers (or even turn them off).
+3. Look at the `Advanced Parameters` and try changing them (**do not change the refresh interval, we will do this in the final exercise**).
+
+
+
+Onto the next section: exploring the functions directly!
+
+
+[← Previous](./getting-started.md){ .curved-button }
+[Next →](./functions.md){ .curved-button }
+
+## Course Progress
+-   [X] Overview
+-   [X] SDK
+-   [X] APIs
+-   [ ] Excel Connector
+    *   [X] Overview
+    *   [X] Getting Started
+    *   [X] Exercise: Exploring the Taskpane
+    *   [ ] Exercise: Exploring the Functions
+    *   [ ] Exercise: Creating a Simple Dashboard with Live Data