Update release 2.0 documentation

[dpazos-infragistics]

Summary

• Update Java server SDK docs to use the new reveal-sdk-servlet artifact and RevealEngineServlet servlet setup
• Remove the old Jersey/JAX-RS Reveal setup guidance and rename the Spring Boot doc/sidebar/url away from Spring Boot - Jersey
• Add Java 17, Jakarta EE 9, Jetty 12.0.12, AIX/platform support, CORS, and native packaging/deployment notes
• Update release notes with Java SDK requirements and feature parity, with InMemoryDataProvider noted as a future Java port
• Mirror the Java setup and requirements updates in the Japanese docs

Testing

• Not run: npm run build fails because local node_modules are not installed and docusaurus is not available

[Copilot]

Pull request overview

This PR updates Java server SDK documentation for the new servlet-based SDK artifact and setup model, including Java/runtime requirements and packaging notes.

Changes:

• Replaces the old reveal-sdk / Jersey initialization guidance with io.revealbi:reveal-sdk-servlet and RevealEngineServlet.
• Adds Java 17, platform, Jetty, and native packaging/deployment notes.
• Updates release notes with Java SDK requirements and feature-parity information.

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 5 comments.

Show a summary per file

File	Description
docs/web/install-server-sdk.md	Updates English Java install guidance for servlet setup and deployment notes.
docs/web/getting-started-spring-boot-jersey.md	Updates English Spring Boot Java getting-started flow to use servlet registration.
docs/web/release-notes.md	Adds Java SDK breaking-change and feature-parity release notes.
i18n/ja/docusaurus-plugin-content-docs/current/web/install-server-sdk.md	Mirrors Java install updates in Japanese.
i18n/ja/docusaurus-plugin-content-docs/current/web/getting-started-spring-boot-jersey.md	Mirrors Spring Boot Java getting-started updates in Japanese.

Comments suppressed due to low confidence (18)

docs/web/getting-started-spring-boot-jersey.md:98

• The sample calls createPropertiesFrom(request), but this helper is not defined or explained anywhere in the page or repository, so copying this Application.java example will not compile. Include the helper implementation or use a defined RVUserContext construction.

                .build(), request -> new RVUserContext("user identifier", createPropertiesFrom(request)));

docs/web/getting-started-spring-boot-jersey.md:100

• This registers the servlet without enabling async support, while the Tomcat example for the same RevealEngineServlet explicitly calls setAsyncSupported(true). Spring Boot's ServletRegistrationBean leaves async disabled unless configured, so async Reveal endpoints can fail at runtime.

       return new ServletRegistrationBean<>(revealEngineServlet, "/reveal-api/*");

docs/web/getting-started-spring-boot-jersey.md:94

• Using src/main/resources/dashboards as the dashboard path only works when running from the project source directory. After packaging/deploying the WAR/JAR, that source path is not present, so the provider will not find the dashboards created as resources.

                .setDashboardProvider(new RVDashboardProvider("src/main/resources/dashboards"))

docs/web/getting-started-spring-boot-jersey.md:115

• Using src/main/resources/dashboards here repeats a development-only source path. The new packaging/deployment section below makes this misleading because packaged applications will not have that directory at runtime.

    .setDashboardProvider(new RVDashboardProvider("src/main/resources/dashboards"))

docs/web/getting-started-spring-boot-jersey.md:119

• This update removes the Java CORS setup and replaces that step with packaging notes, but the other server getting-started guides still document CORS because the web client commonly runs on a different origin during development. Without equivalent Spring Boot/servlet CORS guidance, users following this guide can still hit cross-origin failures.

## Step 4 - Packaging and Deployment

docs/web/install-server-sdk.md:106

• The sample calls createPropertiesFrom(request), but this helper is not defined or explained anywhere in the page or repository, so copying this Spring Boot example will not compile. Include the helper implementation or use a defined RVUserContext construction.

                .build(), request -> new RVUserContext("user identifier", createPropertiesFrom(request)));

docs/web/install-server-sdk.md:108

