RelativityOne Developer News

The following enhancements are available in the RelativityOne 11.2.214.8 - September 10, 2020.

Application framework

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.

Application Install API

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

Client Manager API

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.

Custom pages

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.

Database schema updates

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.

dtSearch Manager API

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.

Group Manager API

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

Library Application API

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.

Relativity Forms API

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

Review API

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

Resource Pool API

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.

Resource Server API

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.

Tab Manager API

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.

User Manager API

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.

Workspace Manager API

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.

The following enhancements are available in the RelativityOne 11.1.152.1 - March 28, 2020.

Auth Profile Manager API

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.

Object Manager API

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.

Object Type Manager API - Object Rule Manager API enhancements

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.

Processing API

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.

Production API

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.

Relativity Integration Points API

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 11.1.152.1 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 RelativityOne 11.1.152.1 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.

The following enhancements are available in the RelativityOne 10.3.170.1 - September 28, 2019.

Application Install API

The Application Install API allows clients to install applications into one or more workspaces, cancel pending installations, as well as get the status of any specified application installations. Additionally, this API allows support for conflict resolution for any failed application installations. For more information, see Application Install API.

Document File Manager API

The new Document File Manager API exposes methods for downloading native, image, and produced image files associated with documents in Relativity. You can download a file by specifying its GUID, or you can download a native file by specifying the Artifact ID of the document associated with it. The Document File Manager API also supports retrieving information about these files, such as GUID, name, type, size, and others.

These methods are available on the IDocumentFileManager interface in the Relativity.Services.Interfaces.Document namespace. The class and enumerations supporting this functionality are available in the Relativity.Services.Interfaces.Document.Models namespace. For more information, see Document File Manager (.NET).

Additionally, the Document File Manager service exposes endpoints through REST that provide the same functionality as available through .NET. For more information, see Document File Manager (REST).

Document Viewer Services API

The Document Viewer Services API now allows you to view information about the persistent highlight sets and terms in a specific document and workspace. The GetPersistentHighlightSets endpoint also supports this functionality through REST. For more information, see Document Viewer Services API and Document Viewer Services in REST.

Field Manager API

The Field Manager API now has the new Source property on the FieldResponse class. This property references a FieldSource object, which contains information about mapping the current field to a processing field. The FieldResponse class is available in the Relativity.Services.Interfaces.Field.Models namespace. For more information, see Field Manager (.NET) .

In REST, the Field Manager service also now includes the Source field on the JSON response returned by the read endpoint. For more information, see Field Manager (REST).

Note: For compatibility with RelativityOne 10.3.170.1 and above, upgrade any existing custom code and implement any new applications by referencing the new DLLs provided for this release. See Download the SDKs and NuGet packages.

Import API

The Import API includes the following enhancements:

• NuGet package for SDK - Beginning with the RelativityOne Goatsbeard release, the Import API is available only as a NuGet package called Relativity.DataExchange.Client.SDK. The Import API will no longer be part of the Relativity Services SDK published in the Community, but you can easily add the NuGet package to your project through Visual Studio.

  The delivery of the Import API as a NuGet package offers the advantages of simplifying deployment by handling dependencies. The NuGet package also handles Import API versioning and deployment requirements, as well as updates.

  Note: The Relativity.Import.Client NuGet package has now been deprecated. Any existing Import API applications must now be migrated to the new Relativity.DataExchange.Client.SDK NuGet package. If you don't migrate your applications to this package, they will fail.

• New versioning scheme - The new versioning scheme coupled with the release of the Import API as a NuGet package provide the following enhancements:
  • The package and assembly versions follow Semantic Versioning 2.0.0. They aren’t coupled to the Relativity build number as in previous releases.
  • They are decoupled from the Relativity core build, which eliminates common assembly version conflicts and the need to reference the kCura.dll and Relativity.dll .NET assemblies.
  • They minimize compatibility issues with Relativity. All NuGet packages are tested against prior releases of Relativity and Import API samples on GitHub.
• New RelativityNotSupportedException - This new exception is thrown when the API isn't compatible with the import or export API services provided by Relativity. It replaces the RelativityVersionMismatchException, which was thrown from the ImportAPI class constructor when the .NET assembly for the Import API didn’t match the Relativity version.
• No dependencies on kCura and Relativity .NET assemblies - The Import API is now decoupled from Relativity core, so it no longer has dependencies on these .NET assemblies. If your Import API application uses objects from the kCura.dll or Relativity.dll .NET assemblies, add a reference to the Relativity.Other package to continue using these components.
• File Identification API - In the Relativity.DataExchange.Client.SDK, this new File Identification API handles the identification of all file types. This API is available in the Relativity.DataExchange.Io API namespace.

  Note: You must now use the File Identification API because the kCura.OI.FileID assembly is no longer supported.

