CONFIGURING SQL SERVER FOR METRIX

Transcription

1 CONFIGURING SQL SERVER FOR METRIX Rules Based Productivity Copyright 2012 Outback Software Pty. Metrix is a trademark Outback Software Pty Limited and may be registered in certain jurisdictions.

2 2 Metrix SQL Server Guide Copyright and Contact Information Metrix SQL Server Guide (version ) Documentation: Developers: Lisa Chambers, Michael R. Saia Copyright 2013 Electronics For Imaging, Inc. All rights reserved. Company, brand, or product names are for identification purposes only and may be registered trademarks of their respective holders. Metrix software: Copyright Outback Software Pty Limited. All rights reserved. Portions Copyright Romain Guy. All rights reserved. Includes JavaMail v 1.4.1, source can be found at: Portions Copyright LWJGL Project. Portions Copyright Sun Microsystems, Inc. All rights reserved. Portions Copyright The Legion Of The Bouncy Castle Portions Copyright Chet Haase, Tim Halloran. All rights reserved. Portions Copyright , The HSQL Development Group. All rights reserved. Portions Copyright by the Hypersonic SQL Group. All rights reserved. Contact us on the EFI website at: w3.efi.com/about-efi/contact-us or us at: metrixsupport@metrixsoftware.com or Call us at: Technical Support:

3 Metrix SQL Server Guide 3 Contents Copyright and Contact Information Preface Installing and Configuring MS-SQL Server Configuring Windows 7 Firewall Settings Configuring Windows XP Pro Firewall Settings Creating an Empty Metrix Database on the SQL Server WITHOUT Data Migration Connecting Metrix to SQL Server WITHOUT Data Migration Connecting Metrix to SQL Server and Migrating Data from a Windows computer Connecting Metrix to SQL Server and Migrating Data from a Mac computer Database Backups

4 4 Metrix SQL Server Guide Preface This Guide is provided in order to share the knowledge gained through Testing and Quality Assurance in migrating Metrix data and connecting to Microsoft SQL Server. However, EFI does not support the SQL Server itself. Microsoft SQL Server is a very complex product, and requires the services of a knowledgeable Database Administrator to manage and maintain it. To illustrate this point, here is a small portion of the Certification Test for Microsoft SQL Server 2008: Metrix only supports a connection to an English installation of SQL Server 2005 or SQL Server 2008, either the Full or Express Editions of either version. EFI recommends using an English installation of SQL Server. Other language installations of SQL Server may work, but may just as well have problems.

5 Metrix SQL Server Guide 5 Installing and Configuring MS-SQL Server 2008 See the Microsoft website at for SQL Server System Requirements. 1 The general Installation options you select are dependent upon how your company intends to use SQL Server. The critical installation option that enables SQL Server 2008 to connect with Metrix is the Database Engine Configuration. You must choose Mixed Mode Authentication to enable SQL Server to communicate with Metrix. Enter a password for the SQL Server System Administrator (sa) Account and confirm it. Write down the password, as you will need to enter it later when you edit the metrix.properties file. Click on to continue.

6 6 Metrix SQL Server Guide 2 Next is the Error Reporting dialog. Choose the desired setting then click on the button to continue.

7 Metrix SQL Server Guide 7 3 The Installer should now run until the installation is complete and you see the Complete dialog below. If the Installer stops before this screen, just click on the button to continue until the installation is finished. Now click on to exit the SQL Server 2008 Installer.

8 8 Metrix SQL Server Guide 4 Click on your Start button and go to All Programs. Click on the Microsoft SQL Server 2008 R2 folder, then the Configuration Tools folder, then the SQL Server Configuration Manager.

9 Metrix SQL Server Guide 9 5 In the Configuration Manager select SQL Server Network Configuration, and then Protocols. 6 Right click on TCP/IP, and then left click on Enable. You will be warned that the changes you are making will be saved, but will not take effect until the service is restarted. Click on to close the warning box.

10 10 Metrix SQL Server Guide 7 Right click on TCP/IP, and then left click on Properties.

11 Metrix SQL Server Guide 11 8 Click on the IP Addresses tab and scroll to the bottom of the window. Under IPAII, type 1433 in the field to the right of the TCP Port option. 9 Now click on Apply, and you will be warned that the changes you are making will be saved, but will not take effect until the service is restarted. Click on to close the warning box, then click on to close the TC/IP Properties windows. 10 Now exit the SQL Server Configuration Manager.

