INHECO ODTC Script Editor. For INHECO Script Editor Version and higher. User s Manual

Size: px

Start display at page:

Download "INHECO ODTC Script Editor. For INHECO Script Editor Version and higher. User s Manual"

Noel Franklin
5 years ago
Views:

1 INHECO ODTC Script Editor For INHECO Script Editor Version and higher User s Manual

2 INHECO Industrial Heating and Cooling GmbH reserves the right to modify their products for quality improvement. Please note that such modifications may not be documented in this manual. This manual and the information herein have been assembled with due diligence. INHECO GmbH does not assume liability for any misprints or cases of damage resulting from misprints in this manual. If there are any uncertainties, please feel free to contact How to contact INHECO, page 4. The brand and product names within this manual are registered trademarks and belong to the respective titleholders. INHECO 02

3 TABLE OF CONTENTS IMPORTANT S General Information Explanation of symbols How to contact INHECO Abbreviations and Glossary PRODUCT DESCRIPTION Intended Use SOFTWARE INSTALLATION Hardware and System Requirements Installation of INHECO Script Editor DAILY USAGE Operation of the ODTC User Interface descriptions Edit a Method Set Save a Method Set Delete a row Load Method to the Script Editor Change between Methods within the Script Editor Change data of an already save method Delete method Reset method TROUBLE SHOOTING Feasibility of.xml files APPENDIX Example of correct method order Example of wrong method order Example Process for Standard PCR (amplification) INHECO 03

4 1 IMPORTANT S 1.1. General Information Read the user instructions completely. The manual explains how to use the INHECO Script Editor to edit methods for the ODTC. To transfer the methods into the ODTC it is necessary to use a SiLA Process Management Software (PMS) provided by a robotic system provider. INHECO also offers a SiLA PMS to test the ODTC without integration. Please contact sales@inheco.com if you need further information. Missing or insufficient knowledge of the manual leads to loss of liability against INHECO GmbH. This manual is part of the ODTC and must be retained until the unit is disposed of and must be passed on with the device when the unit is taken over by a new user. Manual instructions must be followed in order to ensure safe handling of the unit. Security-related warnings in this manual are classified as following: - The signal word stands for general precautionary measures that have to be taken to avoid issues with the software or your methods. There is no health risk or risk of damaging the device due to the use of this software. Contact INHECO in case there are any uncertainties of how to operate or how to handle the INHECO Script Editor. Your opinion about this manual provides us with valuable insights on how we can improve this document. Please do not hesitate to direct your comments to sales@inheco.com, How to contact INHECO, chapter 1.3 below Explanation of symbols Symbol Explanation Bullet points indicate steps of instructions. - Hyphens refer to enumeration How to contact INHECO INHECO GmbH Arrows indicate: refer to and are mostly active links Address Fraunhoferstr Martinsried Germany Telephone - Sales Fax Sales - Technical -Hotline Website sales@inheco.com techhotline@inheco.com Technical Support & Trouble Shooting Instructions: INHECO 04

5 1.4. Abbreviations and Glossary Symbol Explanation SiLA Standard in Laboratory Automation PMS Process Management Software ODTC On Deck Thermal Cycler FWCS Firmware Command Set.exe executable file C Degree Celsius K Kelvin dll dynamic link library LAN Local Area Network Gbit/s GigaBit per second MB MegaByte 2 PRODUCT DESCRIPTION 2.1. Intended Use The ODTC needs to be addressed by a SiLA PMS ( Standardization in Laboratory Automation Process Management System) for operation. For non SiLA based workstations an additional driver has to be written which translates the workstation protocol into a SiLA based protocol. The ODTC command set ( Firmware Command Set) and the description of the SiLA communication standard are part of the scope of delivery. Please contact your workstation provider for the integration. The temperature profiles have to be programmed in xml format and then transferred/ loaded to the ODTC via the Ethernet connector. The xml files must be created by using the ODTC Script Editor as the ODTC Script Editor automatically compiles an xml file with the correct control parameters for the ODTC. The ODTC Script Editor allows an easy editing of temperature profiles and the translation into ODTC compatible xml files. After editing the desired temperature profiles, the xml files must be transferred to the PMS of the liquid handling workstation. INHECO 05

