Merge pull request #24 from divyabhushan/prod-master

Updates from Staging

.vscode/settings.json

@@ -1,3 +1,28 @@
 {
-    "git.ignoreLimitWarning": true
+    "git.ignoreLimitWarning": true,
+    "grammarly.overrides": [
+        {
+            "files": [
+                "**/docs/admin-guide/settings/general.md"
+            ],
+            "config": {
+                "audience": "knowledgeable",
+                "dialect": "american",
+                "domain": "technical",
+                "emotions": [
+                    "confident",
+                    "optimistic",
+                    "friendly"
+                ],
+                "goals": [
+                    "inform",
+                    "describe"
+                ],
+                "emotion": "mild"
+            }
+        }
+    ],
+    "editor.formatOnSave": true,
+    "editor.formatOnType": true,
+    "markdown.extension.preview.autoShowPreviewToSide": true
 }

docs/admin-guide/admin-utilities/admin-utilities.md

@@ -4,4 +4,23 @@ title: Administrator Utilities
 sidebar_label: Administrator Utilities
 ---
 
-These utilities help the administrator to perform actions such as change his/her password and setup scheduled synchronization between BI Hub and BI platforms. The steps are described in the following sections.
+import useBaseUrl from "@docusaurus/useBaseUrl";
+import Link from '@docusaurus/Link';
+import Zoom from "react-medium-image-zoom";
+import "react-medium-image-zoom/dist/styles.css";
+
+These utilities help the Server Administrator to perform actions such as change the admin password and set-up scheduled synchronization between BI Hub and BI platforms.
+
+## Synchronization Information
+
+A summary of "Sync Authentication", "Sync Reports", and "Sync Users",  is displayed on the **Home** page of the Admin's BI Hub application.
+
+  <div class="center">
+    <Zoom>
+      <img alt="Agent Manager" src={useBaseUrl('doc-images/admin-guide/admin-utilities/synch-info.png')}/>
+    </Zoom>
+    <p>Agent Manager main screen</p>
+  </div>
+
+- The sync utilities executed by the Server Admin is listed as **"Bot"** in the **Last Updated By** column.
+- The Utilities run by an Admin from BI Hub app are listed as **"Admin"** in the **Last Updated By** column.

docs/admin-guide/admin-utilities/change-passwd.md

@@ -1,16 +1,32 @@
 ---
 id: change-passwd
-title: Change Password
-sidebar_label: Change Password
+title: Change Administrator Password
+sidebar_label: Change Admin Password
 ---
 
-To reset the admin password, follow the steps below:
+import useBaseUrl from "@docusaurus/useBaseUrl";
+import Link from '@docusaurus/Link';
+import Zoom from "react-medium-image-zoom";
+import "react-medium-image-zoom/dist/styles.css";
 
-1. Go to **<C:\Program Files\Visual BI Solutions\BI Hub\BIHubServer>\utilities** directory:
+1. Go to `C:\Program Files\Visual BI Solutions\VBI View\VBIViewServer\utilities`.
+1. Right-click on **BI Hub Change Admin Password.exe** and select **Run as administrator**.
 
- ```
- cd <C:\Program Files\Visual BI Solutions\BI Hub\BIHubServer>\utilities\
- ```
-2. Click on **File > Open in command prompt > Open command prompt as administrator** from the above location. Type the command: `ChangePassword.exe` and press Enter.
-3. In the **Change Password utility**, a prompt to enter the new password appears. Type the new password and press **ENTER**.
-4. Confirm the password, and your *Admin* password is now reset.
+  <div class="center">
+    <Zoom>
+        <img alt="Admin change password utility"
+        src={useBaseUrl('doc-images/admin-guide/passwd/admin-passwd-utility.png')}/>        
+    </Zoom>
+    <p>Admin change password utility</p>
+  </div>
+1. Select **Yes** to continue with the change password utility.
+1. In the **Change Password utility**, a prompt to enter the new password appears. Type the new password and press **ENTER**.
+  <div class="center">
+    <Zoom>
+        <img alt="Enter the new password prompt" 
+        src={useBaseUrl('doc-images/admin-guide/passwd/enter-new-passwd.png')}
+        />
+    </Zoom>
+    <p>Enter the new password prompt</p>
+  </div>
+1. Confirm the password, and your *Admin* password is now reset.

docs/admin-guide/admin-utilities/scheduled-sync-ad.mdx

