Relativity Server 2022 Developer News

The API Explorer application will no longer be supported for RelativityOne nor Relativity Server as of May 20, 2024. All supporting documentation and access to the RAP file will be removed on that date, and no further changes will be made to the application after deprecation. See this post in the developer group for more information.

RSAPI will be removed from the Relativity Server 2023 release. See RSAPI deprecation process for more information, including the replacement schedule and replacement APIs.

Resource Files that are added to an application with Custom Pages since the last time the application was "Pushed to Library" will be deleted on the upgrade to Server 2022. To prevent the Resource Files from being deleted and to persist with this resource file when the application is exported, the application needs to be pushed to library from a workspace it is installed in.

The content in the Deprecated Functionality topic has moved to the Platform change log to make it easier for you to see all changes in a release or of a certain type in one place. You can use the Breaking change and Deprecated filter options in the Platform change log table to display only deprecated items and breaking changes.

To reduce the size of the Platform Change Log topic and make it easier to find relevant changes, entries prior to 1/1/2019 have moved to the Platform change log (Archive) topic.

• The new Analytics Classification Index .NET API and REST endpoints exposes CRUD operations for working with classification indexes used by the Active Learning application. It also supports submitting, canceling, and checking the statuses of index jobs. For more information, see Analytics Classification Index (.NET). and Batch Sets Manager (REST).
• The Analytics Conceptual Index API is now versioned. The namespace has been updated to include the business domain and version number, as exemplified by Analytics.Conceptual.V1.Services. The URLs used through REST also include these updates, as exemplified by conceptual-analytics/v1. For more information, see Analytics Conceptual Index (.NET) and Analytics Conceptual Index (REST).

The Audit APIs are now versioned. The namespaces have been updated to include the business domain and version number, as exemplified by Relativity.Audit.Services.Interfaces.V1. The URLs used through REST also include these updates, as exemplified by relativity-audit/v1. For more information, see Audit (.NET) and Audit (REST).

• The new Layout Manager .NET API and REST endpoints supports programmatically managing layouts in Relativity. It supports create, read, update, and delete operations on layouts. To simplify working with layouts, it also provides a helper method used to retrieve a list of users with permissions necessary to own layouts. For more information, see Layout Manager (.NET) and Layout Manager (REST).
• The Object Rule Manager API is now versioned. The namespace has been updated to include the business domain and version number, as exemplified by DataVisualization.v1.ObjectRules. The URLs used through REST also include these updates, as exemplified by relativity-data-visualization/v1. For more information, see Object Rule Manager (.NET) and Object Rule Manager (REST).
• The Tab Manager API is now versioned. The namespace has been updated to include the business domain and version number, as exemplified by DataVisualization.v1.Tab. The URLs used through REST also include these updates, as exemplified by relativity-data-visualization/v1. For more information, see Tab Manager (.NET) and Tab Manager (REST). Additionally, the Tab Manager API includes the following new methods on the ITabManager interface:
  • GetEligibleObjectTypesAsync() method - replaces the deprecated GetAvailableObjectTypesAsync() method.
  • GetEligibleParentTabsAsync() method - replaces the deprecated GetAvailableParentsAsync() method.
• The View Manager API is now versioned. The namespace has been updated to include the business domain and version number, as exemplified by Relativity.DataVisualization.V1.View. The URLs used through REST also include these updates, as exemplified by relativity-data-visualization/v1. For more information, see View Manager (.NET) and View Manager (REST)

The new Short Message Viewer Manager API supports programmatically interacting with messages displayed in the Short Message Viewer in the Relativity UI. It exposes methods for retrieving the JSON, attachments, and participant information for short messages. It also provides endpoints for validating the Relativity Short Message Format (RSMF). This versioned API exposes the methods on the IShortMessageViewerManager interface available in the Relativity.DocumentViewer.SDK. These endpoints are also supported through REST. For more information, see Short Message Viewer Manager (.NET) and Short Message Viewer Manager (REST).

• The Error Manager API is now versioned. The namespace has been updated to include the business domain and version number, as exemplified by Relativity.Environment.V1.Error. The URLs used through REST also include these updates, as exemplified by relativity-environment/v1. For more information, see Error Manager (.NET) and Error Manager (REST).
• The Instance Setting Manager API is now versioned. The namespace has been updated to include the business domain and version number, as exemplified by Relativity.Services.Environment.V1.InstanceSetting. The URLs used through REST also include these updates, as exemplified by relativity-environment/v1. For more information, see Instance Setting Manager (.NET) and Instance Setting Manager (REST). Additionally, the signatures for all methods on the IInstanceSettingManager interface no longer require a workspace ID set to -1 to indicate the admin-level context. The REST URLs include a similar update that makes the integer for the admin-level context part of the URL.
• The Matter Manager API is now versioned. The namespace has been updated to include the business domain and version number, as exemplified by Relativity.Environment.V1.Matter. The URLs used through REST also include these updates, as exemplified by relativity-environment/v1. For more information, see Matter Manager (.NET) and Matter Manager (REST).
• The Resource File API allows clients to manage resource files for the Relativity applications in the environment. It includes support to create, read, update, delete and download resource files, update/upload file content and metadata, and secondary methods that enable the client to read all eligible applications. For more information, see Resource File API.
• The Workspace Manager API is now versioned. The namespace has been updated to include the business domain and version number, as exemplified by Relativity.Environment.V1.Workspace. The URLs used through REST also include these updates, as exemplified by relativity-environment/v1. For more information, see Workspace Manager (.NET) and Workspace Manager (REST)

• The Mass Operations Manager API is now versioned. The namespace has been updated to include the business domain and version number, as exemplified by Relativity.Extensibility.V1.MassOperations. The URLs used through REST also include these updates, as exemplified by relativity-Extensibility/v1. For more information, see Mass Operation Manager (.NET) and Mass Operation Manager (REST).
• The Script Manager API is now versioned. The namespace has been updated to include the business domain and version number, as exemplified by Relativity.Extensibility.V1.Scripts. The URLs used through REST also include these updates, as exemplified by relativity-Extensibility/v1. Additionally, this API contains the following new methods that allow you to queue a script to run, retrieve status of a script, query action results, export action results, export script report, and clean up script results. For more information, see Script Manager (.NET) and Script Manager (REST)

The Identity APIs are now versioned. The namespace has been updated to include the business domain and version number, as exemplified by Relativity.Identity.V1.Services. The URLs used through REST also include these updates, as exemplified by relativity-identity/v1. These include the following APIs:

• Authentication Provider type API
• Client Manager API
• Federated Instance Manager API
• Group Manager API
• Login Profile Manager API
• OAuth2 Client Manager API
• Permissions API
• User Manager API

For more information, see Identity (authentication and user accounts).

The Infrastructure APIs are now versioned. The namespace has been updated to include the business domain and version number, as exemplified by Relativity.Infrastructure.V1. The URLs used through REST also include these updates, as exemplified by relativity-infrastructure/v1. These include the following APIs:

• Agent Manager API
• Notifications Manager API
• Resource Pool/Resource Server APIs

For more information, see Infrastructure.

The APIs within the ObjectModel.SDK are now versioned. The namespace has been updated to include the business domain and version number, as exemplified by Relativity.ObjectModel.V1. The URLs used through REST also include these updates, as exemplified by relativity-object-model/v1. For more information, see Object Model.

The Production API is now versioned. The namespaces have been updated to include the business domain and version number, as exemplified by Services.V1.IProductionManager. The URLs used through REST also include these updates, as exemplified by relativity-productions/v1. For more information, see Production.

Additionally, the Production API include multiple enhancements available through .NET and REST:

• Production Manager API – includes the following new methods described in Production Manager (.NET) and Production Manager (REST):
  • CancelReproductionJobAsync() method - cancels jobs for a re-production.
  • CreateSingleAsync() method - adds a new production set to a Relativity workspace.
  • DeleteSingleAsync() method - removes a production set from Relativity.
  • GetAllAsync() method - retrieves all productions in a workspace.
  • GetProducedProductionsFromDocumentsAsync() method - retrieves produced productions for documents by using document IDs or a mass operation token.
  • GetProductionImagesAsync() method - retrieves information about produced image files.
  • GetProductionImagesTokenAsync() method - retrieves a unique token for paging through images.
  • ProductionRunCheckAsync() method - retrieves document conflicts, production errors, and information about whether the production can be run.
  • ReadSingleAsync() method - retrieves a production set.
  • RerunProductionAsync() method - re-runs a production.
  • RunProductionAsync() method - runs a production job.
  • StageProductionAsync() method - stages a production.