6 3 SOFTWARE INSTALLATION Please follow the instructions in the given order. Ignoring the correct order may cause complications during installation Hardware and System Requirements - Windows compatible x86 based CPU (32 and 64 bit are supported) - Supported Architectures: x86; x64 and ia64 (some features are not supported on ia64 for example, WPF) - Operating system: Windows XP, Windows Vista, Windows 7, Windows 8 or Windows net framework 4.0 (client or full version, or higher version compatible with.net framework 4.0 ) as the Script Editor is compiled with.net framework 4.0. =>.net framework 4.0 (client or full version) is required Download link.net for installation also possible without Web-Access - Network Adapter: IEEE Ethernet Network Interface (10/100/1000 BASE-T) - Processor: 1GHz or faster - Ram Minimum 512 MB - Disk space minimum for Script Editor x86: 10MB with.net framework already installed - Disk space minimum for Script Editor with.net framework x64: 10 MB with.net framework already installed 3.2. Installation of INHECO Script Editor Content of USB flash drive The required file to install the script editor can be found on the USB flash drive which is part of the scope of supply of the ODTC. USB flash drive content: - Script Editor.exe Installation of INHECO Script Editor Open the software by double-clicking on file Script Editor.exe provided on the USB flash drive or by your workstation provider Fig.1: Software icon for INHECO Script Editor on taskbar INHECO 06

7 4 DAILY USAGE 4.1. Operation of the ODTC The ODTC needs to be addressed by a SiLA PMS (Process Management Software) for operation. For the integration into SiLA based liquid handling workstations the already existing workstation SiLA protocol (SiLA standard 1.2) can be used to operate the ODTC. For the operation of the ODTC with your liquid handling workstation software please contact your platform provider. The temperature profiles have to be programmed in xml format and then transferred/ loaded to the ODTC via the Ethernet connector. The xml files must be created by using the ODTC Script Editor as the ODTC Script Editor automatically compiles an xml file with the correct control parameters for the ODTC. The ODTC Script Editor allows an easy editing of the temperature profiles and the translation into ODTC compatible xml files. After editing the desired temperature profiles, the xml files must be transferred to the PMS of the liquid handling workstation. The following chapters describe how to use the INHECO Script Editor to program a given thermal protocol as ODTC compatible sequence User Interface descriptions The Script Editor provides the possibility to edit temperature profiles only. Other process steps, like "open door" (to allow pipetting or gripping of the disposable) or "close door" must be executed via the PMS. For translation of your application into an ODTC compatible process/sequence please divide your process in single temperature and non temperature methods. After double clicking the INHECO Script Editor.exe the following window will open: Fig.2: Start Window 1 Initial set up section Shows method configurations. chapter and Temperature profile Enter heating or cooling rate, target temperature, step duration, editor loop information chapter and Graph Section Shows the profile of edited temperature steps chapter 4.4 INHECO 07

8 Method Menu Fig.3: Method menu New Method Delete Method Reset Method Initial Method Setup Load Method Set Save Method Set Delete all methods at the device Exit start a new method delete a method within a method set delete temperature profile steps within a method change of Method-related data load a saved method set save a new method or a method set If this function is enabled and saved with the method set, all methods transferred earlier to the ODTC will be deleted on the ODTC when transferring a method set to the ODTC. exit the script editor The transfer of xml files has to be performed by the PMS of the workstation -> please see documentation of workstation provider DEFINITION Method: Defines all temperature steps for one single method. Method Set: Comprises all edited temperature initialization steps and methods. Temperature initialization step: Is mandatory to set the ODTC mount and lid to a defined start temperature Mode Menu The Mode Menu allows to change between "Normal" and "Expert" Mode. The Expert Mode is secured by password and not accessible by the user. The use of the Expert Mode might be necessary if a temperature profile which is not supported by the "Normal Mode" needs to be programmed. Please contact sales@inheco.com for further support. All standard amplification or hybridization profiles will be supported in the "Normal" Mode Help Menu Fig.4: help menu About provides information about the Script Editor Version INHECO 08 View limits window provides information about the temperature and slope limits of the ODTC.

