Software Setup
Last updated
Was this helpful?
Last updated
Was this helpful?
Setting up Illumina Connected Software
Thank you for purchasing Illumina Connected Software. To begin using the software, please complete the setup process. This process activates the software and allows you to assign access to specific users. To get started, follow the steps below.
Below are examples of Illumina order confirmation and software registration reminder emails you may have received. The registration reminder email includes both a registration link and an order code. You can share this order code with other users to allow them to assign themselves to the order via the Illumina . To begin, click the registration link in the email to access the portal, where you can either create a new account or log in to an existing one.
Once you have navigated to the , you can log in or create a new account.
If you already have a user account for Illumina Connected Software, enter those credentials into the login screen and proceed to step 3 below. If you do not have an Illumina user account, then select the "Sign up" link to create a new account. You should choose this option if this is the first time you have registered through the Software Registration Portal.
Once you have logged in, you will either be directed straight to the software setup page (if you created a new account), or you will see your (if you are logging into an existing account).
To access the Software Registration page from the Product Dashboard, click the icon next to your name in the top-right corner to open a dropdown menu of options. Select "Software Registration" from the dropdown menu.
Once you have made it to the Software Registration page, you should see a list of all the orders that need to be registered.
If you’ve been given an order code, you can enter it using the link at the top of the page. This will add the order to your account so you can proceed with registration.
For each order awaiting registration, you can assign specific users to set up the software. Click the button “Assign User" to invite someone else to set up the software.
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 a link to the Software Registration portal. You can optionally check the box to assign the user to set up all available software items associated with the customer account.
Click to view the users currently assigned to the order. To remove someone, click the X next to their email address.
The purchaser of the software cannot be removed from the order, and you cannot remove yourself.
You can review the "Order details" for each order. This information includes the date the order was placed, the order number, the purchaser email, the subscription term, and other key information about the order. This information is not editable.
The section labeled "Setup" contains software settings. You will need to select a region and domain/workgroup to which the software will be registered. The domain and region cannot be easily changed after the setup is complete.
First, select the region where the software will be registered. This determines the AWS Region in which your software will be installed and run. It is best practice to choose a region that is geographically close to where the software will be used. Most subscriptions are regional and require selecting a region, but consumables (e.g., iCredits) are not, so this step will be skipped for them.
Next, select the domain or workgroup to which the software will be registered.
This step may vary slightly depending on the type of software you're registering:
Software Subscriptions
Examples:
BaseSpace Sequence Hub Professional
ICA Professional, ICA Enterprise, Illumina Connected Insights, Illumina Connected Multiomics
Software Consumables
Examples:
iCredits, Genome Equivalent Samples
For software subscriptions such as BaseSpace Sequence Hub Professional, you will need to select a workgroup during setup. For all other software subscriptions, you will need to select a domain. For software consumables (e.g., iCredits or Sample Analyses), you may choose either a workgroup or a domain to apply them to.
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.
If the account you're logged in with has access to existing domains or workgroups, they will be listed on the page for you to choose from. Selecting an existing domain or workgroup will not affect or modify user access permissions associated with that account.
If you do not have existing domains or workgroups, then select the "Create a new domain" or "Create a new workgroup" button (depending on the type of order you are registering).
Create a New Domain
Note: When creating a new domain, you will be considered the administrator for that domain. The domain administrator can later be changed in the .
Upon clicking "Create a new domain", a modal window will be displayed where you can enter the following details for your domain:
Domain Name: Nickname for domain that is unique and easy to identify (ex. “My Company Name’s Domain”). You may only use lowercase alphanumeric, dash (-), max 50 characters and no spaces.
Login URL: URL used to log into your account. For example, “yourcompanyname.illumina.com”.
Allowed Email: Emails for individual users who should be granted access to the software. The email of the user creating the domain will automatically be added to the list of allowed emails.
Allowed Email Extension: The email extensions for all permitted users of this domain (e.g., @company.com). Only email addresses that end with the specified extensions will be allowed to access the domain.
The list of allowed emails and email extensions can be updated later in the .
Click "Save" to create the domain. Make sure to select the name of your domain once it's been created.
Create a New Workgroup
Upon clicking "Create a new workgroup", a modal window will be displayed where you can type in the name you prefer for the workgroup. You may only use lowercase alphanumeric, dash (-), max 50 characters and no spaces
Click "Create" to create the workgroup. Make sure to select the name of your workgroup once it's been created.
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 products 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.
You can choose to add software consumables to either a workgroup or a domain.
Once the configuration settings have been selected, press the button at the bottom of the order item to make the software available for use. Upon clicking this button, you will no longer be able to access or modify the order in the Software Registration Portal.
Provisioning of your software in the cloud can take up to 15-30 minutes after registration is complete. When provisioning is completed, you will receive a welcome notification that includes getting started information about your subscription.
At this point, all users in the domain or workgroup should be able to access the software from . However, if you have a software which requires adding specific users to the subscription before someone can access the associated application—such as ICM—you can navigate to the page to assign users.
If you have a software which requires every user to be part of a workgroup before they can access the app—such as ICI, Emedgene, and ICM— you can navigate to the to create workgroups and add users to the workgroup.
From the Admin Console, you can also assign different domain admins.
See the for frequently asked questions and answers.
