HemaTrax® Unity - digi-trax.com€¦ · HemaTrax® "Unity" – FILE MIGRATION USER GUIDE File...

18
HemaTrax® "Unity" FILE MIGRATION USER GUIDE By Larry Cullen Date: 7 MAR 2011 This document's contents are subject to change without notice. Copyright © 2011 by Digi-Trax Corporation All Rights Reserved HemaTrax is a registered trademark of Digi-Trax Corporation

Transcript of HemaTrax® Unity - digi-trax.com€¦ · HemaTrax® "Unity" – FILE MIGRATION USER GUIDE File...

Page 1: HemaTrax® Unity - digi-trax.com€¦ · HemaTrax® "Unity" – FILE MIGRATION USER GUIDE File Migration Overview File Migration Overview This portion of the HemaTrax "Unity" File

HemaTrax® "Unity"FILE MIGRATION USER GUIDE

By Larry Cullen

Date: 7 MAR 2011

This document's contents are subject to change without notice.

Copyright © 2011 by Digi-Trax Corporation All Rights Reserved

HemaTrax is a registered trademark of Digi-Trax Corporation

Page 2: HemaTrax® Unity - digi-trax.com€¦ · HemaTrax® "Unity" – FILE MIGRATION USER GUIDE File Migration Overview File Migration Overview This portion of the HemaTrax "Unity" File
Page 3: HemaTrax® Unity - digi-trax.com€¦ · HemaTrax® "Unity" – FILE MIGRATION USER GUIDE File Migration Overview File Migration Overview This portion of the HemaTrax "Unity" File

Table of ContentsIntroduction................................................................................................................................................1File Migration Overview............................................................................................................................2

Directory Scan of System Drive............................................................................................................2Scan for File Names..............................................................................................................................2HemaTrax Standalone File Migration Decision....................................................................................3HemaTrax Print Server File Migration Decision..................................................................................4Standalone Migration Path Decision.....................................................................................................4Print Server Migration Path Decision...................................................................................................5Standalone Conversion/Copy Process...................................................................................................5

Standalone Files Converted and Then Copied..................................................................................5Standalone Files Copied...................................................................................................................6

Print Server Conversion/Copy Process.................................................................................................7Previous Server Files Converted and Then Copied..........................................................................7Previous Server Files Copied............................................................................................................7

Convert/Copy or Skip Dialog................................................................................................................7Choosing the Action.........................................................................................................................8Do For All Files Decision.................................................................................................................8Continuing the Migration.................................................................................................................8

File Conversion/Copy Anomalies.........................................................................................................8File Migration Details..............................................................................................................................10

Migrating Files to the HemaTrax "Unity" Print Server.......................................................................10Migration From a Previous or Current HemaTrax Software Installation............................................10

AltPCode Files................................................................................................................................10User ID/Password File....................................................................................................................11Printer Port Configuration File.......................................................................................................11Processing Legend File...................................................................................................................11Qwik-Pik Products File..................................................................................................................12Alternative Rhesus Factor Text File...............................................................................................12Facility Information Table..............................................................................................................12Instruction Label Design Table.......................................................................................................12Licensed Products Table.................................................................................................................12Format Files....................................................................................................................................13

File Migration Limitations.......................................................................................................................14Installation Wizard Limitation.............................................................................................................14Migration from Previous Release Only...............................................................................................14File Corruption Prior to Installation....................................................................................................14Reinstalling HemaTrax “Unity”..........................................................................................................14

i

Page 4: HemaTrax® Unity - digi-trax.com€¦ · HemaTrax® "Unity" – FILE MIGRATION USER GUIDE File Migration Overview File Migration Overview This portion of the HemaTrax "Unity" File

ii

Page 5: HemaTrax® Unity - digi-trax.com€¦ · HemaTrax® "Unity" – FILE MIGRATION USER GUIDE File Migration Overview File Migration Overview This portion of the HemaTrax "Unity" File

HemaTrax® "Unity" – FILE MIGRATION USER GUIDEIntroduction

IntroductionNear the end of the HemaTrax "Unity" installation process a file migration program is executed that scans the computer directories on the system drive. This scan is a search for evidence of current or previous HemaTrax software installations. This guide provides details about the purpose and operation of the file migration program.

