Tetra IDBS E-Workbook Integration

The Tetra IDBS E-Workbook Connector is a built-in integration in the Tetra Data Platform. This connector allows users to pull experiments and spreadsheets from IDBS E-Workbook folders and places them in the Tetra Data Lake.

How the Integration Works

The Tetra Data Platform leverages IDBS E-Workbook APIs to continuously detect new experiment versions in your E-Workbook folders and uploads experiment and spreadsheet details in the Tetra Data Lake, which triggers Data Pipelines. The Tetra IDBS E-Workbook Connector polls the E-Workbook for new version events every minute.

📘

NOTE:

The Tetra IDBS E-Workbook Connector tracks when new versions of an experiment are saved. If you delete an experiment from a folder in E-Workbook, the Tetra Data Lake will not mirror that change and delete the corresponding experiment and spreadsheet files.

Setting Up the Connector and Adding Sources

To configure the connector, you will use the Tetra Data Platform web interface to create the connector and add at least one source. The source specifies the E-Workbook folder you want to get files from, as well as the labels, metadata, or tags that you want to apply to those files before they are placed in the Tetra Data Lake.

📘

PREREQUISITES:

Before you start, you must create a dedicated IDBS user and API Key for this connector. The user’s API password is separate from the login password to use the E-Workbook web client. For more details on how to do this, refer to IDBS documentation.

Create an IDBS E-Workbook Connector

To create and configure an IDBS E-Workbook connector, complete the following steps.

  1. Log into the Tetra Data Platform.
  2. Click the "hamburger" menu icon on the top left to open the sidebar menu.
Hamburger menuHamburger menu

Hamburger menu

  1. Select Data Sources, then IDBS E-Workbook.
IDBS E-Workbook Menu OptionIDBS E-Workbook Menu Option

IDBS E-Workbook Menu Option

  1. The IDBS E-Workbook Source Management screen appears. Click the Add IDBS E-Workbook Integration link.
IDBS E-Workbook Source Management ScreenIDBS E-Workbook Source Management Screen

IDBS E-Workbook Source Management Screen

Create IDBS E-Workbook ConnectorCreate IDBS E-Workbook Connector

Create IDBS E-Workbook Connector

  1. Enter the base URL for your E-Workbook instance. For example, if you normally go to https://customerxyz.idbs-eworkbook.com:8443/EWorkbookWebApp/ to access E-Workbook, enter https: //customerxyz.idbs-eworkbook.com:8443/ as the base URL.
  2. Enter the username and API password that you set up for this connector.
Create IDBS E-Workbook Connector (Filled In)Create IDBS E-Workbook Connector (Filled In)

Create IDBS E-Workbook Connector (Filled In)

  1. Click the Login button to check the credentials; you will see a brief "Authentication successful" pop-up at the bottom of the page if successful.
  2. Click the Create button to create the connector. The connector you just created appears on the IDBS E-Workbook Source Management screen.

Add a Source to Specify E-Workbook Folders of Interest

Once you've created the connector, add at least one source to point to a specific folder in your E-Workbook. The source specifies the E-Workbook folder you want to get files from, as well as the labels, metadata, or tags that you want to apply to those files before they are placed in the Tetra Data Lake.

  1. In the Click the Add Source link to configure the specific folder in your E-Workbook that you would like to integrate.
Add Source LinkAdd Source Link

Add Source Link

Add a New IDBS SourceAdd a New IDBS Source

Add a New IDBS Source

  1. Enter the Entity ID of the IDBS project or folder that you would like to integrate.
  • You can find the entity ID in IDBS E-Workbook by navigating to that project or folder and looking at the URL in the address bar.
  • The entity ID is shown in the URL after entityID= and before the following &; it is normally a 32-character alphanumeric string.
Entity ID)Entity ID)

Entity ID)

  1. Once the entity ID is entered into the field, click the Validate button to ensure that the connector can access that entity. You will see a brief "Validation successful" pop-up at the bottom of the page if the connector can successfully access that entity.
Add a New IDBS Source (Entity ID Filled In)Add a New IDBS Source (Entity ID Filled In)

Add a New IDBS Source (Entity ID Filled In)

  1. Whether you need to enter anything in the Tables JSON field depends on the version of IDBS E-Workbook you are using.
  • If you are connecting to an IDBS E-Workbook version that is 10.5 or newer, leave the Tables JSON field blank and go to the next step.
  • If you are connecting to an IDBS E-Workbook version that is older than version 10.5, you will need to write a JSON string that contains the tables expected in each spreadsheet. This is because before version 10.5, the E-Workbook Spreadsheet API did not contain this information. The structure of the code should be like this:
{
  "Spreadsheet Name": [ "Table Name 1", "Table Name 2", "Table Name 3"],
  ...
}
Add a New Source (with Table JSON)Add a New Source (with Table JSON)

Add a New Source (with Table JSON)

  1. The date and time in the third field determines how far back in the past the connector listens for activities. The connector defaults to 30 days in the past, you can modify it by clicking on the field and choosing a different date or by typing another date.
  2. Click Next to continue.
  3. Enter a name for the source and an optional description, then click the Next button to continue.
  4. Specify labels, metadata fields, and tags that you want to apply to data loaded through the connector. For information on how to add labels, metadata fields, and tags see this topic.
  5. When complete, click Finish. The source appears in the IDBS E-Workbook Source Management screen.

Did this page help you?