GlobalSearch. Server Migration Guide. 127 Church Street, New Haven, CT O: (203) E:

Transcription

1 GlobalSearch Server Migration Guide 127 Church Street, New Haven, CT O: (203) E: Square 9 Softworks Inc. 127 Church Street New Haven, CT (+1) education@square-9.com

2

3 Square 9 GlobalSearch Server Migration Guide Version Copyrights, Legal Notices, Trademarks, and Servicemarks Copyright 2017 Square 9 Softworks All rights reserved. No part of this work may be reproduced or transmitted in any form or by any means whatsoever, without written permission of Square 9 Softworks unless such copying is expressly permitted by Federal copyright law. For information regarding permissions, contact: Square 9 Softworks Inc., 127 Church Street, New Haven, CT 06510, USA, info@square-9.com. February, 2017 edition Publication subject to change without notice, Square 9 Softworks assumes no liability for any damages incurred directly or indirectly from errors, omissions, or discrepancies between the actual software you install and/or the contents of this publication or any other accompanying publication. GlobalSearch, GlobalCapture, and GlobalAction are registered trademarks of Square 9 Softworks. All other products and devices listed in this document are trademarks or registered trademarks of their respective companies and are hereby acknowledged. Microsoft, SQL Server, SQL Server Management Studio, and Windows are trademarks and service marks of Microsoft, Inc., registered in the United States and other countries, and are the property of Microsoft, Inc. Square 9 Softworks Inc. 127 Church Street New Haven, CT (+1) education@square-9.com

4

5 Table of Contents GlobalSearch Server Migration... 1 Before Beginning a Server Migration... 1 Upgrade and Migrate from Version or Earlier... 1 Upgrade and Migrate from Version or Later... 1 Relocate the License File... 1 Perform a Custom Installation... 1 SQL Database Migration... 3 Relocate Databases to New SQL Server/Instance... 3 Point GlobalSearch to a New SQL Server/Instance... 4 Updating SQL Paths to a New Drive Letter... 7 Modify Already Existing Client Installations GlobalSearch Server Migration Guide Table of Contents i

6

7 How to Use This Guide Purpose The GlobalSearch Server Migration Guide provides the steps necessary to upgrade your installation during the server migration process. How to migrate your GlobalSearch installation from one server to another How to migrate your GlobalSearch databases from one SQL server/instance to another How to migrate your Inbox and database documents from one storage server to another Audience GlobalSearch administrators should read this guide to understand how to migrate GlobalSearch from one server to another. GlobalSearch Server Migration Guide How to Use this Guide iii

8 Conventions Used in this Guide Icons Name Icon Description Behind the Scenes Business Case CAUTION Example Note Tip Troubleshooting Highlights technical information useful to administrators and installers Calls attention to specific examples which demonstrate how features can be used to address business needs Highlights important information to know to avoid situations that could potentially cause a loss of data or configuration, or could impact performance, functionality, or successful implementation Highlights examples of settings for typical business uses Highlights information of interest or important information needed to successfully accomplish a task or understand a procedure Highlights techniques, shortcuts, or productivity tips Highlights information or references troubleshooting resources that might prove helpful in solving a problem Typographic Conventions Convention Bold Italics Underlined Blue Fixed Width Font SMALL CAPITAL LETTERS Description Highlights interface items such as menus, dialog boxes, settings, and options. Emphasizes text or indicates a placeholder variable which the user should replace with a specific word or symbol Points out URL links to external web pages or documents Used for filenames, Windows folder paths, URLs, code samples, and system text Indicates keyboard keys, such as CTRL+C, ENTER, DELETE, or TAB Writing Conventions Convention Description Angle brackets enclosing a word or phrase in italics indicates that information must be entered specific to the <Username> installation, configuration, or system. For example, <Username> means to enter a specific username in the indicated field > Indicates the need to select an item from a menu. For example, File > Save Indicates the item referenced is particular to GlobalSearch or a Square 9 product or feature. For example, the Index Initial Caps Fields selected when creating an Archive Help and Support Support Phone: , option 2 support@square-9.com Other Resources Forums: forums.square-9.com Square 9 classes: education@square-9.com iv How to Use this Guide GlobalSearch Server Migration Guide

9 GlobalSearch Server Migration Before Beginning a Server Migration CAUTION: To prevent any risk of data lost, it is highly recommended that you first back up your database or databases before attempting a migration. Upgrade and Migrate from Version or Earlier GlobalSearch must be on v4.1.1 before you can upgrade to a newer version of GlobalSearch. However, it is recommended that you migrate your data to the same version of GlobalSearch that was installed on your original server. 1. Before you begin your migration, back up your data and upgrade your current GlobalSearch installation to v Then install v4.1.1 on the new server and migrate your data following this guide. 3. Once that is complete, follow the GlobalSearch Upgrade Guide to upgrade to the latest version of GlobalSearch. Upgrade and Migrate from Version or Later GlobalSearch should be migrated to the same version of software that it is currently residing on. Once you have installed version 4.1.1, If you plan to upgrade to a newer version of GlobalSearch, it is recommended that you upgrade after your server migration is complete. Relocate the License File Before beginning the installation, first copy your Square 9 ssfeatures.lic license file from the bin folder on the old server to the server you are migrating to. By default, the bin folder is located in C:\Inetpub\wwwroot\GetSmart\bin. Copy the license file over to your selected location on the new server. Perform a Custom Installation CAUTION: Do not point to your new installation to your already existing GlobalSearch. This could potentially overwrite the data on your databases. GlobalSearch can be modified after the installation is complete to point to original database or databases where your GlobalSearch data resides. GlobalSearch Server Migration Guide GlobalSearch Server Migration 1