Note: For specific information about the installation process please read the "HT_UnityInstallInstrctns.pdf" file that may be found in the primary directory of the installation CD-ROM or the directory holding the extracted files of the downloaded archive (.ZIP) file.

1

Page 6: HemaTrax® Unity - digi-trax.com€¦ · HemaTrax® "Unity" – FILE MIGRATION USER GUIDE File Migration Overview File Migration Overview This portion of the HemaTrax "Unity" File

HemaTrax® "Unity" – FILE MIGRATION USER GUIDEFile Migration Overview

File Migration OverviewThis portion of the HemaTrax "Unity" File Migration User Guide breaks down the migration process into major processing steps to give the user an overall idea of the steps taken by the program to accomplish the file conversion and copying tasks.

Note: The file migration program will only function during the installation process. The program will not run unless it is invoked from the installation wizard.

Directory Scan of System DriveThe first step taken automatically by the migration program is to scan the primary system drive (typically drive "C:"). This scan produces a list of all the directory paths found on the drive. This list of directory paths is stored in an in-memory array.

Note: Files that are created after the HemaTrax Standalone or Print Server application has been installed are NOT removed as part of the application removal process. It is these residual files that remain after a HemaTrax software is uninstalled that can be migrated. The Standalone application doesn't need to be uninstalled before the installation of the HemaTrax "Unity" software. Any installed copy of the HemaTrax Print Server must be uninstalled before the installation of HemaTrax "Unity" software.

Scan for File NamesWithin each of the directory paths saved in the in-memory array all of the file names in each directory is obtained. A comparison is made between each obtained file name and a list of known file names that should be found in a HemaTrax software installation. When favorable comparisons are made the directory path is saved in one of two lists. One list is for possible HemaTrax Standalone directory paths and the other is for the HemaTrax Print Server.

Note: The process that scans for possible current Standalone directories or previously installed Print Server directories may take several minutes, so be patient. Every directory and sub-directory on the system drive is examined for current or residual HemaTrax software files.

2

Page 7: HemaTrax® Unity - digi-trax.com€¦ · HemaTrax® "Unity" – FILE MIGRATION USER GUIDE File Migration Overview File Migration Overview This portion of the HemaTrax "Unity" File

HemaTrax® "Unity" – FILE MIGRATION USER GUIDEFile Migration Overview

HemaTrax Standalone File Migration DecisionAfter the directory scans are complete the migration program looks at the results in two internal lists (current or previous Standalone Directories and previous Print Server Directories) if no migration prospects exist, then the migration program will return control back to the installation wizard.

If one or more directory paths were identified that contain files from a HemaTrax Standalone installation, then a "Yes or No" dialog box will be displayed with the question, "Are you migrating from a previous HemaTrax Standalone installation?" If the user answers "No" and if there are no directories identified for previous HemaTrax Print Server installations then the migration program will return control back to the installation wizard. If the user answers with "Yes" then the program will proceed with the "Standalone Migration Path Decision".

Note: If you are presented with the Standalone Migration dialog box and do not intend to use any previous settings, passwords or product label design additions or changes from your current or previously installed HemaTrax Standalone installation, then click the "No" button to abandon the Standalone file migration process.

3

Page 8: HemaTrax® Unity - digi-trax.com€¦ · HemaTrax® "Unity" – FILE MIGRATION USER GUIDE File Migration Overview File Migration Overview This portion of the HemaTrax "Unity" File

HemaTrax® "Unity" – FILE MIGRATION USER GUIDEFile Migration Overview

HemaTrax Print Server File Migration DecisionIf there are no current or previous HemaTrax Standalone directories detected or if there were but the user answered "No" to the "HemaTrax Standalone File Migration Decision" and if there are directory paths identified for one or more previous HemaTrax Print Server installations then the user will be presented with a "Yes or No" dialog box with the question, "Are you migrating from a previous HemaTrax Print Server installation?" If the user answers "No" then the migration program will return control back to the installation wizard. If the user answers with "Yes" then the program will proceed with the "Print Server Migration Path Decision".

Note: If you are presented with the Print Server Migration dialog box and you do not intend to use any previous settings, product label design additions or changes from your previously installed HemaTrax Print Server, then click the "No" button to abandon the Print Server file migration process.

Standalone Migration Path DecisionWhen more than one HemaTrax Standalone directory path has been identified, then each of the identified directory paths are listed in the migration window and the program will wait for the user to highlight one and then click the "OK" button. After clicking the "OK" button the "Standalone Conversion/Copy Process" will begin using the files in the directory path selected by the user.

4

Page 9: HemaTrax® Unity - digi-trax.com€¦ · HemaTrax® "Unity" – FILE MIGRATION USER GUIDE File Migration Overview File Migration Overview This portion of the HemaTrax "Unity" File

HemaTrax® "Unity" – FILE MIGRATION USER GUIDEFile Migration Overview

Print Server Migration Path DecisionWhen more than one previous Print Server directory path has been identified, then the directory paths will be displayed in the list in the migration window and the migration program will wait for the user to highlight one of the directories. After highlighting one of these directories the user must click on the "OK" button. Upon clicking the "OK" button the migration program's conversion/copy process will begin using the files in the directory path selected by the user.

Standalone Conversion/Copy ProcessThe file migration is a series of file conversion/copy or file copy processes. Not all files need to be converted. Only files whose record structures have been modified need to be converted.

Standalone Files Converted and Then CopiedThe following files first go through a conversion process and are then copied to the new HemaTrax "Unity" Print Server's directory path:

5

Page 10: HemaTrax® Unity - digi-trax.com€¦ · HemaTrax® "Unity" – FILE MIGRATION USER GUIDE File Migration Overview File Migration Overview This portion of the HemaTrax "Unity" File

HemaTrax® "Unity" – FILE MIGRATION USER GUIDEFile Migration Overview

Standalone Source File HemaTrax "Unity" Target File<drv>:\<source dir>\Data\AltPCode.* <drv>:\<target dir>\Data\AltPCode.*<drv>:\<source dir>\Data\paswrd.dat <drv>:\<target dir>\Config\paswrd.dat<drv>:\<source dir>\Portcfg.bin <drv>:\<target dir>\Config\Portcfg.bin<drv>:\<source dir>\Data\ProcLgnd.txt <drv>:\<target dir>\Config\ProcMsg.(def,i00,tbl)<drv>:\<source dir>\Data\QPick.txt <drv>:\<target dir>\Data\QwikPik.(def,i00,tbl)

Standalone Files CopiedThe following files are copied to the new Print Server's Data directory path:

Standalone Source File HemaTrax "Unity" Target File<drv>:\<source dir>\Data\AltPCode.* <drv>:\<target dir>\Data\Old\AltPCode.*<drv>:\<source dir>\AltRh.txt <drv>:\<target dir>\Config\AltRh.txt<drv>:\<source dir>\Data\Facility.* <drv>:\<target dir>\Data\Facility.*<drv>:\<source dir>\Format\*.fmt <drv>:\<target dir>\Format\*.fmt<drv>:\<source dir>\Data\Instruction.* <drv>:\<target dir>\Data\Instruction.*<drv>:\<source dir>\Data\License.* <drv>:\<target dir>\Data\License.*

6

Page 11: HemaTrax® Unity - digi-trax.com€¦ · HemaTrax® "Unity" – FILE MIGRATION USER GUIDE File Migration Overview File Migration Overview This portion of the HemaTrax "Unity" File

HemaTrax® "Unity" – FILE MIGRATION USER GUIDEFile Migration Overview

Print Server Conversion/Copy ProcessIf the conversion is from a previous installation of the HemaTrax print server then the following files first go threw a conversion/copy or copy process to the new "Unity" Print Server's Data directory path:

Previous Server Files Converted and Then CopiedThe following files are converted and then copied to the new Print Server's Data directory path:

Previous Print Server Source File HemaTrax "Unity" Target File<drv>:\<source dir>\Data\AltPCode.* <drv>:\<target dir>\Data\AltPCode.*<drv>:\<source dir>\Portcfg.bin <drv>:\<target dir>\Config\Portcfg.bin

Previous Server Files CopiedThe following files are copied to the new Print Server's Data\Old directory path:

Previous Print Server Source File HemaTrax "Unity" Target File<drv>:\<source dir>\Data\AltPCode.* <drv>:\<target dir>\Data\Old\AltPCode.*<drv>:\<source dir>\AltRh.txt <drv>:\<target dir>\Config\AltRh.txt<drv>:\<source dir>\Format\*.fmt <drv>:\<target dir>\Format\*.fmt

Convert/Copy or Skip DialogAs the migration program begins to Convert and or copy files to the target folder it checks for the presence of the file in the target folder. If it discovers that the target file already exists it will present the user with a dialog box as shown immediately below.

7

Page 12: HemaTrax® Unity - digi-trax.com€¦ · HemaTrax® "Unity" – FILE MIGRATION USER GUIDE File Migration Overview File Migration Overview This portion of the HemaTrax "Unity" File

HemaTrax® "Unity" – FILE MIGRATION USER GUIDEFile Migration Overview

The title line in the top margin of the dialog box states “Target file already exists”. Below the title line and centered in the top panel is the path and name of the file that already exists. There are two panels displayed. The first panel contains the legend “Convert/Copy & Replace the Target File.” and the panel below it contains the legend “Skip Convert/Copy & Leave Existing Target File.”. The panel with the selected action will have a blue background color and be inside of a thin black bordering line. The deselected panel will have a gray background color and have no border line around it.

Choosing the ActionThe user determines which action they wish to take for the indicated file by placing the mouse cursor over the appropriate panel and then clicking on it.

Do For All Files DecisionBelow the action selection panels described above there is a check box labeled “Do this for all remaining files”. If the user checks this box then then action described in the selected panel above will automatically be taken for any existing target files discovered by the migration program from this point on. If the check box is not checked then each time an existing target file is discovered the dialog box will be redisplayed and await a user decision.

Continuing the MigrationAfter the user has make the appropriate selections the migration process is then continued by clicking on the button labeled “Continue” located at the bottom center of the dialog box.

File Conversion/Copy AnomaliesThe files listed in the tables above are each expected to exist on the drive (<drv>:) and in the source directory (<source dir>) listed. If for some reason the file doesn't exist or is of zero length or is not able to be accessed for some reason, then a message will be output indicating the problem on a file by file basis. At the end of the conversion/copy process if any files could not be found or copied, then a message dialog will be displayed that will indicate the number of files that were missing, skipped, etc.

When files are missing or skipped it doesn't mean that the installed Unity Print Server will not function properly. Most missing or skipped files may be recreated manually through the use of the "Unity" Client program after the installation is completed.

8

Page 13: HemaTrax® Unity - digi-trax.com€¦ · HemaTrax® "Unity" – FILE MIGRATION USER GUIDE File Migration Overview File Migration Overview This portion of the HemaTrax "Unity" File

HemaTrax® "Unity" – FILE MIGRATION USER GUIDEFile Migration Overview

Dialog box shown if files were missing.

Dialog box shown at the completion of migration.

9

Page 14: HemaTrax® Unity - digi-trax.com€¦ · HemaTrax® "Unity" – FILE MIGRATION USER GUIDE File Migration Overview File Migration Overview This portion of the HemaTrax "Unity" File

HemaTrax® "Unity" – FILE MIGRATION USER GUIDEFile Migration Details

File Migration DetailsThis portion of the HemaTrax "Unity" File Migration User Guide expands on the information supplied in the previous section entitled "File Migration Overview". This section deals with why file migration should be done when installing on a system that had a copy of either the HemaTrax Standalone or Print Server application installed on it. It provides details about each of the files that may be migrated to the new HemaTrax "Unity" Print Server.

Migrating Files to the HemaTrax "Unity" Print ServerMigration of files to the new HemaTrax "Unity" Print Server is not a requirement, however, performing the migration may save the user some time if more than a few product label designs have been modified or added. The new production quality HemaTrax "Unity" Client application can also make use of the product label, facility information, licensed products, configuration decisions, user IDs/passwords and instruction label designs that may have been created with the HemaTrax Standalone application.

Note: The previous release of the Print Server does not have many of the files that a previous or current copy of the HemaTrax Standalone application may have. For example the previous release of the HemaTrax Print Server doesn't have the following files: Facility, Instruction, paswrd.dat, ProcLgnd.txt and QPick.txt

