Skip to content

Commit ee9ed7e

Browse files
griffin-meteviagriffin-metevia
committed
REL-1281497: add examples
1 parent 473404d commit ee9ed7e

1 file changed

Lines changed: 87 additions & 0 deletions

File tree

‎rapbuilder/README.md‎

Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,93 @@ The `application.xml` schema must stay aligned with `build.xml`.
6262

6363
The easiest way to create `application.xml` is exporting the application schema from Relativity and then validating that it matches your build inputs.
6464

65+
## Example Command
66+
67+
```powershell
68+
relsvr-rap.exe build --source "C:\Projects\MyRelativityApp" `
69+
--input "DevelopmentScripts\build.xml" `
70+
--version "1.5.0.0" `
71+
--relativity-server-release 2025 `
72+
--warnings-as-errors false `
73+
--log-file "Artifacts\Logs\rapbuild.log" `
74+
--log-level Information
75+
```
76+
77+
## Example Output for RAP
78+
79+
Example output for a RAP that passes validation:
80+
```
81+
____ _ ____ ____ _ _ _
82+
| _ \ / \ | _ \ | __ ) _ _ (_) | | __| | ___ _ __
83+
| |_) | / _ \ | |_) | | _ \ | | | | | | | | / _` | / _ \ | '__|
84+
| _ < / ___ \ | __/ | |_) | | |_| | | | | | | (_| | | __/ | |
85+
|_| \_\ /_/ \_\ |_| |____/ \__,_| |_| |_| \__,_| \___| |_|
86+
87+
[12:58:08 RAPBuilder] [Information] relsvr-rap version: 4.0.6.0
88+
[12:58:08 RAPBuilder] [Information] Loading SDK dependencies...
89+
[12:58:08 RAPBuilder] [Information] Parameters passed:
90+
[12:58:08 RAPBuilder] [Information] Source directory is C:\s\rep\server-sample-rap
91+
[12:58:08 RAPBuilder] [Information] Input file path is DevelopmentScripts\build.xml
92+
[12:58:08 RAPBuilder] [Information] RAP Version: 1.0.0.0
93+
[12:58:08 RAPBuilder] [Information] Target Relativity Release is 2024
94+
[12:58:08 RAPBuilder] [Information] Reading input file DevelopmentScripts\build.xml
95+
[12:58:08 RAPBuilder] [Information] Validating RAPs...
96+
[12:58:08 RAPBuilder] [Information] Building RAPs...
97+
[12:58:08 RAPBuilder] [Information] Ensuring all assemblies exist
98+
[12:58:08 RAPBuilder] [Information] Hashing assemblies
99+
[12:58:08 RAPBuilder] [Information] Ensuring all resource files exist
100+
[12:58:08 RAPBuilder] [Information] Moving resource files to destination folder
101+
[12:58:08 RAPBuilder] [Information] Ensuring all custom pages exist
102+
[12:58:08 RAPBuilder] [Information] Hashing custom pages
103+
[12:58:08 RAPBuilder] [Information] Validating all assemblies
104+
[12:58:08 RAPBuilder] [Information] SdkCompatibilityResult: Total files validated: 22
105+
[12:58:08 RAPBuilder] [Information] SdkCompatibilityResult: Total successful validations: 22
106+
[12:58:08 RAPBuilder] [Information] SdkCompatibilityResult: Total failed validations: 0
107+
[12:58:08 RAPBuilder] [Information] Creating RAP file
108+
[12:58:08 RAPBuilder] [Information] Successfully created RAP file SampleRap.rap at C:\s\rep\server-sample-rap\Artifacts\SampleRap.rap
109+
[12:58:08 RAPBuilder] [Information] Complete!
110+
```
111+
112+
Example output for a RAP that fails SDK validation:
113+
```
114+
____ _ ____ ____ _ _ _
115+
| _ \ / \ | _ \ | __ ) _ _ (_) | | __| | ___ _ __
116+
| |_) | / _ \ | |_) | | _ \ | | | | | | | | / _` | / _ \ | '__|
117+
| _ < / ___ \ | __/ | |_) | | |_| | | | | | | (_| | | __/ | |
118+
|_| \_\ /_/ \_\ |_| |____/ \__,_| |_| |_| \__,_| \___| |_|
119+
120+
[13:07:04 RAPBuilder] [Information] relsvr-rap version: 4.0.6.0
121+
[13:07:04 RAPBuilder] [Information] Loading SDK dependencies...
122+
[13:07:04 RAPBuilder] [Information] Parameters passed:
123+
[13:07:04 RAPBuilder] [Information] Source directory is C:\s\rep\assets\sdktesting
124+
[13:07:04 RAPBuilder] [Information] Input file path is C:\s\rep\assets\sdktesting\DevelopmentScripts\build.xml
125+
[13:07:04 RAPBuilder] [Information] RAP Version: 1.0.0.0
126+
[13:07:04 RAPBuilder] [Information] Target Relativity Release is 2026
127+
[13:07:04 RAPBuilder] [Information] Reading input file C:\s\rep\assets\sdktesting\DevelopmentScripts\build.xml
128+
[13:07:04 RAPBuilder] [Information] Validating RAPs...
129+
[13:07:04 RAPBuilder] [Information] Building RAPs...
130+
[13:07:04 RAPBuilder] [Information] Ensuring all assemblies exist
131+
[13:07:04 RAPBuilder] [Information] Hashing assemblies
132+
[13:07:04 RAPBuilder] [Information] Ensuring all resource files exist
133+
[13:07:04 RAPBuilder] [Information] Moving resource files to destination folder
134+
[13:07:04 RAPBuilder] [Information] Ensuring all custom pages exist
135+
[13:07:04 RAPBuilder] [Information] Hashing custom pages
136+
[13:07:04 RAPBuilder] [Information] Validating all assemblies
137+
[13:07:04 RAPBuilder] [Fatal] SDKTesting.dll - Has a reference to an SDK version that is unsupported (SDK name: kCura.Agent, version found: 5000.0.2.0, version required: 5001.1.1.0). Fix: install/update to 5001.1.1.0.
138+
[13:07:04 RAPBuilder] [Fatal] SDKTesting.dll - Has a reference to an SDK version that is unsupported (SDK name: Relativity.API, version found: 5000.0.2.0, version required: 5001.1.1.0). Fix: install/update to 5001.1.1.0.
139+
[13:07:04 RAPBuilder] [Fatal] SDKTesting.dll - Has a reference to an SDK version that is unsupported (SDK name: kCura.Agent, version found: 5000.0.2.0, version required: 5001.1.1.0). Fix: install/update to 5001.1.1.0.
140+
[13:07:04 RAPBuilder] [Fatal] SDKTesting.dll - Has a reference to an SDK version that is unsupported (SDK name: Relativity.API, version found: 5000.0.2.0, version required: 5001.1.1.0). Fix: install/update to 5001.1.1.0.
141+
[13:07:04 RAPBuilder] [Information] SdkCompatibilityResult: Total files validated: 2
142+
[13:07:04 RAPBuilder] [Information] SdkCompatibilityResult: Total successful validations: 0
143+
[13:07:04 RAPBuilder] [Information] SdkCompatibilityResult: Total failed validations: 2
144+
[13:07:04 RAPBuilder] [Information] Validation errors found: 4
145+
[13:07:04 RAPBuilder] [Error] ERROR SDKTesting.dll - Has a reference to an SDK version that is unsupported (SDK name: kCura.Agent, version found: 5000.0.2.0, version required: 5001.1.1.0). Fix: install/update to 5001.1.1.0.
146+
[13:07:04 RAPBuilder] [Error] ERROR SDKTesting.dll - Has a reference to an SDK version that is unsupported (SDK name: Relativity.API, version found: 5000.0.2.0, version required: 5001.1.1.0). Fix: install/update to 5001.1.1.0.
147+
[13:07:04 RAPBuilder] [Error] ERROR SDKTesting.dll - Has a reference to an SDK version that is unsupported (SDK name: kCura.Agent, version found: 5000.0.2.0, version required: 5001.1.1.0). Fix: install/update to 5001.1.1.0.
148+
[13:07:04 RAPBuilder] [Error] ERROR SDKTesting.dll - Has a reference to an SDK version that is unsupported (SDK name: Relativity.API, version found: 5000.0.2.0, version required: 5001.1.1.0). Fix: install/update to 5001.1.1.0.
149+
[13:07:04 RAPBuilder] [Error] One or more assemblies had validation errors.
150+
```
151+
65152

66153
## Common Errors and Solutions
67154

0 commit comments

Comments
 (0)