|BatchKi Reference Manual|
The details of the installation procedure slightly depend on the operating system being used. Regardless of the particular operating system, before the installation can begin one needs to collect several important pieces of information, which will need to be entered manually into the installer's configuration file:
[batchki-setup] Perl = C:/Perl/bin/Perl.exe Apache = C:/Program Files/Apache Group/Apache2 HTMLdir = htdocs/batchki CGIdir = cgi-bin/batchki Server = 127.0.0.1 RelRoot = ../../../htdocs ; document root relative to '*.pl' OperatingSystem = Windows ; 'Windows' or 'Linux' PreserveUserData = Yes PreserveSettings = Yes [email] ; use 'Mailer = NONE' to suppress email notifications Mailer = NONE Sender = No Sender Recipient = No Recipient Subject = No Subject [administrator] Login = Administrator Password = test1234
The BatchKi binary distribution packaged for Linux will show a slightly different configuration information, but otherwise all the steps required for configuring and installing BatchKi are identical.
Edit the entries in this configuration file according to your computer system's configuration. Probably the most important variable is the server I.P. address or symbolic name, which must be used to replace the initial ``localhost'' address 127.0.0.1.
The variable OperatingSystem can have two possible values, namely, Windows or Linux. The variable PreserveUserData is ignored if this is a first time installation of BatchKi. If not, PreserveUserData can be set to Yes or No, depending on whether existing user names and passwords should be preserved upon reinstalling BatchKi.
The variable HTMLdir signifies the relative location of the BatchKi document root directory, relative to the main Apache directory (defined by the variable Apache), as is illustrated in the left-hand portion of Figure 2.1. The variable GGIdir has equivalent meaning, which is also apparent from left-hand portion of Figure 2.1.
The variable RelRoot signifies the relative location of the BatchKi script directories (one for each plate layout, for example generic), relative to BatchKi output directory. This is illustrated in the right-hand portion of Figure 2.1.
As an illustrative example, let us assume that on the given server computer running Microsoft Windows we have the following configuration:
In this case, we would need to rewrite only five lines in the file batchki-setup.ini, as follows:
Perl = C:/Perl/bin/Perl.exe Apache = C:/Program Files/Apache Group/Apache2 Server = 127.0.0.1 Login = Administrator Password = test1234
Perl = F:/Perl/bin/Perl.exe Apache = J:/Apache/Apache2 Server = 192.168.0.106 Login = BatchKiAdmin Password = Test7890
After editing the configuration file [TEMP]/batchki/setup/batchki-setup.ini to match the target computer system, BatchKi can be installed by issuing a simple command from the command line. To install the software, follow these steps:
To test the freshly installed BatchKi system, follow these steps:
The BatchKi package must be enabled for processing of arbitrary data files (as opposed to the distributed sample data files) by installing a software license file. The license file is a simple ASCII text file containing information about the licensed user's email address and license expiration date.
BioKin-License-Begin Program = "BatchKi" Version = "4" User = "John Smith" Email = "email@example.com" Organization = "ACME Pharmaceuticals, Inc." Department = "Research and Development" ComputerID = "n/a" LicenseType = "Commercial" Seat = "1" Expiration = "Tue Dec 31 12:00:00 2021" LicenseCode = "059ec324456e33a0321750872360227a8272bad2f8b06654" BioKin-License-End
The license file is named license.txt and resides in the directory ./system/BatchKi, where ``.'' is the location of the executable numerical engine file BatchKi.EXE.
There are two methods to install the license file:
An important advantage of the first method (installing the license file during the initial installation of BatchKi) is that all of the separate graphical user interface modules are enabled at the same time. When a license file is being installed at any point in time after the initial installation of BatchKi, the individual GUI modules need to be activated one by one.
The following procedure is applicable when the BatchKi installer script is excuted while a valid license file has already been purchased from BioKin.
The following procedure is applicable when a valid license file has already been obtained from BioKin after the BatchKi package installation.
Consult the accompanying User Manual for details on the administrator's module.
Petr Kuzmic | Jul 12 2008