LIMS Interface (LwinS) Installation and Testing manual for OSA

Transcription

1 LIMS Interface (LwinS) Installation and Testing manual for OSA Submitted to Shell Lubricants By Wipro Technologies Version 1.3 Version 1.3 Page 1 of 11

2 Contents Overview:... 3 Intended Audience:... 3 Minimum Basic Requirements:... 3 LwinS Installation Procedure:... 4 Configuration Setup:... 9 Proxy configuration: Testing procedure: Version 1.3 Page 2 of 11

3 Overview: The purpose of this document is to help understand the step by step process of installing the LIMS Services and to carry out testing prior to opening it to the live system. The set-up involves a) Registering an OSA Supplier in Shell LubeAnalyst web application. b) Associating an OSA site to the supplier. c) Installing and configuring the LIMS web interface ( LwinS ) on the OSA machine. The OSA supplier will be registered in Shell LubeAnalyst web application. The OSA sites where the OSA machines will operate from will also be registered and associated to the OSA supplier in the application. IDs of OSA Customer Service and individual OSA machines will be defined. Once associated, an with encrypted UserID and Password will be sent to the addresses defined on OSA Supplier and OSA Site association. The LIMS software installable file will be provided to OSA. The software needs to be installed and configured on each OSA machine by following the below steps. After installation, the registered OSA can send and receive samples through this automated interface. Intended Audience: OSA User and OSA Diagnostician. Minimum Basic Requirements: a) Windows 2003 Server b).net Framework Version 4.0 c) Internet enabled d) 1 GB RAM (Recommended) e) Shell.Georgia.OSAInterface.Installer.msi File Location of LIMS Service Installable (Shell.Georgia.OSAInterface.Installer.msi) file: A link to a directory containing the installable ZIP file will be provided to OSA. This will be updated in due time. URL : The ZIP file needs to be copied and extracted to the Lab System (Eg: copy to C:\Apps folder) in which LwinS needs to be installed. Version 1.3 Page 3 of 11

4 LwinS Installation Procedure: 1. Uninstall the LwinS application, if already installed on the system. This can be done by clicking - Start -> Settings -> Control Panel -> Add/Remove Programs Select LubeAnalyst.Service.Installer or Shell.Georgia.OSAInterface.Installer, then Click Remove/Uninstall Button. 2. Go to C:\Apps (or the location into which the installable files were extracted into). Double click on Shell.Georgia.OSAInterface.Installer.msi file. Following window will be opened. Click on Next Button 3. Accept the Terms of License agreement. Then click Next Button Version 1.3 Page 4 of 11

5 4. Click Next button. 5. Provide your name and organization. Then click Next button. Version 1.3 Page 5 of 11

6 6. The installable chooses a default path for installation. Click on Change if you wish to change the path. Then click Next button. 7. Review the current settings. Then click on Install button. Version 1.3 Page 6 of 11

7 8. Installation will begin. Allow the installation to complete. 9. Once completed, click on Finish to to close the Install wizard. 10. After installation, LwinS will be added as a Service on the OSA machine. Version 1.3 Page 7 of 11

8 11. Navigate to the folder where the LIMS has been installed. In this case, the default location C:\Program Files\Shell\GeorgiaLIMS OSA Service. 12. Open the LubeAnalyst.WindowsService.exe.config file in edit mode and update the details as mentioned in Configuration Setup below. Save the changes. Close the file. 13. Navigate to Services folder on the OSA machine. Steps to do this are Click on Start -> Run Enter services.msc and click on enter. 14. On the Services folder, find LubeAnalyst.OSA.Interface.Service. Select the service and click on Start. 15. The LwinS will now start running and processing samples. 16. The Service can be Stopped or Restarted at anytime by selecting the Service Name, and clicking on Stop or Restart. Version 1.3 Page 8 of 11

9 Configuration Setup: Goto the folder where LIMS Interface Installed. C:\Program Files\Shell\GeorgiaLIMS OSA Service Open the LubeAnalyst.WindowsService.exe.config file in NOTEPAD. A sample of the config file is attached. LubeAnalyst.Window sservice.exe.config Update the keys as below. Keys: 1. <add key="labnamelubes" value="osalab"/> Value = Name of the lab doing service for Lubes. E.g., OUSA1 2. <add key="mode" value="interval"/> Value = Interval. Interface will run at specific Interval. The system will treat Interval as Minutes. 3. <add key="modevalue" value="15"/> Value = Numeric value depicting the interval at which LwinS needs to run. E.g., 15. Here it indicates 15 Minutes. 4. <add key="invokeserviceonstart" value="yes"/> Value = Yes When LIMS Service run in silent mode it will send and receive the file once service is started. 5. <add key="lubesuserid" value="xxyyzz="/> <add key="lubespassword" value="aaaabbbbccccdddd=="/> Value = encrypted user ID received in the . Value = encrypted password received in the . After the OSA has been setup, an will be sent to the admin containing the encrypted user ID, password and the web service URL. These encrypted keys are used as a licence key to get the OSA authenticated to send and receive data from the web application through the web service. 6. <add key="georgiaservicelubes" value=" Value = the web service URL received in the . The following keys are for proxy setting. Please see Proxy Configuration section below - 7. <add key="labmachinewebauthentication" value="automatic"/> 8. <add key="webproxyaddress" value="abc.xyz.com.au:2020/"/> 9. <add key="networkusername" value="aabbcc"/> 10. <add key="networkpassword" value="nnnwww"/> 11. <add key="networkdomain" value="xxyyzz"/> 12. <add key="usenetworkdomaininauthentication" value="yes"/> Version 1.3 Page 9 of 11