12 12 Metrix SQL Server Guide Configuring Windows 7 Firewall Settings Instructions for setting Windows XP Pro firewall setting follow these instructions. Other firewall software will require similar settings. If you need help with the firewall settings in other versions of Windows, please contact Microsoft. Metrix communicates with SQL Server via port If this port is being blocked by a firewall on the SQL Server, then Metrix will fail and report that it can t find the SQL Server. Follow these steps to change the settings in the built-in firewall of Windows 7. 1 Go to Start > Control Panel > Windows Firewall and open the Windows Firewall dialog. 2 In the left-hand column click on Advanced settings.

13 Metrix SQL Server Guide 13 3 In the left-hand column click on Inbound Rules. 4 In the right-hand column click on New Rule. This will begin the New Inbound Rule Wizard.

14 14 Metrix SQL Server Guide 5 In the Rule Type window select the Port option, and then click on.

15 Metrix SQL Server Guide 15 6 In the Protocol and Ports window select TCP and Special Local Ports. 7 Type 1433 in the Special Local Ports field, and then click on.

16 16 Metrix SQL Server Guide 8 In the Action window select Allow the Connection, and then click on.

17 Metrix SQL Server Guide 17 9 In the Profile window leave the options selected, then click on.

18 18 Metrix SQL Server Guide 10 In the Name window type a name for the new port, then click on. 11 Close the Windows Firewall dialog.

19 Metrix SQL Server Guide 19 Configuring Windows XP Pro Firewall Settings Metrix communicates with SQL Server via port If this port is being blocked by a firewall on the SQL Server, then Metrix will fail and report that it can t find the SQL Server. Follow these steps to change the settings in the built-in firewall of Windows XP. Other firewall software will require similar settings. 1 Go to Settings > Control Panel and open the Windows Firewall. If the firewall is set to Off, then the following steps will not be necessary as the firewall is completely disabled. If the Firewall is set to On, make sure the checkbox for Don t allow exceptions is disabled (in other words, you need to allow exceptions).

20 20 Metrix SQL Server Guide 2 Display the Exceptions tab. Click the Add Port button and enter a Name for the exception, and enter 1433 as the Port Number. Click to accept the new exception, and click again to leave the firewall settings.

21 Metrix SQL Server Guide 21 Creating an Empty Metrix Database on the SQL Server WITHOUT Data Migration Follow these steps ONLY if you are installing Metrix for the first time and do not have any data to migrate. The procedure below will create an empty Metrix database in SQL Server 2005 or SQL Server Launch the Run command from the Windows Start menu. 2 Type sqlcmd -E and press ENTER. Make sure to enter a space before the -E and to capitalize the E. The CMD program will drop down a line and insert 1>. 3 Type create database metrix and press ENTER. The CMD program will drop down another line and insert 2>. 4 Type go and press ENTER. When the CMD program drops down a line again and brings up another 1> type quit and press ENTER. 5 Close the CMD window. You have now created an empty Metrix database on the SQL Server. Next you will configure Metrix to connect with the SQL Server.

22 22 Metrix SQL Server Guide Connecting Metrix to SQL Server WITHOUT Data Migration 1 Supplied with this document is a file called Connect_to_Empty_SQLServer_Database.txt. Open it with a text editor such as Notepad or Wordpad and copy the 4 lines in the file. They are: jdbc.driver=com.microsoft.sqlserver.jdbc.sqlserverdriver jdbc.url=jdbc:sqlserver://your IP:1433;DatabaseName=metrix;responseBuffering=adaptive; jdbc.user=sa jdbc.password=your PASSWORD 2 In order to connect Metrix to the SQL Server database, you need to copy the 4 lines into the metrix.properties file, found in the Metrix folder at the root level. Using a text editor such as Notepad or Wordpad, open the metrix.properties file. Here is an example of an unaltered metrix.properties file:

23 Metrix SQL Server Guide 23 3 Paste the 4 lines at the bottom of the file. Replace YOUR IP in line 2 with the IP address of your SQL Server computer, and replace YOUR PASSWORD with the password you used when installing the SQL Server. jdbc.driver=com.microsoft.sqlserver.jdbc.sqlserverdriver jdbc.url=jdbc:sqlserver://your IP:1433;DatabaseName=metrix;responseBuffering=adaptive; jdbc.user=sa jdbc.password=your PASSWORD 4 Now add a # symbol to the first 4 lines that begin with jdbc this will comment out the lines referring to the old Metrix database and effectively disable them. # jdbc.driver=org.hsqldb.jdbcdriver # jdbc.url=jdbc:hsqldb:hsql://your IP:9939 # jdbc.user=sa # jdbc.password= 5 Your metrix.properties file should now look like this, except that it will contain your IP address and your password:

24 24 Metrix SQL Server Guide 6 Save the metrix.properties file and close it. 7 Launch the License Server and a Metrix client. There is no need to ever launch the Metrix Data Server again Metrix will now always connect to the SQL Server. You can now remove the Start Metrix Database Server and Stop Metrix Database Server icons from the desktop since they will no longer be necessary. All necessary changes are now complete. The procedures for launching and quitting the Metrix License Server are unaffected and remain the same. 8 Copy the edited metrix.properties file to all the other Metrix clients.

25 Metrix SQL Server Guide 25 Connecting Metrix to SQL Server and Migrating Data from a Windows computer 1 In order to migrate the data from the Metrix database to the SQL Server database, you will need 2Gb of memory on the Metrix Data Server computer. Ensure your Metrix Data Server meets the minimum system requirements to perform the migration. 2 Quit any Metrix clients and run Stop Metrix Database Server. 3 Supplied with this document is a file called Connect_to_SQLServer_Database_and_Migrate_Metrix_Data.txt. Open it with a text editor such as Notepad or Wordpad and copy the 4 lines in the file. They are: jdbc.driver2=com.microsoft.sqlserver.jdbc.sqlserverdriver jdbc.url2=jdbc:sqlserver://your IP:1433;DatabaseName=metrix;responseBuffering=adaptive; jdbc.user2=sa jdbc.password2=your PASSWORD 4 In order to connect Metrix to the SQL Server database and migrate your existing data, you need to copy the 4 lines into the metrix.properties file, found in the Metrix folder at the root level. Using a text editor such as Notepad or Wordpad, open the metrix.properties file. Here is an example of an unaltered metrix.properties file:

26 26 Metrix SQL Server Guide 5 Paste the 4 lines at the bottom of the file. Replace YOUR IP in line 2 with the IP address of your SQL Server computer, and replace YOUR PASSWORD with the password you used when installing the SQL Server. jdbc.driver2=com.microsoft.sqlserver.jdbc.sqlserverdriver jdbc.url2=jdbc:sqlserver://your IP:1433;DatabaseName=metrix;responseBuffering=adaptive; jdbc.user2=sa jdbc.password2=your PASSWORD Your metrix.properties file should now look like this, except that it will contain your IP address and your password: 6 Save the metrix.properties file and close it. 7 Launch Start Metrix Database Server.

27 Metrix SQL Server Guide 27 8 Open the Metrix folder and double click on the Start_DbMigrator.bat file. It will display a long list of procedures as it performs the migration. When the process is completed, it will report SUCCESS. The data has now been migrated from the existing Metrix Data Server to the SQL Server database. 9 Stop or Shutdown the Metrix Data Server. 10 Using a text editor such as Notepad or Wordpad, open the metrix.properties file again. Add a # symbol to the first 4 lines that begin with jdbc this will comment out the lines referring to the old Metrix database and effectively disable them. # jdbc.driver=org.hsqldb.jdbcdriver # jdbc.url=jdbc:hsqldb:hsql://your IP:9939 # jdbc.user=sa # jdbc.password=

28 28 Metrix SQL Server Guide 11 Remove the 2 just before the = in the remaining 4 lines that begin with jdbc (the ones you copied and pasted into this file earlier). The metrix.properties file should now appear similar to this, except that it will contain your IP address and your password: 12 Save the metrix.properties file and close it. 13 Launch the License Server and a Metrix client to make sure you can access your project data. There is no need to ever launch the Metrix Data Server again Metrix will now always connect to the SQL Server database. You can now remove the Start Metrix Database Server and Stop Metrix Database Server icons from the desktop since they will no longer be necessary. All necessary changes are now complete. The procedures for launching and quitting the Metrix License Server are unaffected and remain the same. 14 Copy the edited metrix.properties file to all the other Metrix clients.