@@ -0,0 +1,43 @@
+---
+id: scheduled-sync-ad
+title: Scheduled Synchronization with AD/LDAP
+sidebar_label: Scheduled Synchronization with AD/LDAP
+---
+
+import useBaseUrl from "@docusaurus/useBaseUrl";
+import Link from '@docusaurus/Link';
+import Zoom from "react-medium-image-zoom";
+import "react-medium-image-zoom/dist/styles.css";
+
+To synchronize the users from Windows AD or LDAP, follow the steps below.
+
+1. Go to `C:\Program Files\Visual BI Solutions\VBI View\VBIViewServer\utilities`.
+1. Click on **File > Open in command prompt > Open command prompt as administrator** and type the command:
+
+```bash
+#Authentication synch for Windows AD
+"BI Hub Authentication Synchronization.exe" -a "Windows AD"
+
+#Authentication synch for LDAP
+"BI Hub Authentication Synchronization.exe" -a LDAP
+```
+`-a` flag: stands for authentications for which the synchronization is triggered.
+
+`"Windows AD"` or `"LDAP"` : Name of the Authentication.
+
+> If the authentication name is more than one parameter, it should be enclosed within double quotes (").
+
+  <div class="center">
+    <Zoom>
+      <img alt="Agent Manager" height="50" src={useBaseUrl('doc-images/admin-guide/admin-utilities/auth-synch-success.png')}/>
+    </Zoom>
+    <p>LDAP authorization sync success</p>
+  </div>
+
+:white_check_mark: The users from Windows AD or LDAP Authentication will be synchronized to BI Hub and a success message will be shown.
+
+<Link to={useBaseUrl('docs/admin-guide/admin-utilities/admin-utilities#synchronization-information')}>Synchronization information</Link> is displayed on the Home screen of the Admin.
+In case of errors, check the <Link to={useBaseUrl('docs/admin-guide/admin-utilities/troubleshoot')}>Troubleshooting</Link> section.
+
+> The above commands can be stored in a batch file and scheduled to run using the organization’s scheduling tool.
+

docs/admin-guide/admin-utilities/scheduled-sync-bi.mdx

@@ -0,0 +1,64 @@
+---
+id: scheduled-sync-bi
+title: Scheduled Synchronization with BI platforms
+sidebar_label: Scheduled Synchronization with BI platforms
+---
+
+import useBaseUrl from "@docusaurus/useBaseUrl";
+import Link from '@docusaurus/Link';
+import Zoom from "react-medium-image-zoom";
+import "react-medium-image-zoom/dist/styles.css";
+
+## Pre-requisite
+
+All the Agents must be configured in the BI Hub platform and the instances must be up and in running status.
+
+## Synchronize Users or Reports
+
+1. Go to `C:\Program Files\Visual BI Solutions\VBI View\VBIViewServer\utilities`.
+2. Click on **File > Open in command prompt > Open command prompt as administrator** and type the command: `"BI Hub Instance Synchronisation.exe"`
+ - The command accepts 2 parameters:
+   1. **Synchronization option**: It can either be Users or Reports to synchronize users and reports respectively.
+   1. **Instance list**: List of configured Instances for which the synchronization process should take place. 
+   > An Instance name with more than one word must be included in double quotes(").
+
+Here are some sample commands that can be stored in a batch file and scheduled to run using the organization’s scheduling tool:
+
+### To Synchronize Users
+
+```bash
+#Synchronize users from all instances
+"BI Hub Instance Synchronisation.exe" --u -i
+
+#Synchronize Users from certain instances
+"BI Hub Instance Synchronisation.exe" --u –i "BOBJ_Rest SSL" Tableau "QlikSense SSL"
+```
+- `--u` : Users
+- `-i` : Instance
+- `BOBJ, Tableau and Qlik Sense` : Instance names configured in BI Hub.
+
+:::note
+Only common users from all the agents will be synchronized, rest excluded.
+  <div class="center">
+    <Zoom>
+      <img alt="Sync details" src={useBaseUrl('doc-images/admin-guide/admin-utilities/agents-users-sync.png')}/>
+    </Zoom>
+    <p>Sync details</p>
+  </div>
+:::
+
+### To Synchronize Reports
+
+```bash
+#Synchronize Reports from all instances
+"BI Hub Instance Synchronisation.exe" --r -i
+
+#Synchronize Reports from certain instances
+"BI Hub Instance Synchronisation.exe" --r –i BOBJ Tableau
+```
+
+- `--r` : Reports
+- `-i` : Instance
+- `BOBJ, Tableau` : Instance names configured in BI Hub.
+
+In case of a failure, refer the <Link to={useBaseUrl('docs/admin-guide/admin-utilities/troubleshoot')}>Troubleshooting</Link> section.

docs/admin-guide/admin-utilities/troubleshoot.md

@@ -0,0 +1,23 @@
+---
+id: troubleshoot
+title: Troubleshooting
+sidebar_label: Troubleshooting
+---
+
+import useBaseUrl from "@docusaurus/useBaseUrl";
+import Link from '@docusaurus/Link';
+import Zoom from "react-medium-image-zoom";
+import "react-medium-image-zoom/dist/styles.css";
+
+If any of the synchronizations failed with the "red" status:
+- In the BI Hub app, click on the Sync information to fetch more details and download sync logs:
+
+  <div class="center">
+    <Zoom>
+      <img alt="Sync details" src={useBaseUrl('doc-images/admin-guide/admin-utilities/sync-error.png')}/>
+    </Zoom>
+    <p>Sync information and logs</p>
+  </div>
+
+- In the Server, check the synchronization Server logs in the location - `C:\Program Files\Visual BI Solutions\VBI View\VBIViewServer\server\log\running_log`.
+- Agent Sync logs in the respective agent installation directory in the location - `C:\Program Files\Visual BI Solutions\VBI View\<agent-name>\logs`.

docs/admin-guide/agent-manager/agent-manager-main.mdx

@@ -0,0 +1,26 @@
+---
+id: agent-manager-main
+sidebar_label: Agent Manager Main Screen
+title: Agent Manager Main Screen
+---
+
+import useBaseUrl from "@docusaurus/useBaseUrl";
+import Link from '@docusaurus/Link';
+import Zoom from "react-medium-image-zoom";
+import "react-medium-image-zoom/dist/styles.css";
+
+**Agent Manager** screen allows Administrators to manage the *Agents* and *Clusters* for users.
+
+  <div class="center">
+    <Zoom>
+      <img alt="Agent Manager" src={useBaseUrl('doc-images/admin-guide/agent/agent-manager-main.png')}/>
+    </Zoom>
+    <p>Agent Manager main screen</p>
+  </div>
+
+The functionalities are categorized as 2 different tabs:
+
+1. <Link to={useBaseUrl('docs/admin-guide/agent-manager/agent/agent-management')}>Agent Manager</Link>: Agent and instance management
+1. <Link to={useBaseUrl('docs/admin-guide/agent-manager/cluster')}>Cluster Manager</Link>: Cluster management for multiple instances for load balancing
+
+---