How to connect benchtop instruments and Local Run Manager™ to a network location

10/11/21


Successful data transfer from the instrument to a network output location requires the instrument control software and Local Run Manager™ (LRM) to be configured according to Windows authentication requirements:

  • The local user account (eg, sbsuser) must have read and write access to the network output folder.
  • As best practice, the folder should be accessed through the Universal Naming Convention (UNC) path (not a mapped letter drive) and the output folder should be two levels deep (eg, \\server\level1\level2\).
  • If the network location is on the same domain (see Appendix) as the instrument, user credentials should be added through Local Run Manager (see Related Support Bulletins).
  • If the network location is on a different domain (see Appendix), see How to add credentials when the instrument is off domain.
  • If the Windows account passwords change, the credential configurations will also have to be updated.

Requirements for network connectivity

  • Use the full UNC path to the output folder. A UNC path uses double backslashes to precede the name of a computer or server:  \\server\level1\level2\.
  • If the output path is only one level deep, a trailing backslash is required: \\server\level1\.
  • Do not use a mapped network drive path (such as Z:\).
  • The account must have read/write access to the network destination folder.
  • The account must have at least “read only” or “list folder content” permissions to all parent folders within the UNC path. In the example of \\server\level1\level2, the account must have access to the “level1” folder.
  • The network location needs enough storage for the run. The amount of storage needed can vary by flow cell type and instrument. Reference the bulletin Approximate sizes of sequencing run output folders for estimates.

How to access the full UNC path?

  • Launch the Windows Command Prompt app
  • Enter the command net use
  • This will display the full UNC path

How to add credentials when the instrument is off domain

  1. Add the network credentials for the user account
    Prerequisite: Add sbsuser (or local instrument user) to the server share config (eg, Samba)
    1. Log in to the instrument with the local user account (by default, this account is sbsuser for all Illumina sequencing systems).
    2. Open File Explorer and enter the output network location (in UNC format) into the address bar.
    3. Enter the credentials of the user who has access to the desired network location into the Windows Security prompt. The credentials should be domain\username and the password of the network storage location.
    4. Select Remember my credentials, then select OK.

      Figure 1. Windows Security Prompt where credentials are entered.
  2. Set up Illumina Windows Services
    1. Search for Services in the taskbar and open the app with right-click and Run as administrator.

      Figure 2. Running Windows Services as administrator.
    2. Enter the local admin credentials (by default the credentials will be the sbsadmin user credentials) in the pop-up window.
    3. Locate the Illumina services.
    4. Right-click on Illumina Local Run Manager Analysis Service.
    5. Select Properties and navigate to the Log On tab.

      Figure 3. Selecting Properties for an Illumina Universal Copy Service.
    6. Select This account and browse to search for the account. In the Select User window, select Advanced and then Find Now. Select the Local user credentials (default sbsuser) from the search results.

      Figure 4. Selecting the local user credentials after clicking Find Now.
    7. Select OK to acknowledge both windows.
    8. Enter the Local user credentials (default sbsuser) password, select Apply and OK.
    9. Restart the service.
    10. Repeat steps 4 - 8 for Illumina Local Run Manager Job Service, Illumina Universal Copy Service (for NextSeq 500/550, NextSeq 550Dx, MiniSeq Control Software v2, and iSeq 100), and Illumina Run Copy Service (for MiniSeq Control Software v1.1).
  3. Ensure Internet Information Services (IIS) is configured for LocalSystem (default setting)
    1. Search for Control Panel in the taskbar, select Administrative Tools and then select Internet Information Services (IIS) Manager.
    2. Under the Connections panel on the left side, select the right arrow to expand the instrument icon, then select Application Pools.

      Figure 5. Selecting Application Pools in Internet Information Services (IIS) Manager.
    3. Right-click Local Run Manager and select Advanced Settings.
    4. Confirm that Identity is configured for LocalSystem.

      Figure 6. Confirm that Identity is configured for LocalSystem.
    5. If Identity is NOT configured for LocalSystem, select Identity, then select the […] elipse button.
    6. In Application Pool Identity, select Built-in account and select LocalSystem from the dropdown menu.

      Figure 7. Ensure Local Run Manager is configured for LocalSystem.
    7. On the left side of the Internet Information Services (IIS) window, expand Sites by clicking the caret to the left.

      Figure 8. Select the caret to the left of the Sites folder to expand it.
    8. Right-click Local Run Manager.
    9. Select Manage Website, then select Restart to restart the website.

Note that for NextSeq 550Dx instruments, the credentials need to be added for both Dx and RUO modes if the output folder is located on a network location for both modes.

Configuring output folder to the network

Instrument Control Software

  • Set Output Folder location as full UNC path with trailing backslash

    Figure 9. Setting the Output Folder location in the instrument control software.

Local Run Manager

  • Refer to the bulletin Local Run Manager: How to requeue and import run data for reanalysis and the section To import data to a new analysis module. Import a run to be able to set the Base Output Folder to the network location. Enter the network location as the full UNC path.

    Figure 10. Setting the network location (using full UNC path) in Local Run Manager when importing a run.

Changing Windows Account Passwords

If the Windows account passwords change, the credential configurations will also need to be updated. This process might include updating the user credentials for the Illumina Windows Services. Failure to update the password can cause connectivity issues and failures during sequencing runs.

Appendix: How to determine if instrument is ON or OFF Domain.

  1. Open Windows Control Panel using Win+x short cut on the keyboard.
  2. From Windows Control Panel, select System.
  3. Under Computer name, domain, and work group settings, determine whether the system is off domain (Workgroup) or on Domain as illustrated in Figure 11.

    Figure 11. Domain Settings are found under System in Control Panel.

Related Support Bulletins