For more information, Get started with the Import API or Import API migration.

Library Application API

The Library Application API allows clients to read application metadata and RAP files from the library, upload new applications, and update or delete existing applications. For more information, see Library Application API.

Matter Manager API

The Matter Manager service exposes multiple endpoints that you can use to programmatically manage matters in your Relativity environment. It includes the following features:

• Supports create, read, update, and delete operations on matters.
• Provides helper endpoints used to retrieve available clients and statuses. Use these endpoints to determine the available clients and statuses with which to create or update matters.

For more information, see Matter Manager API.

Object Manager API - Export API update

The Export API available through the Object Manager API now includes the new RetrieveResultsBlockFromExportAsync() method, which retrieves a specific block of document fields from an in-progress export job. The document fields are specified by calling this method with the index ID for a block of records in a batch, the number of records to export, the workspace ID, and the in-progress export ID. This method is available on the IObjectManager interface in the Relativity.Services.Objects namespace. For more information, see Object Manager (.NET).

The Export service also supports this same functionality with a new endpoint available through REST. For more information, see Object Manager (REST).

Processing API

The Processing API now includes the following new method:

• PivotOnDiscoveredDocumentsAsync method - Retrieves filtered discovered documents on pivot in a specific workspace.

This method is available on the new IProcessingFilterManager 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 Filter Manager.

Additionally, the new methods are available through REST and provide the same functionality as available through .NET. For more information, see Processing Filter Manager (REST).

Note: The Processing Filters Manager API is a preview release, which will continue to undergo contract changes in future releases.

Tab Manager API

The Tab Manager API now includes several modified fields.

• The TabRequest class modified fields include:
  • ObjectType (formerly ObjectArtifactTypeID) - the field type changed from Securable<RelativityObjectRef> to ObjectTypeIdentifier. The field is no longer securable.
  • Parent (formerly ParentID) - the field type changed from Securable<RelativityObjectRef> to Securable<ObjectIdentifier>.
• The TabResponse class modified fields include:
  • CreatedBy - the field type changed from NameIDPair to DisplayableObjectIdentifier.
  • LastModifiedBy - the field type changed from NameIDPair to DisplayableObjectIdentifier.
  • ObjectType - the field type changed from Securable<NameIDPair> to ObjectTypeIdentifier. The field is no longer securable.
  • Parent - the field type changed from Securable<RelativityObjectRef> to Securable<ObjectIdentifier>.

The Tab Manager API also includes new fields on the Parent and ObjectType sub-objects of the Tab object.

• The new fields on the Parent sub-object include:
  • ArtifactID - the Artifact ID of the parent tab.
  • Guids - the GUIDs of the parent tab.
• The new fields on the ObjectType sub-object include:
  • ArtifactTypeID - The ID of the Artifact Type of the object.
  • ArtifactID - the Artifact ID of the object type.
  • Guids - the GUIDs of the object type.
  • Name - the name of the object type.

For C# code samples and additional information, see Tab Manager API.

Through REST, the Tab Manager service also includes the modified and new fields. For additional information, see Tab Manager service.

View Manager API

The View Manager API now includes the following new methods:

• The RetrieveAllViewsAsync() method allows you to see each view in a workspace for a specific Artifact ID. The new RetrieveAllViewsAsync() method is available on the IViewManager interface. For more information, see View Manager API.

Additionally, the View Manager API service exposes endpoints through REST that provide the same functionality as available through .NET. For more information, see View Manager service.

• The RetrieveAllViewsForSearchAsync() method to see each view that is associated with a saved search in a workspace. The new RetrieveAllViewsForSearchAsync() method is available on the IViewManager interface. For more information, see View Manager API.

Additionally, the View Manager API service exposes endpoints through REST that provide the same functionality as available through .NET. For more information, see View Manager service.

The following enhancements are available in the RelativityOne 10.2.170.2 - June 29, 2019.

Audit APIs

The new Audit APIs include methods that programmatically revert, retrieve, and search Relativity audit records stored in Elasticsearch. These services support interactions with both instance-level and workspace-level audit records. For more information, see Audit (.NET).

The following APIs provide methods for this functionality:

• Audit Metrics API - includes a method for retrieving information about the number and size of the audits in a specific workspace.
• Audit Revert API - includes methods for reverting document update actions. It provides endpoints for reverting a single action or list of actions, and for validating whether the revert operation can be performed on an action.
• Audit Pivot API - includes methods for running pivot queries on audit data. It supports querying with group by and pivot on operations for object type, action, username, and timestamp fields.
• Reviewer Statistics API - includes methods for retrieving information about reviewer actions, such as the number of action performed by a reviewer on a document, the usage time per review, a summary report of reviewer actions, and others.
• Audit Query API - includes a method for querying on a specific audit record.
• Audit Object Manager UI API - includes methods for querying on audit details to display in the Relativity UI, including filtering on the returned data.

