Set up an account for IonReporterUploader plugin

Before you can transfer files to Ion Reporter™ Software with the IonReporterUploader plugin, you must configure a valid Ion Reporter™ Software account. Torrent Suite™ Software uses the account information to transfer output files to an Ion Reporter™ Software organization.

You can add more than one account for the IonReporterUploader plugin. When you add multiple accounts, any available account can be selected when you run the plugin, or when you manually upload output files to Ion Reporter™ Software. You can upload the Torrent Suite™ Software output files to any of the Ion Reporter™ Software accounts that are available in Torrent Suite™ Software.

IMPORTANT! When you upgrade to a new version of Ion Reporter™ Software, you must reconfigure the IonReporterUploader plugin with an Ion Reporter™ Software account that is set up for the new version of Ion Reporter™ Software. This account must be set up before you can access the IonReporterUploader plugin from the updated software.

When an account is set up, two email notifications are sent each time that an IonReporterUploader plugin finishes a run. The first email is sent when the plugin run starts. Another email is sent when the upload to Ion Reporter™ Software is complete. The notifications are sent to the email address of the Ion Reporter™ Software user who is signed in when the IonReporterUploader plugin is launched.

If you use Ion Reporter™ Software on Thermo Fisher™ Connect Platform you must have an access code to complete this procedure. An access code is not required for Ion Reporter™ Server.
  1. If you do not already have an access code for use with Ion Reporter™ Software on Thermo Fisher™ Connect Platform, create an access code for use with the IonReporterUploader plugin setup. If you use Ion Reporter™ Server, proceed to Step 2.
    1. Sign into Ion Reporter™ Software.
    2. Click (Settings) > Manage Tokens.
    3. Click Set New Access Code, then enter an access code in the New Access code field.

      The access code must contain at least 6 characters. The maximum length of the access code is 50 characters.

    4. Select an expiration time in the Access code Age dropdown menu, then click Save and Generate.

      Note: The IRU token is used for the IonReporterUploader command-line utility. The API token is used internally for the Ion Reporter™ Software Web services API. Neither token is required for this procedure. For more information, see Ion Reporter™ Software system help.

    The access code that you must use to set up the IonReporterUploader plugin is shown in the Manage Tokens dialog box. Save this access code for use in future account setups. Alternatively, you can reset the access code as needed.
  2. In Torrent Suite™ Software, click (Settings) > Ion Reporter Configure:
  3. In the Ion Reporter Uploader Account Configuration screen, click Add Account, then select an account type.

    Option

    Selection

    Ion Reporter™ Software on Connect

    Select Ion Reporter Cloud

    Ion Reporter™ Software on an Ion Reporter™ Server

    Select Ion Reporter

  4. In the Add Ion Reporter account screen, enter the appropriate account information.

    Ask your system administrator for values for a local Ion Reporter™ Server.

    Item

    Selection

    Server Type

    Enable HTTPS.

    Display Name

    Enter a name of your choice for the account. This name can be selected when you configure a Planned Run template or run the IonReporterUploader plugin manually. Use only the alphanumeric, dash, underscore, and space characters.

    Server

    Enter: 40.dataloader.ionreporter.iontorrent.com, or the address for your local Ion Reporter™ Server.

    Port

    443 is the port number that is automatically populated.

    Username

    Enter your Ion Reporter™ Software username (your email address).

    Password

    For Ion Reporter™ Software on Thermo Fisher™ Connect Platform. Enter the access code.

    For Ion Reporter™ Server, enter the password.
  5. Select one of the following account options:

    • Default—The account that is configured by default in the Planned Run templates and Planned Runs. If the main account is for file transfers, select the Default checkbox. You can change the default account after you set up a Planned Run template, or through the Upload to IR menu on the completed run report.

    • Get Versions—Select an available version of the software.

      This option is available if multiple versions of Ion Reporter™ Software are available and multiple accounts are configured.

  6. Click Add.
  7. (Optional) The IonReporterUploader plugin can manage multiple configurations. To add another configuration, repeat the procedure.

When at least one account is successfully configured, the IonReporterUploader plugin is ready to transfer output files to Ion Reporter™ Software. If you set up multiple accounts, the accounts are listed in the Upload to IR menu in the completed run report that you can use to upload output files manually to Ion Reporter™ Software. The accounts are also listed when you configure an Ion Reporter™ Software Planned Run or Planned Run template.

Related Topics
Parent topic: Integration with Ion Reporter™ Software