MATCH IT! Antibody v1.2 Software Installation Table of Contents 1.0 Table of Contents... 1 2.0 Revisions... 2 3.0 Installation Checklist... 3 4.0 Prerequisites... 4 5.0 Database Configuration Options... 5 6.0 Software Installation... 11 7.0 Services Installation... 24 8.0 Post-installation Steps... 33 9.0 Appendix A... 35 10.0 Appendix B Trouble Shooting...50
2.0 Revisions Date Author Revision Description 6/19/14 J. Cherry-Woods 0 Creation 8/12/2014 J. Cherry-Woods 1 CR10509 CR10510 CR10511 9/23/2014 M. DeConinck 2 CR10785 CR10786 CR10793 10/15/2014 M. DeConinck 3 CR10932 Page 2 of 51 LC1459.3 (10/14)
3.0 Installation Checklist The Installation Checklist has been designed to guide you through this process. Please contact Technical Support with any questions. 1. Before installing MATCH IT! Antibody v1.2 determine the following: a. Does the computer have 4GB of RAM? If yes, proceed. If no, the install will not run without 4GB of RAM. b. Is there an existing MATCH IT! ANTIBODY v1.0.0.x database? If yes, please refer to the MATCH IT! Antibody v1.1 Installation Instructions (LC1327) and complete the steps below: i. Upgrade all databases to MATCH IT! V1.0.0.8 Appendix A ii. Upgrade SQL Server to 2008 Appendix B iii. Uninstall MATCH IT! V1.0 and MATCH IT! V1.0.0.8 on all machines including Clients Appendix C iv. Execute the SQL Script to upgrade the existing V1.0.0.8 database to a V1.1 database Appendix D c. If no existing MATCH IT! Antibody v1.0.0.x is present or if MATCH IT! Antibody v1.1.x database is available or if this is the first time MATCH IT! Antibody v1.2 is installed; decide what database configuration is required? i. Server based pg4 ii. Dedicated workstation pg6 iii. Luminex system pg8 d. Is the Autobatch setup feature going to be used in MATCH IT!? i. If LIFECODES Services has already been setup and working, please update the computer with the most current LIFECODES Services Service Pack. Navigate to WWW.IMMUCOR.COM and from the LIFECODES drop down menu, select the link for Transplant. Select any of the Lifecodes products listed. Select Software. Select the MATCH IT! folder. Select MATCH IT! Antibody. Navigate to the Services Release folder and update with the latest service pack. ii. If LIFECODES Services have not been installed, then installation of the LIFECODES Services is required. Pg 21 1. Are the CSV files held on a network drive? a. If yes, request a service account with access to the network directory from your Network administrator. 2. If a firewall is running on the system open port 7575 for TCP/IP traffic. (directions can be found in appendix A for Windows XP and Windows 7) 2. Administrative rights are required for installation of MATCH IT! v1.2 and LIFECODES Services. If you have any questions about the Installation Process please contact Technical Support for assistance. Page 3 of 51 LC1459.3 (10/14)
4.0 Prerequisites Installation process will install these prerequisites as required. Microsoft SQL Server 2008 Microsoft.NET Framework 3.5 with SP1 or greater Microsoft SQL Server Management Objects 11.0 Page 4 of 51 LC1459.3 (10/14)
5.0 Database Configuration Options Immucor s MATCH IT! product supports a number of different network topologies allowing it to be configured to meet the needs of the network and IT policies. 1. Server Based Installation - Recommended The configuration assumes that the IT department has a dedicated server running Microsoft SQL Server 2008 Standard edition or above. Immucor will provide the database administrator a database as an.mdf file for attachment and instructions for setup of the database user. Pros for this configuration Database Server will be more efficient in processing data compared to a standard desktop database. IT typically backs up their database systems nightly. More stable configuration for the system as a whole. Database size is only limited by the amount of space available on hardware. Cons for this configuration Additional cost for Microsoft SQL Server if IT does not already have a dedicated Server. Page 5 of 51 LC1459.3 (10/14)
Figure 1: Server Based Installation Recommended Figure 1: Server Based Installation Dedicated Database Server MATCH IT! database is created on server using a script provided to IT department. Lab PC 1, 2, N - Only the MATCH IT! client is required on Lab PCs. Each PC connects to the MATCH IT! database on dedicated server. Luminex System(s) LIFECODES Services is required for auto batch processing. The MATCH IT! client is optional on this machine. Notes: Connection between Lab PC(s) and Luminex System is over TCP/IP If the Luminex System has a firewall running, port 7575 must be opened for communication between Lab PC(s) and the Luminex system(s). Page 6 of 51 LC1459.3 (10/14)
2. Dedicated Desktop PC SQL Server Express Installation The configuration assumes the Lab has a dedicated Desktop machine that will be used as the main SQL Server 2008 Express server. Pros for this configuration Less cost than a dedicated database server (SQL Server Express is free from Microsoft) Better option than using Luminex system as the database server if a dedicated database server is not available. Cons for this configuration Limited Database size of 10 GB. SQL Server Express would require intervention to create nightly backups System performance could degrade as the system is database dependent Page 7 of 51 LC1459.3 (10/14)
Figure 2: Dedicated Desktop PC SQL Server Express Installation Figure 2: Dedicated Workstation Database Dedicated PC Workstation Full database installation of MATCH IT! is required. Lab PC 1, 2, N - Only the MATCH IT! client is required on Lab PCs. Each PC connects to the MATCH IT! database on dedicated PC workstation. Luminex System(s) - LIFECODES Services is required for auto batch processing. The MATCH IT! client is optional on this machine. Notes: Connection between Lab PC(s) and Luminex System is over TCP/IP If Luminex System has a firewall running port 7575 must be opened for communication between Lab PC(s) and the Luminex system(s). Page 8 of 51 LC1459.3 (10/14)
3. Luminex System with MATCH IT! Database (Not recommended for high volume) The configuration assumes the Lab is using the Luminex System or another client system to house their main MATCH IT! database. This installation requires the full MATCH IT! database for the Luminex system. This will be accomplished in Step 5 of Section 6. Pros for this configuration no cost as Luminex system is already available Cons for this configuration System performance could degrade as now both the MATCH IT! Database and the Luminex Database are both on the same system contend for resources. User intervention required for nightly backups. Page 9 of 51 LC1459.3 (10/14)
Figure 3: Luminex System with MATCH IT! Database (Not recommended for high volume) Figure 3: Luminex or other client computer serving as Database Server. Lab PC 1, 2, N Only the MATCH IT! Client is required on Lab PCs. Each PC connects to the MATCH IT! database on Luminex PC. Luminex System(s) Full installation of MATCH IT! is required. LIFECODES Services is required for auto batch processing. Notes: Connection between Lab PC(s) and Luminex System is over TCP/IP If Luminex System has a firewall running port 7575 must be opened for communication between Lab PC(s) and the Luminex system(s). Page 10 of 51 LC1459.3 (10/14)
6.0 Software Installation If this is a MATCH IT! v1.0.0.x upgrade to MATCH IT! v1.2, confirm the checklist in Section 3 has been completed before proceeding. The installation of MATCH IT! Antibody v1.2 requires 4GB of RAM. Insert the Installation CD into the CD Player on the target computer. Open the CD from My Computer and Setup.exe. For Windows 7, right click on Setup.exe and select Run as administrator. Please note: there may be a delay when executing the Setup.exe for some computers. 1. MATCH IT! Antibody - InstallShield Wizard- Click Install Please note: depending on the target computer configuration not all of the requirements in the screen shot will be listed. Page 11 of 51 LC1459.3 (10/14)
a. After clicking Install, the installation process will ask if SQL Server 2008 should be installed. i. Click Yes if this is a New and Full install of MATCH IT! v1.2 (Where SQL Server 2008 R2 is not installed on the target computer) ii. Click No if this is a Client install of MATCH IT! (Where MATCH IT! Antibody v1.1 and/or MATCH IT! DNA are already installed on the target computer.) b. The installation process may ask if Microsoft SQL Server System CLR Types should be installed. This is required to be installed. Click Yes for all install types. c. The installation process may ask if Microsoft SQL Server 2008 Management Objects should be installed. This is required to be installed. Click Yes for all install types. d. If any of the Microsoft SQL 2012 prerequisites fail installation, click Yes to continue. Page 12 of 51 LC1459.3 (10/14)
2. Begin the MATCH IT! System Installation Click Next. 3. Database Server Connection Selection: If this is a New Install with a Local Database, proceed to step 3a. If a MATCH IT! Database already exists locally, or if the database is located on a dedicated desktop/server, proceed to step 3b. a. If this is a New and Full install of MATCH IT! v1.2 (no earlier versions of MATCH IT! Antibody or MATCH IT! DNA are installed.), make sure I do not want to configure the MatchIT database is not checked (unchecked). Select Server authentication using the Login ID and password Page 13 of 51 LC1459.3 (10/14)
Login ID: sa Password: GenProbeS@L Click Next The database installation process will create the EVOLUTION instance on the target system. b. If any of the following conditions are true: i. This is a Client install of MATCH IT! v1.2 ii. This is a MATCH IT! v1.1 to MATCH IT! v1.2 upgrade iii. MATCH IT! DNA is already installed. Select I do not want to configure the MATCHIT database this will allow the installation to continue without creating a database on the system. Click Next Page 14 of 51 LC1459.3 (10/14)
Note: For Client Installs when database is located on a dedicated desktop or a server the following message may display. Click OK and continue Installation. 4. Begin Installation Click Install, then Finish. Page 15 of 51 LC1459.3 (10/14)
5. Open MATCH IT! AB v1.2 and then proceed to step 6. 6. For Upgrades Only it is necessary to download DatabaseUpdate_Ab12v1.exe from WWW.IMMUCOR.COM\LIFECODES to complete the upgrade to MATCH IT! Antibody 1.2. a. From the Immucor home page, click the link for LIFECODES Transplant. b. Select any LIFECODES Antibody Transplant product and navigate to the Software link at the bottom half of the page. Page 16 of 51 LC1459.3 (10/14)
c. Select MatchIT MatchIT-Antibody Software_Updates. d. Download the DatabaseUpdate_Ab12v1.exe e. Right click on the executable and select run (as administrator) f. The Run Package will open. Page 17 of 51 LC1459.3 (10/14)
g. Server field should be: server name server name\evolution (local)\evolution *If the database is located on a dedicated server use the server name *If the database is being updated via the network use Server name\evolution *If the database is located locally on a lab computer (PC with Full Installation) use (local)\evolution Please note: In some instances the MATCH IT! Databases may be in the LIFECODES instance. If this is the case, please enter (local)\lifecodes h. Select SQL Server Authentication User name = evosa Password = lifematch#1 i. Select Upgrade an existing database j. Click the arrow on the right-hand side of the Database text box. Select the database to upgrade. Page 18 of 51 LC1459.3 (10/14)
Please note: It may be necessary to enable the TCP/IP from Microsoft SQL Server Configuration Manager to select the database. k. Repeat for each database that will be used with MATCH IT! Antibody v1.2. 7. Verify successful installation or upgrade to MATCH IT! Antibody 1.2 and the new version of Database Management: Link to MATCH IT! Antibody is located in Start Menu All Programs Lifecodes. MATCH IT! Antibody v1.2 files are located in C:\Program Files\LIFECODES\Match IT! Antibody 8. If this is a client install and the database is located on a dedicated desktop or a server, verify the computer /server name is included in the XMLServerList.xml. Locate XMLServerList.xml in the following directory: Windows 7 - C:\Program Data\Lifecodes Windows XP - C:\Documents and Settings\All Users\Application Data\Lifecodes Open the file with Notepad. Add/verify the server name inside the Server tags within the XMLServerList.xml file and close file and save file. Page 19 of 51 LC1459.3 (10/14)
The XMLServerList.xml file can be used on all computers connecting to the same database. 9. If this is a client install and the database is located on a dedicated desktop or a server, connect to the database using Database Management: Start Menu All Programs Lifecodes Database Management. Select DNA from the Select Application dropdown. Log in Database Management: Login Name: dbadmin Password: GenProbeS@L1 Click Login Page 20 of 51 LC1459.3 (10/14)
Note: If this is a new client install the window below will not display. Click on Choose Server Choose a server name or desktop name from the drop down list of Available Sql Instances and select Connect. Highlight the database of interest from the list of Available Databases. Select OK. Page 21 of 51 LC1459.3 (10/14)
Highlight the database of interest on the Database Management home screen. Click Connect. Close Database Management and verify the software is connected to the correct database. 10. Software Release Notes will be sent to all customers when MATCH IT! Antibody v1.2 Service Packs are released. Service Packs are available for download from WWW.IMMUCOR.COM/LIFECODES. 11. There should now be a MATCH IT! Antibody shortcut on the computer desktop. All other MATCH IT! shortcuts can be deleted. 12. Launch the MATCH IT! Antibody software. Please refer to Appendix B for commonly occurring errors. 13. On first launch of the MATCH IT! Antibody Software the following box may pop up indicating successful database upgrade. Page 22 of 51 LC1459.3 (10/14)
Special Notes: For Non-administrator Users: These steps are required prior to using the software for each individual. 1. Navigate to: C:\Program Files\LIFECODES\Match IT Antibody 2. Copy and paste the Lifecodes folder into the following location: Windows 7 - C:\ Users\ <User Name>\ App Data\ Local Windows XP - C:\ Documents and Settings\ <User Name>\ Local Settings Application Data Page 23 of 51 LC1459.3 (10/14)
7.0 Services Installation For the Auto batch processing to run, LIFECODES Services v1.2 must be installed on all Luminex Systems in the Lab. If LIFECODES Services v1.1 is already installed on the computer, download and install the latest service pack version to upgrade to LIFECODES Services 1.2. (go to step 7). If LIFECODES Services is not already installed and this a new install, go to step 1 to complete a full installation of LIFECODES Services. Caution: Administrative Rights are required for this installation. LIFECODES Services Installation Steps: 1. Insert the Installation CD into the CD Player on the target computer. Open Windows Explorer, browse to the CD drive, open the Services folder and Select setup.exe. 2. Installation of Microsoft.NET Framework 3.5 sp1 If the target system does not have the.net Framework 3.5 sp1 installed the first step in the process is to install this component. (Reminder: Administrative Rights are required for this installation.) Page 24 of 51 LC1459.3 (10/14)
3. System Re-boot may be required. Click Yes. 4. Installation begins Click Next. 5. Complete the Installation-Click Install. Page 25 of 51 LC1459.3 (10/14)
6. Upon completion Click Finish. A reboot may be necessary. Go to Step 11 to configure the folder directory. 7. Service Pack Upgrade Install: Download the most current LIFECODES Services Service Pack. Navigate to WWW.IMMUCOR.COM/LIFECODES and click Lifecodes->Tranplant--> Select any product -- select SOFTWARE (located at the bottom half of the screen) Page 26 of 51 LC1459.3 (10/14)
Select MATCHIT! --> MATCHIT!- Antibody Services Releases- Select the latest Service Pack version. 8. Once downloaded, double click to execute and click Next. Page 27 of 51 LC1459.3 (10/14)
9. Click Install. 10. Click Finish. A reboot may be necessary. Page 28 of 51 LC1459.3 (10/14)
11. For Upgrades only a. copy the XMLLumServerList.xml from In Windows XP - C:\Documents and Settings\All Users\Application Data\Gen-Probe In Windows 7 - C:\Program Data\Gen-Probe To In Windows XP - C:\Documents and Settings\All Users\Application Data\Lifecodes In Windows 7 - C:\Program Data\Lifecodes 12. For New Installs Only Services Folder Configuration on Luminex Machine for Auto Import: Three file directories are required for the Lifecodes Services to run correctly. These are set in MATCH IT! Watch Service Configuration Manager. a. Luminex Output Folder this is the folder location where upon assay completion, Luminex puts the CSV file. b. MATCHIT! XML Folder The MATCH IT! Software will place an XML file in this location for each Auto-Batch Created and sent to the Luminex System. c. MATCHIT! Completed Folder When MATCH IT! has completed processing the CSV file, the XML file associated with that CSV is moved to a completed folder. Create the 3 file directories per one of the examples given below: a. Local xponent Folder Structure: C:\ProgramData\Luminex\xPonent31\Output C:\ProgramData\Luminex\xPonent31\ MatchIT! XML C:\ProgramData\Luminex\xPonent31\ MatchIT! XML\Completed b. Local IS 2.3 Folder Structure: C:\My Batches\Output C:\My Batches\MatchIT! XML C:\My Batches\MatchIT! XML\Completed Page 29 of 51 LC1459.3 (10/14)
c. Networked folder directory example: \\<Server computer name>\my Batches\Output \\<Server computer name>\my Batches\ MatchIT! XML \\<Server computer name> \My Batches\MatchIT! XML\Completed 13. Watch Service Configuration Manager Once the folder structure has been setup, enter folder locations in the WatchFolderConfigurator.exe.Config a. Navigate to the Lifecodes Services folder found in C:\Program Files\LIFECODES b. Right click on WatchFolderConfigurator.exe.Config and select Open with Notepad. c. The WatchFolderConfigurator.exe.Config should open in notepad. d. Add the folder locations created in step 11 to the WatchFolderConfigurator.exe.config Please Note: the WatchFolderConfigurator.exe.Config may not be ordered identical to the images below. The directories should match the keys below: InFolder MatchIT! XML directory OutFolder Luminex Output directory Processed Completed directory xponent Folder Structure Page 30 of 51 LC1459.3 (10/14)
IS 2.3 Folder Structure Networked folder directory example e. Select File Save to save WatchFolderConfigurator.exe.Config f. Set the XMLLumServerList.XML i. Navigate to: In Windows XP - C:\Documents and Settings\All Users\Application Data\Lifecodes In Windows 7 - C:\ProgramData\Lifecodes ii. Right click on XMLLumServerList.XML and select Open with Notepad iii. Enter the name of the Luminex Computer into the XMLLumSeverList.XML. iv. Select File Save. Note: If there are more than 1 Luminex, please copy and paste the line <Server>Computername</Server> and paste above </ServerName> and repeat step iii. Notes for Network Paths: Page 31 of 51 LC1459.3 (10/14)
Directories should be entered as UNC paths, not lettered network drives. See example below. \\stmlab-8vc73m1 You may also need to give the services permissions to access the network folders. Request a service account with access to the network directory from your Network administrator. o o o o o o o o Navigate to Control Panel Services Find Watch Folder Listener Right click and select Properties Click on the Log On Tab Tick This Account Enter the network ID/username and password of a user with permissions to the network drive. Repeat steps for MatchIT Listener Restart the computer. Page 32 of 51 LC1459.3 (10/14)
8.0 Post-installation Steps Several items are required to complete the installation process. Failure to complete these steps may result in problems when printing reports and using Auto Batch processing. 1. Lab Information a. Open the MATCH IT! Antibody software b. From the toolbar open the Settings menu and chose the Preferences menu item. c. The preferences window will open d. Enter the pertinent lab information. This is used as the header information in the system reports so it is important for this information to be available. e. Click the Save Settings button the system will indicate that the save has completed successfully f. If reports will be generated, upload a user Lab Logo to ensure reports are generated correctly. 2. Date Format Settings Page 33 of 51 LC1459.3 (10/14)
a. From the Open Preferences window select the Date Format Setting tab. b. Chose the display date for the system, this will format all dates within the system as the Selected Date Format. Select Save Settings. c. Next set the date format that your Luminex system uses. The Run Date from the CSV file is captured by the MATCH IT! System and thus it is necessary to know what format Luminex is using to put the date in the output CSV file. If this does not match the format upon importing of a CSV the system will ask the end user to specify the run date. d. Click the Close Window button to close this form. Page 34 of 51 LC1459.3 (10/14)
9.0 Appendix A-Opening Firewall Port Procedure for Opening Firewall Port 7575 in Windows 7 1. From the Start menu, open the Control Panel Page 35 of 51 LC1459.3 (10/14)
2. In the Control Panel, click the link labeled Windows Firewall Page 36 of 51 LC1459.3 (10/14)
3. In the Windows Firewall Control Panel page, click the link labeled Advanced settings 4. Select Inbound Rules (on the left), then click on New Rule (on the right) Page 37 of 51 LC1459.3 (10/14)
5. On the first page of the New Inbound Rule Wizard, select Port; then click Next Page 38 of 51 LC1459.3 (10/14)
6. On the next page, click on Specific local ports: and type 7575 into the text box; then click Next Page 39 of 51 LC1459.3 (10/14)
7. On the next page, select Allow the connection; then click Next Page 40 of 51 LC1459.3 (10/14)
8. Decide when the port should be open, and check the appropriate boxes (the default is all boxes checked, as shown below); then click Next Page 41 of 51 LC1459.3 (10/14)
9. Give the rule a name, and optionally a description (remembering the name you choose here may make it easier to close the firewall port, if you decide to at some later time); then click Finish Page 42 of 51 LC1459.3 (10/14)
10. Select Outbound Rules (on the left), then click on New Rule (on the right) 11. Repeat Steps 5 through 9. Page 43 of 51 LC1459.3 (10/14)
Procedure for Opening Firewall Port 7575 in Windows XP 1. From the Start menu, open the Control Panel Page 44 of 51 LC1459.3 (10/14)
2. In the Control Panel, click on the Security Center link (note: if your Control Panel screen looks different from the image below, click on Switch to Category View which should change your screen s appearance so it matches the image below) Page 45 of 51 LC1459.3 (10/14)
3. In Windows Security Center, click on the Windows Firewall link Page 46 of 51 LC1459.3 (10/14)
4. Select the Exceptions tab 5. Click on Add Port Page 47 of 51 LC1459.3 (10/14)
6. Make sure TCP is selected; then type a name for the port, type 7575 in the Port number text box, and then click OK Page 48 of 51 LC1459.3 (10/14)
7. Click OK Page 49 of 51 LC1459.3 (10/14)
10.0 Appendix B-Trouble Shooting Post Installation. 1. If MATCH IT! Antibody v1.2 displays a connection error to the database or requests an evosa password upon opening the software follow the below instructions. (This usually occurs after a system upgrade from MATCH IT! Antibody v1.1 to v1.2) a. Close MATCH IT! Antibody software. b. Delete all Old MATCH IT! shortcuts associated with the previous MATCH IT! version. Shortcuts should be manually deleted from desktop and Start menu i. Select old MATCH IT! (Blue) shortcut. ii. Right click on the shortcut iii. Click Delete. iv. Click yes on Delete Shortcut message. c. Copy the External_matchit.config file from Windows 7 - C:\ProgramData\GenProbe Windows XP - C:\Documents and Settings\All Users\Application Data\ GenProbe To Windows 7 - C:\ProgramData\Lifecodes Windows XP - C:\Documents and Settings\All Users\Application Data\Lifecodes 2. If an Unhandled Exception error message (" Conversion from string to type Boolean is not valid") is displayed upon selecting Automated Batch Setup follow the below instructions. a. Select 'Continue' on the Unhandled Exception message box. b. In Automated Batch Setup, select the Automated Batch Preferences tab. Select the columns needed for the batch under Batch Import Column:. Select the Update Batch preferences button. Close Autobatch setup and reopen Automated Batch Setup to ensure the error message does not reappear. Page 50 of 51 LC1459.3 (10/14)
3. If CSV files will not import because of file formatting, copy the NumFormats.xml found in To correct the issue, copy the NumFormats.xml from: Win7- C:\Users\<User Name>\AppData\Local\Lifecodes OR XP- C:\Documents and Settings\<User Name>\Local Settings\Application Data\Lifecodes To C:\Program Files\LIFECODES\Match IT! Antibody Page 51 of 51 LC1459.3 (10/14)