If you’re new to Unstructured, read this note first.Before you can create a source connector, you must first sign in to your Unstructured account:
- If you do not already have an Unstructured account, sign up for free. After you sign up, you are automatically signed in to your new Unstructured Starter account, at https://platform.unstructured.io. To sign up for a Team or Enterprise account instead, contact Unstructured Sales, or learn more.
- If you already have an Unstructured Starter or Team account and are not already signed in, sign in to your account at https://platform.unstructured.io. For an Enterprise account, see your Unstructured account administrator for instructions, or email Unstructured Support at support@unstructured.io.
-
After you sign in to your Unstructured Starter account, click API Keys on the sidebar.
For a Team or Enterprise account, before you click API Keys, make sure you have selected the organizational workspace you want to create an API key for. Each API key works with one and only one organizational workspace. Learn more. -
Click Generate API Key.
-
Follow the on-screen instructions to finish generating the key.
-
Click the Copy icon next to your new key to add the key to your system’s clipboard. If you lose this key, simply return and click the Copy icon again.
For MongoDB Atlas, SCRAM-SHA-1 is not supported for authentication. This means that cluster types that only
include SCRAM-SHA-1, such as Free, M0, Flex, and Serverless, are not supported.
Unstructured only supports SCRAM-SHA-256 for MongoDB Atlas, which is cryptographically stronger than SCRAM-SHA-1.If you try to test or use a connector that refers to a cluster type that only includes SCRAM-SHA-1, the
operation will fail, and you will get an error message similar to the following:
[digital envelope routines] unsupported
.- A MongoDB Atlas account. Create an account.
- A MongoDB Atlas cluster. Create a cluster. Be sure to not select a cluster type that only includes SCRAM-SHA-1, such as Free, M0, Flex, or Serverless.
- The cluster must be reachable from your application environment, for example by adding IP addresses to your IP access list. Learn more.
-
The cluster must be configured to allow IP address. Learn how.
To get Unstructured’s IP address ranges, go to
https://assets.p6m.u10d.net/publicitems/ip-prefixes.json
and allow all of the
ip_prefix
fields’ values that are listed.These IP address ranges are subject to change. You can always find the latest ones in the preceding file. - The cluster must have at least one database. Create a database.
- The database must have at least one user, and that user must have sufficient access to the database. Create a database user. Give the user database access.
-
The database must have at least one collection. Create a collection.
For the destination connector, Unstructured recommends that all documents in the target collection have a field named
record_id
with aString
data type. Unstructured can use this field to do intelligent document overwrites. Without this field, duplicate documents might be written to the collection or, in some cases, the operation could fail altogether. -
The connection string for the cluster. For MongoDB Atlas, this connection string must include the protocol, username, password, host, and cluster name. For example:
To get the connection string in MongoDB Atlas, do the following:
- Log in to your MongoDB Atlas console.
- In the sidebar, under Databases, click Clusters.
- Click on the cluster you want to connect to.
- Click Connect.
- Click Drivers.
- Under Add your connection string into your application code, copy the connection string. You can then close the Connect dialog in MongoDB Atlas. Before you use this connection string, be sure to fill in any placeholders in the string, such as your MongoDB Atlas database user’s password value.
<name>
(required) - A unique name for this connector.<database>
(required) - The name of the database on the target MongoDB instance.<collection>
(required) - The name of the collection within the database.<uri>
(required) - The instance connection string.