Edit

Share via


Egnyte Microsoft 365 Copilot connector

The Egnyte Microsoft 365 Copilot connector allows your organization to index files from Egnyte. After you configure the connector, users can search for these files from Egnyte in Microsoft 365 Copilot and from any Microsoft Search client.

This article is for Microsoft 365 administrators or anyone who configures, runs, and monitors an Egnyte Copilot connector.

Capabilities

  • Access files in Copilot by using the power of Semantic search.
  • Customize your crawl frequency.
  • Create workflows by using this connection and actions from Microsoft Copilot Studio.

Limitations

  • Doesn't index comments and replies.

Prerequisites

  1. Get an Egnyte admin role in the domain of your organization.

    Screenshot of how to check user role.

  2. Apply for a developer account using an admin email.
    The Egnyte Copilot connector requires client ID and secret generated by Egnyte developer account. You can use an existing developer account or follow the following steps to register a new account:

    1. Go to Egnyte for developers in the Egnyte developer portal and enter all required fields.

      Screenshot of how to register a developer account.

    2. Email: Use the admin email you own in your Egnyte workspace

      Screenshot of the filed email in developer account reqisteration page.

    3. Company website: {your domain name}.egnyte.com

      Screenshot of the company website.

    4. Registered OAuth Redirect URI:

      • For Microsoft 365 Enterprise:
        https://gcs.office.com/v1.0/admin/oauth/callback

      • For Microsoft 365 Government:
        https://gcsgcc.office.com/v1.0/admin/oauth/callback

    5. Select Register after entering all the required fields

    6. You'll receive a confirmation email within 24 hrs. If you can't find the message in your inbox, check your spam folder or click "resend" to check the confirmation email.

      Screenshot of the confirmation email.

  3. Obtain the client ID and secret from the developer account.
    Go to Egnyte for developers, sign in to the developer account you created in step 2. Record the key and secret for the Copilot connector setup.

    Screenshot of the client id and secret

  4. Request a rate increase from Egynte. Your new Egnyte Copilot connector connects your Egnyte system with the Microsoft Graph. It's important to review the thresholds Egnyte imposes on data access and synchronization, with more information available here. Please determine your existing rate limit (by signing into your Egnyte developer account) and contact Egnyte support to procure increases if necessary.

Get started

1. Choose a display name

Choose a display name that helps users easily recognize associated files or items in a Copilot response.

2. Add the instance URL

http://<your company domain>.egnyte.com

3. Provide authentication type

Enter the client ID and client secret you obtained from your developer account

4. Roll out to a limited audience

Deploy this connection to a limited user base to validate it in Copilot and other search surfaces before you roll it out to a broader audience.

5. Roll out to limited audience

Deploy this connection to a limited user base if you want to validate it in Copilot and other search surfaces before expanding the rollout to a broader audience.

For other settings, like Access Permissions, Data inclusion rules, Schema, Crawl frequency, etc., we set defaults based on what works best with data in Egnyte. The default values settings are as follows.

Page Settings Default values
Users Access Permissions All files that are accessible to anyone in Egnyte are visible to all Microsoft 365 users in your tenant, from Microsoft Search or Copilot.
Content Index Content All published posts and pages are selected by default.
Content Manage Properties To check default properties and their schema.
Sync Incremental Crawl Frequency: Every 4 hours
Sync Full crawl Frequency: Every day.

Custom setup

In custom setup you can edit any of the default values for users, content, and sync.

Users

Access permissions

The Egnyte Copilot connector supports data visible to Only people with access to this data source (recommended) or Everyone. If you choose Everyone, indexed data appears in the search results for all users.

If you choose Only people with access to this data source, you need to further choose whether your users are Microsoft Entra ID provisioned users or non-AAD users. To identify which option is suitable for your organization:

  1. Choose the Microsoft Entra ID option if the email ID of Egnyte users is the same as the UserPrincipalName (UPN) of users in Microsoft Entra ID.

  2. Choose the non-AAD option if the email ID of Egnyte users is different from the UserPrincipalName (UPN) of users in Microsoft Entra ID.

Important

  • If you choose Microsoft Entra ID as the type of identity source, the connector maps the email IDs of users obtained from Egnyte directly to UPN property from Microsoft Entra ID.
  • If you chose "non-AAD" for the identity type, see Map your non-Azure AD Identities for instructions on mapping the identities. You can use this option to provide the mapping regular expression from email ID to UPN.
  • Updates to users or groups governing access permissions are synced in full crawls only. Incremental crawls do not currently support the processing of updates to permissions.

Content

Manage properties

To add or remove available properties from your Egnyte data source, assign a schema to the property (define whether a property is searchable, queryable, retrievable, or refinable), change the semantic label, and add an alias to the property. Some properties are selected by default.

Default property Label Description Schema
checksum Checksum value of the current version of the file used to determine file changes.
size Size of the file in bytes of the version Query.
path Full path of the file Query, Retrieve, Search.
name fileName Name of the file Query, Retrieve, Search.
locked Status of the lock on the file Query, Retrieve, Search.
entry_id Unique id of the current version of the file.
group_id The id to reference the file as a whole.
parent_id The id of the parent folder requested.
last_modified lastModifiedDateTime Last modified time of the current version of a file. "last_modified" time for the file), the upload time will be used. If not passed during upload (for example, when willing to preserve the original "last_modified" time for the file), the upload time will be used. Query, Retrieve, Search.
uploaded_by createdBy Username of the user that uploaded the version Query, Retrieve, Search
uploaded Uploaded time of the current version of the file. It might be different from the "last_modified" time when the "last_modified" time is passed during upload. Query, Retrieve.
num_versions The total number of versions associated with the specific file path.
url  url  Query, Retrieve.
content Query.
File extension fileExtension Query, Retrieve, Search.

Sync

You can configure full and incremental crawls based on the scheduling options present here. By default, incremental crawl is set for every 4 hours, and full crawl is set for every day. If needed, you can adjust these schedules to fit your data refresh needs.

Next steps

After you publish your connection, you can review the status under Data sources in the admin center. To learn how to make updates and deletions, see Manage your connector.

If you have issues or want to provide feedback, see Microsoft Graph support.