Relativity Server 2023 Developer News

This developer documentation site has been significantly updated to better support Relativity developers. Some noteworthy improvements include:

• Re-organization of content into three main categories: Explore, Integrate and Extend to more closely align with how you may need to interact with our developer documentation.
• Added hyperlinks to headings within topics, allowing you to easily copy a hyperlink to a heading within a topic. Mouse-over any heading to display the link image and then click the link image to copy a hyperlink to that heading.
• Added a topic contents listing on the right-hand side of topics, allowing you to easily see the sections within a topic and quickly jump to the relevant section in that topic. See Basic REST API concepts as an example.
• Implemented a new approach for displaying reference documentation for .NET assembles, based on real-time retrieval from NuGet. See the topic Relativity Identity .NET API Reference as an example.
• Implemented a new approach for displaying reference documentation for REST services, based on OpenAPI (OAS) files. See the topic Audit REST API Reference as an example. You can also download OAS files for Rest services to use these in your own development tooling.
• Improved the API listing table to include links to reference documentation, NuGet packages and OAS files where available. The table is also now filterable and sortable.

Effective with the Relativity Server 2023 release, the NuGet packages required to extend core functionality and implement custom applications for Relativity Server are published and maintained separately from the SDKs hosted on the Relativity NuGet Gallery (nuget.org). The latest SDKs for Relativity Server will be hosted on a regional Relativity Server Artifactory Feed, while the Relativity NuGet Gallery will continue to host the RelativityOne packages. Separating the RelativityOne and Relativity Server packages provides for a more stable and reliable developer experience as each platform evolves.

The Relativity Server Artifactory Feed packages can be accessed from the following URLs:

• Use the URLs below to explore the available packages (these are effectively an equivalent to using nuget.org with a web browser to explore packages):
  • United States: https://relativitypackageseastus.jfrog.io/ui/native/server-nuget-remote/
  • Europe: https://relativitypackageswesteurope.jfrog.io/ui/native/server-nuget-remote/
• Use the URLs below when configuring a package manager (within Windows or Visual Studio, for example)
  • United States: https://relativitypackageseastus.jfrog.io/artifactory/api/nuget/v3/server-nuget-virtual
  • Europe: https://relativitypackageswesteurope.jfrog.io/artifactory/api/nuget/v3/server-nuget-virtual
  • To guarantee that the correct packages are consumed it is strongly recommended to use the provided nuget.config file to set up Visual Studio 2022 with the appropriate package source URL.

You are not required to recompile your custom application against the Relativity Server Artifactory Feed-hosted packages for your application to work on Relativity Server 2023. However, we do recommend recompiling to consume the Relativity Server Artifactory Feed packages if it is a viable option, to ensure that your application is running against the latest Relativity Server SDKs. Moving forward, Relativity Server SDK packages will only be updated and enhanced on the Relativity Server Artifactory Feed sites. Custom applications compiled against the packages hosted on the NuGet Gallery may continue to work on future Relativity Server releases, but we recommend adopting the new Server packages as soon as possible, and strongly advise against updating any Server applications to consume new or updated versions of packages from nuget.org moving forward.

To ensure long-term platform compatibility, Relativity will eventually require Relativity Server custom applications to be compiled against the Relativity Server Artifactory Feed packages. We will communicate a more detailed migration plan and enforcement policy at a later date, and we will provide ample notice before instituting a hard requirement to adopt the Relativity Server Artifactory Feed.

See the topic Supported RelativityOne SDKs for Server 2023 for a listing of supported/equivalent SDKs for Relativity Server 2023, comparing the available SDKs from the Relativity Server Artifactory repository and nuget.org.

RSAPI has been removed in the Relativity Server 2023 release. See RSAPI deprecation process for more information, including the replacement APIs.

Classic Viewer has been removed in the Relativity Server 2023 release. Viewer extensions that only work with the Classic Viewer will no longer be functional. If you have not already done so, you will need to migrate your classic viewer extension code to the Review APIs. See Viewer Extension Migration Guide for more details.