Additionally, the new Audit services expose endpoints that support this same functionality through REST. For more information, see Audit (REST).

Note: The Legacy Audit API is being deprecated in a future release. When implementing custom functionality, use the new Audit APIs and the services that they expose through REST.

Document Viewer Services API

In the Document Viewer Services API, the GetViewerContentKeyOptions class now includes a new property called ClientId. This property represents a string value that indicates the client ID of the application caller, such as DocumentViewer.Conversion.PreConvert.

Through REST, the Document Viewer Services supports the same functionality. For more information, see Document Viewer Services (REST).

Note: For compatibility with RelativityOne 10.2.170.2 and above, upgrade any existing custom code and implement any new applications by setting the new ClientId property. In addition, you must update any calls made through REST with the new ClientId field.

Field Manager API

The new Field Manager API includes multiple operations for programmatically working with field types supported by Relativity, including multiple choice, fixed length text, date, and other fields. It exposes methods for create, read, update, and delete operations on fields. It also provides helper methods for retrieving available object types, views, keyboard shortcuts, and other information about properties that can be set on fields. These methods are available on the IFieldManager Interface in the Relativity.Services.Interfaces.Field namespace. The classes and enumerations supporting this functionality are available in the Relativity.Services.Interfaces.Field.Models namespace. For more information, see Field Manager (.NET).

Additionally, the Field Manager service exposes endpoints through REST that provide the same functionality as available through .NET. For more information, see Field Manager (REST).

Imaging API

The Imaging API now supports programmatically updating the priority of an imaging job. The new UpdateJobPriorityAsync() method is available on the IImagingJobManager interface. The Imaging API also includes the new UpdateJobPriorityRequest and UpdateJobPriorityResponse classes used by the update method. This method and classes are available in the Relativity.Imaging.Services.Interfaces namespace. For more information, see Imaging (.NET).

Note: Beginning with the RelativityOne Foxglove release, the DLL for the Imaging API is available as a NuGet package called Relativity.Imaging.SDK. The Imaging SDK will no longer be published in the Community, but you can easily add the NuGet package to your project through Visual Studio. For more information, see Quickstart: Install and use a package in Visual Studio on the Microsoft website.

Additionally, the new UpdateJobPriorityAsync endpoint provides this same functionality through REST. For more information, see Imaging API (REST).

Instance Setting Manager API

The new Instance Setting Manager API supports create, read, update, and delete operations on instances setting in a Relativity environment. The methods for these operations are available on the IInstanceSettingManager interface in the Relativity.Services.Interfaces.InstanceSetting namespace. The response and request classes, and the enumeration supporting this functionality are available in the Relativity.Services.Interfaces.InstanceSetting.Model namespace. For more information, see Instance Setting Manager (.NET).

Additionally, the Instance Setting Manager service exposes endpoints through REST that provide the same functionality as available through .NET. For more information, see Instance Setting Manager (REST).

MoTD API

The Message of the Day API now includes the following enhancements and general updates:

• DismissMOTDAsync method – Dismisses the Message of the Day for a user so that the same message is not shown until the message is changed.
• HasDismissedMOTDAsync method – Checks if the Message of the Day has been previously dismissed for a user.
• IsTextOnlyMOTDAsync method – Checks if the Message of the Day can display HTML or only text.

Object Manager API

The Object Manager API now includes the new UpdateLongTextFromStreamAsync() method for updating a single long text field that exceeds the length limits of an HTTP request. An instance of the new UpdateLongTextFromStreamRequest class is passed to this method as a parameter. The new method is available in the Relativity.Services.Object namespace, and the new class is available in the Relativity.Services.Objects.DataContracts namespace. For more information, see Object Manager (.NET).

Additionally, the new updatelongtextfromstream endpoint provides this same functionality through REST. For more information, see Object Manager (REST).

Processing API

The Processing API now includes the following new methods:

• GetDocumentMetadataAsync method - Retrieves all metadata fields and values for a specific document.
• GetDiscoveredDocumentsAsync method - Retrieves discovered documents in a specific workspace.

These methods are available on the new IProcessingFilterManager 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 Filter Manager.

Additionally, the new methods are available through REST and provide the same functionality as available through .NET. For more information, see Processing Filter Manager (REST).

Note: The Processing Filters Manager API is a preview release, which will continue to undergo contract changes in future releases.

Production API

The Production API now supports canceling multiple production jobs with a single method call. It also includes updates to the method for canceling a single production job. The following list highlights these updates:

• Updates to the Production API methods - These methods are available on the IProductionManager interface in the Relativity.Productions.Services namespace:
  • New MassCancelAsync() method - mass cancels productions jobs. This method takes a list of ProductionJobRef objects as a parameter.
  • Updated CancelJobAsync() method - the signature for this method has been updated to take a ProductionJobRef object instead of the artifact IDs of a workspace and a production. The method name remains the same.

    Note: In the RelativityOne Foxglove release, the legacy CancelJobAsync() method will be deprecated. Use the updated CancelJobAsync(ProductionJobRef jobRef) method in the current release for any new applications. Upgrade any existing applications before the RelativityOne Foxglove release.

• New classes in the Production API - These classes are available in the Relativity.Productions.Services.Interfaces.DTOs namespace:
  • ProductionJobRef class - represents a production. Its properties include the artifact IDs for the production and the workspace where its exists.
  • CancelJobResult - provides information about a canceled production job, including the IDs for the job, production, and workspace, and other details.
  • MassCancelResult - provides information about the mass cancellation of production jobs, including the number of jobs in the cancel request, the number of jobs successfully canceled, and other details.

For C# codes sample and additional information, see Production Manager (.NET) under the Services API.

Through REST, the Production Manager service also includes the new MassCancelAsync endpoint for canceling multiple production jobs. The CancelJobAsync endpoint now uses an updated format for the JSON request. For more information, see Production Manager (REST).

Note: In the RelativityOne Foxglove release, the legacy JSON request format for the CancelJobAsync endpoint will be deprecated. Use the updated JSON request format for any new applications, and upgrade any existing applications before the RelativityOne Foxglove release.

Relativity Forms API

Relativity Forms API updates now provide more flexibility around Yes/No field behavior and sorting behavior on drop down lists. For more information, see Relativity Forms API.

Relativity Integration Points

The SourceProvider class is now in the kCura.IntegrationPoints.Contracts namespace in the kCura.IntegrationPoints.Contracts.dll. Previously, this class was in the kCura.IntegrationPoints.SourceProviderInstaller namespace. Other updates include the addition of a new assembly called kCura.IntegrationPoints.Services.Interfaces.Private.dll, and the removal of unnecessary DLLs from the SDK. For more information, see Relativity Integration Points.

Note: For compatibility with RelativityOne early access release and above, use the new Relativity Integration Points SDK 10.2.23.7. Upload the new DLLs and rebuild your solution to make your source provider compatible with this release. See Download the SDKs and NuGet packages.

RelativityOne SDK installer

The 64-bit SDK installers have been updated for the RelativityOne 10.1.169.1 - March 30, 2019 release. To obtain an SDK installer, see Download the SDKs.

Note: Contact Client Services if you need an older version of an SDK.

REST API

• File Field Manager service - The REST API provides coverage for the new File Field Manager service. This service has endpoints for uploading and downloading files linked to file fields. For more information, see File Field Manager (REST).
• User Information Manager service - The REST API provides coverage for the new User Information Manager service. This service has the retrieveall endpoint that returns the Artifact ID, full name, and email address for each user in a workspace or admin-level context. It also includes the retrieveusersby endpoint, which supports both filtering on the results, and paging.

Review API

The new Review API is a suite of APIs that you can use to build and maintain Review integrations. Review is an updated Relativity document review application that you can use to review, annotate, and code documents in a workspace. It offers performance and extensibility improvements over the current HTML viewer. The Review API supports the extensibility of Review by providing JavaScript classes and functions. For more information, see Review API.

Services API

• File Field Manager API - This new API exposes a service for uploading and downloading files linked to file fields in Relativity. For uploads, the overloaded UploadAsync() method supports the use of progress indicators and cancellation tokens. The interface for this service is available in the Relativity.Services.FileField namespace. For more information, see File Field Manager (.NET).
• User Information Manager API - This new API provides methods for retrieving all users from a workspace or admin-level context. The RetrieveAll() method returns a list of UserInfo objects, which contain the Artifact ID, full name, and email address for each user. The RetrieveUsersBy() methods filters on a list of users with conditions set in a query, and it also supports paging. The interfaces and classes for this services are available in the Relativity.Services.Interfaces.UserInfo and Relativity.Services.Interfaces.UserInfo.Models namespaces. For more information, see User Information Manager API.

Relativity Forms API

The Relativity Forms API now includes the following enhancements and general updates:

• The Relativity Forms API now supports the ability to override the data source for fields with picker display types.
• The Relativity Forms API now supports the ability to override the data source the file field type.
• Relativity Forms API now supports the ability to specify that yes/no fields are strictly boolean (the field will not have an “unset” possibility, and instead defaults to false). This can be accomplished by setting the field’s RemoveNoValueChoice property to true in the Layout JSON for the yes/no field.
• Relativity Forms API now supports the ability to specify whether options in a non-yes/no fields with a dropdown display type are sorted. This can be set on the field’s SortOptions property.

For more information, see Relativity Forms API.

View Fields Manager API

The new View Fields Manager API allows you to view the relation between the Artifact IDs of View Fields objects and the Artifact IDs of a production. The new RetrieveViewFieldIDsFromProductionAsync() method is available on the IViewFieldManager interface. For more information, see Field Manager (.NET).

Additionally, the View Fields Manager service exposes endpoints through REST that provide the same functionality as available through .NET. For more information, see Field Manager (REST).

The following enhancements are available in the RelativityOne 10.1.169.1 - March 30, 2019.

Agent Manager API

The Agent Manager API now includes the following enhancements and general updates:

• CreateAsync() method - A new overloaded version of this method now supports adding multiple agents to Relativity in a single call. The signature for the overloaded method now includes an additional integer parameter, which specifies the number of agents to add.
• AgentInstanceLimitResult class - The type for AgentServer and ResourcePool properties on this class has been updated to Securable< DisplayableObjectIdentifier>. In the previous releases, these properties had the type Securable<ObjectIdentifier>.
• AgentResponse class - This class now inherits from the DisplayableObjectIdentifier class. In addition, the type for the AgentServer, AgentType, CreatedBy, and LastModifiedBy properties has been updated to Securable<DisplayableObjectIdentifier>. In the previous releases, the AgentResponse class inherited from the ObjectIdentifier class, and the properties had the type Securable<ObjectIdentifier>.
• AgentTypeResponse class - This class now inherits from the DisplayableObjectIdentifier class.

These methods and classes are available in the Relativity.Services.Interfaces.Agent and Relativity.Services.Interfaces.Agent.Models namespaces respectively. For more information, see Agent Manager (.NET).

Additionally, the Agent Manager service also supports the ability to add multiple agents to Relativity in a single call through REST. For more information, see Agent Manager (REST).

Note: For compatibility with RelativityOne 10.1.169.1 and above, upgrade any existing custom code and implement any new applications by referencing the new DLLs provided for this release. See Download the SDKs and NuGet packages.

Keyboard Shortcuts Manager API

The new Keyboard Shortcuts Manager API includes the overloaded GetKeyboardShortcuts() method, which retrieves all keyboard shortcuts available in a workspace, or a specific subset of them, such as those assigned to the system, choices, or fields. This method is available on the IKeyboardShortcutsManager interface in the Relativity.Services.KeyboardShortcuts namespace. The Relativity.Services.KeyboardShortcuts.Models namespace contains the KeyboardShortcutsRequest and other classes used to support this method. For more information, see Keyboard Shortcuts Manager (.NET).

Additionally, the Keyboard Shortcuts Manager service exposes the GetKeyboardShortcuts endpoint that supports this same functionality through REST. For more information, see Keyword Search Manager (REST) for saved searches.

List Page Interaction Event Handler API

In the List Page Interaction Event Handler API, the New Item Button API now includes the new buttonApi.getButtons(). This method returns an array of button objects. For more information, see List Page Interaction Event Handler API.

Object Type Manager API

The new Object Type Manager API exposes methods for programmatically working with custom object types implemented in your applications. It supports create, read, update, and delete operations on object types. To simplify creating and deleting object types, it provides helper methods for retrieving parent object types and dependent objects. These methods are available on the new IObjectTypeManager interface in the Relativity.Services.Interfaces.ObjectType namespace. The classes supporting this functionality are available in the Relativity.Services.Interfaces.ObjectType.Models namespace of the Services API.

The following APIs provide functionality for working with event handlers, object rules, and mass operations for object types:

• Event Handler Manager API - includes methods for attaching event handlers to and removing them from object types. It contains helper methods used for retrieving event handlers available in a workspace, and for retrieving event handlers currently attached to an object type. These methods are available on the new IEventHandlerManager interface in the Relativity.Services.Interfaces.EventHandler namespace. The classes supporting this functionality are available in the Relativity.Services.Interfaces.EventHandler.Models namespace of the Services API.
• Object Rule Manager API - includes methods for creating, updating, reading, or deleting object rules on an object type. It also provides helper methods for retrieving associative objects, layouts, choices, and choice fields used when creating an object rule. These methods are available on the new IObjectRuleManager interface in the Relativity.Services.Interfaces.ObjectRules namespace. The classes supporting this functionality are available in the Relativity.Services.Interfaces.ObjectRules.Models namespace of the Services API.
• Mass Operation Manager API - includes methods for creating, updating, reading, or deleting mass operations on an object type. It also provides helper methods for retrieving available object types, event handlers, and layouts for use with mass operations. These methods are available on the new IMassOperationManager interface in the Relativity.Services.Interfaces.MassOperation namespace. The classes supporting this functionality are available in the Relativity.Services.Interfaces.MassOperation.Models namespace of the Services API.

Additionally, the Object Type Manager, Event Handler Manager, and Object Rule Manager services expose endpoints through REST that provide the same functionality as available through .NET.

Processing API

The Processing API now includes a new feature called the Processing Filter Manager API. It exposes methods for programmatically creating, updating, and deleting processing filters. It supports applying these filters to data and retrieving the filtered data. Additionally, this service exposes helper methods for retrieving filters associated with a data source or available in a specific workspace.

These methods are available on the new IProcessingFilterManager 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 Filter Manager.

Additionally, the Processing Filter Manager service exposes endpoints through REST that provide the same functionality as available through .NET. For more information, see Processing Filter Manager (REST).

Note: The Processing Filters Manager API is a preview release, which will continue to undergo contract changes in future releases.

Production API

The Production API now supports canceling multiple production jobs with a single method call. It also includes updates to the method for canceling a single production job. The following list highlights these updates:

• Updates to the Production API methods - These methods are available on the IProductionManager interface in the Relativity.Productions.Services namespace:
  • New MassCancelAsync() method - mass cancels productions jobs. This method takes a list of ProductionJobRef objects as a parameter.
  • Updated CancelJobAsync() method - the signature for this method has been updated to take a ProductionJobRef object instead of the artifact IDs of a workspace and a production. The method name remains the same.

    Note: In the RelativityOne Foxglove release, the legacy CancelJobAsync() method will be deprecated. Use the updated CancelJobAsync(ProductionJobRef jobRef) method in the current release for any new applications. Upgrade any existing applications before the RelativityOne Foxglove release.

• New classes in the Production API - These classes are available in the Relativity.Productions.Services.Interfaces.DTOs namespace:
  • ProductionJobRef class - represents a production. Its properties include the artifact IDs for the production and the workspace where its exists.
  • CancelJobResult - provides information about a canceled production job, including the IDs for the job, production, and workspace, and other details.
  • MassCancelResult - provides information about the mass cancellation of production jobs, including the number of jobs in the cancel request, the number of jobs successfully canceled, and other details.

For C# codes sample and additional information, see Production Manager (.NET) under the Services API.

Through REST, the Production Manager service also includes the new MassCancelAsync endpoint for canceling multiple production jobs. The CancelJobAsync endpoint now uses an updated format for the JSON request. For more information, see Production Manager (REST).

Note: In the RelativityOne Foxglove release, the legacy JSON request format for the CancelJobAsync endpoint will be deprecated. Use the updated JSON request format for any new applications, and upgrade any existing applications before the RelativityOne Foxglove release.

Relativity Forms API

Relativity Forms is a new Layout-rendering option and the API documentation has been updated and published so that developers can leverage the robust Javascript APIs and enable more controlled Relativity Object customization. For more information, see Relativity Forms API.

RelativityOne SDK installer

The 64-bit SDK installers have been updated for the RelativityOne 10.1.169.1 - March 30, 2019 release. To obtain an SDK installer, see Download the SDKs.

Note: Contact Client Services if you need an older version of an SDK.

REST API

• File Field Manager service - The REST API provides coverage for the new File Field Manager service. This service has endpoints for uploading and downloading files linked to file fields. For more information, see File Field Manager (REST).
• User Information Manager service - The REST API provides coverage for the new User Information Manager service. This service has the retrieveall endpoint that returns the Artifact ID, full name, and email address for each user in a workspace or admin-level context. It also includes the retrieveusersby endpoint, which supports both filtering on the results, and paging.

Services API

• File Field Manager API - This new API exposes a service for uploading and downloading files linked to file fields in Relativity. For uploads, the overloaded UploadAsync() method supports the use of progress indicators and cancellation tokens. The interface for this service is available in the Relativity.Services.FileField namespace. For more information, see File Field Manager (.NET).
• User Information Manager API - This new API provides methods for retrieving all users from a workspace or admin-level context. The RetrieveAll() method returns a list of UserInfo objects, which contain the Artifact ID, full name, and email address for each user. The RetrieveUsersBy() methods filters on a list of users with conditions set in a query, and it also supports paging. The interfaces and classes for this services are available in the Relativity.Services.Interfaces.UserInfo and Relativity.Services.Interfaces.UserInfo.Models namespaces.

The following enhancements are available in the RelativityOne 10.0.161.8 - January 5, 2019.

Agent Manager API

The new Agent Manager API exposes multiple operations for programmatically managing agents in your Relativity environment. It supports create, read, update, and delete operations on agents. To simplify your workflows, it provides helper methods for retrieving agent types and agent servers. The Agent Manager API also includes validation methods used to check whether a create, update, or delete operation violates the maximum or minimum number of required agents for a Relativity environment, server, or resource pool. These methods are available on the new IAgentManager interface in the Relativity.Services.Interfaces.Agent namespace. The classes supporting this functionality are available in the Relativity.Services.Interfaces.Agent.Models namespace of the Services API. For more information, see Agent Manager (.NET).

