Tetra Egnyte Connector

Egnyte is a service that offers secure file sharing. The Tetra Data Platform (TDP) has a built-in integration that allows users to pull raw data files from their secure Egnyte storage and into the Tetra Data Lake.

How Does the Egnyte Connector Work

TetraScience leverages Egnyte's API to constantly detect file change events in your Egnyte account and upload the files into our Data Lake and then trigger Data Pipelines.

Our Egnyte Connector currently tracks file creation events, including different versions of the same file. If you remove your file from Egnyte, the Tetra Data Lake will not mirror that and will not delete the files we collected.

Egnyte integration will track (listen) to three types of events in your Egnyte account:

  • File has been uploaded (create event)
  • File has been changed (update event)
  • File has been copied or moved from another Egnyte location (copy, move events)

For more information on Egnyte events, visit the Egnyte Events API Docs.

The integration will detect events in Egnyte every minute.

🚧

Current limitation

You can only have one Egnyte integration created by one Egnyte user in your organization. This is due to the rate limit of the Egnyte API and TetraScience is working on improvements to address this limitation.

How to Configure the Connector

πŸ“˜

NOTE:

For each environment, there should be one Egnyte application in Egnyte. One Egnyte application cannot be shared between different environments.

Set up your Egnyte account

First, create a dedicated API user for this integration. For production usage, the best practice is to create an API user (standard user) dedicated for this integration. Recommend you name it: [email protected].

After the user is created, share the Egnyte folder that you would like the integration to track with the API user with viewer permission.

πŸ“˜

Organize your Egnyte folder

It is always a good idea to leverage the folder structure to organize your data, the best practice is to include your study number, project name/id, instrument name/id and etc in the folder path. For example:

Shared/instruments-data/plate-reader-1
Shared/instruments-data/plate-reader-2

If you are organizing data from your CRO, you can consider something like the following:

Shared/study-1/CRO-A/assay-x
Shared/study-1/CRO-A/assay-y
Shared/study-1/CRO-A/assay-z

Create and configure an Egnyte Connector

  1. Sign in to the TDP.
  2. In the left navigation menu, choose Data Sources. Then, choose Egnyte.
  3. Select Add Your Egnyte Account.
  4. For Login to your Egnyte account, enter your Egnyte Domain.
  5. Choose Authorize.
  6. Follow the prompts. When authorization is complete, the Egnyte Account appears at the top of the Egnyte Source Management screen.

Adding an Egnyte Folder

After you've added the Egnyte account, you must add a folder by doing the following:

  1. On the Egnyte Source Management page, select the Add Source button.
  2. In the Add a new source screen, choose the folder to track. Then, choose Next.
  3. Enter a name and description for the Connector. Then, choose Next.
  4. Add attributes, if there are any.
  5. Choose Finish.

View Details about the Egnyte Resource/Folder

To view details about the Egnyte folder, do the following:

  1. To the right of the folder, you'll see a hamburger menu (three lines). Right-click the menu.
  2. Select View Details.
  3. Details about the resource, folder, and custom attributes appear in the View Details window.

Edit the Source

To edit the Egnyte source, do the following:

  1. To the right of the folder, you'll see a hamburger menu (three lines). Right-click the menu.
  2. Select Edit Source. The Edit Information page appears. You can edit the name and description, selected folder, or existing attributes. You can also delete existing attributes or add new attributes.

Disable the Source

To disable the Egnyte source, do the following:

  1. To the right of the folder, you'll see a hamburger menu (three lines). Right-click the menu.
  2. Select Disable.
  3. Choose OK to confirm disabling the source.
  4. The label Disabled appears to the right of the source.

Edit Egnyte Account login/authorization

To edit the Egnyte account login/authorization information, do the following:

  1. To the right of the folder, you'll see a hamburger menu (three lines). Right-click the menu.
  2. Select Edit Source.
  3. The Login page appears.

Disable the Egnyte Account

To disable the Egnyte account, do the following:

  1. To the right of the folder, you'll see a hamburger menu (three lines). Right-click the menu.
  2. Select Disable.
  3. Click OK to confirm disabling the account.
  4. The label Disabled appears to the right of the account.