29 Metrix SQL Server Guide 29 Connecting Metrix to SQL Server and Migrating Data from a Mac computer 1 In order to migrate the data from the Metrix database to the SQL Server database, you will need 2Gb of memory on the Metrix Data Server computer. Ensure your Metrix Data Server meets the minimum system requirements to perform the migration. 2 Quit all Metrix clients and run Stop Metrix Database Server (Mac) or Shutdown Metrix Database Server (Windows). 3 Supplied with this document is a file called Connect_to_SQLServer_Database_and_Migrate_Metrix_Data.txt. Open it with a text editor such as TextEdit and copy the 4 lines in the file. They are: jdbc.driver2=com.microsoft.sqlserver.jdbc.sqlserverdriver jdbc.url2=jdbc:sqlserver://your IP:1433;DatabaseName=metrix;responseBuffering=adaptive; jdbc.user2=sa jdbc.password2=your PASSWORD 4 In order to connect Metrix to the SQL Server database and migrate your existing data, you need to copy the 4 lines into the metrix.properties file, found in the Metrix folder in your Applications folder. Using a text editor such as TextEdit, open the metrix.properties file. Here is an example of an unaltered metrix.properties file:

30 30 Metrix SQL Server Guide 5 Paste the 4 lines at the bottom of the file. Replace YOUR IP in line 2 with the IP address of your SQL Server computer, and replace YOUR PASSWORD with the password you used when installing the SQL Server. jdbc.driver2=com.microsoft.sqlserver.jdbc.sqlserverdriver jdbc.url2=jdbc:sqlserver://your IP:1433;DatabaseName=metrix;responseBuffering=adaptive; jdbc.user2=sa jdbc.password2=your PASSWORD Your metrix.properties file should now look like this, except that it will contain your IP address and your password: 6 Save the metrix.properties file and close it. 7 Start the Metrix Data Server. 8 Launch the Terminal application, normally found in the Applications > Utilities folder.

31 Metrix SQL Server Guide 31 9 To change the directory to the Metrix folder, type cd followed by a space. Find the Metrix folder in the Applications folder, drag it into the Terminal window, and press ENTER. This will enter the correct path into the Terminal application. 10 Type sh DbMigrator.sh and press ENTER, which will start the migration process. Terminal will display a long list of procedures as it performs the migration. When the process is completed, it will report SUCCESS. The data has now been migrated from the existing Metrix Data Server to the MS-SQL Database.

32 32 Metrix SQL Server Guide 11 Run Stop Metrix Database Server (Mac) or Shutdown Metrix Database Server (Windows). 12 Using a text editor such as TextEdit, open the metrix.properties file again. Add a # symbol to the first 4 lines that begin with jdbc this will comment out the lines referring to the old Metrix database and effectively disable them. # jdbc.driver=org.hsqldb.jdbcdriver # jdbc.url=jdbc:hsqldb:hsql://your IP:9939 # jdbc.user=sa # jdbc.password= 13 Remove the 2 just before the = in the remaining 4 lines that begin with jdbc (the ones you copied and pasted into this file earlier). The metrix.properties file should now appear similar to this, except that it will contain your IP address and your password:: 14 Save the metrix.properties file and close it. 15 Launch the License Server and a Metrix client to make sure you can access your project data. There is no need to ever launch the Metrix Data Server again Metrix will now

33 Metrix SQL Server Guide 33 always connect to the SQL Server database. You can now remove the Start Metrix Database Server and Stop Metrix Database Server icons from the desktop since they will no longer be necessary. All necessary changes are now complete. The procedures for launching and quitting the Metrix License Server are unaffected and remain the same. 16 Copy the edited metrix.properties file to all the other Metrix clients.

34 34 Metrix SQL Server Guide Database Backups Backup of your Metrix SQL database is of course crucial. Meet with your SQL Server Administrator as soon as possible to determine your backup strategy and procedure. Should you ever need to submit your database to EFI Support for examination, you must supply a FULL backup: