BIOVIA Insight Installation Guide
Total Page:16
File Type:pdf, Size:1020Kb
INSTALLATION GUIDE BIOVIA INSIGHT 2019 Copyright Notice ©2018 Dassault Systèmes. All rights reserved. 3DEXPERIENCE, the Compass icon and the 3DS logo, CATIA, SOLIDWORKS, ENOVIA, DELMIA, SIMULIA, GEOVIA, EXALEAD, 3DVIA, 3DSWYM, BIOVIA, NETVIBES, IFWE and 3DEXCITE, are commercial trademarks or registered trademarks of Dassault Systèmes, a French "société européenne" (Versailles Commercial Register # B 322 306 440), or its subsidiaries in the U.S. and/or other countries. All other trademarks are owned by their respective owners. Use of any Dassault Systèmes or its subsidiaries trademarks is subject to their express written approval. Acknowledgments and References To print photographs or files of computational results (figures and/or data) obtained by using Dassault Systèmes software, acknowledge the source in an appropriate format. For example: "Computational results were obtained by using Dassault Systèmes BIOVIA software programs. BIOVIA Insight was used to perform the calculations and to generate the graphical results." Dassault Systèmes may grant permission to republish or reprint its copyrighted materials. Requests should be submitted to Dassault Systèmes Customer Support, either by visiting https://www.3ds.com/support/ and clicking Call us or Submit a request, or by writing to: Dassault Systèmes Customer Support 10, Rue Marcel Dassault 78140 Vélizy-Villacoublay FRANCE Contents Chapter 1: Introduction 1 Documentation 1 Additional Information 1 Chapter 2: New Installation 2 General Requirements 2 Installation Steps 2 Installing BIOVIA Pipeline Pilot 2 Installing and Configuring BIOVIA Foundation Hub 2 Installing BIOVIA Insight 3 Configuring BIOVIA Foundation Hub Permissions 4 Installing MongoDB 4 Configuring Data Sources (IDS) for Query Service 4 Migrating Custom Authentication Data 5 Chapter 3: Migrating Data 6 Prerequisites for Migrating Data 6 Introduction to Data Migration 6 Admin Configuration Required Before Using Insight 7 Migrating in Place 7 Migrating from a Remote Database 7 Verifying the Data Migration 7 Chapter 4: Upgrading BIOVIA Insight 8 Upgrade Steps 8 Upgrading Pipeline Pilot 8 Installing and Configuring BIOVIA Foundation Hub 9 Upgrading BIOVIA Insight 9 Chapter 5: Configuring Your Databases for Backup and Recovery 10 Chapter 6: Final Validation 11 Searching 11 Developing Plugins 12 Chapter 7: Internationalization 13 Configuring Fonts 13 BIOVIA Insight • Installation Guide | Page i Chapter 1: Introduction BIOVIA Insight allows scientists to query or browse their database, visualize the results and refine and share them as needed, and makes data available to other applications. This guide provides information on the installation of Insight. Documentation The following documents are supplied with Insight: Insight Installation Guide Insight System Requirements Other useful guides that administrators can refer to are included with Pipeline Pilot: BIOVIA Pipeline Pilot Server Installation Guide BIOVIA Pipeline Pilot Client Installation Guide BIOVIA Pipeline Pilot Admin Portal Guide BIOVIA Foundation Hub Installation and Configuration Guide BIOVIA Query Service Administration Guide IMPORTANT! <pps_install> is the root of the Pipeline Pilot installation. On Windows this is typically: C:\Program Files\BIOVIA\PPS On Linux this depends on the location of your Pipeline Pilot installation, but may be: [Home]/BIOVIA/PPS Note: While this product contains features to facilitate GDPR compliance, you, the Customer, are solely responsible and liable for the access to and the use of this product. Therefore, it is your responsibility to ensure that the deployment is GDPR compliant, including provision of a suitable Data Privacy Policy. Additional Information For additional information about BIOVIA Insight and other Dassault Systèmes applications, visit the Dassault Systèmes Support site: https://www.3ds.com/support/ Introduction | Page 1 Chapter 2: New Installation General Requirements BIOVIA recommends using several servers within local network proximity for Insight: 1. A BIOVIA Pipeline Pilot 2019 server with the Insight 2019 application package installed 2. An Oracle Database server 3. A MongoDB server 4. (Optional) A BIOVIA machine for developing protocols or widgets. This development machine must be configured to connect to the Pipeline Pilot server if it is not on the same machine as Pipeline Pilot server. Installation Steps Perform the following steps to install Insight: 1. Installing BIOVIA Pipeline Pilot 2. Installing and Configuring BIOVIA Foundation Hub 3. Installing BIOVIA Insight Application 4. Installing MongoDB 5. Configuring Data Sources (IDS) for Query Service 6. Migrating Custom Authentication Data 7. Migrating Data 8. Performing a Final Validation Note: If you are upgrading from a previous version of Insight, refer to the Upgrading to Insight 2019 section for more information. Installing BIOVIA Pipeline Pilot To install Pipeline Pilot 2019, see the Pipeline Pilot Server Installation Guide. For a production install, see the Pipeline Pilot 2019 Installation and Configuration Guide. The Pipeline Pilot 2019 documentation is available with the Pipeline Pilot installation artifacts. Installing and Configuring BIOVIA Foundation Hub Insight must be used with BIOVIA Foundation Hub. Foundation Hub enables interoperability between different BIOVIA applications, common resource management, and single-sign on. If you are installing Insight for the first time, install Foundation Hub before Insight. To install and configure BIOVIA Foundation Hub, see the BIOVIA Foundation Hub Installation and Configuration Guide. Page 2 | BIOVIA Insight • Installation Guide At the end of the configuration process: The BIOVIA Foundation Hub server should be running as a service. The BIOVIA Foundation Hub should be connected to an Oracle database to store its data. The BIOVIA Foundation Hub should be connected to your Pipeline Pilot server for authentication. Your Pipeline Pilot server should have a Foundation Hub connection configured in the Pipeline Pilot Admin Portal. Installing BIOVIA Insight Install the Insight 2019 application package. 1. Obtain the following: Documentation: Insight_2019_Documentation.zip Windows: Insight2019_Win64.zip Linux: Insight2019_Linux64.tgz 2. Extract the installation archive for your operating system: Windows: Insight2019_Win64.zip Linux: Insight2019_Linux64.tgz tar -xpvzf Insight2019_Linux64.tgz 3. Run the application installer: Windows: a. Verify there are no users in Pipeline Pilot 2019, and that there are no jobs running. b. In the bin folder of the unzipped directory, rght-click scitegicsetup.exe and choose Run As Administrator. c. Verify that the installer has located the installation of BIOVIA Pipeline Pilot 2019. d. Click Add/Remove Products. e. If the Confirm Your License screen does not display the message 'The existing license file is valid', browse to your license file. Click Next. f. In the 'Select product(s) to install' screen, ensure that Insight is checked. Click Next. g. Stop the Pipeline Pilot services if they are running. h. In the next screen, verify the HTTP and HTTPS ports are correct, and edit the ports if needed. i. Click Next to confirm the product(s) to install. The installation will proceed. j. If your Apache Web Server must be run under a named user account, enter that account in the 'Confirm Apache Login' screen. Alternatively, you can change it later, after the installation has finished. k. Click Next. You should see the message 'Completed', followed by 'The actions you have selected have been applied'. Optionally, you can open the BIOVIA Pipeline Pilot Server 2019 Home Page. Click Finish. Linux: a. Run the installer in the bin extracted folder as a non-root user by running sciinstall. b. When a message informs you that the operating system is supported, enter y to continue. c. At the prompt "Enter the target directory for the server installation", enter the directory where your Pipeline Pilot server is installed. This is the <pps_install> directory referenced in the Pipeline Pilot Server Installation Guide. New Installation | Page 3 d. Confirm the path for your Pipeline Pilot server installation. If the path is not correct, enter n, correct the path, then continue. e. You will be prompted regarding your license file. If the license file is valid, press Enter to continue. f. Verify that Insight is listed as an application to be installed, then press Enter to continue the installation. g. At the end of the installation, when prompted to start the Pipeline Pilot server service, press Enter. h. Verify that the Tomcat service started successfully and the installation has completed. 4. During installation, specify the location of your Pipeline Pilot 2019 server installation, and ensure that the Insight application is checked. To propagate Insight-specific settings from Pipeline Pilot to the BIOVIA Foundation Hub: 1. Go to your BIOVIA Pipeline Pilot Server Home Page. 2. Under the Administrators section, go to the Admin Portal. 3. Under Admin Pages, go to Reports > Foundation Applications. 4. Under Registered Applications, click Update Applications. Configuring BIOVIA Foundation Hub Permissions The user who runs the Insight data migration wizard must be a member of the following groups: Insight/Administrators List Management/Administrators Platform/Administrators Foundation/Administrators To manage a group in the BIOVIA Foundation Hub, see Administering users, external claims, groups, and permissions in the BIOVIA Foundation Hub Admin Guide. Installing MongoDB To install MongoDB