Validation and Errors

RAP Builder validates your application components during the build process and reports errors when issues are detected. This page documents all validation checks, error messages, and SDK version verification.

How Validation Works

When you run relsvr-rap build, the tool performs the following checks in order:

1. Input validation - Verifies that required arguments are provided and valid.
2. Schema validation - Confirms that application.xml exists and can be parsed.
3. Destination validation - Checks that <Destination> ends with .rap.
4. Assembly validation - Cross-references assemblies between build.xml and application.xml.
5. Resource file validation - Cross-references resource files between the two XML files.
6. Custom page validation - Cross-references custom page GUIDs between the two XML files.
7. SDK version validation - Verifies that Relativity SDK assemblies match the expected versions for the target Relativity Server release.
8. Target framework validation (Server 2026) verifies that every assembly in the RAP targets .NET Framework 4.8.1 (Server 2026 builds only).

If any check fails, RAP Builder reports the error and exits with a non-zero exit code - 1 for general errors (bad paths, missing files) or 4 for validation and build logic errors (schema mismatches, SDK failures).

Input Validation Errors

These errors occur when required command-line arguments are missing or invalid.

Unsupported Relativity Server Release

The Relativity Server Release value of <value> is less than the minimum compatible Relativity Server Release of 2024

Cause: The --relativity-server-release value is less than 2024. RAP Builder only supports Relativity Server 2024 and later.

Schema Validation Errors

Missing Application Schema

Missing application schema, cannot make RAP!

Cause: The <ApplicationSchema> element is missing from build.xml, or its value is empty.

Fix: Add the <ApplicationSchema> element to your build.xml:

<ApplicationSchema>ApplicationsXML/application.xml</ApplicationSchema>

Invalid Application Schema

Cannot find application schema file, cannot make RAP!

Cause: The application.xml file referenced in <ApplicationSchema> does not exist at the resolved path, or cannot be parsed as valid XML.

Fix: Verify the path is correct relative to the --source directory and that the file is well-formed XML.

Destination Errors

Missing Destination Path

Missing destination path, please add destination path to build RAP!

Cause: The <Destination> element is missing from build.xml.

Fix: Add a <Destination> element:

<Destination>Artifacts\MyApp.rap</Destination>

Invalid Destination Path

Destination path does not end in '.rap', please name your destination with the .rap extension to proceed!

Cause: The <Destination> value does not end with .rap.

Fix: Ensure the output path ends with the .rap extension:

<Destination>Artifacts\MyApp.rap</Destination>

Assembly Validation Errors

Assembly Not Found in application.xml

DLL(s) <names> was/were not found in schema. Please check that you have added all required assemblies to the application.xml file.

Cause: One or more assemblies listed in build.xml do not have a corresponding <Assembly><Name> entry in application.xml.

Fix: Add the missing assembly to application.xml:

<Assembly>
  <ArtifactId>1000002</ArtifactId>
  <Keywords />
  <Name>MyApp.Core.dll</Name>
  <Notes />
</Assembly>

Assembly in application.xml Not Found in build.xml

DLL in schema was not found. Please check that you have added all required assemblies to the build.xml file.

Cause: An assembly defined in application.xml does not have a corresponding <Assembly> path in build.xml.

Fix: Either add the missing assembly path to build.xml, or remove the entry from application.xml.

Assembly Name Case Mismatch

DLL file name case mismatch. Please ensure DLL file name <filename> and schema node text <nodeName> match exactly.

Cause: The assembly filename in the build.xml path differs in letter case from the <Name> value in application.xml. For example, myapp.dll vs. MyApp.dll.

Fix: Make the names match exactly in both files. File names in RAP Builder are case-sensitive.

Resource File Validation Errors

Resource File Not Found in application.xml

Resource File(s) <names> was/were not found in schema

Cause: One or more resource files in build.xml do not have a corresponding <ResourceFile><Name> entry in application.xml.

Fix: Add the missing resource file to application.xml:

<ResourceFile>
  <ArtifactID>1016210</ArtifactID>
  <Name>image.jpg</Name>
  <FileType>1</FileType>
</ResourceFile>

Resource File in application.xml Not Found in build.xml

Resource File <filename> in schema was not found

