VBI View V Installation Guide -

Transcription

1 VBI View V Installation Guide -

2 Contents 1 COPYRIGHT TRADEMARK INFORMATION INTRODUCTION DOCUMENT HISTORY WHO SHOULD READ THIS GUIDE? WHAT IS VBI VIEW? SUPPORTED PLATFORMS System Requirements Browser Compatibility Databases, Webserver DOWNLOADING VBI VIEW INSTALLATION PRE-REQUISITES INSTALLATION OF VBI VIEW VBI VIEW SERVER INSTALLATION Installation of VBI View Server VBI View Server Configuration Config Tab General Section Database Section Audit Database Section SSL Section Elastic Search Section Mail Connection Section Instances Tab Post Configuration Steps Troubleshooting Steps VBI VIEW WEB INSTALLATION Installation of VBI View Web VBI View Web Configuration Changing VBI View Server URL Details SSL Configuration Post Configuration Steps Troubleshooting Steps VBI VIEW AGENTS INSTALLATION Installation of VBI View Agents VBI View Agent Configuration SSL Configuration SSL Configuration for BOBJ Agent Advanced Agent Configuration BI Platform Configuration BOBJ Platform Configuration BOBJ REST BI Platform Configuration Tableau Platform Configuration QlikSense Platform Configuration PowerBI Platform Configuration File BI Platform Configuration SSRS Platform Configuration Spotfire Platform Configuration VBI View Installation Guide P a g e 2 of 42

3 Microstrategy Platform Configuration Post Configuration Steps Troubleshooting Steps SYNCHRONIZATION OF VBI VIEW AND BI PLATFORMS UPGRADE TRIAL VERSION OF VBI VIEW UPGRADE FROM RELEASE 2 TO RELEASE UPGRADE FROM TRIAL TO PRODUCTION EXTEND THE TRIAL PERIOD MOVING VBI VIEW INSTANCE FROM ONE SERVER TO ANOTHER UNINSTALLATION OF VBI VIEW RE-INSTALLATION OF VBI VIEW VBI View Installation Guide P a g e 3 of 42

4 1 Copyright Visual BI Solutions, Inc. ( Visual BI ). All rights reserved. No part of this document may be reproduced or transmitted in any form or by any means, electronic or mechanical, for any purpose, without the express written permission of Visual BI. Under the law, reproducing includes translating into another language or format. As between the parties, Visual BI retains title to, and ownership of, all proprietary rights with respect to the software contained within its products. The software is protected by United States copyright laws and international treaty provision. Therefore, you must treat the software like any other copyrighted material (e.g. a book or sound recording). Every effort has been made to ensure that the information in this manual is accurate. Visual BI Solutions is not responsible for printing or clerical errors. Information in this document is subject to change without notice. 1.1 Trademark Information Visual BI and the Visual BI logo design are trademarks of Visual BI. in the United States and various other countries. All other trademarks are the property of their respective owners. solutions@visualbi.com Phone: Fax: Plano, TX Dallas, TX Chennai, India VBI View Installation Guide P a g e 4 of 42

5 2 Introduction 2.1 Document History This document is valid for the releases shown in the table below (see Table 2.1): Major Release Minor Release Patch Date rd Feb rd March th April 2018 Table 2.1: Document History 2.2 Who Should Read This Guide? The Installation Guide for VBI View application offered by Visual BI is meant for people who will perform the installation of the software. 2.3 What is VBI View? VBI View (Visual BI View) a Visual BI product, is a web-based application which enables users to view and analyse reports built in various BI platforms in one page, without having to login into those platforms individually. Highlights of this product includes but not limited to: Smart view and Discovery of BI assets Discover not accessible assets and request access Unified view of BI assets A consolidated view of reports from multiple BI platforms in one page. Incredibly easy setup and maintenance Easy to setup and 100% automated synchronization between VBI View and BI platforms VBI View 1.5 consists of VBI View Server, VBI View Web and VBI View Agents. This installation document explains the steps involved in installation of the three components and procedure to check the success/failure of the installation process. 2.4 Supported Platforms The System Requirements and the Browser Compatibility for production version of VBI View is described as follows System Requirements The following table shows the various scenarios of application installation and their system requirements (Recommended Requirements) (See Table 2.2) VBI View Installation Guide P a g e 5 of 42

