Skip to content
Snippets Groups Projects
README.md 3.2 KiB
Newer Older
# Sequence® Connector for Relativity®
The Sequence Connector for Relativity® allows users to automate ediscovery
antonyoni's avatar
antonyoni committed
and forensic workflows that use [Relativity](https://www.relativity.com/).
antonyoni's avatar
antonyoni committed

This connector has [Steps](https://sequence.sh/steps/Relativity) to:
antonyoni's avatar
antonyoni committed

antonyoni's avatar
antonyoni committed
- Create new matters and workspaces
- Ingest data from CSV/Concordance or as entities
- Search and tag items
- Export Data as entities
antonyoni's avatar
antonyoni committed

antonyoni's avatar
antonyoni committed
## Connector Settings
Mark Wainwright's avatar
Mark Wainwright committed

The Sequence Connector for Relativity® requires additional configuration
antonyoni's avatar
antonyoni committed
which can be provided using the `settings` key in `connectors.json`.
Mark Wainwright's avatar
Mark Wainwright committed

### Supported Settings

| Name               | Required |   Type   | Description                                                                             |
| :----------------- | :------: | :------: | :-------------------------------------------------------------------------------------- |
| RelativityUsername |    ✔     | `string` | The Username to use for authentication                                                  |
| RelativityPassword |    ✔     | `string` | The Password to use for authentication                                                  |
| Url                |    ✔     | `string` | The URL of the Relativity Server                                                        |
| DesktopClientPath  |          | `string` | The Path to the Relativity Desktop client. Required for the `RelativityImport` step.    |
| APIVersionNumber   |          |  `int`   | The version of the API to use. Defaults to `1`. You probably don't need to change this. |
Mark Wainwright's avatar
Mark Wainwright committed

antonyoni's avatar
antonyoni committed
### Example `connectors.json` Entry
Mark Wainwright's avatar
Mark Wainwright committed

```json
"Sequence.Connectors.Relativity": {
  "id": "Sequence.Connectors.Relativity",
Mark Wainwright's avatar
Mark Wainwright committed
  "enable": true,
  "version": "0.16.0",
Mark Wainwright's avatar
Mark Wainwright committed
  "settings": {
    "RelativityUsername": "YourUsername",
    "RelativityPassword": "YourPassword",
    "Url": "http://relativitydevvm/",
    "DesktopClientPath": "C:\\Program Files\\kCura Corporation\\Relativity Desktop Client\\Relativity.Desktop.Client.exe",
  }
}
```
antonyoni's avatar
antonyoni committed

https://sequence.sh

# Download

https://sequence.sh/download

# Try SCL and Core

https://sequence.sh/playground
To successfully run integration tests, a copy of the [EntityImportClient](https://gitlab.com/sequence/connectors/entityimportclient)
needs to be in the `Sequence.EntityImportClient` directory in the solution root.
- [Release](https://gitlab.com/sequence/connectors/entityimportclient/-/releases)
- [Main branch build](https://gitlab.com/sequence/connectors/entityimportclient/-/jobs/artifacts/main/download?job=package+exe+dev)

The EntityImportClient is automatically downloaded and included in the connector
package when building using the CI.

# Package Releases
Can be downloaded from the [Releases page](https://gitlab.com/sequence/connectors/relativity/-/releases).
# NuGet Packages

Release nuget packages are available from [nuget.org](https://www.nuget.org/profiles/Sequence).

antonyoni's avatar
antonyoni committed
## Licensing
This product is licensed under the Apache License, Version 2.0.
For further details please see http://www.apache.org/licenses/LICENSE-2.0.
This product may only be used by parties with valid licenses for Relativity®, a product of Relativity ODA LLC.
Relativity ODA LLC does not test, evaluate, endorse or certify this product.