server-sample-rap

This repository is a sample Relativity Application Package (RAP) project targeting Relativity Server. It demonstrates the structure and tooling required to build a RAP that includes a compiled .NET assembly and an ASP.NET MVC custom page. It is intended as a reference for developers building Relativity Server applications.

Prerequisites

Before running the build, ensure the following tools are installed and available on your PATH:

• .NET SDK — required for dotnet restore
• Visual Studio 2022 or later (or Build Tools for Visual Studio) — required to compile the solution; includes MSBuild. MSBuild must also be added to the PATH Environment Variable
• Node.js and npm — required to install front-end dependencies for the custom page
• relsvr-rap CLI — Relativity's RAP build tool; make sure it is copied to a location in the %PATH% environment variable

Building

Run the build script from the repository root in PowerShell:

.\build.ps1

Parameters

Parameter	Default	Description
-AssemblyVersion	1.0.0	The three-part version number to embed in the assembly versions (independent of the RAP version)
-RAPVersion	1.0.0.0	The four-part version number to embed in the RAP package
-RelativityServerRelease	2024	The target Relativity Server release year; must be one of: 2024, 2025, 2026
-Configuration	Release	The MSBuild build configuration (e.g., Debug or Release)

Example with custom parameters:

.\build.ps1 -AssemblyVersion 2.0.0 -RAPVersion 2.0.0.0 -RelativityServerRelease 2025 -Configuration Debug

What the build script does

1. Runs dotnet restore to restore NuGet packages for the solution
2. Runs npm install in the SampleRap.CustomPage project to install front-end dependencies
3. Runs msbuild to compile the full solution, writing build logs to Artifacts/Logs/
4. Runs relsvr-rap.exe build to package the compiled outputs into a RAP file

Build Artifacts

After a successful build, the following files are created under the Artifacts/ directory:

Artifacts/
├── Logs/
│   ├── buildsummary.log    # General MSBuild output summary
│   ├── builderrors.log     # MSBuild errors only
│   └── rapbuild.log        # Output from the relsvr-rap build step
└── SampleRap.rap           # The final Relativity Application Package

SampleRap.rap is the primary deployable output. It is a ZIP-based package that can be installed into a Relativity Server environment. It contains:

• SampleRap.dll — the main .NET assembly (agents, event handlers, services)
• The compiled SampleRap.CustomPage ASP.NET MVC application (zipped as a custom page)
• application.xml — the Relativity application schema defining the app's components