API ReferenceProduct Documentation
Product Documentation
Start typing to search…

Tetra Biacore Insight Connector

The Tetra Biacore Insight Connector is a standalone, containerized application that that receives evaluation data from Cytiva Biacore Insight, augments it with a generated report point table, and then uploads it to the Tetra Data Platform (TDP).

Operational Guide

The following procedures show how to install and operate the Tetra Biacore Insight Connector.

Install a Tetra Biacore Insight Connector

To install a Tetra Biacore Insight Connector, do the following.

Prerequisites

The Tetra Biacore Insight Connector requires the following.

System Requirements

  • Linux OS
  • Docker installed
  • Outbound network access to TDP v4.0.0 or higher
  • Outbound network access to all Biacore Insight instances the Connector will contact

If Biacore Insight is running in an on-premises network, the Connector should run either on an on-premises Tetra Hub or as a standalone deployment on an on-premises Linux server.

Network requirements for multiple Biacore Insight instances

To use the Connector to contact multiple Biacore Insight instances, the Connector's host machine must be able to access all relevant Biacore Insight instances.

Biacore Insight Server Requirements

The Tetra Biacore Insight Connector requires the following Biacore Insight server configuration:

  • Biacore Insight Evaluation Software with API access enabled
  • A valid Biacore Insight user account with appropriate permissions to access evaluation data
  • Firewall configured to allow connections (see Configure Firewall Settings)
  • Network connectivity between the Connector's host and the Biacore Insight server
📘

NOTE

The Connector was developed and tested using Biacore Insight Evaluation Software version 6.0.7.1750. The Connector may work with other versions, but this has not been tested.

Configure Firewall Settings

The Biacore Insight API port is configurable. Common examples use port 50000 for HTTP. Contact your Biacore Insight administrator for the specific port number and protocol (HTTP/HTTPS) configured for your installation.

The server hosting the Biacore Insight instance must allow inbound traffic on the configured port to allow the Connector to reach it. The relevant firewall rules should be introduced as part of the Biacore Insight installation. You can confirm that the rules are set by looking at Windows Defender Firewall with Advanced Security > Inbound Rules.

To learn about TDP networking best practices, see Recommended Architectures for Network Connectivity to Private Cloud and On-Premises Components in the TetraConnect Hub.

(Optional) Provision a Tetra Hub or Standalone Instance

To set up an on-premises Tetra Hub, see Create and Install a Tetra Hub.

To set up a standalone Connector deployment, see the Standalone Connector Installation and Upgrade Guide in the TetraConnect Hub. For access, see Access the TetraConnect Hub.

For more information about deployment options, see Connector Deployment Options.

Create a Tetra Biacore Insight Connector

To create a Tetra Biacore Insight Connector, do the following:

  1. Sign in to the TDP. Then, in the left navigation menu, choose Data Sources and select Connectors. The Connectors page appears.
  2. Follow the instructions in Create a Pluggable Connector. For CONNECTOR TYPE, make sure that you select Biacore Insight Connector.
📘

NOTE

After the Connector is created, the initial MODE status is set to IDLE by default. To activate the Connector, you must configure its settings. For instructions, see the Configure the Connector section.

Configure the Connector

On the Connectors page, select the name of the Connector that you created. Then, select the Configuration tab to configure the required settings.

Configuration Parameters

The Tetra Biacore Insight Connector requires the following configuration parameters.

Username

  • Parameter Name: username
  • Type: String
  • Required: Yes

Username for Biacore Insight API authentication. This should be a valid Biacore Insight user account with appropriate permissions to access evaluation data.

Password

  • Parameter Name: password
  • Type: String
  • Required: Yes

Password for Biacore Insight API authentication.

Cytiva Biacore Insight API Base URL

  • Parameter Name: urlBase
  • Type: String
  • Required: Yes

Base URL for the Biacore Insight API including the port number.

Example: http://localhost:50000

Polling Interval

  • Parameter Name: pollingInterval
  • Type: Number (integer)
  • Required: No
  • Default: 10 minutes

How often the Connector checks for new evaluations, specified in minutes. The Connector will poll the Biacore InsightsAPI at this interval to discover and upload new evaluation files.

Path Configurations

  • Parameter Name: pathConfigurations
  • Type: Array of JSON objects
  • Required: No

