Deprecated functionality
The following information describes functionality that has been deprecated in Relativity:
Relativity 10.3.287.3 - January 20, 2020
The following functionality is scheduled for deprecation or has been deprecated.
APIs scheduled for deprecation
The View Fields Manager API is scheduled for deprecation in the Relativity Indigo release coming in January 2020.
The View Fields Manager API will be removed from the Relativity assemblies. The related documentation will no longer be available in the RelativityOne and Relativity Server Developers sites for the Indigo and higher releases.
Note: Prior to the Indigo release, upgrade any existing custom applications calling this API to ensure they continue to function properly. Consider using similar functionality exposed through the Object Manager API. For more information, see Object Manager API and Object Manager service.
Import API
The following list includes deprecated features and functionality in the Import API:
- Import API SDK removed from Relativity SDK MSI - Beginning with the Relativity Goatsbeard release, the Import API is no longer part of the Relativity Services SDK published in the Community. The Import API SDK is available only as a NuGet package called Relativity.DataExchange.Client.SDK. For more information, Get started with the Import API or Import API migration.
- Deprecated the Relativity.Import.Client NuGet package - Beginning with the Relativity Goatsbeard release, the new NuGet package called Relativity.DataExchange.Client.SDK replaces this legacy Relativity.Import.Client NuGet package. For more information, Get started with the Import API or Import API migration.
Note: You must migrate to the Relativity.DataExchange.Client.SDK package to ensure that your custom applications continue to function properly. If you don't migrate your applications to the new package, they will fail.
- RelativityVersionMismatchException - This exception is now deprecated. In previous versions, it was thrown from the ImportAPI class constructor when the .NET assembly for the Import API didn’t match the Relativity version.
As of the Goatsbeard release, the new RelativityNotSupportedException replaces the RelativityVersionMismatchException. For more information, see Import API migration.
- Deprecated Import API dependencies on kCura.dll and Relativity.dll assemblies - Because the Import API is decoupled from Relativity core, it no longer has dependencies on the kCura.dll and Relativity.dll assemblies. If your Import API application uses objects from the kCura.dll or Relativity.dll assemblies, add a reference to the Relativity.Other package to continue using these components. For more information, see Import API migration.
- Deprecated kCura.OI.FileID assembly - This assembly is no longer supported for file type identification purposes. You must now use the File Identification API in the Relativity.DataExchange.Io API namespace.
Object Query Manager API
The Object Query Manager API is scheduled for deprecation in the Relativity Indigo release coming in January 2020.
Note: Prior to the Indigo release, upgrade any existing custom applications calling this API to ensure that they continue to function properly. Use the query functionality exposed through the Object Manager API. For more information, see Object Manager API and Object Manager service.
Migrating to the Object Manager API
You can easily migrate your existing code to the Object Manager API. The following list outlines the differences between the Object Manager and Query Object Manager APIs:
- With the Object Manager API, you can identify the object types and fields by Name, ArtifactID, and GUID. This functionality was unavailable in the Query Object Manager API.
- With the Object Manager API, you can now use ref object types, which offer several optional properties, rather than just string and integer values.
- The Object Manager API also offers different result formats, such as a QueryResultSet object or a QueryResultSlim object, which contains a smaller payload. See Query for Relativity objects.
Legacy code sample using the Object Query Manager API
The following legacy code queries for the top 25 decimal fields on the Document object type with the Object Query Manager API.
using(var objectQueryManager = Helper.GetServicesManager().CreateProxy<Services.ObjectQuery.IObjectQueryManager>()) { var query = new Services.ObjectQuery.Query() { Condition = "(('Object Type' == 'document') AND ('Field Type' == 'Decimal'))", Fields = new String[] { "Name" }, IncludeIdWindow = false, Sorts = new String[] { "Name ASC" }, }; var includePermissions = new int[] {}; var queryToken = String.Empty; var results = await objectQueryManager.QueryAsync(this.WorkspaceArtifactID, (int) kCura.Relativity.Client.ArtifactType.Field, query, 0, 25, includePermissions, queryToken); }
Updated code sample using the Object Manager API
The following updated code illustrates how to perform the same query as the legacy sample, but it uses the Object Manager API.
using(var objectManager = Helper.GetServicesManager().CreateProxy <Services.Objects.IObjectManager>()) { var nameField = new Services.Objects.DataContracts.FieldRef() { Name = "Name" }; var query = new Services.Objects.DataContracts.QueryRequest() { ObjectType = new Services.Objects.DataContracts.ObjectTypeRef() { ArtifactTypeID = (int) kCura.Relativity.Client.ArtifactType.Field }, Condition = "(('Object Type' == 'document') AND ('Field Type' == 'Decimal'))", Fields = new [] { nameField }, IncludeIDWindow = false, Sorts = new [] { new Services.Objects.DataContracts.Sort() { FieldIdentifier = nameField, Direction = Services.Objects.DataContracts.SortEnum.Ascending } } }; var results = await objectManager.QuerySlimAsync(this.WorkspaceArtifactID, query, 0, 25); }
For full information about deprecated functionality in the previous versions of Relativity, see the Platform change log and the documentation sites for the following versions.
- Deprecated functionality in Relativity 10.2
- Deprecated functionality in Relativity 10.1
- Deprecated functionality in Relativity 10.0
- Deprecated functionality in Relativity 9.7
- Deprecated functionality in Relativity 9.6
- Deprecated functionality in Relativity 9.5
- Deprecated functionality in Relativity 9.4
- Deprecated functionality in Relativity 9.3
- Deprecated functionality in Relativity 9.2
- Deprecated functionality in Relativity 9
- Deprecated functionality in Relativity 8.2
- Deprecated functionality in Relativity 8.1
- Deprecated functionality in Relativity 8.0
- Deprecated functionality in Relativity 7.5