4.3. Edit a Method Set After starting the Script Editor you can choose between Load Method Set or New Method. 4.3.1. Editing of "temperature initialization step" select Method => New Method Fig.

9 4.3. Edit a Method Set After starting the Script Editor you can choose between Load Method Set or New Method Editing of "temperature initialization step" select Method => New Method Fig.5: New Method in Method Menu The following window will open : Fig.6: Method type selection After selecting the method type temperature initialization step the following window will be shown to configure the initial temperature condition of the ODTC. NOTICE This window is nearly the same for changing an already existing method. You can see distinguish whether you have opened the window for a new method or to change an old method with the text next to the Initial Method Setup. For changing a method: Change metadata for EXISTING method For a new method: NEW method Fig.7: Method Name entry Type: temperature initialization step Name of method Description of method Name of creator Start temperature Temperature initialization step is mandatory to set the ODTC mount and lid to a defined start temperature. Enter your method name Enter a description for the method. Enter name of the method creator. Enter Start temperature of ODTC mount. Methods with the same name will be automatically overwritten on the ODTC. in case you don't intent to overwrite an existing method on the ODTC, make sure that the method name differs from the method names that are stored on the ODTC. INHECO 09

10 The temperature initialization step sets the ODTC mount and lid to a defined start condition and always needs to be executed first, when starting a new application. For unsealed plates INHECO recommends to set the target temperature of the mount in the temperature initialization step to +25 C (or as close as possible to room temperature) to minimize evaporation of the sample. The evaporation may cause cross contamination and / or reduced process quality. Enter name of method, (required information) Enter description, Enter name of creator, Enter start temperature, (required information, INHECO recommends to set the start temperature of the mount to 25 C) Select OK After acknowledging all information with clicking on the ok button the temperature initialization step will be displayed in a graph. Fig.8: Temperature initialization step (after entry of all required information) Name of Method Type: Temperature Initialization Step and Method* Description of method* Name of Creator* Target temperature* Estimated time Shows entered method name Change between the user interface for methods and the user interface for temperature initialization step. Shows entered method name Shows name of the method creator entered for this method Shows start temperature for the following method The duration of the temperature initialization step is always 10 minutes * Editing or changing of parameters/information is not possible in this window The default lid temperature is set to +110 C. INHECO 10

4.3.2. Edit a "method" select Method => New Method and the new window will open: Fig.

10: Method entry with tool tips for explanation INHECO 11 Type: method Name of method Description of method Name of Creator Select method Enter method name. Enter a description for the method.

11 Edit a "method" select Method => New Method and the new window will open: Fig.9: New Method in Method Menu After selecting the method type method the following window will be shown to configure the initial conditions of the temperature profile. Fig.10: Method entry with tool tips for explanation INHECO 11 Type: method Name of method Description of method Name of Creator Select method Enter method name. Enter a description for the method. Enter the name of the method creator. Well type Choose between 96 and 384 well type of ODTC. Plate type Fluid quantity Keep temperature after method Start temperature Choose your PCR plate Choose fluid quantity range of sample per well. For further information refer to the table on the next page. Select parameter "ON" or "OFF". If the ODTC should keep its temperature after the method is finished (e.g. open door for pipetting step) set the selector to "ON". Set it to "OFF" to switch off the temperature control after method is finished. Note: If the selector is set to "OFF" no new method can be started within the ODTC after this method. Appendix Chapter 6.2, page 20 Set temperature with which the method will start. Note: Make sure that the start temperature matches always the temperature that is set in the "temperature initialization step" or the temperature at the end of the previous method.

Enter name of method, (required information) Enter description, Enter name of creator, Enter well type with selector, Enter plate type with selector, Enter fluid quantity, Fig.