• This registers the servlet without enabling async support, while the Tomcat example for the same RevealEngineServlet explicitly calls setAsyncSupported(true). Spring Boot's ServletRegistrationBean leaves async disabled unless configured, so async Reveal endpoints can fail at runtime.

       return new ServletRegistrationBean<>(revealEngineServlet, "/reveal-api/*");

docs/web/install-server-sdk.md:128

• The Tomcat sample also calls createPropertiesFrom(request), but no such helper is defined or described. As written, the documented AppInitializer will not compile for users copying the example.

                .build(), request -> new RVUserContext("user identifier", createPropertiesFrom(request)));

docs/web/install-server-sdk.md:89

• This section still targets "Spring Boot - Jersey" while the new text says the SDK no longer uses JAX-RS and does not require Jersey registration. Keeping the Jersey framing makes the setup misleading and can cause users to keep an unnecessary/conflicting Jersey dependency.

Register `RevealEngineServlet` as a Spring Boot servlet. The current Java SDK no longer sits on top of JAX-RS, so you do not need to register Reveal SDK classes with Jersey.

i18n/ja/docusaurus-plugin-content-docs/current/web/getting-started-spring-boot-jersey.md:100

• The sample calls createPropertiesFrom(request), but this helper is not defined or explained anywhere in the page or repository, so copying this Application.java example will not compile. Include the helper implementation or use a defined RVUserContext construction.

                .build(), request -> new RVUserContext("user identifier", createPropertiesFrom(request)));

i18n/ja/docusaurus-plugin-content-docs/current/web/getting-started-spring-boot-jersey.md:102

• This registers the servlet without enabling async support, while the Tomcat example for the same RevealEngineServlet explicitly calls setAsyncSupported(true). Spring Boot's ServletRegistrationBean leaves async disabled unless configured, so async Reveal endpoints can fail at runtime.

       return new ServletRegistrationBean<>(revealEngineServlet, "/reveal-api/*");

i18n/ja/docusaurus-plugin-content-docs/current/web/getting-started-spring-boot-jersey.md:96

• Using src/main/resources/dashboards as the dashboard path only works when running from the project source directory. After packaging/deploying the WAR/JAR, that source path is not present, so the provider will not find the dashboards created as resources.

                .setDashboardProvider(new RVDashboardProvider("src/main/resources/dashboards"))

i18n/ja/docusaurus-plugin-content-docs/current/web/getting-started-spring-boot-jersey.md:117

• Using src/main/resources/dashboards here repeats a development-only source path. The new packaging/deployment section below makes this misleading because packaged applications will not have that directory at runtime.

    .setDashboardProvider(new RVDashboardProvider("src/main/resources/dashboards"))

i18n/ja/docusaurus-plugin-content-docs/current/web/getting-started-spring-boot-jersey.md:121

• This update removes the Java CORS setup and replaces that step with packaging notes, but the other server getting-started guides still document CORS because the web client commonly runs on a different origin during development. Without equivalent Spring Boot/servlet CORS guidance, users following this guide can still hit cross-origin failures.

## 手順 4 - パッケージ化と配置

i18n/ja/docusaurus-plugin-content-docs/current/web/install-server-sdk.md:106

• The sample calls createPropertiesFrom(request), but this helper is not defined or explained anywhere in the page or repository, so copying this Spring Boot example will not compile. Include the helper implementation or use a defined RVUserContext construction.

                .build(), request -> new RVUserContext("user identifier", createPropertiesFrom(request)));

i18n/ja/docusaurus-plugin-content-docs/current/web/install-server-sdk.md:108

• This registers the servlet without enabling async support, while the Tomcat example for the same RevealEngineServlet explicitly calls setAsyncSupported(true). Spring Boot's ServletRegistrationBean leaves async disabled unless configured, so async Reveal endpoints can fail at runtime.

       return new ServletRegistrationBean<>(revealEngineServlet, "/reveal-api/*");

i18n/ja/docusaurus-plugin-content-docs/current/web/install-server-sdk.md:128

