Software Setup

Setting-up Illumina Connected Software

What is Software Setup?

Thank you for purchasing Illumina Software. Illumina Connected Software is made available for your use by completing a software setup process. The process “activates” the software and enables you to assign access to specific persons who will use it. The process has four steps:

1. Click a link in an email provided by Illumina.

2. Access the Illumina Connected Software Registration Portal.

3. Identify a software administrator.

4. Configure software settings.

---

Information You Need to Setup Illumina Software

To setup your Illumina Software subscription or software consumable (e.g. iCredits), you will need the following:

1. An Illumina order confirmation or registration reminder email.

2. Email address of a person who will serve as software administrator

   1. (See: “Choosing a Software Administrator").

3. Optional: Names of existing Illumina Software workgroups or domains.

Choosing a Software Administrator (Admin.)

Choosing a Software Administrator

The admin email address should be for a person or group that knows enough about your team’s use of the software to provide team members with access to the Illumina Software product(s) when requested.

NOTE: Software administration does NOT require any advanced technical or computer skills.

Software Administration Features

The administration features of Illumina Software are simple. Here are examples of some of the things an administrator can do:

1. Add, remove, and edit user access to Illumina Software Products

2. Organize users into workgroups so they can collaborate

3. Limit login access to specified email addresses

4. Limit login access to specified domains (ex: lucyhealthcorp.com)

5. View the Illumina Software usage reports

Tips for choosing an admin email address

1. Use the same email to register applications if they are purchased as a solution. For example:

   • Illumina Connected Insights can only be accessed if it is setup with the same domain and admin email address used by Illumina Connected Analytics.

2. The administrator email address can be shared by an informatics team, for example [e-mail].

3. NOTE: When setting up software on a new domain or workgroup, the email address of the person setting up the software will be used as the admin.

4. The admin email address can be changed later if necessary. To do so, contact Illumina Technical Support.

How to Setup Illumina Connected Software

Step 1: Click a link in an email provided by Illumina

Below are examples of Illumina order confirmation and software setup reminder emails that you should have received. Clicking on the button provided in these messages will bring you to the Illumina Software login page in Step 2.

Fig. 1.1 - Illumina Order Confirmation Email

Fig. 1.2 - Illumina registration reminder email

If you do not have an Illumina order confirmation or software setup email, then please contact Customer Care at [e-mail]. For additional contact information, click here.

Step 2: Access the Software Registration Portal

NOTE: A public Illumina user account is required to access the Software Registration Portal

The Software Registration Portal requires the use of a public Illumina user account (like those used with BaseSpace Basic and Pro). This is different than the one used to access Illumina Enterprise Software applications.

If you do not have a public Illumina user account, then select the link labeled “Don’t have an account” to create a user from the public Illumina login page. The same email address can be used as your other Illumina user account(s).

If you already have a user account for Illumina Software, enter those credentials into the login screen and proceed to step 3 below.

If you do not have a user account, then select the link labeled “Don’t have an account” to create an Illumina user account.

You should choose this option if this is the first time you have registered through the Software Registration Portal.

❗IMPORTANT❗ The use of an institutional email with the Registration Portal is critical to retaining access to your data. Customers have reported using non-institutional email addresses (Gmail, yahoo, etc.) has led to them losing access to their registered software because their institution chooses to block access to these types of email accounts. Please use an email address from your institution’s domain (e.g. GeneOrg.com) when creating an Illumina user account to access the Software Registration Portal.

Fig. 2 - Public Domain login page

Step 3 - Identify a Software Administrator

Once you have logged in, you will see the software setup page.

This page is where the software is configured for your use. Here, you assign access to a specific person who will be the software administrator. You will need that person's email address to complete this step.

An administrator is the person who leads or organizes a team of people who are using Illumina Software. An administrator can add or remove users, provide access to specific products, and view software usage data.

If you are unsure of the email address that should be used for the software administrator, then refer to the “Choosing a Software Administrator” section above.

Step 3a - Setup software as the software administrator

If you are the person who is going to be the software administrator, proceed to Step 4 below.

Step 3b - Assign another person as an administrator

You should use the button labeled “Assign User" to invite someone else to become software administrator if:

1. Your role is purchasing, or another role unrelated to software.

2. You were sent an Illumina registration email incorrectly.

3. Someone else on your team should be the software admin.

The images below (see fig.5-6) show the button labeled “Assign User" below each order awaiting registration.

Fig. 5 - "Assign User" Button

When you click the “Assign User" button, a modal window is displayed where you can enter the email address of the person you wish to invite. Press the “Assign” button to send an email to that person containing links to the Software Registration portal.

Fig 6 - Modal window that is displayed when the link labeled “assign another person” is pressed

When that person logs into the Software Registration portal and completes the software configuration steps below, the software is available for use.

Step 4: Configure software settings

Step 4a - View Products Pending Registration

The person identified as software administrator may view and register software orders pending registration (Fig. 7).

Fig. 7 - register software orders pending registration

Step 4b - Products Pending Registration Details

Each product listed contains two types of information for the user to review or select.

1. Order Detail: This information includes the dates on which the order was placed, the order, number, and the product that was ordered. This data in this section is not editable.

Fig. 8 – Order Details

1. "Setup": The section labeled "Setup" contains software settings. Examples of settings are choosing an AWS region, or selecting/creating an enterprise domain that the software instance will be associated with.

<figure><img src="../.gitbook/assets/20241218 StepbyStep_fig9_Large_ICA_v1.2.png" alt=""><figcaption><p><em>Fig. 9 – Setup Details</em></p></figcaption></figure>

Examples of configuration details for specific Illumina software are shown below.

Configuration Examples: How to Configure Illumina Software

There are two types of software that use the setup process:

1. Software Subscriptions

   • Examples:

     • BaseSpace Sequence Hub Professional

     • ICA Professional, ICA Enterprise, Illumina Connected Insights

2. Software Consumables

   • Examples:

     • iCredits, Genome Equivalent Samples

The Software Setup for different types of software are slightly different. The sections below contain three examples that describe how to setup each software type.

NOTE: It is important to complete the setup for subscriptions FIRST before registering software consumables. Software consumables require an active subscription for them to be used.

Example 1: Setup BaseSpace Sequence Hub Professional

There are two settings to configure for this software subscription:

1. Select the instance region for your subscription

2. Select a Professional Workgroup or Create a New Workgroup

Setting 1 - Select the Instance Region for Your Subscription.

This selects the AWS Region where your software will be installed and run. Most administrators select a region that is close to their geographic location. If you are unsure what instance region to select, click here to learn more.

Fig. 10 – Selecting an AWS Region

Setting 2 - Select or Create a Professional Workgroup

Q: Why do I have to choose a workgroup?

A: Workgroups are used by some Illumina Software to control access to different customer’s data and assets.

New and Existing Workgroups

If your login has access to existing workgroups, these are listed on the page for you to choose from. Selecting an existing workgroup will not change the user access on the account. If you do not have existing workgroups, then select the "Create New" menu item and type in the name you prefer (Fig. 11-12). Remember to select the name of the professional workgroup you created so that it appears in your completed configuration (Fig.13).

Fig. 11 – Selecting or Creating a Professional Workgroup

If the value “Create New” is selected from the dropdown menu, then a modal window is displayed which enables the user to create a new workgroup name.

Fig. 12 – Modal window displayed when user selects Create New Professional Workgroup

Fig. 13 – Completed Configuration

Press the Register Button

Once the configuration settings have been selected, pressing the register button at the bottom of the order item makes that software available for use. Within 15-30 minutes, you will also receive a welcome notification to confirm the account details.

Example 2: Configuring Illumina Connected Analytics (ICA) Subscriptions

There are two settings to configure for this subscription:

1. Select the Instance Region.

2. Select or Create a Domain.

Fig. 14. - The ICA software subscription order.

Setting 1 - Select the Instance Region

This selects the AWS Region where your software will be installed and run. Most administrators select a region that is close to their geographic location. If you are unsure what instance region to select, click here to learn more.

Fig. 15. - The Choose Instance Region dialog box.

Setting 2 - Select or Create a Domain

Q: Why do I have to choose a domain?

A: Domains are used by some Illumina Software to control access to different customer’s data and assets. Examples of a domain are “dcehealth.Illumina.com” or “coreseqinc.Illumina.com”. Choosing a domain is required when registering BaseSpace Enterprise, Illumina Connected Analytics, or Cohorts subscriptions.

Existing Domains If your login has access to existing domains, these are listed on the page for you to choose from. Selecting an existing domain will not change the user access on the account. Create a New Domain Note: When creating a new domain, you will be considered the administrator for that domain.	Fig. 16. – Selecting an existing domain.
Enter data for the new domain: · Domain Name: Nickname that is easy to identify for the domain to be created. (ex. “My Company Name’s Domain”) · Login URL: URL used to log into your account. For example, “yourcomanyname.Illumina.com”. · Allowed Email: Emails for individual users who can access the software. If the user is creating a new enterprise domain, then their email will be added automatically to the list of emails. · Allowed Domain: All allowed users should belong to this domain (ex. @company.com). · Note: The list of the allowed emails and domains can be updated later once an administrator is logged into the account.	Fig. 17. – Adding new domain fields.
NOTE: Domain or workgroup names may use only lowercase alphanumeric, dash (-), max 50 characters and no spaces.

Press the Register Button

Pressing the register button at the bottom of an order item makes that software available for use. Within 15-30 minutes, you will receive a welcome notification to confirm the account details.

Example 3: Configuring Software Consumables (iCredits or Sample Analyses)

Once a subscription has been setup, then you can select software consumables and add them to your subscription. Examples of software consumables are iCredits or Sample Analyses.

• iCredits are the units that Illumina customers purchase to pay for cloud compute and storage resources they consume in Illumina Software.

• Sample Analyses are the units of software sold with Illumina Product that entitle a customer to perform genomic analyses in Illumina Software. An example of this is Illumina Connected Insights service that provides cloud-based analysis.

There is only one setting to configure for this software consumables:

Setting 1 - Select a Professional Workgroup or Enterprise Domain

Q: Why do I have to choose a workgroup or domain?

A: Workgroups and domains are used by Illumina Software to control access to different customer’s data and assets.

Fig.18. - Selecting or Domain or Workgroup.

Press the Register Button

Once the configuration settings have been selected, pressing the register button at the bottom of an order item makes that software available for use. Within 15-30 minutes, you will also receive a welcome notification to confirm the account details.