12 Enter name of method, (required information) Enter description, Enter name of creator, Enter well type with selector, Enter plate type with selector, Enter fluid quantity, Fig.11: Selector fluid quantity The fluid quantity is defined as a fluid quantity range. The control parameters of the ODTC will be adjusted depending on the selected fluid quantity range. The control parameters work for the complete selected fluid range, but they are optimized for a specific fluid quantity (see following table). Fluid quantity range 10-29µl 25µl 30-74µl 50µl µl 100µl optimized fluid quantity In case you need adjusted/optimized controlling parameters for a specific fluid quantity, please contact techhotline@inheco.com. Select keep temperature after method If the ODTC should keep its temperature after the method is finished (e.g. for a pipetting step) select keep temperature after method "ON". Enter start temperature Make sure that the start temperature matches always the temperature that is set in the "temperature initialization step" or or the temperature at the end of the previous method. Select OK INHECO 12

13 Fig.12: Configured method before entering the temperature profile Edit temperature steps within a method The temperature profile divided in different temperature steps have to be edited in the temperature profile editor. Fig.13: Editor temperature profile Enter slope The following table shows the maximum possible average heating and cooling rates (slope) depending on fluid quantity and target temperature. The table opens when the first field is selected with a mouse click. Fig.14: Table implemented in the Script Editor The maximum number of temperature steps within one method is 100. INHECO 13

14 Depending on the language of your operating system (Windows) you must either use "." or "," as decimal separator. If you use the wrong separator the field will red for a short time and the separator is not accepted. Enter your target temperature. Minimum temperature: +4 C and maximum temperature: +99 C. Enter the plateau time. For repeating steps please edit the step number which should be repeated in go to step and the number of repeats in loops. fig. 15 As soon as you have entered all data the method or method set can be saved chapter 4.4 The maximum number of methods within one method set is 255. Fig.15: User Interface with all data (last row empty). The Method can be saved Current limitations of Script Editor - The currently available Script Editor will not automatically detect if a slope is not entered correctly according to the limitation shown in fig. 14 page 13 In case methods with slope rates that are out of the specified limits are run on the ODTC, the ODTC will always generate the warning "temperature out of specifications". Please check your workstation PMS error management for guidance. - Maximum temperature profile steps within one method are 100 steps. - Maximum methods within one method set are 255 methods. - Maximum file size for a method set is 500kB (only of relevance for method sets with many methods or steps, e.g. 100 methods with 10 steps each). INHECO 14

4.4. Save a Method Set Select Save Method Set Fig.

17: Save method set to PC If a mandatory entry is missing, the method cannot be saved and the fields, which require an

Options after successful saving: If you want to edit further methods of the set: Select new method in method menu page

15 4.4. Save a Method Set Select Save Method Set Fig.16: Selection Save Method Set Enter file name and storage location Fig.17: Save method set to PC If a mandatory entry is missing, the method cannot be saved and the fields, which require an entry, are marked in red or with a red question mark. Options after successful saving: If you want to edit further methods of the set: Select new method in method menu page 9 ff. If you are ready with editing: Select Exit Script Editor. The xml file is ready for the transfer into the PMS documentation SiLA PMS from workstation provider The maximum number of temperature steps is 100 within one method and maximum number of methods within a method set are 255 methods. INHECO 15

4.5. Delete a row right mouse click on the row then select delete row Fig.

Load Method to the Script Editor The method/method set can be loaded at any

16 4.5. Delete a row right mouse click on the row then select delete row Fig.18: Delete row confirm with yes Fig.19: Confirm with yes 4.6. Load Method to the Script Editor The method/method set can be loaded at any time into the Script Editor for re-editing. Select Load Method Set Fig.20: Load method set 4.7. Change between Methods within the Script Editor You can change between saved methods of a method set with the method name selector: Fig.21: Method name selector INHECO 16

22: Method name selector The Initial Method Setup window will open NOTICE In the header text you can see whether you are editing a

17 4.8. Change data of an already save method The method data can be changed at any time using Initial Method Setup. select the method you want to change with the method name selector ( chapter 4.7) select Initial Method Setup Fig.22: Method name selector The Initial Method Setup window will open NOTICE In the header text you can see whether you are editing a NEW method or an already Existing method: Header for New Method Header for existing Method Fig.23: Method data can be changed Fig.24: Method data can be changed INHECO 17

