Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
The Coda Enterprise Microsoft 365 Copilot connector allows your organization to index documents and pages from Coda. After you configure the connector, end users can search for this content from Coda in Microsoft Copilot and from any Microsoft Search client.
This article is for Microsoft 365 administrators or anyone who configures, runs, and monitors a Coda Enterprise Copilot connector.
Note
To access Copilot connectors that are in preview, enable the Targeted release option for your admin account.
Capabilities
- Index documents and emails from the Coda Enterprise instance while maintaining access control.
- Use content filters to selectively index content based on criteria such as a time range filter.
- Use Semantic search in Copilot to enable users to find relevant content.
Limitations
- Support the Enterprise edition, as this connector is exclusively compatible with the Coda Enterprise edition.
- Exclude Coda Free, Pro, and Team editions, as they are not supported due to Coda API restrictions on those editions.
- Documents exceeding 125 MB cannot be exported via the Coda API, regardless of the export format. For more information, see Overview: Documentation limits | Coda help center.
Prerequisites
- You must be the search admin for your organization's Microsoft 365 tenant.
- A Coda org administrator account to obtain the API Token to index content in your organization.
- Coda Enterprise supports API token authentication. The Coda API token can be obtained from the Account settings in the Coda org administrator.
Get started
1. Configure the display name
A display name is used to identify each reference in Copilot, helping users easily recognize the associated file or item. Display name also signifies trusted content.
2. Add the Coda Enterprise instance organization ID
The Coda Enterprise organization ID is required to set up the connection, which usually follows this format, org-AbCDeFGHIj, and can be found in the page URL of Coda admin settings page such as https://coda.io/organizations/org-AbCDeFGHIj/about
3. Provide authentication details
Coda API Key
To connect to the Coda Enterprise instance and allow the Coda Enterprise Copilot connector to index the Coda documents and pages regularly, you need to create a Coda Enterprise API token from the Coda Org Admin account.
Navigate to Account settings > API Settings of a Coda Org Admin account, and click Generate API Token to generate a new token. Use the default values.
| Field | Default value |
|---|---|
| Type of restriction | Doc or table. |
| Type of access | Read and write. |
| Doc or table to grant access to | not required, leave it empty. |
4. 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 more information about limited rollout, see Staged rollout for Copilot connectors. To create the connection for Coda, click create to publish your connection and index content from your Coda account.
For other settings, like Access permissions, Schema, and Crawl frequency, we have default values based on what works best with Coda data.
| Users | Description |
|---|---|
| Access permissions | Only people with access to content in Data source. |
| Map Identities | Data source identities mapped using Microsoft Entra IDs. |
| Content | Description |
|---|---|
| Select time range | Last 1 year |
| Manage Properties | 12 default properties and their schema. |
| Sync | Description |
|---|---|
| Incremental Crawl | Frequency: Every 15 mins |
| Full Crawl | Frequency: Every Day |
To edit any of these values, go to Custom setup.
Custom setup
Custom setup is for those admins who want to edit the default values for the settings listed in the previous table. Once you click Custom Setup, edit the values in Users, Data, and Crawl.
Users
Access permissions
The Coda Enterprise Copilot connector supports search permissions visible to Everyone or Only people with access to this data source. 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, indexed data appears in the search results for users who have access to it.
Mapping identities
The default method for mapping your data source identities with Microsoft Entra ID is by checking whether the email ID of Coda users is the same as the UserPrincipalName (UPN), or Mail of the users in Microsoft Entra. If you believe the default mapping wouldn't work for your organization, you can provide a custom mapping formula. To learn more about mapping Non-Microsoft Entra ID identities, see Map your non-Azure AD Identities.
To identify which option is suitable for your organization:
- Choose Microsoft Entra ID if the Email ID of Coda users is the same as the UserPrincipalName (UPN) or email of users in Microsoft Entra ID.
- Choose the Non-Microsoft Entra ID option if the Email ID of Coda users is different from the UserPrincipalName (UPN) and Email of users in Microsoft Entra ID.
Data
Content filter
Currently, Coda API limits are attached to a user/IP. To optimize the indexing performance, consider setting up multiple connections or utilizing a content filter to reduce the number of items indexed per connection.
Define a time range for the content to index. Only content with a last modified date and time within the specified range to index. Select an appropriate time range based on the volume of content to index.
Caution
Selecting "All time" may significantly impact your platform's performance if there is a large volume of content to index.
Manage properties
You can view the available properties from your Coda. 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. Properties that are selected by default are in the following list.
| Properties | Semantic label | Schema | Description |
|---|---|---|---|
| authors | Authors | Query, Retrieve, Search | List of contributors (for example, creator + editors) of the doc. |
| browserLink | url | Retrieve | Web link (URL) to open the document in Coda. |
| content | — | Search | The main content/body of the document (for search indexing). |
| createdAt | CreatedDateTime | Query, Retrieve | Timestamp when the document was created. |
| folderId | — | Query | Unique identifier for the folder. |
| folderName | ContainerName | Query, Retrieve, Search | Name of the container for the Coda document. |
| folderURL | ContainerUrl | Query, Retrieve, Search | URL of the container for the item. |
| id | Identifier | Query, Retrieve | Unique identifier of the Coda document (GUID/ID). |
| name | Title | Query, Retrieve, Search | Title of the Coda document. |
| owner | — | Query, Retrieve, Search | The owner of the document. |
| ownerName | CreatedBy | Query, Retrieve, Search | User who created the document (document owner). |
| updatedAt | LastModifiedDateTime | Query, Retrieve | Timestamp of the last modification to the document. |
| workspaceId | WorkspaceId | Query | Identifier of the workspace containing the doc (if needed). |
| workspaceName | — | Query, Retrieve, Search | The name of the workspace containing the document. |
Crawl
The refresh interval determines how often your data is synced between the data source and the Coda Enterprise Copilot connector index. There are two types of refresh intervals - full crawl and incremental crawl. For more details, see refresh settings.
You can change the default values of the refresh interval from here if you want to.
Tip
If you have a large amount of content in your Coda Enterprise instance that needs indexing with this connector, we highly recommend setting an appropriate crawl frequency to balance content freshness in Copilot with the performance of your Coda Enterprise instance.
Troubleshooting
After publishing your connection, you can review the status in the Connectors section of the admin center. For more information, see Manage your connector.
If you have issues or want to provide feedback, contact Microsoft Graph | Support.