10 1. Perform a custom installation of GlobalSearch on the new server. Refer to the instructions in the GlobalSearch Installation Guide. 2. When prompted during the installation for the Database Type, select Create a new GetSmart database instance. During the custom installation, be sure to include any optional modules which you have purchased, such as Image XChange or GlobalForms. 3. Once your installation has been completed, copy the following folders (located by default in C:\GetSmart) from the original server and paste them in your new server: \99 - To retain any legacy Work XChange Workflows, back up the 99 folder. \13 - To retain any OCR Zonal Templates, back up the 13 folder. \KAOS - To retain the configuration files for all your mapped forms (if you have installed the optional GlobalForms module), back up the KAOS folder. \mongodb To back up your GlobalCapture and GlobalAction Workflows. \CaptureServices- To back up any DLLs custom written for GlobalCapture. When the folders are copied to the new server, it is likely that they should be copied to the same location on the new server, depending on any custom install modifications. 4. To migrate all your documents, copy the entire GlobalSearch folder from the original server (located in the C drive by default) to the new server. If you are upgrading from a version older than version 4.4.1, this folder may be called SmartSearch. If you have a version installation, please read the Updating SQL Paths to a New Drive Letter chapter, as you will need to modify the SQL paths to accommodate the name change. 2 GlobalSearch Server Migration GlobalSearch Server Migration Guide

11 SQL Database Migration You can migrate your custom and system Square 9 databases from one SQL server or SQL database instance to another. Begin by backing up and copying all the necessary database files, modifying GlobalSearch configuration files to interact with the new SQL server/instance, and updating SQL pointers to locate documents that have been migrated to a new storage server. Relocate Databases to New SQL Server/Instance To migrate your Square 9 databases from one SQL server or SQL database instance to another, do the following: 1. Confirm all users are logged out of the system. 2. Open Microsoft SQL Server Management Studio and log on to your original server. 3. Referring to the GlobalSearch Backup Procedures, create backups of your SmartSearch, SSMaster, SSProcessing, SSCapture, and Square9Users databases, as well as any custom databases. 4. Using SLQ Server Management Studio, detach the SmartSearch, SSMaster, SSProcessing, SSCapture, and Square9Users databases, as well as any additional custom databases. Right-click on the database and select Tasks. Then select Detach. Once the window opens, enable both the Drop Connections and Update Statistics checkboxes. Click OK. 5. With the databases detached, make a copy of each, including the MDF (Main Database File) and LDF (Log Database File) files. By default, these databases are located in: C:\Program Files (x86)\microsoft SQL Server\MSSQL11.GETSMART\MSSQL\DATA. Detach and Copy Databases GlobalSearch Server Migration Guide SQL Database Migration 3

12 6. Paste the LDF and MDF files of each of the databases into the SQL storage location of the new SQL server/instance. The path should be similar to the location where you originally found the documents. 7. Open SQL Management Studio for the new SQL and attach the copied databases. Attached Copied Databases Once you have attached the databases to the new SQL server/instance, your databases have been fully migrated. 8. In the ssmaster database, update the ssconnectionstrings table. The server\instance name is defined in this table for each database connection. It will need to be updated to reflect the new server\instance name if there is a change. To check the instance name, log into the new instance and observe the name on the top of the Object Explorer. Instance Name 9. In the sscapture database, repeat step 8 and update the ssconnectionstrings table. Point GlobalSearch to a New SQL Server/Instance You will now need to update your configuration files to allow GlobalSearch to locate and interact with the SQL server/instance where it is stored. 4 SQL Database Migration GlobalSearch Server Migration Guide

13 1. Navigate to the following files: C:\inetpub\wwwroot\Getsmart\Web.config C:\inetpub\wwwroot\Square9Rest\Web.config C:\inetpub\wwwroot\Square9API\Web.config C:\inetpub\wwwroot\Square9CaptureAPI\Web.config C:\inetpub\wwwroot\Square9DocuSignReceiver\Web.config 2. Look for the line that contains the data source= entry and change it to reflect the new SERVER\INSTANCE. Example: <add name= GetSys connectionstring= Data Source=(local)\GetSmart; 3. After your connection strings have been updated, update your configuration files. 4. Look for where the Data Source is defined in the configuration file. 5. Update the following files (found in GetSmart by default): C:\GetSmart\CaptureDesigner.exe.config C:\GetSmart\ServiceConsole.exe.config C:\GetSmart\Square9.DocuSignRetriever.exe.config C:\GetSmart\Square9.Services.GlobalSearch.exe.config C:\GetSmart\ssCaptureManager.exe.config C:\GetSmart\Square9.CaptureConverter.exe.config C:\GetSmart\ssContentIndex.exe.config C:\GetSmart\ssDocWFManager.exe.config C:\GetSmart\SSIMPORTERWS.exe.config GlobalSearch Server Migration Guide SQL Database Migration 5