6 Component Single Box Backend Multiple Box Agent Operating System Windows Server 2008 or later Windows Server 2008 or later Windows Server 2008 or later Processor 2.4 GHz, Quadcore 2 GHz, Quadcore 2 GHz, Quadcore RAM 16 GB 8 GB 8 GB Table 2.2: System Requirements Browser Compatibility The following table shows the various Browsers compatible with VBI View (See Table 2.3) Product Version Chrome Mozilla Firefox Internet Explorer Edge or above 30 or above 11.xxx 40 or above Table 2.3: Browser Compatibility Databases, Webserver The following table shows a certified list of databases and webservers which are certified to run VBI View. (See Table 2.4) Components Supported Recommended Database MSSQLServer 2012, Oracle 10g, MySQL 5.7, PostgreSQL 9.6 MySQL that is bundled with the product Webserver Nginx, Apache Tomcat, Microsoft IIS 8.0 Nginx that is bundled with the product Text search engine Apache Elastic Search 5.5 If customer prefers MSSQL database, any one of the following drivers is required. SQL Server Native Client released with SQL Server 2012 ODBC Driver 11 for SQL Server - supports SQL Server 2005 through 2014 ODBC Driver 13 for SQL Server - supports SQL Server 2005 through 2016 Elastic Search that is bundled with the product 2.5 Downloading VBI View To download the trail version of the product, launch Fill in the form details and click Start Trial. An will be sent with the details on how to proceed with the download and the activation of the software. Launch the website mentioned in the ( and download the latest version into the server where the VBI View is to be installed. VBI View Installation Guide P a g e 6 of 42

7 2.6 Installation Pre-Requisites Access to internet for registration of license. Access to license key information obtained in the . Microsoft.NET Framework 3.5 Microsoft Visual C++ Redistributable for Visual Studio 2015 ( Supported Web Server and Database (see Section 2.4.3) SSL certificates - If secure communication (https) is desired, The Certificate has to be OpenSSL compactable X.509 with the following format (PEM encoded format) private.key Private Key public.crt Public Certificate file VBI View Installation Guide P a g e 7 of 42

8 3 Installation of VBI View VBI View installation consists of installation of three components, VBI View Server, VBI View Web and VBI View agents. It is very important that the steps explained in this section are followed in the order given below. At each stage of the installation, the process to verify the successful installation and details of configuring the components are also explained in detail. During installation, if there are any issues, the VBI View support team can be contacted at 3.1 VBI View Server Installation Installation of VBI View Server Follow the steps below to activate the license and install the VBI View Server. 1. Double Click on the VBIViewServer windows-installer.exe file to start the installation process. 2. Click Next in the startup page. 3. Read through the license terms and conditions. To proceed further accept the license terms and click next to continue. 4. In the Component Selection screen, select MySQL component to install bundled MySQL Database. If you have your own Database, Click next to continue to the Directory Selection screen without selecting MySQL component 5. In the Directory Selection screen, choose the directory to install VBI View Server. The default directory is C:\Program Files\Visual BI Solutions\VBI View\VBIViewServer 6. Select the preferred activation step and click Next Online Mode Choose this option if this machine is connected to internet. If this machine is behind the firewall, make sure to whitelist the URL If the installer can reach the VBI View activation server, then it will navigate to the next screen. Offline Mode Choose this option if this machine is not connected to internet. License can be activated offline. 7. If Offline mode is chosen, continue with this step, else skip to Step 12. The next screen will give a unique activation key for this installation instance. Open (Refer Fig:3.1) in another computer which has internet connection. In that page, type the contact address, the license key that was provided during VBI View download and copy paste the activation key generated into the Key code box. VBI View Installation Guide P a g e 8 of 42

9 Figure 3.1: Offline License Generator Webpage 8. Click Download file button which will generate the license.licx file and prompt to download the file. 9. Download the file and copy paste it to the system where the installer is currently running. Then click next button in the installer which will prompt to select the generated license file. 10. Browse for the downloaded license file and select the correct license file. This file is valid only for the current installation. It cannot be reused for another fresh installation in another machine or same machine. 11. On clicking next, selected license file will be verified and on successful verification the next screen is shown. Skip the next step and go to step number In the next screen, fill out license information in its respective box. On clicking next, installer will try to activate your license with the information provided. On successful validation, next screen is shown. 13. If MySQL component is selected in Step:4, provide port and root user password details. 14. In the next screen, Elastic Search user details should be provided which is used later to connect Elastic search with VBI View Server. Kindly save the details which will be required while configuring the VBI View Server in the section After that Elastic Search port configuration will be prompted by the installer. Kindly use the ports which are free or leave the default value. Kindly save the details which will be required while configuring the VBI View Server in the section The next screen provides details of installation. Clicking next button will start to install the VBI View Server with all the selected components. 17. Kindly wait for the installation to finish. After successful installation, the final screen provides options to Open Readme file and to Open VBI View Server Configuration Utility. After viewing the readme file, proceed with the Configuration utility in Section Click finish with necessary option. You have successfully installed the VBI View Server in your server. To configure and start the VBI View Server you can follow the next section in this Installation Guide. VBI View Installation Guide P a g e 9 of 42

10 3.1.2 VBI View Server Configuration The configuration utility is used to configure VBI View Server which was installed as indicated in previous section. The shortcut to configuration utility is present in the VBI View Server Installation folder. Right click the Shortcut and select run as administrator option to open the Configuration Utility in an Administrator Mode. Configuration Utility will have two main tabs namely config tab and Instances tab Config Tab Changing the value of Properties in this tab affects VBI View server. Since changing the configuration affects all the VBI View server instances they need to be restarted for the configuration changes to take effect. This tab contains following sections which are as follows. General Section Database Section Audit Database Section SSL Section Elastic Search Section Mail Server Section General Section This section will have configuration fields which are general to the server. Property Purpose Description Max Log Size Maximum size of the log file in MB Default value - 10 Max Log Count Maximum number of log files that can be generated without a backup. Once the number is reached, the files need to be backed up. Default value - 10 Log Level Level of detail at which the log is written Info Will log all the available information Warning Will log all the warnings and errors Error Will log only errors. VBI View Installation Guide P a g e 10 of 42

11 Database Section This section will have configuration fields related to the main database connection to the server. Property Purpose Description Type Driver Host Name Port Type of the database in which the metadata is stored Only available for MSSQL database type Host name of the preferred database server Database server port at which the database server is running MySQL/MSSQL/Oracle/PostgreSQL Kindly provide the name of the MSSQL driver installed in the current system. For other database types, this field won t be available Default value : Default value : 3306 Name Schema to connect to Default DB Name : vbiview Username Enter the database username It should have all the privilege for the provided schema.default username is root Password Create database Password of the above provided username Create the database mentioned if not already present If the installer software should create database/schema, check this box. If this box is not checked, the database/schema should be created manually with the same name as indicated in the Name property Audit Database Section This section will have configuration fields related to the audit database connection to the server. Property Purpose Description Type Driver Type of the database in which the metadata is stored Only available for MSSQL database type MySQL/MSSQL/Oracle/PostgreSQL Kindly provide the name of the MSSQL driver installed in the current system. For other database types, this field won t be available VBI View Installation Guide P a g e 11 of 42

12 Host Name Port Host name of the preferred database server Database server port at which the database server is running Default value : Default value : 3306 Name Schema to connect to Default DB Name : vbiviewaudit Username Enter the database username It should have all the privilege for the provided schema Password Create database Password of the above provided username Create the database mentioned if not already present If the installer software should create database/schema, check this box. If this box is not checked, the database/schema should be created manually with the same name as indicated in the Name property SSL Section This section establishes a secure connection via SSL between browser and VBI View components. To configure the SSL properly, kindly have a proper valid SSL certificate from an authorized vendor in.crt format. This public certificate should be provided in <certificate_name>.crt and private key in <certificate_name>.key file format. If the customer wishes to use the organization s own self signed SSL certificate, then necessary steps have to be taken to add the certificate in the trusted certificate key store in all client machine. Making this self-signed certificate as a trusted certificate in all browsers is out of the scope of this documentation. VBI View recommends having a valid SSL certificate to properly secure the connection. Enable the SSL by checking the checkbox. After enabling the SSL, use the file selection browse button to select the files (private.key and public.crt files) and then click continue for the next section. Important Note: If you are going to configure SSL, please make sure that VBI View Web and VBI View Agents and its respective BI platforms should be also configured with proper SSL. You cannot access http content from the https protocol. Browser will throw the mixed content error, if you try to access http content from the https URL Elastic Search Section This section helps to configure the connection details of the Elastic Search which is pre-installed with the VBI View Server. VBI View Installation Guide P a g e 12 of 42

13 Type Purpose Description URL Username Password Index Provide the URL to reach the elastic search server Username of the Elastic search which is provided in the Elastic Search user configuration section of the installer Password of the user which is provided in the Elastic Search user configuration section of the installer Name of the index under which all the metadata needs to be stored It is always recommended to use the https version and its format is https port>/elasticsearch. Default port is If http is desired, then the format is http port>/elasticsearch. Default port is 9080 Default username : esadmin Default index : vbiview Mail Connection Section This section helps to configure the mail server connection details. Mail server connection will be used to send s from Smart Search feature of VBI View. Type Purpose Description Server Mail Server host name Ex: smtp.office365.com Port Encryption Sender Password Port which should be used to connect with mail server Encryption type that needs to be used Sender address. s generated by Smart Search will use this address in From Sender address password Default value : 567 Default Encryption : TLS After configuring all this section, press save and continue to start configuring Instances. VBI View Installation Guide P a g e 13 of 42

14 Instances Tab Instances tab is used to configure VBI View Server Instances and at least one instance is required to run VBI View Server. To add new instance press, Add New Instances button in the top right corner to launch New form. In that form, provide name of the instance and the port number at which the Instance will need to run. To delete an instance press trash icon for that instance. To start the instances press the play button for that instance. To stop the already started instances, press the stop button for that instance. To restart the instance, press the reload icon for that instance. With the adding of instances, configuration of VBI View Server is completed. To verify the configuration, kindly follow the next section Post Configuration Steps To verify the successful installation and configuration of VBI View Server, perform the following steps. Open any browser in the server. If SSL is enabled, go to URL If SSL is not enabled, go to URL The webpage with the message Welcome to VBI View as shown in the figure below should appear. Figure 3.2: VBI View Server Verification Screen If the above webpage is seen, then VBI View server installation and configuration is successfully completed. The next component to be installed is, VBI View Web, which is explained in the section Troubleshooting Steps If you didn t get the webpage response then kindly follow the steps below to troubleshoot on your own. Verify whether the instance is in running state in Configuration Utility. Open the log files which could be found in <installation folder>/server/log/<instance_name>.log Check the log files for any errors. VBI View Installation Guide P a g e 14 of 42

15 If you have enabled SSL, verify whether you have valid SSL certificate. Check the logs for any SSL certificate error. If there is SSL certificate error, Server instance will fall back to http. You could verify by visiting the http URL Verify any Database connection errors have occurred in log. Change the log level to Info in configuration utility and try to restart the server instance. After that check whether any errors have occurred in the log. If you are not able to successfully connect the server after following this steps, kindly contact the VBI View Support Team by raising ticket in the support portal or by sending to with the supporting log files with the logger level set to Info. 3.2 VBI View Web Installation Installation of VBI View Web Follow the steps below to install and configure the VBI View Web. Kindly make sure whether you have installed VBI View Server and configured at least one instance of VBI View Server in running state. 1. Double Click on the VBIViewWeb windows-installer.exe file to start the installation process. 2. Click Next in the startup page. 3. Read through the license terms and conditions. To proceed further accept the license terms and click next to continue. 4. In the next screen provide the DNS resolvable URL and port details of VBI View Server instance. 5. In the next Component Selection screen, select VBI View Web with NGINX if you prefer the bundled NGINX webserver. If you have your own webserver then select VBI View Web without NGINX component. You cannot select both the components. 6. In the Directory Selection screen, choose the directory to install VBI View Server. The default directory is C:\Program Files\Visual BI Solutions\VBI View\VBIViewWeb. If you have chosen VBI View Web without NGINX version, then kindly make sure that you choose the web root directory of your webserver. For example in Apache the directory should be <Apache installation directory>/htdocs. In Nginx the directory should be <Nginx Installation directory>/html 7. If you have chosen bundled NGINX webserver to be installed you will be shown a NGINX port details screen. Accept the default port or else provide your own port details. 8. The next screen provides details of installation. Clicking next button will start to install the VBI View Web with all the selected components. 9. Kindly wait for the installation to finish. After successful installation, the final screen provides options to Open Readme file You have successfully installed and configured the VBI View Web in your server. As of now, VBI View Web has been configured with basic default configuration. If you want to do advanced configuration, kindly follow the next section of the document VBI View Web Configuration VBI View Web has been configured with default basic configuration in the installer phase itself. There is no need for other configuration required for normal working of http version of VBI View Web. But if there is additional SSL configuration or to change the configuration that you need, kindly follow the section below Changing VBI View Server URL Details VBI View Web will be configured with provided URL details of VBI View Server in the installation step number 4. But if you want to change the configuration for any reasons, then you need to follow the steps below. VBI View Installation Guide P a g e 15 of 42

16 Open the config.json file in administrator mode. If you have installed the bundled Nginx version of VBI View Web, then the config.json file could be found in the <installation folder>/nginx/nginx/html/. If you have installed the nonbundled version of VBI View Web, then the config.json file could be found in the <installation folder>/. Replace the host with the desired URL of VBI View Server URL. Please note that the URL should be DNS resolvable and it should be accessible for all client machines. Replace the port with the desired VBI View Server port. Save the file. There is no need for restarting the server. Make sure that the client browser cache has been cleared or restart the client browser for the new configuration to take effect SSL Configuration If you have installed VBI View Web without Nginx, then configuring SSL will be out of the scope for this documentation. If you have installed VBI View Web with Nginx, then follow the steps below to properly configure SSL. By default the bundled Nginx will contain the self-signed SSL certificate issued to example.com. Kindly have the proper SSL certificate from the authorized vendor in.crt format and key file. You can also have your own Self-Signed SSL certificate, but you need to make sure that certificate to a trusted certificate store by following the configuration steps provided by the particular browser which is out of scope for this document. VBI View recommends to have the proper SSL certificate from the authorized vendor. To start with rename the SSL files to the required names. The XXXX.crt file should be renamed to server.crt file and the XXXX.key file should be renamed to server.key. Take backup of the server.crt and server.key files which could be found in the folder location <installation_folder>/vbiviewweb/nginx/nginx/conf. In case of any failure in SSL configuration, we will need this file to bring back the server to normal working condition. Now replace these files with your own SSL files. Nginx Server needs to be restarted for the configuration to take effect. For restarting the Nginx server, open manager-windows.exe file in administrator mode which could be found in the location <installation_folder>/vbiviewweb/nginx/ In that application, select Manage Server tab, select Nginx server and click restart button. Wait for the server to get restarted. If there is any problem in restarting server, check the log files for the errors which could be found at <installation_folder>/vbiviewweb/nginx/nginx/logs/ If you couldn t trouble shoot the errors, kindly replace the old SSL file with the new one and restart the server. If the server starts successfully, then the problem will be mostly with the SSL file. Kindly verify the SSL certificate format and have a proper SSL format. If you continue to have the problem, you could raise the support ticket in support portal or by sending to support@visualbi.com with supported log files and error images. Important Note: If you are going to configure SSL, please make sure that VBI View Server and VBI View Agents and its respective BI platforms should be also configured with proper SSL. You cannot access http content from the https protocol. Browser will throw the mixed content error, if you try to access http content from the https URL Post Configuration Steps To verify the successful installation and configuration of VBI View Web, perform the following steps. Open any browser in the server. If SSL is enabled, go to URL View Web full URL> VBI View Installation Guide P a g e 16 of 42

17 If SSL is not enabled, go to URL View Web full URL> The webpage with the VBI View login page as shown in the figure below should appear. Figure 3.3: VBI View Web Verification Login to VBI View with the default administrator username: vbiview, default password: password, select authentication method as Native and click Login button. If there is no Native authentication method in the dropdown box or the error connecting to backend error message is shown, follow the troubleshooting steps provided in the next section. In the next change password screen, kindly change the default password. The next screen will be initial profile settings screen, provide the necessary details and save the profile settings. On saving the profile settings, you will be provided with the admin dashboard. On finishing these steps, you have successfully installed and configured VBI View Web. You can skip the troubleshooting section and start installing the required Agents. If you are struck at any stage of this verification steps, kindly follow the troubleshooting steps provided in the next section Troubleshooting Steps If you didn t get the webpage response as shown in the figure number 3.3, then kindly follow the steps below to troubleshoot on your own. If you are trying with https version of URL, make sure that the VBI View Server is also configured with SSL properly. You cannot have VBI View Web in https and VBI View Server in http protocol. Mixed content error will be thrown by the browser, if you try to mix these two protocols. VBI View Installation Guide P a g e 17 of 42

18 Verify whether the VBI View Web server machine is reachable by using ping test from the command prompt. If you see the webpage response with the Error Connecting to Backend error message, then open new tab in the browser and type the VBI View Server URL which has been configured during the installation step number 4. You should see the webpage with the message Welcome to VBI View as shown in the figure 3.1. If you couldn t get that page, then check whether the VBI View Server machine is reachable by doing ping test from the command prompt. Also check whether the URL is resolvable with your DNS settings. Check the firewall or antivirus for rules which may block the VBI View Web and VBI View Server incoming and outgoing connections. Open the browser console by pressing F12 and check for any mixed content error or insecure response error. If you are using Self Signed SSL certificate, make sure that the SSL certificate has been added to trusted certificate store, to avoid insecure response error. If you are not able to successfully connect the VBI View Web after following this steps, kindly contact the VBI View Support Team by raising ticket in the support portal or by sending to support@visualbi.com with the supporting log files and images. 3.3 VBI View Agents Installation This section is applicable and same for all the agents which are being released and supported by VBI View. Download the required agents from product downloads page Installation of VBI View Agents Follow the steps below to install and configure the VBI View Agents. 1. Double Click on the <desired agent name>agent windows-installer.exe file to start the installation process. 2. Click Next in the startup page. 3. Read through the license terms and conditions. To proceed further accept the license terms and click next to continue. 4. In the Directory Selection screen, choose the directory to install VBI View Server. The default directory is C:\Program Files\Visual BI Solutions\VBI View\<installing agent name>agent. 5. On clicking next you will be shown Agent port details screen. Accept the default port or else provide your own port details. Make sure that the given port is free and not used by other applications. Kindly make note of these port, since you will need these port details while configuring the agent which can be found at VBI View Administration Guide, section step number The next screen provides details of installation. Clicking next button will start to install the VBI View Agent. 7. Kindly wait for the installation to finish. After successful installation, the final screen provides options to Open Readme file You have successfully installed VBI View Agent in your server. Repeat all the above steps to install other required agents. Proceed to next section for configuring the agent, after finished installing all the required agents VBI View Agent Configuration SSL Configuration VBI View Agents will communicate with VBI View Server and Web via REST API connection. For configuring these REST connections to https, kindly follow the steps below. This step is common for all the agents except BOBJ Agent. For BOBJ Agent proceed to next section. Kindly have the proper SSL certificate from the authorized vendor in.crt format and key file. You can also have your own Self-Signed SSL certificate, but you need to make sure that certificate to a trusted certificate store by following the configuration steps provided by the particular browser which VBI View Installation Guide P a g e 18 of 42

19 is out of scope for this document. VBI View recommends having the proper SSL certificate from the authorized vendor. Open the manager.ini file in edit mode with administrative privileges. File location in <installation location>. Change the SSL property from False to True and save the file Copy paste the SSL files to the SSL folder found in the <Agent Installation Folder>/SSL Rename the file <your name>.crt to public.crt and <your name>.key to private.key Restart the agent service manager by going into services.msc. The service name will be VBI<Agent name>sm. For example for tableau agent the service name will be VBITableauSM Now the SSL has been configured successfully SSL Configuration for BOBJ Agent For BOBJ Agent, the SSL certificates also need to be in.jks format which is Java Key Store format apart from.crt format. Open the manager.ini file in edit mode with administrative privileges. File location in <installation location>. Change the SSL property from False to True and save the file Rename the file <your name>.crt to public.crt and <your name>.key to private.key Copy paste the SSL files to the SSL folder found in the < BOBJ Instance installation location >/SSL Import the SSL Certificate and key into the Java KeyStore. Make sure that the Java KeyStore file generated is in the name BOBJ_Keystore.jks Place the generated file in the SSL folder under the location <BOBJ Instance installation location>/ssl Enter the appropriate password of the generated KeyStore file in the SSL Password field in the manager.ini file. This must be given after the SSL field. Example : SSL Password = password of the keystore.jks Restart the agent service manager by going into services.msc. The service name will be VBIBOBJSM. Now the SSL has been configured successfully for BOBJ Agent Advanced Agent Configuration By default agent will be configured with the basic default configuration and port number given during the installation process. If you want to change any property of the agent, you can change it by editing the manager.ini file. Open the manager.ini file in edit mode with administrative privileges. File will be located in <agent installation location>/.change the required property to the desired value. Save the file and restart the agent service manager by going into services.msc. The service name will be VBI<Agent name>sm. For example for tableau agent the service name will be VBITableauSM BI Platform Configuration After installing agent, an agent instance needs to be created. For this step, please refer to the section in VBI View Administration Guide. After this, each BI Platform needs to be configured to make the trusted connection between respective VBI View Agent and its BI Platform. Kindly follow the steps given below to configure the BI Platform properly BOBJ Platform Configuration 1. BOBJ Agent uses Trusted Secret Key file mechanism to authenticate itself with the BOBJ. For this we need to generate and download the Trusted Secret Key for BOBJ authentication. Kindly follow the steps below Login to the BOBJ CMC In the Central Management Console Screen, select Authentication from the top down list. VBI View Installation Guide P a g e 19 of 42

20 Select Enterprise from the menu list. Next scroll down to the Trusted Authentication segment and enable the checkbox Trusted Authentication is enabled. Next select New Shared Secret and click Download Shared Secret. The TrustedPrinciple.conf will get downloaded. This file must then be copied to the <agent installation location>/trusted/ directory. 2. Next, we need to disable the CORS settings by editing the crossdomain.xml file. Location of the crossdomain.xml file: <Business Objects installation directory>\tomcat55\webapps\root\. Change the following section. VBI View Installation Guide P a g e 20 of 42

21 <?xml version="1.0"?> <!DOCTYPE cross-domain-policy SYSTEM " -<cross-domain-policy> <allow-http-request-headers-from secure="true" headers="*" domain="*"/> <allow-access-from secure="true" domain="*"/> </cross-domain-policy> Save the file after making changes and proceed to the next step. 3. Next we need to make the dashboards and reports in iframe compatibility (Web standards). Create a folder 'w3c' in <Business Objects Installation directory>\tomcat55\webapps\>. Create file p3p.xml in the folder with the following code in it. <META> <POLICY-REFERENCES> <POLICY-REF about="/w3c/policy.xml"> <INCLUDE>/</INCLUDE> <COOKIE-INCLUDE/> </POLICY-REF> </POLICY-REFERENCES> </META> Save the file and restart the Apache Tomcat server BOBJ REST BI Platform Configuration Launch Central Management Console. Go to Authentication Enterprise. VBI View Installation Guide P a g e 21 of 42

22 Under Trusted Authentication, check the box against Trusted Authentication is enabled. Choose New Shared Secret. This will generate the shared secret key. VBI View Installation Guide P a g e 22 of 42

23 Choose Download Shared Secret and then Update. Copy the downloaded file TrustedPrincipal.conf to <INSTALLDIR>\SAP BusinessObjects Enterprise XI 4.0\java\pjs\container\bin in Windows. Copy the downloaded file TrustedPrincipal.conf to <INSTALLDIR>\SAP BusinessObjects Enterprise XI 4.0\win64_x64\ and <INSTALLDIR>\SAP BusinessObjects Enterprise XI 4.0\win32_x86\ Next in CMC go to Servers -> Core Services -> WebApplicationContainerServer VBI View Installation Guide P a g e 23 of 42

24 Now right click that WACS services and then select properties. In that properties, under Trusted Authentication Configuration set Retrieving Method as 'HTTP_HEADER' and User Name Parameter as 'X-SAP-VBI-TRUSTED-USER' or some other name that you want. Kindly note this parameter name since it will be needed for BOBJ REST Agent creation step Tableau Platform Configuration Follow the steps below to configure the tableau system. 1. Click the Start button, and select All Programs > Accessories > Command Prompt. Right-click Command Prompt and select Run as administrator. 2. To enable the trusted host run the following commands in the command prompt. IP address or host name of the Tableau agent Server machine should be given in the place of <trusted IP addresses or host names> cd "<Tableau Server Installation Location>\Tableau\Tableau Server\<version>\bin" tabadmin stop tabadmin set wgserver.trusted_hosts "<trusted IP addresses or host names>" tabadmin config tabadmin start 3. To disable clickjack protection run the following commands in the command prompt VBI View Installation Guide P a g e 24 of 42

25 cd "<Tableau Server Installation Location> \Tableau\Tableau Server\<version>\bin" Run the following commands, in order: tabadmin stop tabadmin set wgserver.clickjack_defense.enabled false tabadmin config tabadmin start QlikSense Platform Configuration Below are the steps to generate certificates Log in to Qlik Sense QMC as an administrator. In the left side menu bar click Certificates menu under the configure system menu sections. Certificate generation form opens. Click on Add machine name to which the certificate needs to be generated. In the export file format for certificate dropdown, select platform independent PEM-format. Fill in other additional optional fields, but it s not necessary. Click export certificate button in the bottom. VBI View Installation Guide P a g e 25 of 42

26 The certificate will be generated and will be exported to the location shown in that form itself. Now copy and paste that certificates to the agent installed machine into the directory <installation location>/trusted directory PowerBI Platform Configuration We need to Setup the application in Azure Active Directory This application will be the communication point for the PowerBI Agent. All calls to the Microsoft API's will be made on behalf of this application. This guideline assumes that the user has a tenant in Azure. If the tenant is not present, please refer to for steps to acquire a tenant. Please contact the Active Directory Administrator to do the steps since some actions will require administrator consent. There are 3 main steps: Set up the Application in Azure. Go to Navigate to Azure Active Directory and select App Registrations Click on New Applicant registration. VBI View Installation Guide P a g e 26 of 42

27 Figure 3.4: Azure Application setup Set the name, type and redirect URI of the application. The type should be Native and the Redirect URI must be formatted as follows: Once the data is entered, click on Create. This URI should reflect the PowerBI Agent machine hostname or public IP address and the port at which the new agent instance needs to be created. VBI View Installation Guide P a g e 27 of 42

28 Figure 3.5: Application Registration Note the Application ID upon successfully registering the application. VBI View Installation Guide P a g e 28 of 42

29 Provide this under the key "CLIENTID" in the config.json file in the PowerBI agent. To verify the Redirect URI, Click on the application and go to Settings. Select Redirect URI. The URI given during create will be reflected here. VBI View Installation Guide P a g e 29 of 42

30 Figure 3.6: Settings page & Redirect URI Create the Application Secret. Open the application in Azure Portal. Navigate to All Settings Keys and create a new key. Specify a desired value for the key name and note down the value provided. Figure 3.7: Application Key setup Note that, this value will be displayed only once and will not be displayed again after we close the blade. This value will be the CLIENTSECRET in the config.json file of Power BI Agent. If failed to note down the value, please repeat step two to create a new key. Configure Permissions for the Application The application requires some permission to do the actions on behalf of the user. Click on the application and go to settings required permissions. Click on Add. Map the permissions for the API's referring to the table below for Microsoft Graph API, Windows Azure Active Directory API and Microsoft Power BI API. VBI View Installation Guide P a g e 30 of 42

31 API Microsoft Graph Permissions View Users Basic Profile View Users Address Read All Groups Microsoft Azure Active Directory Power BI Service Read Directory Data Read All Groups Read all users' basic profiles Sign in and read user profile View all Dashboards (preview) View all datasets Read and write all datasets View content properties (preview) View all Reports (preview) View all groups View users groups Read and write all reports Table 3.1: Permissions to be given Click Save. Upon granting the permissions, click Grant Permissions to delegate the permissions to the service account. Figure 3.8: Permissions File BI Platform Configuration For this, you just have to create a share drive and a service account which has full rights to access that drive folder. Moreover to give permissions for each user, kindly give read permission to each user. Other than these, there are no other special configurations needed for the File BI. VBI View Installation Guide P a g e 31 of 42

32 SSRS Platform Configuration For SSRS BI Platform, create a service account for accessing the SSRS database. Service account should have the role/permissions of DB_DATAREADER assigned to it. It should have authentication method of SQL User with Login Spotfire Platform Configuration Spotfire requires external authentication to be enabled to work with VBI View. Copy all the files from <spotfire installation location>/ext_auth/ directory and paste that to tibco\tss\tomcat\lib\webapps\spotfire\web-inf\lib. In Spotfire configuration utility, to enable Spotfire Server to use the custom Java authentication filter, set the type in the external authentication to Authentication Filter. With the external authentication set to Authentication Filter, the Filter class in the authentication filter configuration is set to vbi.spotfireagent.vbiextauthenticator. Service account needs to be created for this agent and that account should have the role of API User, Impersonator. VBI View Installation Guide P a g e 32 of 42

33 Restart the server for the changes to take place Microstrategy Platform Configuration To access MicroStrategy reports through VBI View, SSO should be configured and enabled in the MicroStrategy Platform as the only authentication mode. The following steps are to be followed to achieve the same: Mapping Windows AD users: In MicroStrategy Developer, select a user group under Administration > User Manager, right click on each user and select Edit VBI View Installation Guide P a g e 33 of 42

34 Go to Authentication > Metadata and select the corresponding Windows AD user in the Link Windows user section Create a Group Policy object for Internet Explorer: In the Group Policy Management, go to User Configuration > Administrative Templates > Windows Components > Internet Explorer > Internet Control Panel > Security Page > Site to Zone Assignment List and Enable Site to Zone Assignment list as in the screenshot VBI View Installation Guide P a g e 34 of 42

35 Click on the show button and add MicroStrategy Server URL in Value Name and 2 in value to mark it as a trusted Server In Windows Control Panel > Internet Options >Advanced, check Enable Integrated Windows Authentication VBI View Installation Guide P a g e 35 of 42

36 In MicroStrategy Web Administrator > Default Properties, Enable the Windows Authentication and make it default and uncheck all the other login mode and change the Trusted Authentication Providers to Custom SSO Restart the server for the changes to take place. Note : It is recommended to do the above configuration in IIS Server Post Configuration Steps After successfully configuring the agent and its respective BI Platforms, you can verify it by following the below steps. Open browser and navigate to If you have configured agent with SSL, use https instead of http. You should see the screen as shown in the figure below. VBI View Installation Guide P a g e 36 of 42

37 Figure 3.9: Agent Success Screen If you didn t get the success screen, kindly follow the troubleshooting steps given below Troubleshooting Steps Verify whether the instance is in running state in Agent Instance Manager in VBI View Web. Open the log files which could be found in <installation folder>/log/<instance_name>.log Check the log files for any errors. If you have enabled SSL, verify whether you have valid SSL certificate. Check the logs for any SSL certificate error. If there is SSL certificate error, Server instance will fall back to http. You could verify by visiting the http URL Verify any BI Platform connection or authentication errors have occurred in log. Change the log level to Info in manager.ini and try to restart the agent service manager. After that check whether any errors have occurred in the log. If you are not able to successfully connect the server after following this steps, kindly contact the VBI View Support Team by raising ticket in the support portal or by sending to support@visualbi.com with the supporting log files with the logger level set to Info. 3.4 Synchronization of VBI View and BI platforms Congratulations! You have successfully installed and configured VBI View V The next step is to synchronize VBI View with Users from Microsoft AD/LDAP/BI platform and Reports from BI platforms. Details of these steps are available in Section:3 Getting Started and Section:4 Admin Functions in VBI View_Administrator Guide V1.5 VBI View Installation Guide P a g e 37 of 42

38 4 Upgrade trial version of VBI View The user can upgrade the trial version to either the production version or extend the trial period. 4.1 Upgrade from Release 2 to Release 3 Perform the steps provided below to upgrade VBI View from to Download latest version from S3. 2. Double click on the installer. It automatically detects that a version is already running and will upgrade to the new version when clicked on Next. 4.2 Upgrade from trial to production Follow the steps below to upgrade from trial to production: 1. Contact Visual BI support team (support@visualbi.com) by raising a ticket to upgrade the trial version. 2. The support team will work on trial to production license upgrade and send a confirmation upon successful upgrade. 3. The application can be checked for the updated license. 4.3 Extend the trial period Follow the steps below to extend the trial period of VBI View application: 1. Contact Visual BI support team (support@visualbi.com) and raise a ticket requesting for an extension in trial period with a valid reason. 2. Note that the trial period will be extended only if the reason for the extension is valid. 3. The support team will work on extending the trial and send a confirmation VBI View can be used with the extended trial period. VBI View Installation Guide P a g e 38 of 42

39 5 Moving VBI View instance from one server to another VBI View Instance can be moved from one server to another by following the steps below: 1. Uninstall the entire application in the existing server by following the steps given under the Section 6 Uninstallation of VBI View. 2. The next step is to Install the application in the other server again by following the steps given under the Section 3 Installation of VBI View VBI View Installation Guide P a g e 39 of 42