M8240BA Shimadzu LC Control Driver 1.51 for OpenLAB CDS self-paced training Course # AN-CE-NDS-2-265-D September 2017 This training information is provided as basic background on the driver for Shimadzu LC s and will take approx. 2.0 hours to complete. This training requires the OpenLAB CDS 2.x Workstation course # AN-CE-NDS-2-246 to be completed first.
Training Objectives This is a self-paced CBT for the latest Shimadzu LC Driver and an overview of how to set up the instruments in OpenLAB CDS. The main objectives of this course are listed below: Understand the driver products and their support requirements Install the required drivers and configure them Successfully configure the instrument(s) How to troubleshoot Page 2
Agenda General Information Requirements Installation Configuration Operation Known Issues & Limitations Troubleshooting This training will take approximately 2 hours to complete. Page 3
GENERAL INFORMATION Product Information Documentation Driver Distribution Services Support Page 4
General Information Product Information What s New Description Agilent Product Number Notes Shimadzu LC Control for OpenLAB M8240BA 1 license per instrument required. There has been a change in the OpenLAB CDS licensing structure. The previous M8300AA Instrument Connection License is no longer required. The legacy OpenLAB CDS product M8360AA for Spectral Control and Processing has also been obsoleted as part of the new OpenLAB CDS product structure. Licenses for this Shimadzu LC Control for OpenLAB can be ordered by Shimadzu and Agilent Technologies. Page 5
General Information Product Information What s New Shimadzu LC Drivers 2.0 and 2.1 is a new RC.NET-based driver available as product number M8240BA. This driver provides support specifically for OpenLAB CDS 2.1 and supports Windows 7 SP1 64bit (English), Windows 8.1 64bit (English) and Windows 10 64bit (English). Windows Professional Edition and above is supported. Windows Server 2012 R2 Enterprise is not tested (to be tested Q1 2018). This driver covers the following Shimadzu LC product families: - Prominence-i (LC-2030 / LC-2030C / LC-2030C 3D) - Nexera-i (LC-2040C / LC-2040C 3D) (more details on slide 14) Page 6
General Information Product Information Classic vs RC.NET Driver differences An authorization code must be used to create a license in SubscribeNet. https://agilent.subscribenet.com The new RC.NET driver can be distinguished by looking at Windows Programs and Features. The latest RC.NET driver version will be shown as Shimadzu LC Driver for OpenLAB CDS. The co-existence and co-execution of the classic Shimadzu LC driver in combination with this v.1.51 driver is not supported in OpenLAB CDS 2.x. Before upgrading OpenLAB or the Shimadzu LC Driver to a newer version, uninstall all existing previous Shimadzu LC Drivers first. This should be done automatically if using the Deployment Manager. Page 7
General Information Product Information Driver Revision History Shimadzu LC RC.NET Driver Versions Shimadzu LC Driver v1.00 Shimadzu LC Driver v1.10 and v1.10 SP1 Shimadzu LC Driver v1.30 SP1 Shimadzu LC Control Driver v1.41, v1.50, and v1.51 Supported CDS OpenLAB CDS EZChrom Edition A.04.04 A.04.05 OpenLAB CDS EZChrom Edition A.04.04 A.04.05 A.04.06 * * (Ensure v1.10 SP1 is installed. It resolves an issue with instrument configuration in EZChrom A.04.06) OpenLAB CDS EZChrom Edition A.04.04 A.04.05 A.04.06 A.04.07 OpenLAB CDS 2.0 2.1 Note: The driver versions v1.00, v1.10, v1.10 SP1 and v1.30 SP1 are not supported on OpenLAB CDS EZChrom Edition A.04.03 and lower! The Shimadzu LC driver v1.30 was not released by Agilent and is not supported. For OpenLAB CDS 2.x: The Shimadzu LC driver v1.41, v1.50, and v1.51 (M8240BA) are supported only on OpenLAB CDS 2.x. For OpenLAB CDS EZChrom Edition, use M8240AA The Shimadzu LC driver v.1.40 was not released and/or published by Shimadzu. Page 8
General Information Documentation Shimadzu provides the following documentation in the Shimadzu RC.NET Installation Disk Image Documents/ENG folder: Shimadzu Readme Shimadzu Release Notes Shimadzu Quick Start Guide Shimadzu Installation Manual Shimadzu Certificate of Compliance Agilent provides the following documentation: Agilent Revisions SSB/SRB Page 9
General Information Driver Distribution The Shimadzu LC Control Driver v.1.51 for OpenLAB CDS 2.0 and 2.1 is available for download from SubscribeNet. 1. Navigate to OpenLAB Software > OpenLAB 3rd-Party Instrument Drivers > Shimadzu Drivers Download Only. 2. Select the driver you need for download. Page 10
General Information Services Installation and Familiarization Service & SPIFPMs: I&F services are now available for OpenLAB CDS 2.x drivers. For M8240BA, 2 hours of Installation time and 1 hour of Familiarization are bundled, but may be deleted by your Sales account manager. Check the Sales Order for these details. For details on what to deliver for I&F, review the SPIFPM checklists. They can be found in the e-library: Installation: http://intranet.chem.agilent.com/workspaces/service/entitled%20partner/104459 Familiarization: http://intranet.chem.agilent.com/workspaces/familiarizationchecklists/entitled%20partner/104460 NAT (Network Assessment): No impact. No direct relationship between driver and NAT. Qualification ACE (Agilent Compliance Engine): No specific impact on SW OQ communication test is part of general checkout and system SW OQ that will also test the driver. Service Notes Third party drivers for OpenLAB are announced via OpenLAB Service Notes. Please make sure you specifically register for these SNs. These can be found by subscribing to OpenLAB CDS Service Notes. https://extranet.chem.agilent.com/sites/frontiersupport/servicenotes/pages/admin.aspx Page 11
General Information Support User Manual M8240BA driver Installation and User s Guide (ENG and JPN) SSB present in the driver package in SubscribeNet or in Driver folder on USB stick for non- Agilent 3 rd party drivers Field Training: 2 hours CBT, Course : M8240BA Shimadzu LC Control Driver v1.51 for OpenLab CDS 2.1 Overview/Support matrix of available 3 rd party drivers for OpenLAB CDS (in Support Portal): http://sparklink.collaboration.agilent.com/x/-owuaw 3rd Party Web Pages in Support Portal: http://intranet.chem.agilent.com/sites/partners/support/product%20pages/third%20party%20 Hardware%20in%20Agilent%20CDS.aspx Page 12
REQUIREMENTS Supported Modules and Firmware Software Requirements Instrument Connections Page 13
Requirements Supported Modules and Firmware Module Model Supported Firmware Version Prominence i series LC - 2030, LC - 2030C, LC - 2030C 3D, LC - 2030C LT 2.10 or later Nexus i series LC - 2040C, LC - 2040C 3D, LC - 2040C LT, LC - 2040C MT, LC - 2040C 3D MT 2.10 or later System Controller CBM-20A, CBM-20A lite 2.40 or later * See Notes 1 and 2 below Pump Column Oven Autosampler Subcontroller Detector LC - 30AD LC - 20AD LC - 20ADXR LC - 20AT LC - 20Ai LC - 20AB CTO - 30AS CTO - 30A CTO - 20A, CTO - 20AC SIL - 30ACMP, SIL - 30AC SIL - 20A (HT, UFLC), SIL - 20AC (HT, UFLC), SIL - 20AXR, SIL - 20ACXR Rack Changer II Rack Changer, Rack Changer C Subcontroller VP (Option Box VP) SPD - M30A SPD - M20A SPD - 20A, SPD - 20AV RF - 20A, RF - 20AXS RID - 20A Analog Input Board (PC - 55N) 3.00 or later 1.12 or later 2.02 or later 1.10 or later 1.00 or later 1.10 or later 3.00 or later 3.00 or later 1.07 or later 3.00 or later 1.25 or later 2.00 or later 1.11 or later 5.22 or later 3.02 or later 2.00 or later ** See Note 2 below 1.11 or later 1.10 or later 1.00 or later ** See Note 2 below n/a *Note 1 If 2 PDA detectors are connected to 1 AIC or Workstation, upgrade the System Controller f/w to version 2.60 or later. **Note 2 For these modules to function correctly, upgrade the System Controller f/w to v2.80 or later Page 14
Requirements Software Requirements Localization of the Shimadzu Driver - English only Supported Topologies - Workstation - Networked Workstation - Distributed System Operating System Requirements - Windows 7 SP1 64 bit, Enterprise or Professional Edition - Windows 8.1 64 bit, Enterprise or Professional Edition - Windows 10 Page 15
Requirements Instrument Connections Max. Number of Instruments (1/2) 4 instruments can be used with one AIC/Workstation if a PDA detector is not being used. (2D instruments) 3 instruments can be used with one AIC/workstation if one of the instruments has a PDA detector. (3D) 2 instruments can be used with one AIC/workstation if both instruments have a PDA detector. (3D) In this case, an upgrade to at least firmware v2.60 or later on the system controller is also required. A chromatographic system supports a maximum of 5 detectors but is dependent upon the system controller in use: - 2 digital detectors such as SPD-20A and RF-20AXS, plus 2 PC-55 A/D boards, and an additional PDA detector) for CBM-20A - maximum of 3 detectors (2 digital detectors and an additional PDA detector) for the CBM-20Alite. Page 16
Requirements Instrument Connections Max. Number of Instruments (2/2) For the integrated LC systems (LC-2030/2040), two scenarios are possible, depending on which version of the integrated detector is present: Shimadzu LC Driver is limited to a maximum of 4 LC detectors, including the internal UV (2D) detector, 1 external detector supported by the LC-2030/2040, 1 A/D board, 1 PDA detector. For LC systems (LC-2030/2040) with the internal PDA detector, Shimadzu LC Driver is limited to a maximum of 3 LC detectors, including the internal PDA detector, 1 external detector supported by the LC-2030/2040, 1 A/D board. Page 17
Requirements Instrument Connections Communication Options Shimadzu uses LAN communications to connect to the instrument from an AIC or Workstation. RS232 is not supported. A second NIC card is needed on the AIC or Workstation. The second NIC card is used for a private LAN to connect the AIC or Workstation to the Shimadzu instrument. By default the Shimadzu controller you plug the LAN cable into has an IP address of 192.168.200.99. Check the IP address of the Shimadzu controller by accessing one of the other modules. Refer to the Quick Start Guide for additional details on setting IP addresses and enabling remote mode for the System Controller from one of the other modules such as the pump or Autosampler front panel, or from the i-series touch panel. To connect more than 1 Shimadzu LC instrument to an AIC or Workstation, you need to use a switch. The IP addresses on the controllers on the Private LAN need to be different. Page 18
INSTALLATION Hardware Software Register the Driver Software Verification Uninstall and Upgrade Page 19
Installation Hardware NIC Card IP On the second NIC card of the AIC or Workstation, assign a static IP address that is the one of the controller incremented by one. For example, if the controller is 192.168.200.99, add a static IP address of 192.168.200.100. Page 20
Installation Hardware Connect one Instrument via LAN To connect the AIC or Workstation to one instrument insert the LAN cable into the second LAN card (LAN card in the slot) on the AIC or Workstation (Figure 1). Then, insert the other end of the LAN cable into the Ethernet port on the CBM-20A/20 or CBM-20A/20Alite System Controller (Figure 2). Figure 1 Figure 2 Page 21
Installation Hardware Connect Multiple Instruments via LAN To connect the AIC or Workstation to more than one instrument: 1. Insert the first LAN cable into the second LAN card (LAN card in the slot) on the AIC or workstation (Figure 1). Then, insert the other end of the first LAN cable into the Switch (Figure 2). 2. Take a second LAN Cable and insert one end into the switch (Figure 2). Then, insert the other end into the CBM-20A/20 or CBM-20A/20Alite controller (Figure 3). Figure 1 Figure 2 From AIC/ Workstation to Switch From AIC/ Workstation To LC# 1 From Switch to LC Figure 3 To LC# 2 Page 22
Installation Hardware Set the IP Address for PDA Detector Set the IP address for the PDA detectors (SPD-M20A and SPD-M30A) separately. Access a web browser to set the IP address on the detector. Update/change the IP address to reflect an IP address different from the default address of the instrument LAN. Enter an IP address between 192.168.0.2 and 192.168.0.254, and subnet mask of 255.255.255.0. Once set, synchronize the start of the System Controller and the PDA detector. Follow the steps in the Quick Start Guide to ensure the PDA detector contains the same Group and Master Names as per the System Controller settings that have been configured. Important: For the external PDA detector to start synchronization with other HPLC systems or the i-series (LC 2030/2040), a separate start/stop cable is required to be connected from the Shimadzu System Controller start output connector to the start input of the detector. Page 23
Installation Hardware Synchronization of External PDA Detectors As a last step of the PDA connection and configuration, ensure that the configuration of both the PDA detector and the System Controller are aligned. 1. Call http://192.168.200.98 in Internet Explorer. The SPD-M20A Login window is displayed. 2. Log in as administrator with the password pdaadmin. 3. Enter an IP address and subnet mask compatible with the network settings for the instrument LAN, then click OK. 4. In the System Information area, enter the same name in the Group Name box as specified for the CBM-20A/20Alite controller. 5. Enter the same name in the Master Name box as the System Name specified for the CBM-20A/20Alite controller. 6. Click Update to complete the synchronization settings. The Screenshot above is an example of SPD-M20A detector configuration. The SPD-M30A is slightly different. For more information on the detailed process, refer to the Quick Start Guide, supplied with the driver under Section 3.a. Page 24
Installation Software Prepare When upgrading, remember to revoke the licenses and regenerate new licenses for the M8240BA product. Before upgrading the Shimadzu LC Driver to a newer version, uninstall the old driver version. If you use the Deployment Manager as described in the following, the uninstallation will be done automatically. Check the OpenLAB Authentication Service Provider and the user information of the administrator. Log in as a local administrator (admin rights on a user account may not be sufficient!). Refer to the Release Notes about the OpenLAB CDS versions supported by Shimadzu LC Driver. Close OpenLAB CDS if running. Page 25
Installation Software Workstation (1/5) 1. Insert the Shimadzu Drivers installation medium. a. Click the Windows Start menu. b. In the Search programs and files box, enter (CD-ROM drive letter):\setup.exe. c. Confirm the User Account Control dialog. 2. The Deployment Manager window opens. Click Next to proceed. Page 26
Installation Software Workstation (2/5) 3. Click Install or upgrade instrument drivers. 4. On the Select driver packages page, select the LC items, and click Next. Note: If Current version is same as Latest version, packages are not installed. Page 27
Installation Software Workstation (3/5) 5. Click Install. Note: If you click Cancel, the installation will stop after the current package is installed Page 28
Installation Software Workstation (4/5) 6. Click Next to proceed to the Completed window. 7. Click Finish to complete the installation Page 29
Installation Software Workstation (5/5) After the installation, the Shimadzu LC Control driver should be listed in Windows Programs and Features. Register the driver (see slide 33). Perform the OpenLAB SVT to ensure the installation was successful (see slide 35). Page 30
Installation Software Client/Server System (1/2) AIC: Log in as a local administrator (admin rights on a user account may not be sufficient). Close OpenLAB CDS if running. Install the driver on the AIC first, following the installation instructions on slide 25. Register the driver on the AIC, see slide 33. Perform the OpenLAB SVT to ensure the installation was successful (see slide 35). Page 31
Installation Software Client/Server System (2/2) Client: Log in as a local administrator (admin rights on a user account may not be sufficient). Install the driver on each Client computer, following the installation instructions on slide 25. You do not need to register the driver on the clients. Perform the OpenLAB SVT to ensure the installation was successful (see slide 35). Page 32
Installation Register the Driver 1. From the Start menu, select Agilent Technologies > OpenLAB Configuration. The OpenLAB Configuration dialog opens. 2. Under Step 1 Server, enter the hostname of the server that you would like to connect to, and click Connect. 3. In Step 2 Authentication, enter your administrator credentials for the server specified. 4. In Step 3 - Additional Options, select Register as Instrument Controller. 5. Click Register. Page 33
Installation Register the Driver 6. When the registration is finished, the registration results are shown. Click OK to close the dialog. Page 34
Installation Software Verification To verify successful installation, run the Software Verification Tool (SVT): 1. Go to Start > All Programs > Agilent Technologies and click Software Verification Tool. 2. Select OpenLAB CDS and click Qualify. 3. Check if the overall evaluation result shows a PASS after the procedure has finished. 4. Check for Shimadzu LC System driver entries ID# 64 and ID# 97 in the report. 5. If the test fails or Shimadzu LC driver entries are missing, do not proceed further and contact 3P-IC team technical support. Page 35
Installation Software Driver Check Tool Shimadzu Driver Check Tool: Shimadzu offers a possibility to check the Shimadzu hardware status, driver status and functionality with the CMB Web Controller. The customer is supplied with an IP address, and after disconnecting from the CDS (in this case OpenLAB) the plain driver can be checked. Important If you are using Internet Explorer 10 and higher it may happen that empty panels are displayed. If this is the case downgrade to Internet Explorer 9. Page 36
Installation Uninstall and Upgrade The driver can be uninstalled in 2 different ways: Open the Windows Control Panel/Programs and Features. Select the Agilent OpenLAB CDS Shimadzu LC driver and select Uninstall. or Run Setup.exe from the installation medium to open the Deployment Manager. Select Remove instrument drivers and follow the instructions. Note: When performing the uninstall, the user must be logged in as a local administrator with an administrator account. Running this option logged as another user with administrator rights is not sufficient, the uninstallation will not be possible. When upgrading the RC.Net driver to a newer version, use the Deployment Manager as described above. A reboot of the Workstation or AIC may be required. Page 37
CONFIGURATION Create Instrument Configure Instrument Page 38
Configuration Create Instrument To create an instrument within Agilent OpenLAB CDS, open the Control Panel and perform the following: Note: A Project must exist before creating an instrument. 1. Select the Instruments view and Instruments node, then click Create Instrument in the ribbon. 2. In the Name field, type a name for the instrument. 3. Check that the Application field contains an entry for OpenLAB CDS, and the Instrument Controller field also contains the name of the host PC/controller. 4. In the field Instrument type, select from the drop-down list the appropriate LC or GC instrument. Click OK. Page 39
Configuration Configure Instrument 1. Click Configure Instrument to configure the Instrument. 2. Click Auto Configuration. Type in the required IP-Address of the system and click OK. Manual configuration is not supported. 3. The LC modules are received and displayed under Configured modules. Page 40
Configuration Configure Instrument Add a PDA Detector (1/2) To add a Shimadzu PDA Detector to an existing HPLC System, perform the following in the OpenLAB Control Panel: 1. Select the Instruments node, and select the instrument to update. 2. In the ribbon, click Configure Instrument to configure the instrument. 3. Select the Shimadzu PDA Detector and add the module to Configured modules. 4. To configure the module, double-click the module icon. Page 41
Configuration Configure Instrument Add a PDA Detector (2/2) 5. Click Connection settings and type in the IP-Address of the PDA detector. 6. Click OK. The module configuration will be filled in. 7. Click OK to finish the process. Page 42
OPERATION Instrument Status Method Setup Data Acquisition Quick Start Guide Migration Page 43
Operation Instrument Status Dashboard Instrument Status Control Buttons: Display details of error Instrument activation on/off System Check Autopurge LC stop Help Instrument windows (maximized view) Status and parameters of instruments are displayed and can be edited. Page 44
Operation Method Setup 1. In Acquisition, select Method. 2. In the Acquisition Method window, click Create a new Acquisition Method. 3. Set all necessary instrument parameter for all modules in the instrument windows. (The next three slides show examples for instrument parameters.) 4. To save the method click Save Acquisition Method. Page 45
Operation Method Setup Instrument Parameters (1/3) System Controller: Pump: Page 46
Operation Method Setup Instrument Parameters (2/3) Autosampler: Column oven: Page 47
Operation Method Setup Instrument Parameters (3/3) Detector: Page 48
Operation Data Acquisition Single Sample Analysis 1. Click Single Sample in the Home ribbon tab. 2. In the Single Sample Analysis window, enter the required information, such as: - Sample name - Acq. Method - Result filename - Injection source. 3. Click Run. Note: The first sample starts immediately. Page 49
Operation Data Acquisition Create a Sequence 1. Click the Sequence button in the Layouts toolbar. 2. Click the Create a new Sequence button and edit the sequence table. 3. To save the sequence, click the Save Sequence button. Page 50
Operation Data Acquisition Run a Sequence 1. In the Sequence windows click Run. 2. Enter a result file name in the Save Result As dialog. 3. Click the Save button. Page 51
Operation Quick Start Guide For more information on how to set up a method and make either a single run or a sequence, refer to chapters 6 + 7 of the supplied Quick Start Guide. Page 52
Operation Migration There is no possibility to migrate methods from previous versions of OpenLAB CDS EZChrom Edition as these methods were based and created on a completely different driver platform. In order to migrate existing OpenLAB CDS methods created in version A.xx to OpenLAB CDS 2.x, you must create a new method from within OpenLAB CDS. Page 53
KNOWN ISSUES & LIMITATIONS Page 54
Known Issues & Limitations For known issues and limitations, please refer to the documentation delivered with the driver on contact the 3 rd Party support team. Page 55
TROUBLESHOOTING Tools Troubleshooting Page 56
Troubleshooting Tools Software Verification Tool (Outside OpenLAB CDS) Check the Status of the installation of the CDS and drivers with SVT. Shimadzu Driver Check Tool (Outside OpenLAB CDS) Use this tool to check the Shimadzu hardware status, driver status and functionality with the CMB Web Controller. System Check (Inside OpenLAB CDS) Request system information and perform a performance and maintenance check. Page 57
Troubleshooting If you cannot connect to the instrument, verify the following: Double-check the LAN settings as documented in the User manuals/guides. - Ensure there are no IP address conflicts with other instruments! Double-check that all components are connected and turned on. Check the firmware revision is correct on the instrument. Check that the driver is correctly installed and reports the correct version. For other problems, check the known problems list. Check the Support Portal for additional information, for example: - 3 rd party instrument Supportability matrix etc. - Service Notes for known problems If more assistance is required, contact the 3P-IC team using the following email: techsupport.3rd-party-ic@agilent.com Page 58