The Tetra Egnyte Connector pulls raw data from your secure Egnyte storage and automatically uploads it to the Tetra Data Lake every minute.

Design Overview

The Connector uses Egnyte's API to constantly detect file change events in your Egnyte account and upload the files into the Tetra Data Platform (TDP). You can then set up [Tetra Data Pipelines](https://developers.tetrascience.com/docs/pipeline_overview) to run automated data operations and transformations on the uploaded data, and then enrich and push that data to downstream systems.

What's Tracked

The Tetra Egnyte Connector tracks file creation events, including different versions of the same file. If you remove your file from Egnyte, the associated files uploaded to the Data Lake will not be deleted unless you manually delete the files from the TDP.

The Connector tracks (listens) 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.

⚠️

Current Limitation

You can only have one Egnyte integration created by one Egnyte user in your TDP organization. This is because of the rate limit imposed by the Egnyte API.

Prerequisites

Before you configure the Tetra Egnyte Connector, you must complete the following prerequisites:

1. Contact your customer account leader to to make sure that an Egnyte application key is configured as an AWS Systems Manager (SSM) parameter in your account.
2. Configure Egnyte folder permissions to share the Egnyte folder(s) that you want to track with the API user (viewer permission).
3. Organize your Egnyte folders to include your study number, project name/id, and instrument name/id in the folder path (for example, Shared/instruments-data/plate-reader-1). If you're organizing data from your CRO, consider using the following folder path structure: Shared/study-1/CRO-A/assay-x

📘

NOTE

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

Create an Egnyte Connector

To create a Tetra Egnyte Connector, do the following:

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.

Add 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, choose Add Source. The Add new source screen appears.
2. 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 Folder

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

1. To the right of the folder, right-click the menu icon.
2. Select View Details.
3. Details about the folder and custom attributes appear in the View Details window.

Edit the Source Folder

To edit the Egnyte source, do the following:

1. To the right of the folder, right-click the menu icon.
2. Select Edit Source.The Edit Information page appears.
3. Edit the name and description, selected folder, or existing attributes. You can also delete existing attributes or add new attributes.

Disable the Source Folder

To disable the Egnyte source folder, do the following:

1. To the right of the folder, right-click the menu icon.
2. Select Disable.
3. Choose OK to confirm disabling the source. 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, right-click the menu icon.
2. Select Edit Source. The Login page appears.
3. Edit the login authorization information as needed.

Disable the Egnyte Account

To disable the Egnyte account, do the following:

1. To the right of the folder, right-click the menu icon.
2. Select Disable.
3. Click OK to confirm that you want to disable the account. The label Disabled appears to the right of the account.