Additionally, the Agent Manager service exposes endpoints through REST that provide the same functionality as available through .NET. For more information, see Agent Manager (REST).

Document Viewer Service API

The Document Viewer Services API now supports converting files contained in File fields on a Relativity Dynamic Objects (RDOs) for display in the standalone viewer. These files are converted to their native format on the fly. The following list highlights updates to this API:

• GetViewerContentKeyOptions class - includes the new FileId property, which provides the identifier for the RDO with an associated File field. An object of this type is on the request object that you pass to the GetViewerContentKeyAsync() method, which submits a conversion request.
• GetViewerContentKeyRequest class - includes an update to the DocumentIds property. When it is used for converting files contained in File fields, this property contains only the FieldArtifactId. You pass an object of this type to the GetViewerContentKeyAsync() method.

The Document Viewer Services API is available in the Relativity.DocumentViewer.Services namespace. The GetViewerContentKeyAsync endpoint also supports this new functionality through REST. For more information, see Document Viewer Services (.NET) and Document Viewer Services (REST).

Object Manager API

Review the following sections to learn more about enhancements for mass operations and export functionality now available in the Object Manager API.

Retrieve object dependencies

The Object Manager API now supports the ability to retrieve a list of objects dependent on one or more specific objects selected for deletion. You can use this new functionality to determine whether a delete operation may be blocked by object dependencies, or how other Relativity objects may be affected by deleting a specific object. This functionality is similar to the dependency report available in the Relativity UI.

The following list highlights enhancements for this feature in .NET:

• GetDependencyListAsync() method - retrieves a list of dependent objects based on a request object containing references to objects selected for deletion. This method is available on the IObjectManager interface in the Relativity.Services.Objects namespace.
• DependencyListByObjectIdentifiersRequest class - represents a request for information about dependent objects for a list of RelativityObjectRefs, which are specified in its Object property. This class is available in the Relativity.Services.Objects.DataContracts namespace.
• Dependency class - represents an object dependent on a specific object selected for deletion. Its properties indicate the relationship between the objects, the action to be taken on the dependent object, and other information. This class is available in the Relativity.Services.Interfaces.Shared namespace.

Through the REST API, the Object Manager service also exposes the dependencylist endpoint, which supports the functionality for retrieving a list of dependent objects. For more information and code samples, see Object Manager (.NET) and Object Manager (REST).

File field support

The Object Manager API now supports setting and updating values in file fields. This functionality is also available through REST. For more information, see Object Manager (.NET) and Object Manager (REST).

Updated ReadOptions class

In the Object Manager API, the ReadOptions class now has a new property called FieldTypesToReturnAsString, which returns a list of currency or decimal field types as a string. This functionality is also available through REST. For more information, see Object Manager (.NET) and Object Manager (REST).

Processing API

In the Processing API, the Entity constant in the CustodianType enumeration has been renamed to Other. The value and description of Other remains unchanged. It continues to have a value of 2, and to represent a corporation, data location, or other construct. The CustodianType enumeration is available in the Relativity.Processing.Services namespace of the Processing API reference. For general information, see Get started with the Processing API.

Note: You must upgrade any existing code that references the Entity constant. Instead, reference the Other constant in any .NET or JSON used in your custom applications.

Structured Analytics API

The Structured Analytics API supports the new name normalization feature now available in Relativity. This feature simplifies identifying the senders and recipients of email messages, which frequently have multiple aliases assigned to them. It identifies the aliases within email headers, such as a proper name, email address, and other items. It then assigns these aliases to entities that are imported into Relativity and linked to document fields. For more information, see Name normalization on the RelativityOne Documentation site.

To support the name normalization feature, the Structured Analytics API includes the following enhancements:

• NameNormalizationStatistics class - This new class provides information about the number of aliases in the headers for a group of email messages. Its contains the AliasesIdentified property that retrieves a count of all aliases in the group, and the NewAliasesImported property that retrieves the number of new aliases added to Relativity.
• JobResults class - This class now has the new NameNormalizationStatistics property, which references a NameNormalizationStatistics object to provide easy access to information about the number of aliases identified.
• JobPhase enumeration - This enumeration has the new ImportingEntityAndAliases enum, which indicates that the alias and entity results from the Analytics engine are being imported to a workspace database.
• JobOperation enumeration - This enumeration has the new NameNormalizationId enum, which indicates that a name normalization job is the type of Analytics job currently executing.

These classes and enumerations are available in the Relativity.StructuredAnalytics.Services.Interfaces.StructuredAnalytics.Models.Status namespace. For more information, see Structured Analytics Job Manager (.NET).

Additionally, the Structured Analytics Manager service also supports the new name normalization feature through REST. For more information, see Structured Analytics Job Manager (REST).