18 4.9. Delete method An edited method can be deleted by using the "delete method" function. Fig.25: Reset Method Reset method Edited temperature profile steps can be deleted by using the "reset method" function. Fig.26: Reset Method 5 TROUBLE SHOOTING 5.1. Feasibility of.xml files The INHECO Script Editor will check all programmed steps of a method (definition page 8 ) and will only allow steps which the ODTC is capable of handling. However in case you have issues with running a method on the ODTC or if you need assistance with programming the xml files, please contact techhotline@inheco.com. Please send us your requirements and temperature profiles needed for testing your application on the ODTC here at INHECO. If this information should contain proprietary information, please send us a NDA to cover this. INHECO will evaluate if your temperature profiles are realizable. The currently available Script Editor does not detect incorrectly entered slopes outside the limitations shown in fig. 14 page 13 In case methods with slope rates that are out of the specified limits are run on the ODTC, the ODTC will always generate the warning "temperature out of specifications". Please check your workstation PMS error management for guidance. INHECO 18

19 6 APPENDIX 6.1. Example of correct method order Following features have to be taken into account when defining a method set: - If another method follows this method you should select keep temperature after method: ON - The following method must start with the end temperature of the prior method, otherwise the ODTC goes into error status. Premethod Method 1 Method 2 Method 3 Temperature: 55 C Start Temperature: 55 C Start Temperature: 4 C Start Temperature: 45 C End Temperature: 4 C End Temperature: 45 C End Temperature: 20 C Post temp: ON Post Temp: ON Post temp OFF Fig.27: Example of correct Method Order Different combinations of methods within a method set are possible: Premethod Method 5 Method 6 Method 7 Temperature: 55 C Start Temperature: 55 C Start Temperature: 4 C Start Temperature: 4 C End Temperature: 4 C End Temperature: 4 C End Temperature: 20 C Post temp: ON Post Temp: ON Post temp OFF Premethod Method 5 Method 7 Temperature: 55 C Start Temperature: 55 C Start Temperature: 4 C End Temperature: 4 C End Temperature: 20 C Post temp: ON Post temp OFF Fig.28: Example of correct Method Combination INHECO 19

20 6.2. Example of wrong method order Premethod Temperature: 55 C Method 1 Start Temperature: 55 C End Temperature: 4 C Method 2 Start Temperature: 60 C End Temperature: 45 C Start Temperature of Method 2 is different then End Temperature of Method 1 Post temp: ON Post Temp: ON Method 4 Start Temperature: 4 C End Temperature: 4 C Start Temperature of Method 4 is different than Temperature of Premethod Post temp: Off Method 1 Start Temperature: 55 C Method 5 Start Temperature: 4 C Method 3 Start Temperature: 45 C Post Temp of Method 5 is set to OFF End Temperature: 4 C End Temperature: 45 C End Temperature: 4 C Post temp: ON Post Temp OFF Post temp OFF Fig.29: Example of wrong Method Combination 6.3. Example Process for Standard PCR (amplification) The following example shows how to program an amplification process Description of standard PCR Process (amplification) - 10 minutes (600 s) denaturation at 95 C - Annealing at 55 C for 10 seconds - Elongation at 72 C for 10 seconds - Denaturation at 95 C for 10 seconds - Amplification 35 times - After amplification keep samples at 4 C Translation of standard PCR process into ODTC compatible sequence open the Script Editor Create and save new method set create temperature initialization step with temperature 25 C (or near ambient temperature chapter , page 10) Fig.30: Temperature initialization step for PCR INHECO 20

initialization step and the method save the method set and

21 create PCR method Fig.31: Method for PCR Fig.32: Temperature profile PCR After editing the temperature initialization step and the method save the method set and close the Script Editor. => Method set needs to be loaded to PMS INHECO 21

INHECO Heat, Shake & Cool. Thermoshake Part No.: / Maintenance & Cooling Liquid Refill Instructions

INHECO Heat, Shake & Cool. Thermoshake Part No.: / Maintenance & Cooling Liquid Refill Instructions INHECO Heat, Shake & Cool Thermoshake Part No.: 7100144 / 7100146 Maintenance & Cooling Liquid Refill Instructions September 2013 INHECO Industrial Heating and Cooling GmbH reserves the right to modify