Docusnap X Installing and Configuring. Installing and Configuring Docusnap X

Size: px

Start display at page:

Download "Docusnap X Installing and Configuring. Installing and Configuring Docusnap X"

Imogene Charles
5 years ago
Views:

1 Docusnap X Installing and Configuring Installing and Configuring Docusnap X

2 TITLE Docusnap X Installing and Configuring AUTHOR Docusnap Consulting DATE 12/18/2018 VERSION 1.4 valid as of September 26, 2018 This document contains proprietary information and may not be reproduced in any form or parts whatsoever, nor may be used by or its contents divulged to third parties without written permission of itelio GmbH. All rights reserved. Docusnap X Installing and Configuring 2018 Docusnap All rights reserved Page 2 of 32

3 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 Docusnap X Installing and Configuring 2018 Docusnap All rights reserved Page 3 of 32

4 Introduction These instructions explain how to install and configure Docusnap X, Docusnap Server, and Microsoft SQL Server Express. Docusnap can only be used if you have completed the installation of Docusnap and the configuration of the Docusnap Server. Docusnap X Installing and Configuring 2018 Docusnap All rights reserved Page 4 of 32

1.1 The architecture of Docusnap X Docusnap database Data Scheduling Inventory Documentation Docusnap Server service Docusnap Server Static & dynamic content Standard port: 9001 Inventory Docusnap

5 1.1 The architecture of Docusnap X Docusnap database Data Scheduling Inventory Documentation Docusnap Server service Docusnap Server Static & dynamic content Standard port: 9001 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 Installing and Configuring 2018 Docusnap All rights reserved Page 5 of 32

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. In order to be able to use the full range of functions in Docusnap (including Docusnap Connect V2), a Microsoft SQL Server Express or a full SQL Server from Version 2012 is required. 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 the latest Microsoft SQL Server Express Version. 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 or higher o Supports a single processor, but up to four cores o Max. usable RAM: 1GB o Max. database size: 10GB 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 Installing and Configuring 2018 Docusnap All rights reserved Page 6 of 32

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 (Express)

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 Installing and Configuring 2018 Docusnap All rights reserved Page 7 of 32

5 - Basic installation - Installation To complete the basic installation, click the Finish button.

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 Installing and Configuring 2018 Docusnap All rights reserved Page 8 of 32

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 Installing and Configuring 2018 Docusnap All rights reserved Page 9 of 32

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 Installing and Configuring 2018 Docusnap All rights reserved Page 10 of 32

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 Installing and Configuring 2018 Docusnap All rights reserved Page 11 of 32

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 Installing and Configuring 2018 Docusnap All rights reserved Page 12 of 32

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 Basic configuration - File paths Docusnap X Installing and Configuring 2018 Docusnap All rights reserved Page 13 of 32

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 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 Installing and Configuring 2018 Docusnap All rights reserved Page 14 of 32

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 Docusnap Server - Configuring the server service Docusnap X Installing and Configuring 2018 Docusnap All rights reserved Page 15 of 32

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 Server settings Fig Docusnap Server - Database connection 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 Docusnap server - Path settings Docusnap X Installing and Configuring 2018 Docusnap All rights reserved Page 16 of 32

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 Completing the installation and configuration - Docusnap X home screen Docusnap X Installing and Configuring 2018 Docusnap All rights reserved Page 17 of 32

Installing the database 4.1 Installing Microsoft SQL Server 2016 Express You can download the setup files directly from the Microsoft website.

18 Installing the database 4.1 Installing Microsoft SQL Server 2016 Express You can download the setup files directly from the Microsoft website. 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 SQL Server Express installation - SQL Server installation center Docusnap X Installing and Configuring 2018 Docusnap All rights reserved Page 18 of 32

4.1.2 Feature selection Select the functions as shown in Fig. 17. Fig. 17 - SQL Server Express installation - Feature selection 4.1.3 Instance configuration Here, you can either select Default instance or assign a special name under Named instance, e.

- SQL Server Express installation - Instance Configuration 4.1.

19 4.1.2 Feature selection Select the functions as shown in Fig. 17. Fig SQL Server Express installation - Feature selection Instance configuration Here, you can either select Default instance or assign a special name under Named instance, e.g. Docusnap. Fig 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 Installing and Configuring 2018 Docusnap All rights reserved Page 19 of 32

