Prerequisites

  1. SampleManager LIMS version 21.0 or later is installed and running correctly.
  2. Chromeleon CDS version 7.2.10 ES MUg or later is installed and running correctly.

Procedure

  1. Double-click the WebAPI Service Setup.exe file.
  2. Select the checkbox to agree to the license terms and conditions.
  3. Select Install.
  4. In the SampleManager Chromeleon Link WebAPI Service Wizard, select Next.
  5. Keep the default Destination Folder (recommended) or enter a path to the desired destination folder.
  6. Select Next.
  7. Select the Web API Settings:
  8. Leave the default HTTP/HTTPS Port (8082) or enter a new port number. The default port number corresponds to the existing Legacy web API port number. Thus, it is overwritten. If you want to run both, the WebAPI Service and the Legacy web API, in parallel, enter a new port number.
  9. Select the checkbox to ignore ready check warnings with source URL.
  10. TIP

    For Legacy web API installations, ready check warnings with source URL were ignored by default. For WebAPI Service installations, ready check warnings are enabled by default. If you want to ignore ready check warnings, you must select the checkbox.

  11. Select the HTTPS enabled checkbox to enable HTTPS transfer.
  12. NOTE

    Unlike the Legacy web API, the WebAPI Service does not automatically create a self-signed SSL certificate.

  13. Skip this step if you did not enable HTTPS. On the HTTPS settings page, enter the following settings:
  14. Certificate Path: Enter the path of your SSL certificate.
  15. Certificate Password: Enter the password of your SSL certificate.
  16. Certificate Store: Enter your certificate store. For more information, refer to the Microsoft website.
  17. Certificate Location: Select your certificate location.
  18. Allow Invalid: Select this checkbox to allow invalid self-signed SSL certificates.
  19. Select Next.
  20. Specify the authentication settings for the WebAPI Service:
  21. If you do not require authentication, that is, User Mode is not enabled in the Chromeleon CDS, select Next.
  22. To use single-user authentication, enter a valid Chromeleon User Name and Password and select Next.
  23. NOTE

    This option is only available when User Mode is enabled in the Chromeleon CDS.

  24. To use multiple-user authentication, enter a valid Chromeleon User Name and Password and select the Require Authorization checkbox. Select Next.
  25. NOTE

    This option is only available when User Mode is enabled in the Chromeleon CDS.

  26. Select Install.
  27. Select Finish.
  28. Installation successfully completed.