Kepler framework

The Relativity Kepler framework provides you with the ability to build custom REST EndPoints via a .NET interface. You build a Kepler service using standard .NET contracts, which the Kepler framework uses to build HTTP endpoints. Your Kepler service is then deployed in Relativity as part of a custom application built on the Application Deployment System (ADS). Additionally, the Kepler framework includes a client proxy that you can use when interacting with the services through .NET.

Kepler services offer these advantages:

  • Easily hosts endpoints for your application.
  • A lightweight framework as compared to packaging DLLs used by custom pages and Web API endpoints.
  • Ability to create web and C# endpoints simultaneously.
  • Endpoints are automatically protected by Relativity authentication.

This page contains the following information:

Basic concepts and implementation workflow for a Kepler service

Use the information in this section to become familiar with the basic concepts and implementation workflow for a Kepler service. The outline of this workflow includes both the server-side implementation of a service, and the client-side interactions with it. See the following sections:

For code samples, see Kepler service structure and components.

Server-side implementation of Kepler service

The implementation of a Kepler service includes defining the service contract, implementing the required functionality, and organizing the service by module. The following sections provide a high-level description of each step in this workflow:

Client-side interactions with a Kepler service

You can interact with a Kepler service by making calls through a .NET client or by submitting HTTP calls similar to those used for other RESTful services. The following sections outline how to make calls to your service:

NuGet package for the Kepler framework

You can add the assemblies for the Kepler framework as a NuGet package to your Visual Studio projects. For more information about the Kepler API SDKs, see Download the SDKs and NuGet packages.

For installation information, see Quickstart: Install and use a package in Visual Studio on the Microsoft website.

Kepler FAQs

Review these FAQs for answers to general questions related to the Kepler framework.