Docusnap X. Installing and Configuring Docusnap X

Size: px

Start display at page:

Download "Docusnap X. Installing and Configuring Docusnap X"

Gwenda Armstrong
5 years ago
Views:

1 Docusnap X Installing and Configuring Docusnap X

2 TITLE Docusnap X AUTHOR Docusnap Consulting DATE 7/12/2017 VERSION 1.2 valid as of September 27, 2016 The reproduction and distribution of this document as a whole or in part as well as the utilization and disclosure of its contents to third parties without the express authorization by itelio GmbH are prohibited. Offenders will be held liable for the payment of indemnification. All rights reserved. All rights reserved. Docusnap X 2017 Docusnap All rights reserved Page 2 of 34

3 TABLE OF CONTENTS Introduction The Architecture of Docusnap X 5 Basic Installation of Docusnap System Requirements Preparing the Database Server Basic Installation 7 Configuring Docusnap Basic Configuration of Docusnap Activating the Product Feature Selection Database Connection Setting the Data Paths Encryption Configuring Docusnap Server Server Database Server Settings Completing the Installation 17 Installing the Database Installing Microsoft SQL Server 2016 Express Installation Center Feature Selection Instance Configuration Database Engine Configuration SQL Server Management Tools Configuring SQL Server 2016 Express SQL-Server Network Configuration Starting the SQL Browser Service Database Users and Permissions Enabling SQL Server in the Windows Firewall 26 Optional Step: Updating Your LocalDB to SQL (Express) Server 28 Checklist 32 Docusnap X 2017 Docusnap All rights reserved Page 3 of 34

4 Introduction These instructions explain how to install and configure Docusnap X, Docusnap Server, and Microsoft SQL Server 2016 Express. Docusnap can only be used if you have completed the installation of Docusnap and the configuration of the Docusnap Server. The checklist at the end of this document summarizes the most important installation and configuration steps and points out some important issues. Docusnap X 2017 Docusnap All rights reserved Page 4 of 34

5 1.1 The Architecture of Docusnap X Docusnap database Data Scheduling Inventory Documentation Docusnap Server service IIS Contents Static website Docusnap Server Inventory Docusnap Client Docusnap Client Docusnap Discovery Service Docusnap Discovery Service Browser Docusnap Clients Docusnap Discovery Services Web browser Fig. 1 Overview of the Docusnap X architecture Docusnap X 2017 Docusnap All rights reserved Page 5 of 34

6 Basic Installation of Docusnap 2.1 System Requirements Microsoft Windows 7 SP1 or Windows Server 2008 R2 SP1 or higher o For Docusnap Web, at least Microsoft Windows 8 / 2012 or higher is required! At least 4GB RAM (recommended) At least 2 CPU cores (recommended).net Framework or higher 2.2 Preparing the Database Server For storing the data in Docusnap, a database system is required. You can select Microsoft SQL Server Express LocalDB, Microsoft SQL Server Express (version 2008 or higher) or a fully-featured Microsoft SQL Server (version 2008 or higher) as the database system. It is recommended to restrict the use of Microsoft SQL Server Express LocalDB to testing. With this database system, it is not possible to use the Docusnap Server Service (scheduled task execution), the Docusnap Web Client, and the Docusnap Discovery Services (decentralized inventory of remote sites). If you used Microsoft SQL Server Express LocalDB for testing purposes, the Docusnap database created there can be added to a Microsoft SQL Server Express or fully-featured Microsoft SQL Server this procedure is described in chapter 5. For your production environment, we recommend the use of Microsoft SQL Server Express 2016 or better. This is a free solution with the following limitations compared to a fully-featured Microsoft SQL Server: SQL Server Express 2008 R2 o Supports a single processor or core o Max. usable RAM: 1GB o Max. database size: 10GB Previous SQL Server Express versions only support 4GB SQL Server Express 2012, 2014, 2016 o Supports a single processor, but up to four cores o Max. usable RAM: 1GB o Max. database size: 10GB Use the following link to download Microsoft SQL Server 2016 Express together with the Management Tools (32 or 64-bit version) from the Microsoft website: Download link Section 4.1 describes how to install and configure Microsoft SQL-Server Express 2016 and the Management Tools. We recommend that you install and configure it before performing the basic Docusnap installation. Docusnap X 2017 Docusnap All rights reserved Page 6 of 34

