MATCH IT! Platelet Antibody Software Installation v1.0.1

Transcription

1 MATCH IT! Platelet Antibody Software Installation v Table of Contents 1.0 Table of Contents Revisions Installation Checklist Prerequisites Database Configuration Options Software Installation Services Installation Post-installation Steps Appendix A... 23

2 2.0 Revisions Date Author Revision Description 3/11/13 A.Storm 0 Creation for Software v1.0 4/1/13 A.Storm 1 Modify footer to add address 6/24/13 A.Storm 2 Rebranding to GTI Immucor 6/9/2014 L Calzetta 3 Update for Software v /26/2015 A Cochran D Transfer ownership of document to Waukesha. Update telephone number. Remove LIFECODES brand A. Cochran E Removed software part number. Installation Guide will be used for both CE and RUO versions of software S. Bettencourt F Update Installation Instructions to include DatabaseUpdate_PakLXv101_v S. Bettencourt G Update Installation Instructions to include DatabaseUpdate_PakLXv101_v H. Shah H Update Installation Instruction for new Installation UI Page 2 of 42

3 3.0 Installation Checklist 3.1 Before installing MATCHIT! PLATELET ANTIBODY v1.0.1 determine the following a. What database configuration is required? i. Server based ii. Dedicated workstation iii. Luminex system b. Is auto batch setup going to be used? i. If the LIFECODES Services have already been setup and are working then there is nothing to do. If not, then installation of the LIFECODES Services is required. 1. Are the CSV file held on a network drive? a. If yes, request a service account with access to that directory from your IT for the services to run under. 2. If a firewall is running on the system open port 7575 for TCPIP traffic. (directions can be found in appendix B for Windows XP and Windows 7) 3.2 Administrative rights are required for installation of MATCH IT! Platelet Antibody v1.0.1 and LIFECODES Services. 4.0 Prerequisites Installation process will install these prerequisites as required. 4.1 Microsoft.NET Framework 3.5 with SP1 4.2 Microsoft SQL Server Management Objects 10.0 Page 3 of 42

4 5.0 Database Configuration Options Immucor s MATCHIT! product supports a number of different network topologies allowing it to be configured to meet the needs of the network and IT policies. 5.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 customer s IT department with a database script which when run on their server will create the necessary database user along with necessary permissions as well as the default database. 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 4 of 42

5 Figure 1: Server Based Installation Recommended Figure 1: Server Based Installation Dedicated Database Server MATCHIT! Database is created on server using a script provided to IT department. Lab PC 1, 2, N - Only the MATCHIT! Client is required on Lab PCs. Each PC connects to the MATCHIT! database on dedicated server. Luminex System(s) LIFECODES Services is required for auto batch processing. The MATCHIT! 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 5 of 42

6 5.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 6 of 42

7 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 MATCHIT! Client is required on Lab PCs. Each PC connects to the MATCHIT! database on dedicated PC workstation. Luminex System(s) - LIFECODES Services is required for auto batch processing. The MATCHIT! 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 7 of 42

8 5.3 Luminex System with MATCHIT! Database (Not recommended for high volume) The configuration assumes the Lab is using the Luminex System or another client system to house their main MATCHIT! database. This installation requires the full MATCHIT! 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 MATCHIT! Database and the Luminex Database are both on the same system contend for resources. User intervention required for nightly backups. Page 8 of 42

9 Figure 3: Luminex System with MATCHIT! Database (Not recommended for high volume) Figure 3: Luminex or other client computer serving as Database Server. Lab PC 1, 2, N Only the MATCHIT! Client is required on Lab PCs. Each PC connects to the MATCHIT! database on Luminex PC. Luminex System(s) Full installation of MATCHIT! 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 9 of 42

10 6.0 Software Installation 1. Insert the Installation CD into the CD Player on the target computer. CD will begin playing and display the install directory, if it does not Autorun, then through Windows Explorer browse to the CD Player and Right Click on the MATHCH_IT_PakLx_Setup.exe file and Select Run as administrator. Please note: There may be a delay when executing the MATCHIT! Platelet Install for some computers. 2. MATCH IT! Platelet Antibody Installation- User Account Control- Click Yes Page 10 of 42

11 3. MATCH IT! Platelet Antibody Installation- Welcome screen Click Next 4. MATCH IT! Platelet Antibody Installation- System Check- Click Next The Installation process is checking the operating system and available system memory. If the minimum requirement for installation are not met the install will cancel and the MATCH IT! Software will not install. NOTE for Vista and XP: If Microsoft SQL server pre-requisite is required than Installer will install it automatically. This will cause an automatic restart on the target computer. After Computer reboot go to back to step1 Page 11 of 42