Migration From a Previous or Current HemaTrax Software InstallationAs mentioned in the paragraphs above, current or residual files from an existing or uninstalled HemaTrax Standalone or an uninstalled Print Server application can be migrated to the new HemaTrax "Unity" Print Server installation. The migration will serve to reduce the time and effort to create an environment similar to the one provided under the existing or previous HemaTrax software application.

The migration process will convert or copy all of the files created as part of the previous or existing HemaTrax Standalone or Print Server application.

Note: Unless otherwise noted the following files may be created and maintained via the file maintenance facilities available in the HemaTrax "Unity" Client application that is installed automatically along with the HemaTrax "Unity" Print Server.

AltPCode FilesThe AltPCode.def, AltPCode.i00, AltPCode.i01 and AltPCode.tbl files are used to store the alternative blood product label design records that have been added or changed by the customer. These files are maintained by both the Print Server and the Standalone applications. The PCode

10

Page 15: HemaTrax® Unity - digi-trax.com€¦ · HemaTrax® "Unity" – FILE MIGRATION USER GUIDE File Migration Overview File Migration Overview This portion of the HemaTrax "Unity" File

HemaTrax® "Unity" – FILE MIGRATION USER GUIDEFile Migration Details

table, in contrast, holds all of the blood product label design records as supplied by Digi-Trax Corporation with the HemaTrax software. The AltPCode table is converted and then copied to the new HemaTrax "Unity" print server "Data"sub-directory. The AltPCode table, without conversion, is copied to the HemaTrax "Unity" print server "Data\Old\" sub-directory. The PCode and AltPCode files are stored in a proprietary "Indexed Sequential Access Method" (ISAM) format. Since the HemaTrax "Unity" Print Server continues to support the previous server's messages, the previous PCode and AltPCode tables are copied unchanged to the new server's "Data\Old" sub-directory. The new print server messages require a new PCode table record structure so it is also necessary to convert the previous AltPCode table records to conform to the new table record structures and then copy the converted table to the new print server's "Data" sub-directory.

User ID/Password FileThe "Unity" Client program will now store its User ID/Password file on the central HemaTrax "Unity" print server. To make the transition from a Standalone environment to a more distributed multi-user environment and to handle minor changes that have been made to the user ID and password record structure it is necessary to convert and copy the file from the current or previous HemaTrax Standalone application to the new print server's "Config" sub-directory. This migration operation makes it unnecessary to re-enter all of the user's information on the newly installed print server. If no administrator's password can be found in the converted password file, then the user will be requested to enter an administrator ID and password near the end of the installation process.

Printer Port Configuration FileThe previous releases of the HemaTrax Standalone and Print Server applications made use of the print port configuration file (Portcfg.bin). Since this file's record structure has been expanded slightly, the file migration program will convert the file and then copy it to the new HemaTrax "Unity" print server's "Config" sub-directory. The new print server will allow double the number of printer port definitions (now sixty-four ports) and each definition may include a forty character comment field for any purpose the user desires.

Processing Legend FileThe HemaTrax Standalone application provided for multiple user-defined "Processing Legends" such as "Further Processing By" or "Irradiated By". These legends were used to populate a pull-down list box form which a selection could be made. The legend selected from the list would then be printed in quadrant four above a secondary processing facility's name. This file stored as an ASCII text file (ProcLgnd.txt) in the previous releases is now stored as an Indexed Sequential Access Method (ISAM) file (ProcMsg.def,i00,tbl) on the new HemaTrax "Unity" Print Server.

11

Page 16: HemaTrax® Unity - digi-trax.com€¦ · HemaTrax® "Unity" – FILE MIGRATION USER GUIDE File Migration Overview File Migration Overview This portion of the HemaTrax "Unity" File

HemaTrax® "Unity" – FILE MIGRATION USER GUIDEFile Migration Details

Qwik-Pik Products FileThe HemaTrax Standalone application provided for a user-defined list of commonly manufactured products. This list is referred to as the "Qwik-Pik List". Now this list will be maintained for all users on the central HemaTrax "Unity" Print Server. The list was formerly maintained as an ASCII text file named "QPick.txt". The text file will be converted and then copied to the new HemaTrax "Unity" Print Server as an Indexed Sequential Access Method (ISAM) table called (QwikPik.def,i00,tbl).