10 Leave the following keys unchanged 13. <add key="filenameprefixsampletestdata" value="samplexml"/> 14. <add key="sleepdurationonstart" value="0"/> 15. <add key="debugtraceon" value="no"/> 16. <add key = "DownloadMaterialOrder" value = "No"/> 17. <add key = "FileNamePrefixMaterialOrder" value = "MATERIALORDERXML"/> 18. <add key = "FolderPathMaterialOrderLubes" value = "C:\LIMS\Material\"/> Folders need to be created on the OSA machine for receiving and sending files. Following keys need to be updated accordingly <add key="folderpathsampletestlubes" value="c:\lims\in\"/> Value = The folder path where the sample XML files from LubeAnalyst will be placed by LwinS. 20. <add key="folderpathsampletestresultlubes" value="c:\lims\out\"/> Value = The folder path where sample test results XML file will be placed by the OSA software. 21. <add key="archivefolderpathsampletestresultlubes" value="c:\lims\archive\"/> Value = The folder path where the archive of both inbound and outbound sample XML files will be placed by LwinS. 22. <add key="logfilepathlubes" value="c:\lims\logs\"/> Value = The folder path where a log of issues will be placed by LwinS. 23. <client> <endpoint address=" binding="basichttpbinding" bindingconfiguration="basichttpbinding_ilubeanalystservice" contract="osaservice.ilubeanalystservice" name="basichttpbinding_ilubeanalystservice" /> </client> endpoint address = the webservice URL received in the . Update only the value within the double quotes after endpoint address= and before binding=. Proxy configuration: Some machines use a proxy server connection to connect to the network. In such cases, the proxy server details will need to be updated in the configuration file. Multiple scenarios can be possible with this. The configuration file will need to be updated with one of these options before starting the LwinS Service. 1. The Proxy Server does not require authentication. In this case, please do the following changes. <add key="labmachinewebauthentication" value="automatic"/> 2. The Proxy server requires authentication and will always ask for user ID and password. In this case, please do the following changes. <add key="labmachinewebauthentication" value="proxyserver"/> <add key="webproxyaddress" value="enter your proxy address or IP here:enter the proxy port here/"/> <add key="networkusername" value="enter your network proxy user ID here"/> <add key="networkpassword" value="enter your network proxy password here"/> <add key="usenetworkdomaininauthentication" value="no"/> 3. The Proxy server requires authentication, but the user ID and password is blank. In this case, please do the following changes. <add key="labmachinewebauthentication" value="proxyserver"/> Version 1.3 Page 10 of 11

11 <add key="webproxyaddress" value="enter your proxy address or IP here:enter the proxy port here/"/> <add key="networkusername" value=""/> <add key="networkpassword" value=""/> <add key="usenetworkdomaininauthentication" value="no"/> 4. The Proxy server requires authentication and will always ask for user ID, password and Domain. In this case, please do the following changes. <add key="labmachinewebauthentication" value="proxyserver"/> <add key="webproxyaddress" value="enter your proxy address or IP here:enter the proxy port here/"/> <add key="networkusername" value="enter your network proxy user ID here"/> <add key="networkpassword" value="enter your network proxy password here"/> <add key="networkdomain" value="enter your network proxy domain here"/> <add key="usenetworkdomaininauthentication" value="yes"/> Testing procedure: After the configuration file has been updated and saved, the LwinS service can be Started and sample files will start flowing between OSA and LubeAnalyst in the defined frequency of time. The following steps are typically carried out to perform the testing of the process. 1. OSA samples will be registered by the customer/osa user using LubeAnalyst web application. Details of various samples registered can be viewed or modified by logging into the application. 2. OSA samples with sample statuses Registered and Retest will be picked from LubeAnalyst. Samples with statuses Testing and Retesting that have been Re-sent to LIMS will also be picked. An XML file with all such sample details will be created and placed in the IN folder in the OSA machine. The format of the XML file is provided below: SAMPLEXML2015_01 _21_17_04_01_PM.x 3. The OSA software will then place an XML file containing the test results of the samples that were sent by LubeAnalyst in the OUT folder on the OSA machine. The format of the XML file is provided below. For testing purposes, the user may also create a dummy XML file with sample test results and manually place the file in this location. LIMSToLA.xml 4. After the file from the OUT Folder has been picked by LwinS, the OSA user can login to the LubeAnalyst web application and verify that the test results have been correctly updated against the sample number. Version 1.3 Page 11 of 11