• The Tomcat sample also calls createPropertiesFrom(request), but no such helper is defined or described. As written, the documented AppInitializer will not compile for users copying the example.

                .build(), request -> new RVUserContext("user identifier", createPropertiesFrom(request)));

i18n/ja/docusaurus-plugin-content-docs/current/web/install-server-sdk.md:89

• This section still targets "Spring Boot - Jersey" while the new text says the SDK no longer uses JAX-RS and does not require Jersey registration. Keeping the Jersey framing makes the setup misleading and can cause users to keep an unnecessary/conflicting Jersey dependency.

`RevealEngineServlet` を Spring Boot サーブレットとして登録します。現在の Java SDK は JAX-RS 上で動作しなくなったため、Reveal SDK クラスを Jersey に登録する必要はありません。

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[Copilot]

Pull request overview

Copilot reviewed 7 out of 7 changed files in this pull request and generated 6 comments.

Comments suppressed due to low confidence (6)

docs/web/getting-started-spring-boot-jersey.md:107

• The old CORS setup section was removed here, but no Spring Boot/servlet CORS replacement is provided. Other server getting-started guides still enable CORS for the common separate client/server debug setup, so Java users will hit browser CORS failures when following the same flow.

## Step 3 - Create Dashboards Folder

docs/web/getting-started-spring-boot-jersey.md:113

• This step no longer tells users what folder name or location to create for dashboards; it only points at the placeholder c:\your-path later. The getting-started flow should provide a concrete folder path/name so the sample can be followed as written.

1 - Create a folder for your dashboards.

2 - Configure `RVDashboardProvider` with the folder that contains your dashboards.