Alternative Rhesus Factor Text FileThe alternative Rh text stored in the previous Standalone's or Print Server's Altrh.txt file is copied, unchanged, to the new HemaTrax "Unity" Print Server's file by the same name. This file holds the alternative text for the Rhesus factor text that appears at the bottom of the quadrant two (ABO-Rh) label. If this file is absent, then the standard text will appear as appropriate below the blood type on the ABO-Rh labels ("Rh NEGATIVE" or "Rh POSITIVE").

Note: This file is can be created and maintained via the Print Server Settings application that is available from the application menu.

Facility Information TableThe HemaTrax Standalone application created and allowed for the maintenance of a facility information table. Each record in the table provided space for the facility's name, location, FDA registration number and license number. Space was also provided for the licensee name and location if these were different from the facility name or location. The structure of the table records have not changed and so the table files may be copied to the new HemaTrax "Unity" Print Server "Data" sub-directory without any conversion.

Instruction Label Design TableThe HemaTrax Standalone application created and provided for the maintenance of an instruction label design table. Each record in the table defines the information that may be printed on 2" x 2" (single ISBT quadrant size) labels. The record structure for these definitions have not been changed so this table is copied to the new HemaTrax "Unity" Print Server "Data" sub-directory without any conversion.

Licensed Products TableThe HemaTrax Standalone application created and provided for the maintenance of the licensed products table (License.[def, i00, i01, tbl]). The record structureof the licensed products table has not been changed so this table is copied to the new HemaTrax "Unity" Print Server "Data" sub-

12

Page 17: HemaTrax® Unity - digi-trax.com€¦ · HemaTrax® "Unity" – FILE MIGRATION USER GUIDE File Migration Overview File Migration Overview This portion of the HemaTrax "Unity" File

HemaTrax® "Unity" – FILE MIGRATION USER GUIDEFile Migration Details

directory without any conversion.

Format FilesWhile certain label format files for use in printing unit ID sets are shipped with the HemaTrax Print Server and Standalone software, it i possible that other format files, such as wristband format files, were added at a later time. To insure that other added format files are copied, the file migration includes the logic to find and transfer all file names with an extension of ".fmt" from an existing sub-directory named "Format" that is located in the directory path selected by the user at the start of file migration process.

13

Page 18: HemaTrax® Unity - digi-trax.com€¦ · HemaTrax® "Unity" – FILE MIGRATION USER GUIDE File Migration Overview File Migration Overview This portion of the HemaTrax "Unity" File

HemaTrax® "Unity" – FILE MIGRATION USER GUIDEFile Migration Limitations

File Migration LimitationsThis final part of the HemaTrax "Unity" File Migration User Guide deals with limitations that the user must keep in mind and understand before the migration process is used.

Installation Wizard LimitationIt should be understood that the file migration application cannot be executed outside of the installation wizard process. The migration tools will only run when it has been invoked by the installation wizard.

Migration from Previous Release OnlyThe file migration process is intended to only to migrate files from the previous software release. If your installed application has not been updated for more than a couple of years, then it is unlikely that the file migration will be successful. Changes in record structures over the years will cause improper or unsuccessful table conversions to occur. The resulting file conversions and copy may then cause problems with the new HemaTrax "Unity" software.

File Corruption Prior to InstallationIf the files to be converted are from the previous Print Server or Standalone release, but have been corrupted either through a hardware failure or software problems, then it will not likely be possible for the conversion and copy processes of the file migration to produce useable files for the new HemaTrax "Unity" software.

Reinstalling HemaTrax “Unity”Files that have been converted and / or copied as the result of a previous installation of the HemaTrax “Unity” software will not be removed from the HemaTrax “Unity” directories if the software is thereafter uninstalled. If HemaTrax “Unity” is then reinstalled, all of the file conversion and / or copy operations normally done by the file migration process will be skipped. The file migration process first determines if a destination file already exists and when it does the conversion and copy operation is skipped for that file. The migration process will not replace an existing target file to prevent regression of files to a data content which may be less current.

In cases where it is desirable to have the file migration process replace the copied or converted files it will be first necessary to remove the target files before reinstalling the HemaTrax “Unity” software. This file removal process must be done manually.

14