Version 19.4 Installation Guide 1 Bocada Installation Guide
Copyright 2019 Bocada LLC. All Rights Reserved. Bocada and BackupReport are registered trademarks of Bocada LLC. Vision, Prism, vpconnect, and the Bocada logo are trademarks of Bocada LLC. Other product names mentioned herein may be trademarks or registered trademarks of their respective companies. Protected by U.S patents 6,640,217; 6,708,188; 6,745,210; 7,457,833; 7,469,269; 7,496,614; 8,407,227 The material in this manual is for information only and is subject to change without notice. While efforts have been made to ensure accuracy, Bocada LLC assumes no liability resulting from errors or omissions in this document, or from the use of information contained herein. Bocada LLC reserves the right to make changes in the product design and documentation without reservation and without notification to its users. 2 Bocada Installation Guide
Contents Introduction... 4 Pre-Installation Checklist... 4 Minimum System Requirements... 4 Hardware... 4 Supported Browsers... 5 Regional Settings... 5 SQL Server... 6 Data Collection Server... 6 Application Server... 7 Firewall Port Requirements... 9 Pre-installation... 10 Download Latest Version... 10 Planning... 11 Hardware and Software Requirements... 12 Release Notes... 12 License Key... 13 Installation... 13 Data Collection Service... 14 Application Server... 23 Configure HTTPS Certificate... 30 Deploying the Certificate... 30 Upgrade... 31 Accessing the Application... 32 Adding Bocada License... 33 General Settings... 34 Technical Support... 35 Appendices... 36 Appendix A: Database Troubleshooting... 36 Appendix B: Windows Services and User Management... 37 Appendix C: Website Setup... 38 Appendix D: Windows Server Roles & Features... 40 3 Bocada Installation Guide
Introduction This document describes the requirements and instructions for installing Bocada. Please discuss Bocada configuration options with your Bocada Sales or Support Engineer should you need further clarity. You will need at minimum one Windows Server which will host: Microsoft SQL Server Bocada Data Collection Services Bocada Web Application running on Microsoft IIS Web Server Pre-Installation Checklist Detailed requirements for installation are in other sections of this document. Please use this checklist to verify that you are ready for the installation. Hardware/VM with adequate Disk, RAM, and CPU (see below for details) Windows with supported OS versions and settings (see below for details) Microsoft SQL Server installed Bocada server(s) added to the Windows Active Directory domain Service login to install and run the Bocada Services, including required SQL permissions SQL Server User with required credentials Microsoft IIS server role installed Firewalls open between Bocada components as needed Firewalls open between Bocada Data Collection Service(s) and backup servers. See Plugin Configuration Guides for details. Supported web browser (see below for details) Bocada Installation software Bocada license key (please contact sales@bocada.com regarding licensing) Minimum System Requirements The following describe the minimum required to run the Bocada product. Virtual servers are supported for the application and data collection servers. Hardware For an initial deployment of Bocada, the following are considered a minimum: 2 Cores/CPU 12 GB RAM 250 GB Disk space Bocada recommends that the SQL Server be placed on a server separate from where the Bocada software is installed for any long-term production deployment. 4 Bocada Installation Guide
Supported Browsers The following browsers are supported for use with this version of the Bocada application. Chrome (most recent version at time of release) Firefox (recent version at time of release) Internet Explorer (11.x, 10.x) When using Internet Explorer, IE Enhanced Security must be turned off for all Bocada reports to run properly. Internet Explorer versions prior to 10.0 are not supported, and some features will be unavailable. The most current version of Firefox and Chrome at the time of release are supported; older versions of these browsers may work as well but are not officially supported. Regional Settings The regional setting for the Application, Data Collection and SQL Servers must be set to English (United States) and the date format set to MM/DD/YYYY. Please check any Windows group policies that may govern this setting. 5 Bocada Installation Guide
SQL Server Software Microsoft SQL Server (Standard or Enterprise edition, not Express or Developer) versions: Microsoft SQL Server 2016 Microsoft SQL Server 2014 Microsoft SQL Server 2012 all SPs Microsoft SQL Server 2008 R2 SP1, SP2, SP3 Microsoft SQL Server 2008 SP2 SQL Server Notes: Do not create a database prior to installation. The Installer will create the Bocada database during installation of the Data Collection server. The following user credentials must have access to the SQL Server with db_creator or db_owner roles and assigned the dbo schema: - Windows Domain user logged in to the server when running the installer - SQL user entered into the installer if running services as Local System Data Collection Server Software Microsoft Windows Server 2016 Microsoft Windows Server 2012 R2 Microsoft Windows Server 2008 R2 Additional requirements.net 3.5 Framework.NET 4.5 Framework ASP.NET 3.5 and higher The Data Collection Server must be part of a Domain (not necessarily the same domain as the backup servers); application users (and various other features) leverage Active Directory Domain Services. 6 Bocada Installation Guide
Application Server Software Microsoft Windows Server 2016 Microsoft Windows Server 2012 R2 Microsoft Windows Server 2008 R2 Additional requirements.net 4.5 Framework Internet Information Services: IIS (latest supported version) Configured to use Windows Authentication Configured to allow IIS 6.0 metabase compatibility ASP.NET 3.5 and higher ASP.NET 2.0 set to Allowed The following Roles from Server Manager must be installed: Web Server: Common HTTP features (ALL) Web Server: Application Development (ALL) Web Server: Security (Basic and Windows Authentication) Management Tools: IIS Management Console Management Tools: IIS 6 Management Compatibility (IIS 6 Metabase Compatibility and IIS 6 Management Console) The following Features from Server Manager must be installed:.net Framework 3.5 Features (.NET Framework 3.5 (includes.net 2.0 and 3.0) and HTTP Activation).NET Framework 4.6 Features (.NET Framework 4.6, ASP.NET 4.6, WCF Services (TCP Port Sharing)) Please see Appendix D: Windows Server Roles & Features for screenshots of the Roles and Features for different versions of Windows Server. The Application Server must be part of a Domain, and should be within the same Domain as the Data Collection Server. Application users (and various other features) leverage Active Directory Domain Services. The Bocada Application Server must have SMTP connectivity to the mail server to send email. 7 Bocada Installation Guide
FIPS FIPS is a security measure that prevents proper operation of the Bocada application. Please ensure that FIPS is disabled on the Data Collection and Application servers and Windows group policy is configured accordingly. If FIPS is enabled it will cause failure of the Application Server installation when using SQL Authentication. Disable FIPS 1. Click Start > Run > type gpedit.msc and press Enter or click OK. 2. In the Local Group Policy Editor, under the Computer Configuration node, navigate to Windows Settings > Security Settings > Local Policies > Security Options, scroll down to System cryptography: Use FIPS-compliant algorithms for encryption, hashing, and signing. 3. If this setting is not already Disabled, double-click to open the dialog panel, select Disabled, and click OK. 8 Bocada Installation Guide
Firewall Port Requirements DCS and Application Server to Database Each Bocada DCS, and the Bocada Application Server, communicates with the SQL Server database using TCP/IP. The default port used by SQL instances is 1433, but this port is configurable and may have been changed. In addition, UDP port 1434 might be required for the SQL Server Browser Service if named instances are used. These ports should be opened in both directions. Service Protocol Default SQL Port Direction SQL Server TCP 1433 Both SQL Server browser UDP 1434 Both Bocada Application WCF Service When installing the Bocada Application and Data Collector on separate servers, the Windows Communication Foundation (WCF) port 8003 must be open on the firewall of the Application Server. The Data Collection Server must also allow outbound connections to the Application Server to connect to the WCF service. Service Protocol Default Port Direction WCF Application Server and Report Data WCF Application Server and Metadata Exchange Bocada Application IIS Web Server TCP 8003 HTTP 8002 Incoming (on Application Server) Outgoing (on Data Collection Server) Incoming (on Application Server) Outgoing (on Data Collection Server) The default web port in IIS is port 80. However, when installing the Bocada Application Server, it is possible to configure a different HTTP port for accessing the application; See IIS Configuration, below. Service Protocol Default Port IIS HTTP 80 9 Bocada Installation Guide
Backup Server Communication Additional ports that may be necessary to communicate to each Backup Server for data collection are listed in the respective Plug-in Configuration Guides for those backup products. Pre-installation Note: Please see the convenient Pre-installation Checklist at the top of this document. Download Latest Version Bocada can be downloaded via ftp with the username and password provided by your Bocada representative. Current documentation is available in the Docs folder at that location. Note: If your Bocada release zip file was downloaded using HTTP protocol instead of FTP, then your browser may have added a :Zone.Indentifier:$DATA stream to the zip file. This places a security block on the zip file, and when the contents of the zip file are unzipped they will also have this stream applied to them. To avoid this problem there are a couple of solutions: When the zip file is downloaded, right click on the file and select Properties. Click on the Unblock button to unblock the zip file. Unzip the contents of the zip file to another folder and the contents will not be blocked. 10 Bocada Installation Guide
Planning The planning area of the Bocada Software Installation consists of: Hardware and Software Requirements Release Notes Installation Guide (this document) 11 Bocada Installation Guide
Hardware and Software Requirements Run Hardware and Software Requirements to verify your system meets the minimum requirements. Any prerequisites not met will be indicated with a red X and must be addressed prior to installation. Requirements are detailed above in the Minimum System Requirements section. Release Notes Please read the current version Release Notes to learn about new features, enhancements, and any known issues. Click on the Release Notes link in the Setup Application to open the release notes. 12 Bocada Installation Guide
License Key The license key is provided by the Bocada Finance department. The following information is required: SQL Server Fully Qualified Domain Name (FQDN) SQL Instance name (default is no instance) SQL Port (default is 1433) Database Name (default is Bocada ) Note: The above information used to create the license key must match the environment exactly for data collection to function. If the SQL Server FQDN, Instance, or DB names are changed, contact Bocada Support. Installation Proceed with installation once the prerequisites have been met. The Bocada installation consists of two separate components: 1. Data Collection Service 2. Application Server Every installation requires at least one installed Data Collection Service which must be installed prior to the Application Server. The primary (master) Data Collection Service installation will create or upgrade the Bocada database required to run the application and any additional data collectors necessary for larger environments. Installation needs to be performed by a Domain Account with administrative privileges (minimum of Local Admin on the Data Collection server), and it should be noted that the Domain Account running the installer will be the only User initially added to the Bocada application. The installer will also install the Bocada Database (if one is not detected already), and so should have the db_creator role for the SQL server. Privileges may be reduced to db_owner after installation is completed. Note that the Default Schema for the user account performing the installation should be set to dbo in SQL Server. Important Note: Prior to installing the Data Collection Service as part of an upgrade, please confirm that you have backed up the database. If there are multiple Data Collection Servers, the first installation will become the Master Data Collection Server. Note: The Master Data Collection Server is retained in the Bocada database. If the Master DCS is to be renamed or moved, contact Bocada Support. 13 Bocada Installation Guide
Data Collection Service Installation Page Click Install Data Collection Service on the main installation page: 14 Bocada Installation Guide
Requirements Page Review the requirements for installation: When you have all necessary details for the SQL Server & instance, click Next. 15 Bocada Installation Guide
Data Collection Installer Verify Database Server Requirements 16 Bocada Installation Guide
License Agreement Carefully review and accept the terms of the license agreement then click Next. If you have questions or concerns regarding the license agreement, please cancel the installation and contact Bocada Support. Destination Folder Select Next to install to the default location or Change to a different destination: 17 Bocada Installation Guide
Service Login Enter the Windows User Domain Account credentials or select Local System Account, then click Next. Authentication Requirements Domain User Performing Installation If installing with Windows Authentication, then user requires access to the SQL Database Preferred for the installer to log in or use Run As with the windows domain user that will run the services Service Login Users Local System Account Requirements: Database connection requires SQL Authentication Master DCS and Application required on the same server Secondary DCS are not required to be the same authentication method Domain account: If different than account running installer, requires addition of services account to the Bocada Users view as an administrator Non-expiring password is recommended else risk of Data Collection failure If services Log on as user manually changed to a different Domain user after installation, must also have access to the Bocada database Secondary DCS are not required to be the same authentication method (e.g. they can use Local System account even though the maser uses a Domain account) 18 Bocada Installation Guide
Database Server Authentication Must have create database permission Can lower permission to db_owner after installation Default Schema must be dbo Confirm DBO Schema for Bocada SQL User The SQL User (using Windows or SQL Authentication methods) must have DBO as the default schema. This can be confirmed through SQL Server Management Studio: 1. Navigate to Security (instance level) --> Logins 2. Open the Login Properties window for that user (Right click the user --> select Properties) 3. Select User Mapping. 4. Verify that the Default Schema for that user is set to dbo. Database Server Enter the SQL Server fully-qualified domain name (FQDN), instance name (if any) and nonstandard port (if any), and database name, as specified in the Bocada license key. If you select Windows Authentication, the Bocada database will default to the domain account that is running the service. Then select Next. Database Server Notes: The Database Settings must match the Bocada license key and the primary (master) DCS Instance and Database exactly. 19 Bocada Installation Guide
If the environment variables for server, instance (and/or port), and database do not match that given for the license key, data collection will not function, and you will need to obtain a different license key through Bocada Support. The installation will attempt to connect to the Database. If authentication fails, the following error will be displayed: At this point the Database or Login settings must be verified. Please refer to Appendix A for troubleshooting information. Start Installation After confirming the intent to upgrade or for new installations click Install to begin installation. Installation Note: If the installer is unable to start the Bocada Data Collection Service, then it will need to be started manually. Please refer to Appendix B for troubleshooting assistance. 20 Bocada Installation Guide
Installing Installation Complete Once the installation is successful, you will be presented with an option to view the installation log. Select Show the Windows Installer log to view the installation log if desired, then click Finish. 21 Bocada Installation Guide
Clicking Finish will return the main installer where you can continue to the Application installation or close the installer to install the Application on another server. 22 Bocada Installation Guide
Application Server Installation Page Click Install Application Server on the main installation page: Requirements Page Review the requirements for installation: 23 Bocada Installation Guide
When you have all necessary details for the SQL Server & instance, click Next. Application Server Installer License Agreement Carefully review and accept the terms of the license agreement then click Next. If you have questions or concerns regarding the license agreement, please cancel the installation and contact Bocada Support. 24 Bocada Installation Guide
Destination Folder Enter a desired installation directory or leave as default then select Next to install: Select Yes to send anonymous product usage data (such as the License Count report) to Bocada, or No to opt out of product data sharing. Service Login Enter the Windows User Domain Account credentials or select Local System Account, then click Next. 25 Bocada Installation Guide
Authentication Requirements and Notes Domain User Performing Installation Requires access to the SQL Database Service Login Users Local system Account: Database connection forces to SQL Authentication Master DCS and Application required on the same server Secondary DCS are not required to be the same authentication method Domain account: If different than account running installer, requires addition to the Bocada Users view as an administrator Non-expiring password is recommended else risk of Data Collection failure If services Log on as user manually changed to a different Domain user after installation, must also have access to the Bocada database Secondary DCS are not required to be the same authentication method Database Server Authentication Must have db_owner permission Default Schema must be dbo 26 Bocada Installation Guide
Database Server Enter the SQL Server FQDN, Instance and/or Port (if applicable) and Database Name as specified in the Bocada license key and select Next. Database Server Notes: The information entered must match what was used for the Data Collection installation. After clicking Next, the installation will attempt to connect to the Database. If unable, the following error will be displayed. Please refer to Appendix A for troubleshooting information. 27 Bocada Installation Guide
IIS Configuration A web application will be installed as part of the Bocada Application. Configure IIS and click Next to start installation. IIS Configuration Notes: If Default is selected, the Application will be installed using the specified HTTP Port (e.g. port 8086) from the HTTP Port setting. If HTTPS is selected, the Application will be installed using HTTPS using the specified HTTP Port from the HTTP Port setting. If Virtual Directory on Port 80 is selected, the Application will be installed to HTTP Port 80 using the HTTP Virtual Directory specified. An HTTP Virtual directory can only be created if there is already a website on the HTTP Port 80. 28 Bocada Installation Guide
Start Installation Click Install to begin installation of the Application Server Installation Complete Once the installation is successful, you will be presented with an option to view the installation log. Select Show the Windows Installer log to view the installation log if desired then click Finish. 29 Bocada Installation Guide
Configure HTTPS Certificate If HTTPS was select during the Application install, the following steps will provide a guide for deploying your SSL certificate. Note that the certificate is not something Bocada can provide since the server name is required with the certificate. Deploying the Certificate After acquiring a certificate, it will need to be applied to the binding in IIS Manager. 1) Open the IIS Manager 2) Select the Bocada Web Site 3) Select Bindings from the right-hand side of the Manager 4) Select your Site Binding and click Edit 5) In the Edit Site Binding window, select your certificate from the SSL Certificate drop down and then click OK. 30 Bocada Installation Guide
Upgrade Upgrading Bocada requires first uninstalling the previous Bocada application, then installing the newest version. Please visit the Bocada 19.2 Upgrade Guide for instructions and notes on the upgrade process. 31 Bocada Installation Guide
Accessing the Application After completing installation there are two ways to access the application: 1. Using a supported browser local to the Application Server: http://localhost[:port]/[virtualdirectory] or http://[appserverfqdn][:port]/[virtualdirectory] 2. Using a supported browser from a server other than the Application Server: http://[appserverfqdn][:port]/[virtualdirectory] or http://[appservershortname][:port]/[virtualdirectory] (in-network only) User Access Note: During the application installation, the Windows User that was logged in during the installation is automatically added as an Administrator to the product. This is the only account with access to Bocada until other Users are added. Additional Users can be added by this Administrator from the Bocada Administration module under Users. For more information about User management, please refer to the Bocada Administration guide. 32 Bocada Installation Guide
Adding Bocada License Upon initial login, the Edit General Settings wizard will be displayed with a text field for a product key. Paste the product key into the field and click Add, then Finish. Congratulations, Bocada is now licensed and ready to use! 33 Bocada Installation Guide
General Settings Upon setup, most users will immediately want to edit their Global Report Settings. From the Administration module (at lower left), select Settings to view your Global Settings. Next, select the Edit icon from the right Action panel to open the Edit General Settings wizard (as above). Select the second tab, Global Report Settings, to make global changes appropriate to your own environment: Most users will want to set the Default Time Zone to match the time zone of their backup servers (if backup servers are in multiple time zones, these can be configured individually). Since most backup jobs are done at night and can take an indeterminate length of time to start/finish, most users will want to set their Backup Day to begin at Noon. See the Bocada Admin Guide for common next steps, available at ftp://ftp2.bocada.com/docs/ 34 Bocada Installation Guide
Technical Support For technical support or if you would like a copy of our standard support agreement, please contact us. E-mail: support@bocada.com Phone: 425-818-4480 Toll-free: 866-BOCADA-1 (866-262-2321) Both new and existing customers, who have purchased annual support and maintenance, have full access to Bocada Support: Online knowledge base and problem ticketing system E-mail and toll-free telephone assistance Monday through Friday, 6 a.m. to 6 p.m. Pacific, US Time (except holidays) Product documentation and documentation updates Program error fixes, hotfixes, and service packs Product upgrades for the Bocada application To access the support portal, click on Customer Support Portal from the following URL: https://www.bocada.com/product-support/ 35 Bocada Installation Guide
Appendices Appendix A: Database Troubleshooting Possible Errors during Installation: Issue Possible Reason Troubleshooting Step(s) Cannot connect to SQL database Remote connection failure Installation or Upgrade fails ERROR: Must install Bocada with the DBO schema, but schema is currently: <other> SQL server is incorrect or server short name is used. Instance or Port specified is incorrect. Domain/SQL User specified does not have access to SQL Server. SQL Server services are not running. SQL Server is not allowing Remote Connection SQL Server version is unsupported The domain account used must be assigned the DBO schema as the default Return to Data Collection Service Installation Return to Application Server Installation Confirm SQL Server name is correct and FQDN is used. Confirm Instance and Port (leave blank for default). Confirm access using SQL Server Management Studio. Confirm that SQL Server Services are running. Configure SQL Server to Allow Remote Connections. Specify different SQL Server with supported version. Upgrade SQL Server to supported version. Set DBO Schema for Bocada SQL User 36 Bocada Installation Guide
Appendix B: Windows Services and User Management Services management (including manually starting services) and User management processes are described in the following two Microsoft TechNet references: Windows Services Management https://technet.microsoft.com/enus/library/cc772408%28v=ws.11%29.aspx?f=255&mspperror=-2147217396 Windows User Management https://technet.microsoft.com/en-us/library/dd391974(v=ws.10).aspx The following settings for the Bocada services must be met for the application to function properly: Bocada Data Collection Service Startup Type is Automatic. The account assigned to start the service (Log On) has sufficient privileges to start services. Local System account is not used when Data Collection and Application are on separate servers. Bocada Service (Application Server) Startup Type is Automatic. The account assigned to start the service (Log On) has sufficient privileges to start services. Local System account is not used when Data Collection and Application are on separate servers. Note: Management of the Bocada Data Collection and Application services requires Administrative privileges on the server(s) where the applications are installed. If launching the application results in an error, one possible solution is to explicitly raise the permissions of the user running the Bocada Service on the Bocada installation directory to Admin. Return to Data Collection Service Installation Return to Application Server Installation 37 Bocada Installation Guide
Appendix C: Website Setup During Application Server installation, the following web site options are available for set up: Example IIS Configuration HTTP Port = 80 Directory = NULL HTTP Port = 80 Directory = bocada HTTP Port = 8080 Directory = NULL HTTP Port = 8080 Directory = bocada Reason Using default HTTP Port HTTP Port is not in use Using default HTTP Port HTTP Port is in use Using non-default HTTP Port HTTP Port is not in use Using non-default HTTP Port HTTP Port is in use Web Site Address http://appserver.domain.com/ http://appserver.domain.com/bocada http://appserver.domain.com:8080 http://appserver.domain.com:8080/bocada For illustration purposes, appserver.domain.com is the Bocada Application Server. Possible Errors during installation: HTTP Virtual Directory not specified, selected HTTP Port (80) already in use: HTTP Virtual Directory is specified for a port which is not already in use: 38 Bocada Installation Guide
Possible Errors while attempting to access the application: Occasionally after successful installation of the application server, the application may fail to load. The following are possible errors with solutions. Error Message HTTP Error 404.17 Not Found Server Error in '/Bocada' Application. Runtime Error Description: An exception occurred while processing your request Headings & Menus appear, but Reports display no data Reason The requested content appears to be script and will not be served by the static file handler. C++ runtime libraries are missing on the Application server Browser is running in Protected Mode and the Bocada Application site is not a Trusted site. The Bocada Database was not correctly updated (some necessary components have been installed to the incorrect schema). Solution Windows Server 2008 & 2012: 1. Issue the following command: C:\Windows\Microsoft.NET\Framework\v4.0.3031 9\aspnet_regiis.exe -i 2. Restart IIS Windows Server 2016: 1. Open Server Manager and navigate to Features > Add Features 2. Add the Windows Feature Web Server (IIS) > Web Server > Application Development > ASP.NET 4.6 Download and install the missing component from the link below: http://www.microsoft.com/enus/download/details.aspx?id=5555 Navigate to Tools > Internet Options > Security, uncheck the checkbox next to "Enable Protected Mode", and add the site to Trusted Sites. If you then clear the cache (Tools > Internet Options > General > Browsing History > Delete) and refresh the browser session (CTRL-F5), reports should appear as normal. Verify that the Default Schema for the user account performing the installation is set to dbo in SQL Server, and reinstall the Data Collection Server to repair the Bocada database. Return to IIS Configuration 39 Bocada Installation Guide
Appendix D: Windows Server Roles & Features While the same Roles and Features are required of any Windows Server installation, these appear slightly differently depending upon your version of Windows Server. Below are some examples of Windows Server installation requirements from various server versions: Windows Server 2008R2: Roles: Features: 40 Bocada Installation Guide
Windows Server 2012R2: Roles: Features: 41 Bocada Installation Guide
42 Bocada Installation Guide
43 Bocada Installation Guide
Windows Server 2016: Roles: Features: 44 Bocada Installation Guide