14

15 Updating SQL Paths to a New Drive Letter When migrating GlobalSearch from one server to another, if you have copied or moved Inbox and Archive folders to a location on the new server which differs from the path on the original server, please follow the steps in this chapter. CAUTION: To protect from data loss, before making any changes to SQL, first back up your databases using the procedure found in the GlobalSearch Backup Procedures. With the release of GlobalSearch version 4.4.1, the location of the Archive and Inbox folders have been changed. Where previously the location was C:\SmartSearch, in new installations of version or later, this location is called C:\GlobalSearch. If the folder on your old server is called SmartSearch, use the scripts in this chapter to update the folder location, not just the drive letter. 1. Open SQL Server Management Studio and log on. 2. Select New Query to open a new Query window. New Query in SQL Server Management Studio 3. Update dbo.ssarchives table found in the SmartSearch database. use SmartSearch update ssarchives set basepath = replace(basepath, 'C:\SmartSearch', 'D:\SmartSearch') update ssarchives set FullTextPath = replace(fulltextpath, 'C:\SmartSearch', 'D:\SmartSearch') In this example, the drive letter is updated from C:\SmartSearch to D:\SmartSearch. If the drive letter is not D, you will need to modify the script to reflect the location where you are moving the C:\SmartSearch folder. 4. If you are migrating from an upgraded version to a new installation of version 4.4.1, it is important to do the following: a) Modify the script to accommodate the Archive folder location. b) If the drive letter is changing as well, update the script to reflect that. use SmartSearch update ssarchives set basepath = replace(basepath, 'C:\SmartSearch', 'C:\GlobalSearch') update ssarchives set FullTextPath = replace(fulltextpath, 'C:\SmartSearch', 'C:\GlobalSearch') 5. Once you have properly formatted your script, click Execute. GlobalSearch Server Migration Guide Updating SQL Paths to a New Drive Letter 7

16 Execute in SQL Server Management Studio 6. Select New Query to open a new Query window. 7. Update the dbo.ssarchives# Archives individually in the SmartSearch database. 8. If you are migrating to a version installation, you may need to update this script to reflect the new Archive location, as done in step 4. (For example, from C:\SmartSearch to D:\GlobalSearch.) use SmartSearch update ssarchive1 set filepath = replace(filepath, 'C:\SmartSearch', 'D:\SmartSearch') In this example, ssarchives1 is being updated. 9. Modify the script to apply to the other numbered Archive folders listed in the SmartSearch database. Modify Script for Archive Folders The numbered Archive folders can be found under the SmartSearch database. Numbered Archive Folders in the SmartSearch Database 8 Updating SQL Paths to a New Drive Letter GlobalSearch Server Migration Guide

17 10. To ensure consistency with the new Archive paths, once you have edited all of your numbered Archives, manually update dbo.ssdefaults. a) Right click on dbo.ssdefaults and from the pop-up menu, select either Edit Top 200 Rows or Open Table, depending on which version of SQL Server you are currently using. b) In the open table, edit all the rows to reflect the new file paths. Manually Update dbo.ssdefaults 11. Under the ssmaster database, manually update the paths in dbo.ssinboxes and dbo.sssystem following the same process as in step Under the SSProcessing database: a) Expand the Tables folder. b) Modify the dbo.defaults table so that the basepath and targetpath are pointing to the correct location for the CaptureProcessing folder and the Output folder found normally in C:\GetSmart. 13. If there are any other databases used besides the default SmartSearch database, follow steps 3 through 10 to ensure those paths get updated as well. After you have ensured that all paths in your SQL instance have been updated, your databases should now be fully migrated. GlobalSearch Server Migration Guide Updating SQL Paths to a New Drive Letter 9

18

19 Modify Already Existing Client Installations After you have migrated your servers, any existing client installations will need to be pointed to the new server. 1. Copy all the files with the CONFIG file extension from the new C:\GlobalSearchClientInstallation folder on the server. You can sort the GlobalSearchClientInstallation folder by file type and list all the CONFIG files together. 2. Copy the RestProxy.xml file from the new C:\GlobalSearchClientInstallation folder on the server. 3. Move both set of files to the C:\ProgramFiles(x86)\CommonFiles\Square9\GetSmart on the client machine. 4. From here, replace the already existing files in this location with the new ones, effectively updating the IP address or the server name so the clients point to the new server. You can also perform a reinstallation of the client machines from the newly installed C:\GlobalSearchClientInstallation folder. Note: For Older Installations and for Upgrades, Look for SmartSearch. If you are performing a server migration from a freshly installed GlobalSearch version or later, the folder will be called GlobalSearchClientInstallation. If you are performing a server migration from an earlier version, or from a version which was installed as an upgrade, the folder will be called SmartSearchClientInstallation. GlobalSearch Server Migration Guide Modify Already Existing Client Installations 11