12 5. MATCH IT! Platelet Antibody Installation- End User License Agreement Check off I accept the license agreement. Click Next 6. MATCH IT! Platelet Antibody Installation Available Application Installation Page 12 of 42

13 Note: if Luminex xponent software is present on the computer, the install will install LIFECODES Services. Otherwise installer will disable LIFECODES Service check box. 7. MATCH IT! Platelet Antibody Installation- Database server a. If this is a New Install with a local Database: Select Install SQL Server Express and create a new database locally b. If any of the following condition are true: Page 13 of 42

14 i. This is a client Install of MATCH IT! Platelet Antibody. ii. This is a MATCH IT! Platelet Antibody upgrade. Select I do not wish to configure the MATCH IT! Database Select Next 8. MATCH IT! Platelet Antibody Installation- Click Next 9. MATCH IT! Platelet Antibody Installation- Installation Process Click Next Page 14 of 42

15 10. MATCH IT! Platelet Antibody Installation Completed Click Complete. Page 15 of 42

16 NOTE: Database Connection information The database installation process completed above created the EVOLUTION instance on the target system. Leave all of the defaults as they are on the screen Login ID: sa Password: 11. Database Updates Note: If MATCH IT! Antibody software v1.3 and/or MATCH IT! DNA software v1.2.4 is installed on the computer please follow the steps below to run DatabaseUpdate_PakLXv101_v1 DatabaseUpdate_PakLXv101_v1 1) Download DatabaseUpdate_PakLXv101_v1 from 2) From the Immucor home page click the link for LIFECODES Transfusion Medicine. 3) Select LIFECODES Pak Family Products and navigate to the Software link at the bottom half of the page. 4) Select MATCHIT! MATCHIT Platelet-Antibody Database Updates 5) Download the DatabaseUpdate_PakLXv101_v1.exe 6) Right click on the executable and select run (as administrator) 7) The Run Package will open. Page 16 of 42

17 8) 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 9) Select SQL Server Authentication User name = evosa Password = lifematch#1 10) Select Upgrade an existing database 11) Click the arrow on the right-hand side of the database text box. Select the database to upgrade. Select Run. DatabaseUpdate_PakLXv101_v2 Page 17 of 42

18 1) Download DatabaseUpdate_PakLXv101_v2 from 2) From the Immucor home page click the link for LIFECODES Transfusion Medicine. 3) Select LIFECODES Pak Family Products and navigate to the Software link at the bottom half of the page. 4) Select MATCHIT! MATCHIT Platelet-Antibody Database Updates 5) Download the DatabaseUpdate_PakLXv101_v2.exe 6) Right click on the executable and select run (as administrator) 7) The Run Package will open. 8) Server field should be: server name* server name/evolution** (local)\evolution*** * If the database is located on a dedicated server use the server name Page 18 of 42

19 ** 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 9) Select SQL Server Authentication User name = evosa Password = lifematch#1 10) Select Upgrade an existing database 11) Click the arrow on the right-hand side of the database text box. Select the database to upgrade. Select Run. 7.0 Services Installation SERVICE INSTALLATION For the Auto batch processing, LIFECODES Service must be installed on all Luminex Systems in the Lab. Download from Software.aspx?RootFolder=%2Fglobal%2FProducts%2FLIFECODES%20So ftware%2fmatchit%21%2fmatchit- DNA%2FServices%20Release&FolderCTID=0x012000A24D3CB1FDB11C4 E93C299126A8DC69C&View={2F0C5D D55-9DB2-0987E2E5BE78} 1) Right Click on installer and Run as Administrator. Page 19 of 42

20 2) Select Install 3) Confirm Successful installation and select Exit 7.1 Configuration for Auto Import Folder Structure on Luminex Machines 3 directories are required for the Lifecodes Services to run correctly. These are set in the MATCHIT! Folder Watch Service Configuration Manager. Luminex Output Folder this is the folder location where upon assay completion Luminex puts the CSV file. MATCHIT! XML Folder The MATCHIT! Software will place an XML file in this location for each Auto-Batch Created and sent to the Luminex System. MATCHIT! Completed Folder When MATCHIT! has completed processing the CSV file, the XML file associated with that CSV is moved to a completed folder. 1) Create the 3 file directories. The following are examples Page 20 of 42