• Production Data Source Manager API – includes the new GetProductionDataSourceDefaultFieldValues() method that retrieves default field values for a production data source. See Production Data Source Manager (.NET) and Production Data Source Manager (REST).
• Production Placeholder Manager API - includes the new GetProductionPlaceholderDefaultFieldValues() method that retrieves default field values for a production placeholder. See Production Placeholder Manager (.NET) and Production Placeholder Manager (REST).
• Production Queue Manager API – this new API exposes methods used to cancel a single or multiple production jobs, to retry multiple jobs, and to set the priority for them. See Production Queue Manager (.NET) and Production Queue Manager (REST).

• The new Batch Sets Manager API exposes CRUD operations for batch sets. It also supports creating and purging batches for a batch set. The Batch Sets Manager API exposes the methods for interacting with batches on the IBatchSetsManager interface in the Relativity.Review.Server.Versioned.<VersionNumber>.BatchSets namespace. For more information, see Batch Sets Manager (.NET). Additionally, the Batch Sets Manager service exposes endpoints through REST that provide the same functionality as available through .NET. For more information, see Batch Sets Manager (REST).
• The new Batches Manager API supports retrieving information about existing batches, and checking batches in and out. It exposes these methods for interacting with batches on the IBatchesManager interface in the Relativity.Review.Server.Versioned.<VersionNumber>.BatchSets namespace. For more information, see Batches Manager (.NET). Additionally, the Batches Manager service exposes endpoints through REST that provide the same functionality as available through .NET. For more information, see Batches Manager (REST).
• The Keyboard Shortcuts Manager API is now versioned. The namespace has been updated to include the business domain and version number, as exemplified by Relativity.Review.Server.Versioned.V1.KeyboardShortcuts. The URLs used through REST also include these updates, as exemplified by relativity-review/v1. For more information, see Keyboard Shortcuts Manager (.NET) and Keyboard Shortcuts Manager (REST). Additionally, this API now exposes only the ReadAsync() method for retrieving keyboard shortcuts. Through REST, it also now exposes a single endpoint for this purpose as well.

Relativity applications now has two groups of components. Hosted components, which are installed for the entire instance of Relativity and Workspace components, which are installed into workspaces.

For more information, see Advanced functionality for the application framework.

The Application Install API includes an update to the field Version, which has been renamed to SchemaVersion.

The Client Manager API is a newly exposed API that allows the create, read, update, and delete methods to be used on Client objects. The API supports querying groups, matters, or users related to a given client.

The custom pages now include a Readiness check URL. The Readiness Check URL will be called by the hosting system before any client traffic is routed to the new version of your custom page. This gives you the opportunity to perform final checks if your custom page is functional and setup as expected.

For more information, see Basic concepts for custom pages.

Changes were made to the EDDS and Workspace databases to accommodate new functionality in this release of Relativity. To see a list of those changes, see the Relativity 11.2 Database Schema Updates knowledge base article on the Relativity Community. Note that you need valid Community credentials to access this article.

The dtSearch Manager API includes an update to the CompressIndexAsync() method. The method contains a new boolean field, activateIndex, which determines if the index is activated after completion of the job.

For more information, see dtSearch Manager API. The dtSearch Manager service includes the same update to the CompressIndexAsync() endpoint. For more information, see dtSearch Manager Service.

Note: The existing CompressIndexAsync method/endpoint without the activateIndex field will still exist; it will simply call the new CompressIndexAsync() with the value of true for activateIndex.

The Group Manager API is a newly exposed API designed to create, read, updated, and delete groups within Relativity.

The Library Application API now includes the new following updates:

• GetApplicationHostingStatusAsync - This endpoint retrieves the hosting status of a specified application and indicates the status of the application's hosted components, such as custom pages.
• Updates to the ReadAsync() and ReadAllAsync() endpoints. These endpoints contain two new fields, IsGlobalApplication , which represents whether or not the application is a global application. Global applications are applications that cannot be installed into any workspaces. And SchemaVersion, which represents when the schema components were updated.

For more information, see Library Application API.

The Relativity Forms API introduces some advanced functionality for custom pages. For example, you can enhance custom pages with Windows authentication methods.

The Review API now supports the implementation of Hydro Custom Viewers within Relativity.

The Resource Pool API is a newly exposed API that supports the ability to create, read, update, and delete resource pools within Relativity. This API supports mass additions and mass removals of resources from resource pools, and provides helper methods to retrieve eligible resources.