```java title="Application.java"

docs/web/install-server-sdk.md:132

• This Tomcat example uses undefined placeholders such as MyIRVDataSourceProvider and createPropertiesFrom(request) without defining them or marking them as user-supplied. As written, the installation snippet will not compile when copied into an application.

                .setDataSourceProvider(new MyIRVDataSourceProvider())
                .addSettings(settings -> {
                    // settings.setLicense("your license or remove to use ~/.revealbi-sdk/license.key");
                })
                .build(), request -> new RVUserContext("whatever", createPropertiesFrom(request)));

i18n/ja/docusaurus-plugin-content-docs/current/web/getting-started-spring-boot-jersey.md:109

• 以前の CORS 設定セクションが削除されていますが、Spring Boot/サーブレット向けの代替 CORS 設定が追加されていません。他のサーバー入門ガイドでは別オリジンのクライアント/サーバー デバッグ用に CORS を有効化しているため、このままだと Java 手順の利用者はブラウザーの CORS エラーに遭遇します。

## 手順 3 - dashboards フォルダーの作成

i18n/ja/docusaurus-plugin-content-docs/current/web/getting-started-spring-boot-jersey.md:113

• この手順では、ダッシュボード用に作成するフォルダーの名前や場所が具体的に示されていません。後続のコードも c:\your-path というプレースホルダーだけなので、入門手順としてそのまま実行できる具体的なフォルダー パス/名前を示してください。

## 手順 3 - dashboards フォルダーの作成

1 - ダッシュボード用のフォルダーを作成します。

2 - ダッシュボードを含むフォルダーを使用するように `RVDashboardProvider` を構成します。

i18n/ja/docusaurus-plugin-content-docs/current/web/install-server-sdk.md:132

• この Tomcat 例では、MyIRVDataSourceProvider や createPropertiesFrom(request) など未定義のプレースホルダーを、ユーザーが用意するものとして説明せずに使用しています。このまま既存アプリケーションにコピーするとコンパイル エラーになります。

                .setDataSourceProvider(new MyIRVDataSourceProvider())
                .addSettings(settings -> {
                    // settings.setLicense("your license or remove to use ~/.revealbi-sdk/license.key");
                })
                .build(), request -> new RVUserContext("whatever", createPropertiesFrom(request)));

[Copilot]

Pull request overview

Copilot reviewed 7 out of 7 changed files in this pull request and generated 7 comments.

Comments suppressed due to low confidence (6)

docs/web/getting-started-spring-boot-jersey.md:100

• The sample calls createPropertiesFrom(request) and hard-codes the user id as "whatever", but the guide never defines the helper or explains what value should be used for the user context. As written, the step-by-step sample is not compilable and does not show a safe default for request properties.

                .build(), request -> new RVUserContext("whatever", createPropertiesFrom(request)));

i18n/ja/docusaurus-plugin-content-docs/current/web/getting-started-spring-boot-jersey.md:102

• The sample calls createPropertiesFrom(request) and hard-codes the user id as "whatever", but the guide never defines the helper or explains what value should be used for the user context. As written, the step-by-step sample is not compilable and does not show a safe default for request properties.

                .build(), request -> new RVUserContext("whatever", createPropertiesFrom(request)));

docs/web/getting-started-spring-boot-jersey.md:121

• The Maven option is shown as the literal command -P os_arch, but Maven interprets that as a profile named os_arch and the doc does not define any valid profile IDs or example values. Users cross-packaging for another platform cannot apply this instruction reliably; document the supported profile names or mark this as a placeholder syntax.

Reveal SDK includes native components built for specific platform and architecture combinations. When you package an application, Maven selects the native component for the current machine. If the deployment platform or architecture is different from the packaging machine, use the Maven profile parameter `-P os_arch` to select the target platform and architecture.

docs/web/install-server-sdk.md:147

• The Maven option is shown as the literal command -P os_arch, but Maven interprets that as a profile named os_arch and the doc does not define any valid profile IDs or example values. Users cross-packaging for another platform cannot apply this instruction reliably; document the supported profile names or mark this as a placeholder syntax.

Reveal SDK includes native components built for specific platform and architecture combinations. When you package an application, Maven selects the native component for the current machine. If the deployment platform or architecture is different from the packaging machine, use the Maven profile parameter `-P os_arch` to select the target platform and architecture.

i18n/ja/docusaurus-plugin-content-docs/current/web/getting-started-spring-boot-jersey.md:123

• The Maven option is shown as the literal command -P os_arch, but Maven interprets that as a profile named os_arch and the doc does not define any valid profile IDs or example values. Users cross-packaging for another platform cannot apply this instruction reliably; document the supported profile names or mark this as a placeholder syntax.

Reveal SDK には、特定のプラットフォームとアーキテクチャの組み合わせ向けにビルドされたネイティブ コンポーネントが含まれています。アプリケーションをパッケージ化すると、Maven は現在のマシン用のネイティブ コンポーネントを選択します。配置先のプラットフォームまたはアーキテクチャがパッケージ化に使用したマシンと異なる場合は、Maven プロファイル パラメーター `-P os_arch` を使用して、対象のプラットフォームとアーキテクチャを選択します。

i18n/ja/docusaurus-plugin-content-docs/current/web/install-server-sdk.md:147

• The Maven option is shown as the literal command -P os_arch, but Maven interprets that as a profile named os_arch and the doc does not define any valid profile IDs or example values. Users cross-packaging for another platform cannot apply this instruction reliably; document the supported profile names or mark this as a placeholder syntax.

Reveal SDK には、特定のプラットフォームとアーキテクチャの組み合わせ向けにビルドされたネイティブ コンポーネントが含まれています。アプリケーションをパッケージ化すると、Maven は現在のマシン用のネイティブ コンポーネントを選択します。配置先のプラットフォームまたはアーキテクチャがパッケージ化に使用したマシンと異なる場合は、Maven プロファイル パラメーター `-P os_arch` を使用して、対象のプラットフォームとアーキテクチャを選択します。

[Copilot]

Pull request overview

Copilot reviewed 12 out of 22 changed files in this pull request and generated 11 comments.

Comments suppressed due to low confidence (6)

i18n/ja/docusaurus-plugin-content-docs/current/web/getting-started-spring-boot.md:20

• This image path is missing from the Japanese localized images directory. With onBrokenMarkdownImages: 'throw', this unresolved asset will break the Japanese docs build.

![](images/getting-started-spring-boot-version.jpg)

i18n/ja/docusaurus-plugin-content-docs/current/web/getting-started-spring-boot.md:28

• This image path is missing from the Japanese localized images directory. With onBrokenMarkdownImages: 'throw', this unresolved asset will break the Japanese docs build.

3 - 言語として **Java** を選択します。

i18n/ja/docusaurus-plugin-content-docs/current/web/getting-started-spring-boot.md:32

• This image path is missing from the Japanese localized images directory. With onBrokenMarkdownImages: 'throw', this unresolved asset will break the Japanese docs build.

4 - グループ ID を提供します。この例では、**com.server** を使用しています。

i18n/ja/docusaurus-plugin-content-docs/current/web/getting-started-spring-boot.md:36

• This image path is missing from the Japanese localized images directory. With onBrokenMarkdownImages: 'throw', this unresolved asset will break the Japanese docs build.

5 - 成果物 ID を提供します。この例では、**reveal** を使用しています。

i18n/ja/docusaurus-plugin-content-docs/current/web/getting-started-spring-boot.md:40

• This image path is missing from the Japanese localized images directory. With onBrokenMarkdownImages: 'throw', this unresolved asset will break the Japanese docs build.

6 - **War** パッケージ タイプを選択します。

i18n/ja/docusaurus-plugin-content-docs/current/web/getting-started-spring-boot.md:50

• This image path is missing from the Japanese localized images directory. With onBrokenMarkdownImages: 'throw', this unresolved asset will break the Japanese docs build.

9 - 新しく作成したプロジェクトを保存して開きます。

[Copilot]

Just as a heads up, I was blocked by some firewall rules while working on your feedback. Expand below for details.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

• https://api.github.com/repos/revealbi/reveal-sdk-wrappers/contents/packages/wrappers/src/components/reveal-view/reveal-view.component.ts
  • Triggering command: REDACTED, pid is -1 (http block)
  • Triggering command: /home/REDACTED/work/_temp/ghcca-node/node/bin/node node /home/REDACTED/work/Documentation/Documentation/node_modules/.bin/docusaurus build (http block)
• https://api.github.com/repos/revealbi/reveal-sdk-wrappers/contents/packages/wrappers/src/components/visualization-viewer/visualization-viewer.component.ts
  • Triggering command: /home/REDACTED/work/_temp/ghcca-node/node/bin/node node /home/REDACTED/work/Documentation/Documentation/node_modules/.bin/docusaurus build (http block)
  • Triggering command: REDACTED, pid is -1 (http block)

If you need me to access, download, or install something from one of these locations, you can either:

• Configure Actions setup steps to set up my environment, which run before the firewall is enabled
• Add the appropriate URLs or hosts to the custom allowlist in this repository's Copilot coding agent settings (admins only)

[Copilot]

Just as a heads up, I was blocked by some firewall rules while working on your feedback. Expand below for details.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

• https://api.github.com/repos/revealbi/reveal-sdk-wrappers/contents/packages/wrappers/src/components/reveal-view/reveal-view.component.ts
  • Triggering command: REDACTED, pid is -1 (http block)
  • Triggering command: /usr/local/bin/node node /home/REDACTED/work/Documentation/Documentation/node_modules/.bin/docusaurus build (http block)
• https://api.github.com/repos/revealbi/reveal-sdk-wrappers/contents/packages/wrappers/src/components/visualization-viewer/visualization-viewer.component.ts
  • Triggering command: /usr/local/bin/node node /home/REDACTED/work/Documentation/Documentation/node_modules/.bin/docusaurus build (http block)
  • Triggering command: REDACTED, pid is -1 (http block)

If you need me to access, download, or install something from one of these locations, you can either:

• Configure Actions setup steps to set up my environment, which run before the firewall is enabled
• Add the appropriate URLs or hosts to the custom allowlist in this repository's Copilot coding agent settings (admins only)