Note: For compatibility with RelativityOne 10.0.161.8 and above, upgrade any existing custom code and implement any new applications by referencing the new DLLs provided for this release. See Download the SDKs and NuGet packages.

Tab Manager API

The new Tab Manager API supports programmatically managing tabs in Relativity. It supports create, read, update, and delete operations on tabs. To simplify working with tabs, it also provides helper methods for retrieving information about the display order of tabs, parent tabs, available object types to associated with tabs, and objects dependent on a specific tab. Additionally, it also supports retrieving workspace-level metadata for admin and system tabs.

The Tab Manager API exposes the methods for interacting with tabs on the ITabManager Interface available in the Relativity.Services.Interfaces.Tab namespace. The classes and enumeration supporting this functionality are available in the Relativity.Services.Interfaces.Tab.Models namespace. For more information, see Tab Manager (.NET).

Additionally, the Tab Manager service exposes endpoints through REST that provide the same functionality as available through .NET. For more information, see Tab Manager (REST).

RelativityOne SDK installer

The 64-bit SDK installers have been updated for the RelativityOne 10.0.161.8 - January 5, 2019 release. To obtain an SDK installer, see Download the SDKs.

Note: Contact Client Services if you need an older version of an SDK.

The following enhancements are available in the RelativityOne 9.7.99.15 - September 26, 2018 .

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.

Object Manager API

Review the following sections to learn more about enhancements for mass operations and export functionality now available in the Object Manager API.

Mass operations

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. For the objects undergoing mass update and delete operations, you have the options to set search conditions, or to specify the identifiers to select objects. The mass update operation provides an additional option for specifying a list of common fields for updating on a group of objects. The objects undergoing a mass operation must all be of the same type.

The following list highlights these enhancements in .NET:

• New methods on the IObjectManager interface - This interface exposes the new overloaded versions of the CreateAsync(), UpdateAsync(), and DeleteAsync() methods for mass operations. These methods take a mass operation request object that provides information about how the operation should be executed. They also support progress reporting, and cancellation requests. The IObjectManager interface is available in the Relativity.Services.Objects namespace of the Relativity Services API.
• New classes to support mass operations - The Object Manager API includes several new classes for making mass operation requests and returning results, such as the MassCreateRequest, MassCreateResult, MassUpdateByCriteriaRequest, and other classes. These classes are available in the Relativity.Services.Objects.DataContracts namespace of the Relativity Services 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. The options for progress reporting, and cancellation requests aren't available through REST. For more information and code samples, see Object Manager (.NET) and Object Manager (REST).

Note: For compatibility with RelativityOne 9.7.99.15, upgrade any existing custom code and implement any new applications by referencing the new DLLs provided for this release.

Export API

You can now export document fields, including complete long text fields such as extracted text. The export process uses a three-step workflow involving setting up an export job and retrieving successive blocks of document fields. When the amount of text in a field exceeds a specific size limit, you can use streaming to retrieve this data. Additionally, the retrieval methods for export jobs can be run in parallel to achieve high throughput.

The following list highlights export enhancements in .NET:

• New methods for export jobs - 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. The IObjectManager interface is available in the Relativity.Services.Objects namespace of the Relativity Services API.
• New ExportInitializationResults class - This class represents the results of an initialization operation and provides information about data that is ready for export. The InitializeExportAsync() method returns an object of this type. The class is available in the Relativity.Services.DataContracts.DTOs.Results namespace of the Relativity Services API.

The Object Manager service also supports the new export functionality through REST. It includes the following new endpoints for this functionality: initializeexportasync, retrievenextresultsblockfromexportasync, and streamlongtextasync. It uses the same export workflow as .NET. For more information and code samples, see Object Manager (.NET) and Object Manager (REST).

Relativity Integration Points

In RelativityOne Bluestem 9.7.137.2, Relativity Integration Points now uses jQuery 3.3.1 rather than the previous version of this JavaScript library. The Relativity Integration Points SDK 9.7.32.3 has been updated with this new jQuery library. To download the new SDK, see Download the SDKs and NuGet packages.

Note: You don't need to upgrade your current providers due to this enhancement. Legacy providers are compatible with this update to the JavaScript library.

RelativityOne SDK installer

The 64-bit SDK installers have been updated for the RelativityOne 9.7.99.15 - September 26, 2018 release. To obtain an SDK installer, see Download the SDKs.

Note: Contact Client Services if you need an older version of an SDK.

For full information about changes in the previous versions of Relativity, see the Platform change log and the documentation sites for the following versions.

Relativity 9.7

• What's new for developers in Relativity 9.7
• Deprecated functionality in Relativity 9.7

Relativity 9.6

• What's new for developers in Relativity 9.6
• Deprecated functionality in Relativity 9.6

Relativity 9.5

• What's new for developers in Relativity 9.5
• Deprecated functionality in Relativity 9.5