20 Make sure to remember this password as you will need it later to start and configure the SQL Server. Fig 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 Installing and Configuring 2018 Docusnap All rights reserved Page 20 of 32

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 Installing the SQL Server Management Tools Docusnap X Installing and Configuring 2018 Docusnap All rights reserved Page 21 of 32

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 SQL Server Express configuration - SQL Server Network Configuration Docusnap X Installing and Configuring 2018 Docusnap All rights reserved Page 22 of 32

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.

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 SQL Server Express configuration - SQL Server Browser Service Docusnap X Installing and Configuring 2018 Docusnap All rights reserved Page 23 of 32

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 SQL Server Express configuration - Database permissions Docusnap X Installing and Configuring 2018 Docusnap All rights reserved Page 24 of 32

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 SQL Server Express configuration - Database authentication Docusnap X Installing and Configuring 2018 Docusnap All rights reserved Page 25 of 32

To create these Firewall rules, go to Control Panel Windows Firewall Allow an app or feature through Windows Firewall. Fig.

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 SQL Server Express configuration - Configuring the Windows Firewall Fig SQL Server Express configuration - Allow another app Docusnap X Installing and Configuring 2018 Docusnap All rights reserved Page 26 of 32

$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 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 SQL Server Express configuration - Windows Firewall - Enabled SQL apps Docusnap X Installing and Configuring 2018 Docusnap All rights reserved Page 27 of 32

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 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 Installing and Configuring 2018 Docusnap All rights reserved Page 28 of 32

Fig. 30 - Updating LocalDB to SQL Server - Selecting and attaching the LocalDB

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 BASIC CONFIGURATION - FILE PATHS...13 FIG BASIC CONFIGURATION - CREATING THE ENCRYPTION FILE FIG DOCUSNAP SERVER - CONFIGURING THE SERVER SERVICE...15 FIG DOCUSNAP SERVER - DATABASE CONNECTION...16 FIG DOCUSNAP SERVER - PATH SETTINGS...16 FIG COMPLETING THE INSTALLATION AND CONFIGURATION - DOCUSNAP X HOME SCREEN FIG SQL SERVER EXPRESS INSTALLATION - SQL SERVER INSTALLATION CENTER...18 FIG SQL SERVER EXPRESS INSTALLATION - FEATURE SELECTION...19 FIG SQL SERVER EXPRESS INSTALLATION - INSTANCE CONFIGURATION...19 FIG SQL SERVER EXPRESS INSTALLATION - DATABASE ENGINE CONFIGURATION FIG INSTALLING THE SQL SERVER MANAGEMENT TOOLS...21 FIG SQL SERVER EXPRESS CONFIGURATION - SQL SERVER NETWORK CONFIGURATION FIG SQL SERVER EXPRESS CONFIGURATION - SQL SERVER BROWSER SERVICE FIG SQL SERVER EXPRESS CONFIGURATION - DATABASE PERMISSIONS FIG SQL SERVER EXPRESS CONFIGURATION - DATABASE AUTHENTICATION FIG SQL SERVER EXPRESS CONFIGURATION - CONFIGURING THE WINDOWS FIREWALL FIG SQL SERVER EXPRESS CONFIGURATION - ALLOW ANOTHER APP FIG SQL SERVER EXPRESS CONFIGURATION - ADDING THE SQL SERVER EXE FIG SQL SERVER EXPRESS CONFIGURATION - WINDOWS FIREWALL - ENABLED SQL APPS FIG UPDATING THE LOCALDB TO SQL SERVER FIG UPDATING LOCALDB TO SQL SERVER - SELECTING AND ATTACHING THE LOCALDB Docusnap X Installing and Configuring 2018 Docusnap All rights reserved Page 30 of 32

31 Version history Date September 05, 2016 September 27, 2016 October 25, 2018 Description Adaptations according to RTM Docusnap X Docusnap Server Revision Screenshots updated; New architecture of the web browser Docusnap X Installing and Configuring 2018 Docusnap All rights reserved Page 31 of 32

32 itelio GmbH -

Docusnap X. Installing and Configuring Docusnap X

Docusnap X. Installing and Configuring Docusnap X Docusnap X Installing and Configuring Docusnap X 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