2.3 Basic Installation Open the Docusnap setup file. In the Welcome screen, click Next. Fig.

You must accept it before you can continue the installation.

3 Basic installation Destination folder In the next step, specify whether you want to use an existing MS SQL Server

7 2.3 Basic Installation Open the Docusnap setup file. In the Welcome screen, click Next. Fig. 2 Basic installation Welcome screen and End-User License Agreement Please read the End-User License Agreement. You must accept it before you can continue the installation. In the Destination Folder screen, specify the destination directory for your Docusnap installation. Fig. 3 Basic installation Destination folder In the next step, specify whether you want to use an existing MS SQL Server (Express) or rather create a local database. As explained above, we recommend that you use an existing Microsoft SQL Server. If a Microsoft SQL LocalDB has been installed before, this step will be skipped. Docusnap X 2017 Docusnap All rights reserved Page 7 of 34

5 Basic installation Installation To complete the basic installation, click the Finish

8 Fig. 4 Basic installation Database selection Click Next and then Install to start the installation process. Fig. 5 Basic installation Installation To complete the basic installation, click the Finish button. This completes the basic installation. Now, continue with the next step, which is the basic configuration. Docusnap X 2017 Docusnap All rights reserved Page 8 of 34

9 Configuring Docusnap Once Docusnap and Microsoft SQL Server or the local database have been installed successfully, you can continue with the basic configuration of Docusnap and Docusnap Server. 3.1 Basic Configuration of Docusnap Activating the Product The first step after starting Docusnap is product activation. You can perform it either online or offline. While online activation is straightforward (simply enter the activation key), a few more steps are necessary for offline activation. You will receive the activation key from a member of the Docusnap Sales team by . Enter or paste this key into the Activation Key field. Fig. 6 Basic configuration Product activation Online activation procedure for your Docusnap installation Enter or paste the key and click Activate. Offline activation procedure for your Docusnap installation If the computer where Docusnap is installed has no Internet access or if the online activation fails, you can use the Offline Activation feature to activate your software. Docusnap X 2017 Docusnap All rights reserved Page 9 of 34

10 Fig. 7 Basic configuration Offline activation First, enter the activation key, then click the Offline Activation button. Save the activation file that will be created for you. Now, upload this activation file to the website. Once the activation on the website was successful, you can download the license file. Load this file in Docusnap to complete the offline activation process Feature Selection If the activation was successful, the next step is to select the desired features of your Docusnap installation. The next steps in the configuration depend on the selected features. Configure Docusnap Client o Classic Docusnap user interface o Multi-user environment: Docusnap Client will be connected to a central database Configure Docusnap Server o Central component of multi-user environments o Automated inventory and documentation tasks o Connection endpoint for the Docusnap Discovery Services o Provides the data for the Docusnap Web Client Install Docusnap Web o Docusnap web browser interface o Important! For the installation of Docusnap Web, at least Windows 8 / 2012 or higher is required on the Docusnap system Both Docusnap Server and Docusnap Web can be installed and configured later. Docusnap X 2017 Docusnap All rights reserved Page 10 of 34

11 Fig. 8 Basic configuration Feature selection Database Connection The following steps will prepare the Docusnap Client for regular use. In this process, you need to enter details in accordance with the installation and configuration of the Microsoft SQL Server (please refer to section 4.1) in order to establish a connection to the database server and an existing or new Docusnap database. Fig. 9 Basic configuration Database configuration SQL Server and database parameters: SQL Server name or IP address Server name\instance_name or IP_address\instance_name Database name Docusnap X 2017 Docusnap All rights reserved Page 11 of 34