Advanced file filtering and labeling configurations. When configured, only files matching at least one path configuration will be uploaded to the TDP.

Each path configuration object contains the following fields:

  • path: Folder path prefix in Biacore's folder structure (for example, "Root/Experiments/")
  • filePattern: Glob pattern for file names (for example, "*kinetics*", "QC_*", or "*" for all files)
  • labels: Custom labels to apply to matching files (each label needs name and value fields)

Matching Behavior:

  • Files must be located within the configured folder path or its subfolders.
  • File names must match the glob pattern.
  • When multiple configurations match a file, only the first matching configuration is used.
  • Order matters, so it's a best practice to place more specific configurations before general ones.
  • Files that don't match any path configuration are filtered out and will not be uploaded.

Example Configuration:

[
  {
    "path": "Root/Experiments/",
    "filePattern": "*kinetics*",
    "labels": [
      {"name": "assay_type", "value": "kinetics"},
      {"name": "priority", "value": "high"}
    ]
  },
  {
    "path": "Root/QualityControl/",
    "filePattern": "QC_*",
    "labels": [{"name": "data_type", "value": "quality_control"}]
  },
  {
    "path": "Root",
    "filePattern": "*",
    "labels": [{"name": "data_type", "value": "general"}]
  }
]

For more details on path configurations and label restrictions, see the Tetra Biacore Insight Connector artifact's README documentation. To access the README, see View Connectors and Their Details.

Disable SSL Certificate Validation

  • Parameter Name: disableSSLCertificateValidation
  • Type: Boolean
  • Required: No
  • Default: false

If enabled, the disableSSLCertificateValidation parameter disables certificate validation for HTTPS connections to Biacore Insight servers. When disabled, the Connector will accept any certificate, including self-signed ones.

📘

NOTE

It's recommended that you only disable SSL certificate validation if you trust the network environment and the Biacore server. Disabling SSL certificate validation is useful for environments with self-signed certificates or internal certificate authorities.

Review and Edit the Connector's Information

The Information tab on the Connector Details page displays information about the Connector, the files pending, successfully uploaded, or failed. It also provides functionality to edit a Connector’s information, metadata, and tags.

To edit the Connector's information, select the Edit button on the Connector Details page's Information tab.

For more information, see Review and Edit a Pluggable Connector's Information.

Set the Connector's Status to Running

Set the Connector's status to Running by following the instructions in Change a Pluggable Connector's Status.

Metrics

After a Connector instance is created and running, you can monitor the Connector’s health by selecting the Metrics tab on the Connector Details page. The Metrics tab displays the Connector's container metrics as well as aggregated states on total files scanned and uploaded as well as files that returned errors or are pending.

Access Data

Using the polling interval set in configuration, the Connector periodically queries Biacore Insight to discover new or modified evaluations since the last poll. The Connector then marks these evaluations in its internal data store as pending upload. These will be visible from the Connector's page as files with status PENDING. During each polling interval, the Connector reviews its list of known evaluations that haven't yet been uploaded and uploads them to TDP. The successful uploads are marked as SUCCESS and the failed ones as ERROR.

Custom Commands

The Tetra Biacore Insight Connector supports custom commands that can be sent through the TDP Command Service or through the Connector's page in the TDP user interface. These commands allow you to interact with Biacore Insight instances programmatically.

Manual Upload

Action: TetraScience.Connector.BiacoreInsights.ManualUpload.v1

The Manual Upload command provides the ability to manually retrieve historical evaluation data within a specified time range through the TDP Command Service or the Connector Details page's Historical Data tab in the TDP user interface.

Behavior:

  • Searches for evaluations with DateModified within the specified time range.
  • Queues discovered evaluations for upload during the next polling cycle.
  • Skips evaluations that have already been processed.
  • Respects path configuration filtering, if configured.

Required Payload Fields

  • start_date (string): Start date in ISO 8601 format (for example, "2024-01-01T00:00:00")
  • end_date (string): End date in ISO 8601 format (for example, "2024-01-31T23:59:59")

Example Payload:

{
  "start_date": "2024-01-01T00:00:00",
  "end_date": "2024-01-31T23:59:59"
}

Updated about 18 hours ago