Cause: A resource file defined in application.xml does not have a corresponding <ResourceFile> path in build.xml.

Fix: Either add the missing resource file path to build.xml, or remove the entry from application.xml.

Resource File Name Case Mismatch

Resource file name case mismatch. Please ensure resource file name <filename> and schema node text <nodeName> match exactly.

Cause: The resource file's name differs in letter case between build.xml and application.xml.

Fix: Ensure the filename matches exactly, including case.

Custom Page Validation Errors

Custom Page Not Found in application.xml

Custom Page <guid> in schema was not found

Cause: A custom page GUID in build.xml does not have a corresponding <CustomPage><Guid> entry in application.xml.

Fix: Add the custom page to application.xml with the matching GUID:

<CustomPage>
  <ArtifactID>1040001</ArtifactID>
  <Guid>a1b2c3d4-e5f6-7890-abcd-ef1234567890</Guid>
  <Name>MyCustomPage</Name>
  <FileName>MyCustomPage.zip</FileName>
  <Keywords />
  <Notes />
</CustomPage>

Custom Page in application.xml Not Found in build.xml

Custom Page in schema was not found

Cause: A custom page defined in application.xml does not have a corresponding <CustomPage> entry in build.xml.

Fix: Either add the custom page to build.xml, or remove it from application.xml.

Test Directory Errors

Missing Test Directory

Cannot find test directory.

Cause: A <TestDirectory> element is specified in build.xml, but the directory does not exist at the resolved path.

Fix:

1. Verify the path is correct relative to --source.
2. Ensure you have built your test project before running RAP Builder.
3. If you don't need test assemblies, remove the <TestDirectory> element from build.xml.

SDK Version Validation

RAP Builder validates that Relativity SDK assemblies in your RAP reference the correct versions for the targeted Relativity Server release. This prevents deployment failures caused by SDK version incompatibilities.

How SDK Validation Works

1. RAP Builder maintains a list of known Relativity SDK assemblies and their expected versions for each supported Relativity Server release (2024, 2025, 2026).
2. During the build, RAP Builder inspects each assembly included in the RAP.
3. If an assembly matches a known SDK assembly name, its version is compared against the expected version.
4. Mismatches are reported as errors.

SDK Mismatch Example

[Error] Assembly 'Relativity.ObjectManager.dll' version 12.1.0.0 does not match expected version 5000.0.2.0 for Relativity Server 2024

Target Framework Validation (Server 2026)

When you build with --relativity-server-release 2026, RAP Builder additionally verifies that every assembly packaged in the RAP targets .NET Framework 4.8.1. Server 2024 and 2025 builds are not subject to this check.

This check applies to every assembly in the RAP, including third-party dependencies (for example, Newtonsoft.Json or log4net). An assembly produces a Warning-level finding when it targets an earlier .NET Framework version, targets a different framework family (for example, .NET Standard or .NET), or has no readable target-framework information.

A finding looks like this (the file name and versions vary):

MyApp.Legacy.dll - Targets an unsupported .NET Framework version (found: 4.6.2, required: 4.8.1 or higher). Fix: rebuild against .NET Framework 4.8.1.

Because --warnings-as-errors defaults to true, these warnings fail the build. This is expected while you migrate an application to .NET Framework 4.8.1. Until every assembly is retargeted, pass --warnings-as-errors false to see the findings without failing the build:

relsvr-rap build ... --relativity-server-release 2026 --warnings-as-errors false

Retarget your own assemblies to .NET Framework 4.8.1, and update or replace third-party dependencies that cannot meet the requirement. Then rebuild with the default --warnings-as-errors true to confirm a clean build.

Build Results Output

Every build records its full validation outcome in a build results file (buildresults.xml) that ships inside the RAP. Relativity reads this file when the RAP is imported into a Server 2026 or later environment and uses it to display the Application Compatibility Check. Relativity does not re-run validation at import time; it reads the results RAP Builder recorded during the build.

The results are stored in a signed, encoded form so they are not easily altered after the build. You do not need to read or edit this file directly.

For what Relativity displays at import time, see Application Compatibility Verification in Relativity.

Understanding Log Output

RAP Builder logs each validation step. To get more detail, increase the log level:

relsvr-rap build ... --log-level Debug

See the Troubleshooting guide for help resolving specific issues.