12 Authentication Windows Authentication: This type of authentication is only possible if the logged-on user is allowed to log on to the selected database. SQL Server authentication: If SQL Server user accounts exist, they can be used for authentication. Independently of the authentication type, i.e. Windows or SQL Server authentication, each user must have db_owner permissions to the Docusnap database. To establish a connection to an existing database, click the Connect button. To create a new Docusnap database on the database server, click the Create button. Docusnap X 2017 Docusnap All rights reserved Page 12 of 34

13 3.1.4 Setting the Data Paths In the next step, you can configure the settings for various data paths. In the Base Path field, you can set a general path. All other paths are derived from this path. If you rather want to configure the file paths individually, enable the Adjust settings individually checkbox and specify the desired data paths. CAUTION: If one of the paths references a user folder (user profile), other users of the application might not be able to access the data stored there. If you intend to use the Docusnap Server with more than one person requiring access to the application, make sure to use suitable network shares. If multiple users work with Docusnap, create a central share that can be accessed via UNC paths, as shown in Fig. 10. Fig. 10 Basic configuration File paths Docusnap X 2017 Docusnap All rights reserved Page 13 of 34

14 3.1.5 Encryption In Docusnap, it is possible to store passwords. In order to use the Password module, create a new encryption file or select an existing one. Otherwise, this feature will be disabled in the application. Click Create New File, click the ellipsis button and enter a name for your encryption file. If you prefer not to configure the Password module now, click Disable Encryption. You can set up the encryption file later at any time. If you already created an encryption file, click Select Existing File. Fig. 11 Basic configuration Creating the encryption file You can only create a single encryption file per database. Make sure to keep the encryption file in a safe place, as it is not possible to replace or re-create this file should it get lost. Docusnap X 2017 Docusnap All rights reserved Page 14 of 34

15 3.2 Configuring Docusnap Server Docusnap Server is a Windows service. In order to start it and use its features, you need to specify the start information and the parameters for connecting to the desired Docusnap database once. If the Windows service is run with the local system account and the database has been configured for Windows authentication, the service cannot be started because it is not possible to establish a connection to the database. In this case, use the SQL Server authentication. Fig. 12 Docusnap Server Configuring the Server service Docusnap X 2017 Docusnap All rights reserved Page 15 of 34

16 3.2.1 Server Database Here, the same rules apply as for the configuration of the Docusnap Client. Make sure that the user of this service or the SQL user may access the SQL Server when the service is started otherwise, the Docusnap Server Service fails to start. Specify the same data as in step 3 of the installation wizard, as described in section The same applies to the encryption file that is required for the Password module, as described in section Fig. 13 Docusnap Server Database connection Server Settings For the server settings, the same rules apply again: the user account that starts the service must have access to the paths you specified. Enter the paths as specified in step 2 (please refer to section 3.1.4). Fig. 14 Docusnap Server Path settings Docusnap X 2017 Docusnap All rights reserved Page 16 of 34

17 3.2.3 Completing the Installation Finally, the service will be started. If the start is successful and you selected Docusnap Web in Step 2, the system will continue with the Docusnap Web installation. This installation is described in a separate HowTo document called Docusnap X - Docusnap Web Installation that is available for download in the HowTo area of our website. Fig. 15 Docusnap Server Completing the configuration Fig. 16 Completing the installation and configuration Docusnap X home screen Docusnap X 2017 Docusnap All rights reserved Page 17 of 34

18 Installing the Database 4.1 Installing Microsoft SQL Server 2016 Express You can download the setup files directly from the Microsoft website: Download link. This document does not contain a comprehensive description of all steps to be performed in the setup wizard, but only mentions the special settings that are required for the use of Docusnap. In all other configuration steps, accept the defaults or make any user-specific adjustments Installation Center Start the Microsoft SQL Server 2016 Express setup file. Select a new SQL Server stand-alone installation. Fig. 17 SQL-Server Express installation SQL-Server Installation Center Docusnap X 2017 Docusnap All rights reserved Page 18 of 34

4.1.2 Feature Selection Select the functions as shown in Fig. 18. 4.1.3 Instance Configuration Fig.

19 4.1.2 Feature Selection Select the functions as shown in Fig Instance Configuration Fig. 18 SQL-Server Express installation Feature Selection Here, you can either select Default instance or assign a special name under Named instance, e.g. Docusnap. Fig. 19 SQL-Server Express installation Instance Configuration Database Engine Configuration Under Authentication Mode, select the Mixed Mode option and assign a password for the SQL Server system administrator account (SA). Docusnap X 2017 Docusnap All rights reserved Page 19 of 34

20 Make sure to remember this password as you will need it later to start and configure the SQL Server. Fig. 20 SQL-Server Express installation Database Engine Configuration Finally, complete last steps of the Microsoft SQL Server configuration. This may take some minutes. Please make sure that the Docusnap database is included in the periodic data backups. Backups can be created either in SQL Server or using the backup solution of your company. Docusnap X 2017 Docusnap All rights reserved Page 20 of 34

4.1.5 SQL Server Management Tools In previous SQL Server versions, the Feature Selection page (see Fig. 18) included the SQL Server Management Tools option.

21 4.1.5 SQL Server Management Tools In previous SQL Server versions, the Feature Selection page (see Fig. 18) included the SQL Server Management Tools option. In the current version, this option is no longer available. To install the Management Tools, open the SQL Installation Center. Select the Install SQL Server Management Tools option, download the installer and install the software. Fig. 21 Installing the SQL Server Management Tools Docusnap X 2017 Docusnap All rights reserved Page 21 of 34

22 4.2 Configuring SQL Server 2016 Express SQL-Server Network Configuration Start the SQL Server Configuration Manager The SQL Server can only be used in the network if the TCP/IP protocol is enabled. By default, it is disabled. After enabling it, restart the SQL Server service. Fig. 22 SQL-Server Express configuration SQL-Server Network Configuration Docusnap X 2017 Docusnap All rights reserved Page 22 of 34

23 4.2.2 Starting the SQL Browser Service This step is required in order to register the SQL Server in the Docusnap configuration and to negotiate the communication port. Set the service start mode to Automatic and then start the SQL-Server Browser service. Fig. 23 SQL-Server Express configuration SQL-Server Browser Service Docusnap X 2017 Docusnap All rights reserved Page 23 of 34

4.2.3 Database Users and Permissions Please note that the Docusnap database will not be created in SQL Server Management Studio, but automatically during the initial Docusnap configuration.

24 4.2.3 Database Users and Permissions Please note that the Docusnap database will not be created in SQL Server Management Studio, but automatically during the initial Docusnap configuration. Please note that user permissions to the database can only be granted after creating the latter. Users who want to connect to the Docusnap database must have db_owner permissions to the Docusnap database. As an alternative, you can grant the user the dbowner permission, which includes all individual permissions mentioned above. Missing permissions might cause problems, e.g. when trying to update Docusnap. In the following example, an SQL user called docusnap is created in SQL Server Management Studio first. Then, this user is registered as a member of all three roles for the Docusnap database. Fig. 24 SQL Server Express configuration Database permissions Docusnap X 2017 Docusnap All rights reserved Page 24 of 34

Use of the SQL Server authentication requires that you selected the Mixed Mode authentication mode, i.e. SQL Server authentication and Windows authentication enabled.

25 Use of the SQL Server authentication requires that you selected the Mixed Mode authentication mode, i.e. SQL Server authentication and Windows authentication enabled. If you use the Windows authentication mode only, all users or groups must be granted access permission in SQL Server Management Studio. This also applies in particular to the service account used for the Docusnap Server service. Fig. 25 SQL Server Express configuration Database authentication Docusnap X 2017 Docusnap All rights reserved Page 25 of 34

4.2.4 Enabling SQL Server in the Windows Firewall In order to allow access to the SQL Server and the Docusnap database via the network, you need to configure corresponding Firewall rules for the SQL

26 4.2.4 Enabling SQL Server in the Windows Firewall In order to allow access to the SQL Server and the Docusnap database via the network, you need to configure corresponding Firewall rules for the SQL Server and the SQL Browser services while the Firewall is enabled. To create these Firewall rules, go to Control Panel Windows Firewall Allow an app or feature through Windows Firewall. Fig. 26 SQL Server Express configuration Configuring the Windows Firewall Fig. 27 SQL Server Express configuration Allow another app Docusnap X 2017 Docusnap All rights reserved Page 26 of 34

$Navigate to the following path: C:\Program Files\Microsoft SQL Server\MSSQL13.DOCUSNAP\MSSQL\Binn and select the sqlservr.exe file.$ $It is stored in the following path: C:\Program Files (x86)\microsoft SQL Server\90\Shared Fig.$

27 Navigate to the following path: C:\Program Files\Microsoft SQL Server\MSSQL13.DOCUSNAP\MSSQL\Binn and select the sqlservr.exe file. This path may vary MSSQL13.DOCUSNAP in this case, Docusnap is the name of the SQL instance. Fig. 28 SQL-Server Express configuration Adding the SQL Server exe Repeat this procedure for the sqlbrowser.exe file. It is stored in the following path: C:\Program Files (x86)\microsoft SQL Server\90\Shared Fig. 29 SQL Server Express configuration Windows Firewall Enabled SQL apps Docusnap X 2017 Docusnap All rights reserved Page 27 of 34

Optional Step: Updating Your LocalDB to SQL (Express) Server After the installation of Microsoft SQL Server Express or a fully-featured Microsoft SQL Server with Management Tools, you can add your

28 Optional Step: Updating Your LocalDB to SQL (Express) Server After the installation of Microsoft SQL Server Express or a fully-featured Microsoft SQL Server with Management Tools, you can add your local DB to it. The local database (*.mdf and *.ldf files) is located in the user directory of the user who installed the local database and Docusnap. Copy both files to the SQL Server. Attaching the database works as follows: Open Microsoft SQL Server Management Studio and log on as a user with sysadmin permissions (SA or similar). Right-click Databases Attach. Fig. 30 Updating the LocalDB to SQL Server Now, click Add to add the file location and select the *.mdf file. The Databases to attach panel shows information related to the database. Here, you can e.g. change the database name in the Attach as column. Docusnap X 2017 Docusnap All rights reserved Page 28 of 34

Fig. 31 Updating LocalDB to SQL Server Selecting and attaching the

