Platform change log (Archive)

This change log represents changes before 2019-01-01 that may affect Relativity Developers, such as changes to APIs, deprecation of APIs, new APIs and other developer-focused changes. See the User Guide for version release notes.

You can use the following table to find changes for a specific Relativity version, API, or other value. To filter the data in the table, select a value from a drop-down in the column header (Release, Type, and Feature) or type in the Search field. To sort, click the column name.

Note: For changes since 2019-01-01, please refer to the Platform change log

Showing 1 to 25 of 425 entries
DateReleaseTypeFeatureChange
DateReleaseTypeFeatureChange
2018-09-26 9.7.229.5 Enhancement Services API The Export API now supports exporting document fields, including complete long text fields such as extracted text. The IObjectManager interface exposes three new methods to support the export workflow. The InitializeExportAsync() sets up an export job; the RetrieveNextResultsBlockFromExportAsync() method retrieves successive blocks of document fields; and the StreamLongTextAsync() method streams text when it exceeds a specific size limit. Additionally, the Relativity.Services.DataContracts.DTOs.Results namespace includes the ExportInitializationResults class used to provide information about data that is ready for export. For more information, see Export API in Object Manager (.NET).
2018-09-26 9.7.229.5 Enhancement REST API Through REST, the Export API now supports export functionality. It includes the following new endpoints for this functionality: initializeexportasync, retrievenextresultsblockfromexportasync, and streamlongtextasync. It uses the same export workflow as .NET. For more information, see Export API in Object Manager (REST).
2018-09-26 9.7.229.5 Enhancement Import API In the Import API, OnProcessProgess event now provides information about the throughput for transferring files and document metadata in bytes per second. This enhancement is the result of the new FilesThroughput and MetadataThroughput properties added to the FullStatus class, which represents status information provided to the OnProcessProgess event. This class is available in the kCura.Relativity.DataReaderClient namespace of the Import API. For more information, see Import API events.
2018-09-26 9.7.229.5 Enhancement Services API The Object Manager API now supports mass operations for creating, updating, and deleting Relativity Dynamic Objects (RDOs). It also supports mass operations for updating and deleting Document objects. In the Relativity.Services.Objects namespace, the IObjectManager interface exposes the new overloaded versions of the CreateAsync(), UpdateAsync(), and DeleteAsync() methods for these operations. Additionally, the Relativity.Services.Objects.DataContracts namespace includes several new classes for making mass operation requests and returning results. For more information, see Object Manager (.NET).
2018-09-26 9.7.229.5 Enhancement REST API Through the REST API, the Object Manager service supports mass operations with its existing endpoints for update and delete on Document objects and RDOs, and create on RDOs. It does require new JSON request formats for mass operations. For more information, see Object Manager (REST).
2018-06-30 9.6.202.10 Enhancement RelativityOne Sandbox

Sandbox is an add on feature that provides you a dedicated instance for testing customizations and applications in RelativityOne.

Sandbox provides the ability to further differentiate and customize your RelativityOne offering, enables you to test your customizations and applications without interrupting your production environment, and prepares your organization for the latest RelativityOne functionality and how it will impact custom applications and integrations

Administrators can grant access to Sandbox instances by simply adding users to a Sandbox group in your RelativityOne production instance. Sandbox environments are accessed through Federated Instance Manager (.NET) in the User dropdown.

2018-04-28 9.6.134.78 Breaking change Imaging API In the Imaging API, the StopImagingSetAsync() method has been deprecated for use through .NET. Similarly, the StopImagingSetAsync endpoint has been deprecated for use through REST. Upgrade your custom code to use the StopImagingJobAsync method or endpoint for compatibility with RelativityOne 9.6.110.36 and above, and Relativity Server9.6.134.78 and above. For more information, see Imaging (.NET).
2018-04-28 9.6.134.78 Enhancement Relativity Integration Points API Relativity Integration Points API now supports secured configurations for data source providers. The new DataSourceProviderConfiguration class includes properties for storing both general and secured configurations set by a user. The method signatures on the IDataSourceProvider interface have been updated to include a DataSourceProviderConfiguration object as a parameter rather than configuration JSON as used in previous releases. For compatibility with RelativityOne 9.6.110.36 and above, upgrade any custom source providers by referencing the new DLLs provided in the Relativity Integration Points SDK 9.6.33.7. For sample code, see Use secured configurations for sensitive information.
2018-04-28 9.6.134.78 Enhancement Services API New operators for text conditions have been added to enhance querying for objects, and creating views and saved searches. The TextConditionEnum enumeration includes the new IsLessThanOrEqualTo and IsGreaterThanOrEqualTo members. This enumeration is available in the Relativity.Services namespace. Additionally, the CriteriaConditionEnum enumeration includes the new StartsWith and EndsWith members. This enumeration is available in the Relativity.Services.Search namespace. For more information, see Class library reference.
2018-04-28 9.6.134.78 Enhancement API Helpers Relativity API helpers now provide the InstanceSettingsBundle interface for interacting with instance settings from agents, event handlers, and custom pages. The interface includes synchronous and asynchronous methods for refreshing cached instance settings and reading values of different data types. For more information, see Work with instance settings.
2018-04-28 9.6.134.78 Enhancement Data Grid Audit API We have updated the Data Grid Audit API to follow the query pattern of the underlying Object Manager API. You can now use the queryslim endpoint to return a condensed version of the payload to conserve network bandwidth. The request input parameters and response structure have also changed to follow the changes in the Object Manager API. For more information, see Legacy Audit API.
2018-04-28 9.6.134.78 Breaking change Data Grid Audit API The query/withdetails endpoint of the Data Grid Audit API has been deprecated.
2018-02-03 9.6.50.31 Enhancement Event Handlers The new List Page Interaction Event Handler API is a collection of JavaScript APIs, which are now exposed specifically for use with list pages. You can interact with list pages by implementing a ListPageInteractionEventHandler and writing separate JavaScript files that contain custom code. This custom code must use the new List Page Interaction Event Handler API developed specifically for this purpose. For more information, see List Page Interaction event handlers and List Page Interaction Event Handler API.
2018-02-03 9.6.50.31 Enhancement REST API The Object Manager service now makes POST method calls for all its endpoints. It also offers the QuerySlim endpoint, which streamlines querying by returning a smaller payload than the Query endpoint. All the URLs for the existing endpoints have been updated. Additionally, the format for the JSON requests now require request objects, and include various changes to the fields. For more information, see Object Manager (REST).
2018-02-03 9.6.50.31 Breaking change REST API In the Object Manager service, the URLs for each endpoint have been deprecated, and replaced with ones using a new format. The format for the JSON requests has also been modified, requiring a request object as well as other changes. For more information, see Object Manager (REST).
2018-02-03 9.6.50.31 Enhancement Services API The Object Manager API now includes the new Relativity.Services.Objects.DataContracts namespace, which contains the majority of classes and enumerations needed to interact with this service. The new Relativity.Services.Objects.Extensions namespace includes classes that contain methods used for working with hydrated objects, such as Choice, Field, Layout, and RelativityObject types. The new QuerySlimAsync() method streamlines querying by returning a smaller payload then the QueryAsync() method. Additionally, the methods on the IObjectManager interface now have updated signatures that require you to pass a request object for a specific operation. For more information, see Relativity Server 2023 Developer News and Object Manager (.NET).
2018-02-03 9.6.50.31 Breaking change Services API In the Object Manager API, the Relativity.Services.Objects.Models.WebContent namespace and all of its contents have been deprecated. Multiple classes in the Relativity.Services.Objects.Models and Relativity.Services.Field namespace have also been deprecated. In the Relativity.Services.Objects namespace, all existing method signatures have been deprecated and replaced with new ones that require a request object. For more information, see Object Manager (.NET).
2018-02-03 9.6.50.31 Enhancement Processing API The Processing API now includes the new Processing Profile Manager service that supports CRUD operations on processing profiles. The new IProcessingProfileManager interface exposes the SaveAsync(), ReadAsync(), and DeleteAsync() methods. It includes the new ProcessingProfile class, which has multiple properties for specifying numbering, deNISTing, extraction, and deduplication settings. Additional classes and enumerations have been added to support this functionality. For more information, see Get started with the Processing API and Processing API services for REST.
2018-01-06

9.5.411.4

 Enhancement Imaging API The Imaging API now includes the new ImageDocumentAsync() method, which is used to image a single document on the fly. It takes an instance of the new ImageDocumentJob class, which contains the properties for the workspace, document, and profile IDs. The Imaging API also includes the new StopImagingJobAsync() method, which is used cancel any type of imaging job, including imaging set jobs and jobs for imaging on the fly. The new StopImagingJobRequest and StopImagingJobResponse classes interact with the StopImagingJobAsync() method. The Imaging API services available through REST also support the new ImageDocumentAsync and StopImagingJobAsync endpoints. For more information, see Imaging (.NET) and Imaging API (REST).
2017-12-02

9.5.370.136

 Breaking change Structured Analytics API In the Structured Analytics API, the RunFullAsync() and the RunIncrementalAsync() methods have been deprecated. The RunAsync() method replaces these deprecated methods for running an analysis of a structured analytics set. In addition, the ExecutionOperation enumeration has been deprecated. The new StructuredAnalyticsTask enumeration now replaces it.
2017-12-02

9.5.370.136

 Enhancement Imaging API The new Imaging API supports programmatically executing imaging jobs in Relativity. It includes the imaging job service, which you can use to run, cancel, and retry imaging jobs. The Imaging API provides services for imaging profiles, imaging sets, and application field codes that support all CRUD operations. The imaging set service offers additional functionality used to hide and release images during a quality control review, while the native type service includes functionality for reading native file types supported by Relativity. It also exposes endpoints through REST that support the same functionality as available in .NET. For more information, see Imaging (.NET) and Imaging API (REST).
2017-12-02 9.5.370.136 Enhancement Structured Analytics API The Structured Analytics API now includes the new RunAsync() method used to execute an analysis; the RunAnalysisPreparationAsync() method used to generate fields before running an analysis; the GetValidTasksAsync() method used to retrieve valid operations for a structured analytics set; the RunCopyToLegacyAsync() method used to copy results to legacy document fields; and the CancelCopyToLegacyAsync() method used to cancel a copy operation. It includes the new AnalysisSettings class used to represent a configuration for running an analysis; the ValidTaskResult class used to represent valid operations for a structured analytics set; and the OperationState class used to provide information about an operation status. In addition, it includes the new StructuredAnalyticsTask enumeration, which contains members used to represent valid operations for a set. For more information, see Structured Analytics (.NET) and Structured Analytics Manager (REST).
2017-12-02 9.5.370.136 Enhancement Document Viewer Services API The new Document Viewer Services API includes functionality for converting documents to viewer types supported by Relativity, including native, image, production, and transcript types. It includes the GetViewerContentKeyAsync() method that provides this functionality. This method takes a GetViewerContentKeyRequest object that includes information about how to convert a document, such as its conversion type, priority, and other options. The Document Viewer Services API also exposes an endpoint through REST that supports this functionality. For more information, see Document Viewer Services (.NET).
2017-10-28 9.5.342.116 Breaking change Application Deployment System To improve system security, we have made changes to the way the Relativity HTML sanitizer component parses embedded HTML code in HTML-enabled and custom text fields and labels.
2017-10-28 9.5.342.116 Enhancement REST API The View Manager service now supports the functionality for associating a dashboard with a view. When you can create or update a view, you can optionally include a Dashboard object in the JSON request. For more information, see View Manager (REST).