diff --git a/docs/general/getting-started.mdx b/docs/general/getting-started.mdx
index f17d20a1e..0d4ab40f1 100644
--- a/docs/general/getting-started.mdx
+++ b/docs/general/getting-started.mdx
@@ -66,9 +66,9 @@ Forecast vs Budget, Budget vs Last Year Actuals etc. The data series is
at a certain time grain. This would typically be 1 year by 12 months or
a multiyear view like 5 years plan by year.
-The selecting of the time series will often be based on Filters or
+The selection of time series will often be based on Filters or
Variables. A typical scenario is where the designer has defined 4
-variables on the underlying data sources:
+variables in the underlying data sources:
Primary:
@@ -83,9 +83,9 @@ Version ie. Defaulted to Budget
Year ie. Defaulted to Current Year
This allows the users to compare different versions and years in the
-value driver tree model.
+Value Driver Tree Model.
-The valQ Custom Visual can display individual periods but can also apply
+ValQ Custom Visuals can display individual periods but can also apply
time aggregation such as Full Year, Year-to-Date. You can see the
currently selected Value Display aggregation on the Navigation Panel. In
the screenshot above, Full Year is selected. The primary value displayed
@@ -94,7 +94,7 @@ data.
## Tree Drill Down
-Nodes that has children will have an expand ‘>’ button to the right of
+Nodes that have children will have an expand '>' button to the right of
the Widget as highlighted below:
![Nodes with children]({useBaseUrl("/doc-images/4.2.png")})
@@ -102,14 +102,13 @@ the Widget as highlighted below:
You can drill down the tree by clicking the expand button.
The tree will focus on the branches that are being expanded. You can
-collapse any specific node by clicking the ‘<’ collapse button on the
+collapse any specific node by clicking the '<' collapse button on the
right of a widget.
-Value Driver Trees are in reality networks. The same driver may impact
-multiple aspects of the Tree. The component therefore contains a concept
-of linked nodes. Such nodes have a link
-
-})
icon that you can click
+Value Driver Trees are in reality networks.
+The same driver may impact multiple aspects of the Tree.
+The component therefore contains a concept
+of linked nodes. Such nodes have a link icon that you can click
which will jump to where the linked node is defined and highlight the
node:
![Link]({useBaseUrl("/doc-images/4.3.png")})
@@ -124,8 +123,8 @@ Value Driver Trees can be large. You can zoom and pan the canvas view.
If you are using an iPad or iPhone, you can zoom by pinching and pan by
dragging the same way you would navigate a map.
-If you are using a mouse with a scroll wheel, you can point your curser
-anywhere in the canvas and scroll the wheel to zoom in and out.
+If you are using a mouse with a scroll wheel, you can point your cursor
+anywhere on the canvas and scroll the wheel to zoom in and out.
To pan, click and hold the left bottom of the mouse and drag the tree
around.
@@ -148,13 +147,13 @@ level.
![Value Display]({useBaseUrl("/doc-images/4.5.png")})
-With the ‘Value Display’ functionality you can choose the time
+With the ‘Value Display’ functionality, you can choose the time
aggregation you want to display as the primary value. The designer can
-link certain nodes to a user selected scaling. You can select the scale
+link certain nodes to a user-selected scaling. You can select the scale
you wish to display by selecting this under the Value Display section.
Note that the options here can be configured so they may differ. It is
important to note that not all notes are scaled using this as the value
-driver tree typically contains both amounts, prices, rates and physical
+driver tree typically contains both amounts, prices, rates, and physical
volumes.
In addition to the primary display value, the designer can also choose a
@@ -216,7 +215,7 @@ Display is shown in the below Figure.
src={useBaseUrl("/doc-images/vd1.png")}
/>
-Similarly you can view the Tooltip for other Value Displays.
+Similarly, you can view the Tooltip for other Value Displays.
## Sub Models - Filters
@@ -257,10 +256,10 @@ There are 2 options to simulate:
percentage showing if the adjust has made the scenario better or
worse })
.
-![Data Simulation]({useBaseUrl("/doc-images/4.13.png")})
-- Click on the arrow icon of the node
- })
then click ‘Edit Key
+
+
+- Click on the arrow icon of the node then click ‘Edit Key
Input’ })
and manually
edit the changes in simulation per period. Click X to close manual
input table.
@@ -311,7 +310,7 @@ cost drivers without going into the node details.
Click the ‘Edit Key Input’ icon
})
-and manually edit the changes in simulation per periods.
+and manually edit the changes in simulation per period.
})
@@ -412,7 +411,7 @@ icon"
/>
This will create a new Scenario and will highlight the created Scenario
-as the active scenario.
+as an active scenario.
- Click ‘Compare Scenario’ icon to generate a report comparison format
with the key Assumptions and KPI’s (see Figure below).
@@ -423,8 +422,8 @@ as the active scenario.
the active collection. It also shows the Simulated Data Scenario
(Baseline: Full Year), Comparison Version (Full Year) and Simulated
Data Scenario Year to Date (Baseline: YTD).
-- From the below Figure, the GREEN fonts denotes the most favorable
- results and the RED fonts denotes the least favorable result in the
+- From the below Figure, the GREEN fonts denote the most favorable
+ results and the RED fonts denote the least favorable result in the
scenario comparison report.
![Write back options]({useBaseUrl("/doc-images/wb1.png")})
-- The created Scenarios can be reordered based on our choice by a
- simple drag and drop options. For our example, you have reordered
+- The created Scenarios can be reordered based on our choice with a
+ simple drag and drop option. For our example, you have reordered
the Scenarios as shown in the below Figure.
![Reordered Scenarios]({useBaseUrl("/doc-images/sf9.png")})
@@ -498,7 +497,7 @@ have opportunities for further improvements (WHITE fonts).
Notes:
-- RED fonts means over capacity as compared to the maximum limit.
+- RED fonts mean over capacity as compared to the maximum limit.
(e.g. Production Rate 1.680 tonnes per hour is over capacity as
compared to the maximum limit of 1.600 tonnes per hour).
- WHITE fonts means still have opportunities for improvement as
diff --git a/docs/general/installation_guide_v1.8.mdx b/docs/general/installation_guide_v1.8.mdx
new file mode 100644
index 000000000..c3c105235
--- /dev/null
+++ b/docs/general/installation_guide_v1.8.mdx
@@ -0,0 +1,556 @@
+---
+id: installation_guide_v1.8
+title: ValQ Private Tenant Installation Guide
+---
+import useBaseUrl from '@docusaurus/useBaseUrl'; // Add to the top of the file below the front matter.
+
+## Introduction
+
+### What is ValQ
+
+ValQ is a serverless, lightweight, multi-purpose application running on Power BI supporting use cases such as planning, forecasting, budgeting, time series forecasting, and value driver planning. It helps enterprises run simulations, plans & analyses in a very visual and intuitive manner.
+
+### Supported platforms
+
+### System requirements
+
+Following are the recommended system requirements.
+
+1. Operating System - Windows Server 2012 or later
+2. Processor - 2.4 GHz Quadcore or with similar CPU Performance
+3. RAM- 16 GB
+
+### Browser compatibility
+
+1. Edge
+2. Google Chrome
+3. Mozilla Firefox
+4. IE 11
+
+### Databases
+
+1. Microsoft SQL Server - Version 2016 or latest
+2. MySQL Server - 5.6 or latest
+3. Maria DB - 5.5 or latest
+
+Database can be also installed in the Virtual Machine where we are installing ValQ Server.
+
+## Architecture
+
+
+
+[Private Tenant Notes](https://www.notion.so/Private-Tenant-Notes-8ac88ed255fe41028fa5feda7bc0d006)
+
+### 1. **Private Tenant - License Key**
+
+- Go to your [ValQ-Account](https://valqdev.wpengine.com/my-account) and login with the Account credentials you received in the email
+- Go to **Private Tenant** tab to view the **Product Subscription** details.
+- Copy the **Key Code**. This is your **License key** that you will need in the **ValQ Management Console** [License Key](https://www.notion.so/ValQ-Private-Tenant-Installation-Guide-9525981b1f0b407fa7cad823856e3f04#e7bf9ec65c9a43bea4c9caacd816b2a9) configuration section.
+- **Tenant Info** section displays information about your *Plan, Expiry Date, Users Limit, and [](###Workspace)[Workspace limit](https://www.notion.so/ValQ-Private-Tenant-Installation-Guide-9525981b1f0b407fa7cad823856e3f04#28ec36256e414757939376cc4940f084)*.
+
+
+
+ValQ_email_CustomBuild.png
+
+Click on the **Click here** link in the email and download the **ValQ Collaborate** installer.
+
+### 2. Database Creation
+
+The setup in this guide uses **MySQL** as the backend Database Server. Configure the backend database referring to the [databases](https://www.notion.so/ValQ-Private-Tenant-Inst-allation-Guide-9525981b1f0b407fa7cad823856e3f04#e4014996df9c42fb84e6e215964e407d) prerequisite section.
+
+### 3. Office 365 App
+
+Create an **Azure app** in your **Office 365 Tenant** for the **SSO configuration**
+
+1. Login into your [Azure Portal](https://portal.azure.com) account
+2. Click on **Manage Azure Active Directory** menu item
+3. Click **App registrations** in the left sub menu
+4. Click **New Registration** tab in the top left menu bar.
+
+.png)
+
+Register a new app
+
+- Enter an **Application name** to be displayed to the users
+- In the section **Who can use this application, s**elect **Accounts in this organizational directory only**
+- In the section **Redirect URI**
+ - Select **Web**
+ - Enter the **URL** of the **Virtual Machine** where we are going to install the **ValQ private tenant**.
+
+ Note: Use the **https** protocol.
+
+- Click **Register**
+
+Azure AD assigns a unique application, or client, ID to your app.
+
+The portal opens your application's **Overview** page.
+
+The **Microsoft Azure** portal provides application management configurations:
+
+- Authentication
+ - Go to **Authentication > Implicit grant** section
+ - Ensure that both the checkboxes **Access Tokens** and **ID tokens** are ticked.
+- API permissions
+ - Go to **API permissions**
+ - In the **Microsoft Graph** API/Permission name, add
+ 1. openid
+ 2. profile
+ 3. User.Read
+
+5. Go to the **Overview** section and save the **Application (client) ID** and **Directory (tenant) ID**.
+
+You will need these 2 IDs to setup the **[General Service Configuration](https://www.notion.so/ValQ-Private-Tenant-Installation-Guide-9525981b1f0b407fa7cad823856e3f04#5db81f88a5ad4af1bcc1ceddcae74548)** in the **[ValQ Management Console](https://www.notion.so/ValQ-Private-Tenant-Installation-Guide-9525981b1f0b407fa7cad823856e3f04#8db2934d941343cfb963ab2ed4bf735e)** section.
+
+### 4. Generate SSL Certificate
+
+ValQ Private tenant requires an SSL Certificate for proper working and secure communication.
+
+There are 2 ways to generate an SSL Certificate:
+
+4.1 Buy or generate an SSL certificate for the ValQ private tenant VM in the x.509 if you have a vendor.
+
+4.2 Generate self signed certificate by using the *Open SSL tool:*
+
+- Open Windows File Explorer
+- Navigate to the OpenSSL bin directory, generally it is `c:\OpenSSL\bin\`
+- Right-click the **openssl.exe** file and select **Run as administrator**
+- Enter the following command to begin generating a certificate and private key:
+
+```bash
+**req -x509 -sha256 -nodes -days 365 -newkey rsa:2048 -keyout privateKey.key -out certificate.crt**
+```
+
+- Enter a 7-digit **applicable Distinguished Name (DN)**
+- Once completed, you will find the **certificate.crt** and **privateKey.key** files in the same bin directory location
+
+## Installation
+
+1. Click on the **ValQ_Collaborate_1.8** Installer.
+
+
+
+valQ_installer
+
+
+
+License Agreement
+
+2. Click **Next** to continue with the installation setup.
+
+
+
+Installation Setup
+
+3 .Choose the **Installation Directory** path to install **ValQ**. Click **Next**.
+
+
+
+Installation directory path
+
+4. **ValQ Port Assignment**
+
+- Enter the **ValQ HTTP Port**, default value is **80**
+- Enter the **ValQ SSL Port**, default value is **443**
+- Click **Next**
+
+
+
+Nginx_Server_Details
+
+5. Set **ValQ Management Server Port** default value to **5000**. Click **Next**.
+
+
+
+License_Server_Port
+
+6. Set the **ValQ Management Console Password**
+
+
+
+Admin_Console_Password
+
+7. Click **Next** to start the installation process.
+
+
+
+Ready_to_install
+
+8.The average time to complete the installation process is approximately 10 minutes.
+
+
+
+Installation progress bar
+
+9. Click **Finish** to complete the installation.
+
+
+
+finished_installing_valq
+
+Click **OK** to close the **README** file.
+
+
+
+close_Readme.png
+
+Installation Completed Checklist
+- ValQ port assignment for HTTP and SSL
+- ValQ Management Server Port
+- ValQ Management Console Password for the Admin Portal login
+- ValQ Collaborate installed in the chosen installation directory path
+
+
+
+ValQ installed
+
+## Certificate Configuration
+
+1.Update **Nginx configuration files**
+
+- Go to the **ValQ installation directory** on your machine
+- Open **nginx > confs** folder
+- Replace the **Nginx Server** existing *Security Certificate and KEY files with the [SSL Certificates](https://www.notion.so/ValQ-Private-Tenant-Installation-Guide-9525981b1f0b407fa7cad823856e3f04#05752a892828439e8f368ab40cf841de) keys*
+ - The new SSL certificate keys must be of the *same name and in the same format as the original server keys*
+ - *The file should not contain Pass Phrase.*
+ - You can also generate the certificate by using the server.key by using Open SSL.
+ - If you are using self signed certificate, then it should be made trusted in all the computers across the organization.
+
+
+
+Update_Nginx_conf_files
+
+2.Restart the **Nginx Service**
+
+Go to **Start > Services**
+
+- Search and click on the **Nginx** Service that has a **running** instance
+- Click **Restart**
+
+
+
+Restart_Nginx_service
+
+## ValQ Management Console
+
+**Login Page**
+
+- Open up the browser and type the URL: `localhost/config`
+- In the **ValQ Management Console** login page, enter the Management **[Console Password](https://www.notion.so/ValQ-Private-Tenant-Installation-Guide-9525981b1f0b407fa7cad823856e3f04#75fb81e5092a4edab5201b6f858e4ad9)** to log in.
+
+
+
+API_installer_Login
+
+This scree allows you to specify configurations for the **ValQ API**
+
+
+
+Api_installer_welcome
+
+Click **Setup Configuration**
+
+### Configurations Settings
+
+### 1.License Key
+
+Enter the **[License key](https://www.notion.so/ValQ-Private-Tenant-Installation-Guide-9525981b1f0b407fa7cad823856e3f04#c693e77c0d5f4d7fbc6747d728107ce6)** in the text box area and click **Next**.
+
+
+
+License_key
+
+### 2.General Configuration
+
+
+
+- Enter the **Nginx Server URL**.
+
+ The default port is *80* for **http** and the port is **443** for **https**
+
+- Choose the **Log level** as *info*, *war*, or *error*
+- Enter your **Office 365 Tenant ID** generated in the **[Office 365 app](https://www.notion.so/ValQ-Private-Tenant-Installation-Guide-9525981b1f0b407fa7cad823856e3f04#0ca6e78c8f7d48de8f6ab1ef2336801f)** section
+- Enter your **Office 365 Client ID** generated in the **[Office 365 app](https://www.notion.so/ValQ-Private-Tenant-Installation-Guide-9525981b1f0b407fa7cad823856e3f04#0ca6e78c8f7d48de8f6ab1ef2336801f)** section
+
+Click **Save**.
+
+### 3.Database Configuration
+
+
+
+Database_configuration
+
+- Select your **Database**
+- Type the **Database Server Host**, default value is **localhost**
+- Type the **Database Server Port**
+- Enter the **Database Server Username**
+- Enter the **Database Server Password**
+- Enter the **Database Name** that you created in your **Backend Server**
+
+Click **Save**.
+
+### 4.SMTP Configuration
+
+
+
+- Turn on the **Enable SMTP**
+- Enter the SMTP details- *SMTP Host, SMTP Port, Username, Password, Service Provider, Encryption, and Sender Email*
+- Click **Submit** to save the SMTP settings.
+
+### 5.Instance Configuration
+
+
+
+Instances_config
+
+Create an **Instance** of the **ValQ** service.
+
+- Enter an **Instance Port** number starting with the range: **3000**
+- Click **Save**.
+
+### 6. Redis Configuration
+
+### Dashboard
+
+
+
+The **Dashboard** displays the details of the *Database, SMTP, Instance* Status and Port number.
+
+### Workspace
+
+Create a **Private Tenant Workspace** for the **ValQ Custom Visuals**
+
+Go to **ValQ Management Console > Workspace > Create Workspac**
+
+
+
+Create Workspace
+
+- Enter the **Workspace Name**
+- Enter **Workspace Administrator Name**
+- Enter **Workspace Administrator Email**
+- Enter **Company Domain**
+- Click **Add**
+
+ You can create any number of **Workspaces** and assign these workspaces to different **Users**.
+
+ The number of users you can add to the workspace is determined by the plan that you selected during the purchase.
+
+
+
+The **Instances** can be **Created, Edited or Deleted** from this portal.
+
+
+
+You have configured the *Database, SMTP, Workspace and Instances* in **ValQ Management Console.**
+
+---
+
+## ValQ Admin Console
+
+### Admin Console- Login
+
+
+
+Admin_Portal_login
+
+1. Open the browser and type the **[Private Tenant URL](https://www.notion.so/ValQ-Private-Tenant-Installation-Guide-9525981b1f0b407fa7cad823856e3f04#5db81f88a5ad4af1bcc1ceddcae74548)**
+- Click on **Sign in with Microsoft**, and enter your **username** and **password**
+
+
+
+Microsoft_Sign_in_username
+
+
+
+Microsoft_Sign_in_password
+
+- Click **Sign in**
+
+2. Choose and click on the **Private Tenant** Workspace
+
+
+
+private-tenant-workspace selection
+
+### Admin Console- Dashboard
+
+The **Dashboard** gives details about the Workspace that your models will belong to.
+
+- License Details
+- Profile
+
+If you belong to multiple Workspaces, the list of workspaces will be listed in the top **dropdown menu bar.**
+
+You can switch between the Workspaces.
+
+### User Manager
+
+
+
+user_manager
+
+**Admin** user is listed by default.
+
+To add more Members:
+
+- Click **Add Members.** Each member will be able to access the workspace based on the **Role** assigned, such as - **Admin** or **Member**
+- Enter the **Email** and click **Add**
+- Click on **Bulk Upload** to import many Members from a CSV file
+
+You have created your **Private Tenant Workspace** and added the members. You will now be able to share the **ValQ Custom Visuals** Models with the assigned Members.
+
+---
+
+## ValQ Collaborate custom visual in Power BI Desktop
+
+### Add ValQ Visuals to Organization Visuals list
+
+1. Go to the **[Power BI app](https://app.powerbi.com/)** login page
+
+
+
+- Click on the three dots `...` > **Settings > Admin portal**
+
+2. Select **Organization Visuals** and Click on **Add Organizational Visual**
+
+
+
+Add ValQ to Organization visuals in Power BI
+
+- **Browse** the visual file with the ***.pbiviz** extension
+- **Name** your visual
+- Upload an **icon image**
+- Write a **Description** about the visual
+- Toggle the **access** to this visual across the users in the organization to be **enabled** or **disabled**
+- Click **Add**
+
+You have added **ValQ visuals** to your **Organization Visuals** list
+
+### Create a Power BI report with ValQ
+
+1. Go to **Power BI Desktop** application
+
+2. Click on the **Visualizations** pane
+
+
+
+Get ValQ visuals
+
+- Click on the **three dots `...`** and then click **Get more visuals**.
+
+3. Search for the **ValQ** visuals under **[My Organizations](https://www.notion.so/ValQ-Private-Tenant-Installation-Guide-9525981b1f0b407fa7cad823856e3f04#cc422de3430b4bdbac6ed03da7d50b35)** tab, and click **add**.
+
+
+
+### Assign data to ValQ Custom Visual
+
+1. Click on **Get Data** and import the data for your business model.
+- On a successful import, a **ValQ** icon is placed in the **Visualization** pane.
+- Click on the **ValQ** icon and resize the **ValQ image** to fit the window area.
+
+
+
+2. Select the data fields in the **Fields** pane on the right.
+
+- Add measures to the values and data category.
+
+login to private tenant workspace from Valq
+
+
+
+Click **Login** on the **Getting started with ValQ** pop window.
+
+4. You will be navigated to your **Workspace**.
+
+
+
+Choose the Workspace
+
+
+
+Workspace selected
+
+
+
+Congratulations!!! You are logged into your **Private Tenant Workspace**.
+
+
+
+Your **ValQ Custom Visuals** is now mapped to the backend **Workspace.** The custom visuals data will be loaded into the configured **Database Server**.
+
+## What Next
+
+Simulate your business model in **Power BI** with the **ValQ-Collaborate** visuals and enjoy the features:
+
+
+
+BI model simulation in ValQ Collaborate
+
+* Share your Reports in the Workspace with other members
+
+* Comments and Annotations
+
+* Audit Logs
+
+* Scenario Collaboration
+
+* Private Tenant
+
+
+
+Shared Model scenarios in the Workspace
+
+## Troubleshooting steps
+
+## Un-installation
+
+### Uninstall ValQ
+
+1.Go to the **ValQ installation path** on your machine
+
+2.Double click on the **Uninstall ValQ Collaborate** application
+
+
+
+Uninstall_valQ_installer
+
+3.Click **Yes** in the **User Account Control** popup window
+
+
+
+Uninstall_yes
+
+4.Click **Yes** to confirm the deletion of **ValQ Collaborate**
+
+
+
+Uninstall_confirm
+
+5.Uninstallation **Setup** begins and may take approximately 3.5 minutes to complete
+
+
+
+Uninstalling-Setup_progress.png
+
+6.Click **OK** to finish uninstalling **ValQ Collaborate**
+
+
+
+Uninstallation_complete
+
+7.Restart the System.
+
+### Post-uninstallation step
+
+Delete the residual files
+
+- Go to **ValQ installation path**
+- Delete all the remaining files present in the folder.
+
+
+
+Delete residual files
+
+An earlier version of ValQ has been successfully uninstalled.
+
+Go to the [Installation](https://www.notion.so/ValQ-Private-Tenant-Installation-Guide-9525981b1f0b407fa7cad823856e3f04#74dbb514c542437d89127db02fc1f362) section to begin the new installation of **ValQ Collaborate**
\ No newline at end of file
diff --git a/sidebars.js b/sidebars.js
index 42bdb6411..b0162ec59 100644
--- a/sidebars.js
+++ b/sidebars.js
@@ -21,7 +21,8 @@ module.exports = {
"general/more-info-value-driver",
"general/saving-opening-scenarios",
"general/workspace-in-valq",
- "general/valq-in-powerbi"
+ "general/valq-in-powerbi",
+ "general/installation_guide_v1.8"
],
"Model": [
"model/model_tab",
diff --git a/yarn.lock b/yarn.lock
index 1eef0ea83..dd1caa7fa 100644
--- a/yarn.lock
+++ b/yarn.lock
@@ -2663,6 +2663,17 @@ docsearch.js@^2.6.3:
to-factory "^1.0.0"
zepto "^1.2.0"
+docusaurus-lunr-search@^1.0.2:
+ version "1.0.3"
+ resolved "https://registry.yarnpkg.com/docusaurus-lunr-search/-/docusaurus-lunr-search-1.0.3.tgz#24f38133d07a482c6d74f2bd0f1a08f674692c61"
+ integrity sha512-jWcKxvbecJtLizcJ9qcbEyiQgDwi9aTgYg1nlPZ6quMiVr1mYPt6sp/4sirAh+gCxVH+FxF/B0Af8TLytci8HA==
+ dependencies:
+ autocomplete.js "^0.37.0"
+ cheerio "^1.0.0-rc.3"
+ classnames "^2.2.6"
+ hogan.js "^3.0.2"
+ lunr "^2.3.8"
+
dom-converter@^0.2:
version "0.2.0"
resolved "https://registry.yarnpkg.com/dom-converter/-/dom-converter-0.2.0.tgz#6721a9daee2e293682955b6afe416771627bb768"