30 LIST OF FIGURES FIG. 1 OVERVIEW OF THE DOCUSNAP X ARCHITECTURE... 5 FIG. 2 BASIC INSTALLATION WELCOME SCREEN AND END-USER LICENSE AGREEMENT... 7 FIG. 3 BASIC INSTALLATION DESTINATION FOLDER... 7 FIG. 4 BASIC INSTALLATION DATABASE SELECTION... 8 FIG. 5 BASIC INSTALLATION INSTALLATION... 8 FIG. 6 BASIC CONFIGURATION PRODUCT ACTIVATION... 9 FIG. 7 BASIC CONFIGURATION OFFLINE ACTIVATION...10 FIG. 8 BASIC CONFIGURATION FEATURE SELECTION FIG. 9 BASIC CONFIGURATION DATABASE CONFIGURATION FIG. 10 BASIC CONFIGURATION FILE PATHS...13 FIG. 11 BASIC CONFIGURATION CREATING THE ENCRYPTION FILE FIG. 12 DOCUSNAP SERVER CONFIGURING THE SERVER SERVICE...15 FIG. 13 DOCUSNAP SERVER DATABASE CONNECTION...16 FIG. 14 DOCUSNAP SERVER PATH SETTINGS...16 FIG. 15 DOCUSNAP SERVER COMPLETING THE CONFIGURATION FIG. 16 COMPLETING THE INSTALLATION AND CONFIGURATION DOCUSNAP X HOME SCREEN FIG. 17 SQL-SERVER EXPRESS INSTALLATION SQL-SERVER INSTALLATION CENTER...18 FIG. 18 SQL-SERVER EXPRESS INSTALLATION FEATURE SELECTION...19 FIG. 19 SQL-SERVER EXPRESS INSTALLATION INSTANCE CONFIGURATION...19 FIG. 20 SQL-SERVER EXPRESS INSTALLATION DATABASE ENGINE CONFIGURATION FIG. 21 INSTALLING THE SQL SERVER MANAGEMENT TOOLS...21 FIG. 22 SQL-SERVER EXPRESS CONFIGURATION SQL-SERVER NETWORK CONFIGURATION FIG. 23 SQL-SERVER EXPRESS CONFIGURATION SQL-SERVER BROWSER SERVICE FIG. 24 SQL SERVER EXPRESS CONFIGURATION DATABASE PERMISSIONS FIG. 25 SQL SERVER EXPRESS CONFIGURATION DATABASE AUTHENTICATION FIG. 26 SQL SERVER EXPRESS CONFIGURATION CONFIGURING THE WINDOWS FIREWALL FIG. 27 SQL SERVER EXPRESS CONFIGURATION ALLOW ANOTHER APP FIG. 28 SQL-SERVER EXPRESS CONFIGURATION ADDING THE SQL SERVER EXE FIG. 29 SQL SERVER EXPRESS CONFIGURATION WINDOWS FIREWALL ENABLED SQL APPS FIG. 30 UPDATING THE LOCALDB TO SQL SERVER FIG. 31 UPDATING LOCALDB TO SQL SERVER SELECTING AND ATTACHING THE LOCALDB Docusnap X 2017 Docusnap All rights reserved Page 30 of 34

31 VERSION HISTORY Date Description September 05, 2016 September 27, 2016 Version Adaptations according to RTM Docusnap X Version 1.1 Docusnap Server Revision Docusnap X 2017 Docusnap All rights reserved Page 31 of 34

32 Checklist Basic installation Preparations System requirements (2.1) - Microsoft Windows 7 SP1 or Windows Server 2008 R2 SP1 or higher o For Docusnap Web, at least Microsoft Windows 8 / 2012 or higher is required! - At least 4GB RAM (recommended) - At least 2 CPU cores (recommended) -.NET Framework or higher Database server (2.2) - For production environments, we recommend the use of Microsoft SQL Server Express 2016 or better. Basic configuration Database connection (3.1.0) - Specify the database server/localdb, the database, and the authentication mode (SQL or Windows authentication) - Database permissions o db_owner Data paths (3.1.1) - Use central UNC share Encryption (3.1.2) - Encryption file can only be created once per database If the file gets lost, access to the passwords is no longer possible Docusnap Server Set start type of the Server service and start it (3.2) - Local system -> no Windows authentication possible - Users -> permission to run the service is required Database connection (3.2.1) - Connect to the same database as in the basic configuration Docusnap Server Data paths (3.2.2) - The users who run the Server service or the local system must have access to the required directories

33 SQL Express installation Database Engine Configuration (4.1.4) - Select mixed authentication mode Windows and SQL Server authentication Install the Management Tools Microsoft SQL Server Management Studio SQL Express Configuration Network configuration (4.2.1) - Enable the TCP/IP protocol to allow remote access to the database Start SQL Browser service (4.2.2) - Register the SQL Server in the Docusnap configuration and negotiate the communication port Set up SQL services to the Firewall (4.2.4) - Enabling SQL Server in the Windows Firewall Docusnap X 2017 Docusnap All rights reserved Page 33 of 34

34 itelio GmbH -

Docusnap X Installing and Configuring. Installing and Configuring Docusnap X

Docusnap X Installing and Configuring Installing and Configuring Docusnap X TITLE Docusnap X Installing and Configuring AUTHOR Docusnap Consulting DATE 12/18/2018 VERSION 1.4 valid as of September 26,