The Resource Server API is a newly exposed API designed to interact with resource servers in Relativity. The type of interaction is based on the type of server. Some server types can be created and deleted and most of them can be read or edited to some degree. The API also exposes methods that allow to perform actions on a specific server type, like restart the windows service or clear the cache, usually accessible via console in the Relativity UI.

The Tab Manager API team has added a new endpoint to the existing version of the tab manager for the Lanceleaf release. The new endpoint, GetAllNavigationTabs(), retrieves a list of all tabs in a specified workspace that the calling user can navigate to.

The User Manager API is a newly exposed API that exposes multiple operations that you can use to programmatically manage users in your Relativity environment. The API supports create, read, update, and delete operations on users while providing helper methods used to retrieve the available user types.

The Workspace Manager API is a newly exposed API that allows for the creation, reading, updating, and deletion of workspaces. Major use cases for this API include the creation, modification, and retrieval of information about a given workspace.

With the schema version feature, applications can declare two versions in the application.xml file. The first is the existing <Version/> element which is the version of the entire application. Changes to the application version triggers updates to the hosted components. The second is the new <SchemaVersion/> element. It applies only to the schema components. The schema version allows application developers to control when schema components are updated. They can keep the same value to push through updates to hosted components without affecting workspaces resulting in better performance..

When a Custom Page is upgraded, the ADS system will launch a new process to handle the HTTP traffic. The Readiness Check URL will be called by the hosting system before any client traffic is routed to the new process. This gives the application an opportunity to "warm up" by exercising code paths. This technique significantly reduces the delay seen by end users when live traffic is finally routed to the new application process. The Readiness Check URL is defined in a field on the Custom Page RDO in Relativity. The URL should be a relative URL hosted by the custom page, e.g. ~/Relativity/CustomPages/{app_guid}/{route}.

The Auth Profile Manager API now supports specifying scopes for an OpenID Connect Provider. The OpenIdConnectProviders class has the new Scopes property, which is used to specify a list of scopes that a client can request. This class is available in the Relativity.Services.Security.Models namespace in the Relativity Services API.

Additionally, Auth Profile Manager service also supports specifying a list of scopes for an OpenID Connect Provider through REST.

The Object Manager APIs are now versioned. The namespace has been updated to include the business domain and version number, as exemplified by Relativity.ObjectManager.V1. The URLs used through REST also include these updates.

The Object Rule Manager API available through the Object Type Manager API now exposes the new MassDeleteAsync() method, which removes multiple object rules across different object types. Its parameters include the Artifact ID of a workspace and a list containing the Artifact ID for each rule that you want to delete. This method is available on the IObjectRuleManager interface in the Relativity.Services.Interfaces.ObjectRules namespace in the Relativity Services API.

Additionally, the Object Rule Manager service includes a new mass delete endpoint that supports removing multiple object rules in a single call.

The Processing API now includes the following new methods:

• GetSummaryDataAsync method - Retrieves processing set summary data in a specific workspace to display to console, such as environment errors, discover and publish status, and more.
• ValidDeleteAsync method - checks if the specified processing data source is safe to be deleted.

These methods are available on the IProcessingModule interface in the Relativity.Processing.Services namespace. The classes supporting this functionality are available in the Relativity.Processing.Services.Interfaces.DTOs namespace. For more information, see Processing API services for REST.

The Production API now includes the MassRetryAsync() method, which is available in the Relativity.Productions.Services namespace. Use this method to retry multiple production error or delete jobs in a single call. See Production Manager API.

Through REST, the Production Manager service also includes this new endpoint. See Production Manager Service.

The Relativity Integration Points API includes the following updates:

• JQuery version - It now uses jQuery v3.4.1 rather than the previous version 3.3.1 of this JavaScript library. The Relativity Integration Points SDK Server 2021 has been updated with this new jQuery library.
• Renamed namespaces - The namespaces for the Integration Points API have been renamed as follows:

  New namespace name	Deprecated namespace name
  Relativity.IntegrationPoints.Contracts	kCura.IntegrationPoints.Contracts
  Relativity.IntegrationPoints.Services.Interfaces.Private	kCura.IntegrationPoints.Services.Interfaces.Private
  Relativity.IntegrationPoints.SourceProviderInstaller	kCura.IntegrationPoints.SourceProviderInstaller

Note: For compatibility with Relativity ServerServer 2021 and above, update your custom code to use the new namespace names. Additionally, upgrade custom applications by referencing the new DLLs provided for this release. See Download the SDKs and NuGet packages.