21 a. Local xponent 3.1 or 4.2 Folder Structure: C:\ProgramData\Luminex\xPONENT31\Output C:\ProgramData\Luminex\xPONENT31\MatchIT! XML C:\ProgramData\Luminex\xPONENT31\MatchIT! XML\Completed OR C:\ProgramData\Luminex\xPONENT42\Output C:\ProgramData\Luminex\xPONENT42\MatchITXML C:\ProgramData\Luminex\xPONENT42\MatchITXML\Completed b. Local IS 2.3 Folder Structure: C:\My Batches\Output C:\My Batches\MatchIT! XML C:\My Batches\MatchIT! XML\Completed 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 2) Watch Service Configuration Navigate to C:\Program Files\Lifecodes\ Lifecode Services. Right click on the WatchFolderConfigurator.exe.config and open in Notepad. Copy the location created on step for Output into the OutFolder value, MatchITXML into the InFolder value and the Completed folder into the Processed value. Click Save and close. xponent v3.1 Folder Structure (if using xponent 4.2, use xponent42 in the folder structure instead of xponent31) IS 2.3 Folder Structure Networked folder directory example Page 21 of 42

22 Note: If the Luminex output csv files are going to a network location always enter the unc path and not the mapped drive letter. See example: \\stmlab-8vc73m1 Select File Save to save WatchFolderConfigurator.exe.Config. (If you are unable to save the config. file in the Lifecodes directory, save file on the desktop and then drop the config file into the C:\Program Files\LIFECODES\Lifecodes Services directory.) Special Notes: Networked Directory: If using a Networked folder directory, 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. Navigate to Control Panel Adminstrative Tools 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. 3) Setup the XMLLumServerList.XML file: a. Navigate to: Windows 7 - C:\ProgramData\Lifecodes (Note: If the Program Data file is hidden do the following: In Windows Explorer go to Tools Folder Options. Select View tab. Under Advanced setting: toggle Show hidden files, folders, or drives. Select Apply and OK.) b. Right click on XMLLumServerList.XML and select Open with Page 22 of 42

23 Notepad c. Enter the name of the Luminex computer into the file as illustrated below. Select File Save. Note: If there is more than one Luminex computer, copy and paste the line <Server>ComputerName</Server> on the next line inside the <ServerName> and </ServerName> tags. Enter the name of the second Luminex Computer (see below illustration) and Select File Save. This file should be copied on all other computers connecting to the Luminex computer. 4) xponent 3.1 or 4.2 Software Setup 1. Make sure the xponent software has a full Base software and Automation license. If not obtain one from support@luminexcorp.com Page 23 of 42

24 2. Batch Options settings: From the ADMIN Page, click on the Batch Options tab: i. Check "Allow cancelling of the warm-up time to run a batch" (optional) ii. Set Calibration expiration days = 7 iii. Set Analysis decimal places = 3 iv. Set minimum bead count for results = 1 v. Set low bead count detection at Well Count = 3 and Bead Count = 10 vi. Click Save 3. CSV Options settings: From the ADMIN Page, click on the CSV Options tab: Check all the options as shown in the figure below Page 24 of 42

25 4. Importing Protocols: a. Download lot specific protocols (*.lxt) from b. In xponent, go to the PROTOCOLS page c. Click the IMPORT button d. Navigate to desired lxt file e. Click "Open" f. Repeat for all kits latest lots templates 5) Opening Windows Firewall (Windows 7 and Windows XP)- See Appendix A 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. 8.1 Lab Information Open the MATCHIT! Platelet Antibody software From the toolbar open the Settings menu and chose the Preferences menu item. Page 25 of 42

26 8.1.3 The preferences window will open 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 Click the Save Settings button the system will indicate that the save has completed successfully. Page 26 of 42

27 8.2 Date Format Settings From the Open Preferences window select the Date Format Setting tab Chose the display date for the system, this will format all dates within the system as the Selected Date Format Next set the date format that your Luminex system uses. The Run Date from the CSV file is captured by the MATCHIT! 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 Click the Close Window button to close this form. Page 27 of 42

28 8.3 Report Settings Choose the paper size Choose the address format Page 28 of 42

29 9.0 Appendix A Procedure for Opening Firewall Port 7575 in Windows 7 1. From the Start menu, open the Control Panel Page 29 of 42

30 2. In the Control Panel, click the link labeled Windows Firewall Page 30 of 42

31 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 31 of 42

32 5. On the first page of the New Inbound Rule Wizard, select Port; then click Next Page 32 of 42

33 6. On the next page, click on Specific local ports: and type 7575 into the text box; then click Next Page 33 of 42

34 7. On the next page, select Allow the connection; then click Next Page 34 of 42

35 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 35 of 42

36 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 36 of 42

37 Procedure for Opening Firewall Port 7575 in Windows XP 1. From the Start menu, open the Control Panel Page 37 of 42

38 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 38 of 42

39 3. In Windows Security Center, click on the Windows Firewall link Page 39 of 42

40 4. Select the Exceptions tab 5. Click on Add Port Page 40 of 42

41 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 41 of 42

42 7. Click OK Page 42 of 42