エクスポートの構成

ASP.NET

ダッシュボードを画像、PDF、または PowerPoint に (プログラムで、またはユーザーの操作を通じて) エクスポートするために、RevealSDK は内部で Playwright を使用します。

デフォルトでは、ユーザーがダッシュボードを画像、PDF、または PowerPoint に初めてエクスポートしようとすると、Playwright は Chromium ブラウザーを現在のプラットフォームのデフォルトの場所にダウンロードしようとします。Windows の場合、デフォルトのパスは %userprofile%/AppData/Local/ms-playwright です。

このダウンロードには時間がかかり、ダッシュボードをエクスポートしようとする最初のエンドユーザーユーザーに遅延が発生する可能性があります。これは開発中は問題ありませんが、プロダクション環境では望ましくない場合があります。これらのシナリオでは、以下の設定を使用して、エクスポートの動作を微調整できます。

これらの設定は RevealEmbedSettings.Export のプロパティで公開されます。

CreateChromiumInstancesOnDemand - これを false に設定すると、アプリの起動時に Playwright の初期化が強制的に行われます。
ChromiumDownloadFolder - Chromium 実行可能ファイルがダウンロードされるパス。
ChromiumExecutablePath - Chromium 実行可能ファイルがサーバーに予めインストールされているパス。
MaxConcurrentExportingThreads - エクスポートに使用される最大同時スレッド数。
ExportingTimeout - エクスポート操作のタイムアウト期間 (ミリ秒単位)。デフォルト値は 30000 ms。指定されたタイムアウト期間内にエクスポート操作が終了しない場合、エクスポート操作は失敗します。

Playwright と Chromium をサーバーに手動でインストールするには、Playwright CLI を使用します。

dotnet tool install --global Microsoft.Playwright.CLI
playwright install chromium

Java

(プログラム上またはユーザーインタラクションによって) ダッシュボードを画像にエクスポートするには、Reveal SDK は Playwright を使用します。ダッシュボードを Excel、PDF、または PowerPoint にエクスポートするには、Reveal SDK は ExportTool と呼ばれる内部アプリケーションを使用します。

デフォルトでは、エンドユーザーがダッシュボードを画像、PDF、PowerPoint に初めてエクスポートしようとすると、Playwright と ExportTool の両方が、それらの動作に必要な依存関係のダウンロードを自動的に開始します。ただし、プラットフォームによっては、事前にインストールが必要な依存関係があったり、サーバー環境が外部ダウンロードを制限しているなど、これらのツールを手動でセットアップする必要がある場合があります。

Playwright の構成

Playwright は必要なバイナリをダウンロードしようとしますが、手動での構成が必要な場合は、Playwright のドキュメンテーションを確認してください。

Linux 依存性

Linux では、複数のネイティブ・ライブラリに依存します。インストールする必要のある依存関係の正確なリストは、使用するディストリビューション、バージョン、および以前にインストールしたパッケージのリストに依存します。

以下に、基本的な Ubuntu 18.0.4 ディストリビューションに必要なライブラリの一覧を示します。

sudo apt-get update

sudo apt-get install -y libatk1.0-0\
        libatk-bridge2.0-0\
        libxkbcommon0\
        libxcomposite1\
        libxdamage1\
        libxfixes3\
        libxrandr2\
        libgbm1\
        libgtk-3-0\
        libpango-1.0-0\
        libcairo2\
        libgdk-pixbuf2.0-0\
        libatspi2.0-0    

sudo apt-get install -y --no-install-recommends xvfb 

注記

必要であれば、ログファイルに含まれるエラーから、不足しているライブラリに関する詳細な情報を得ることができます。

Ubuntu を使用する場合は、Maven を使用して Chromium の依存関係をインストールする必要があります。

mvn exec:java -e -Dexec.mainClass=com.microsoft.playwright.CLI -Dexec.args="install-deps chromium"

その他の環境では、以下の依存関係が必要な場合があります:

sudo apt-get install -y --allow-unauthenticated libc6-dev
sudo apt-get install -y --allow-unauthenticated libx11-dev

ExportTool の手動セットアップ

ここからの手順は、以下のシナリオの場合のみ必要です。

自動ダウンロードの仕組みに問題がある場合。
事前にすべてをインストールしておきたい場合。

ステップ 1 - お使いのプラットフォームに必要なバイナリをダウンロードします: Windows、Linux、macOS

ステップ 2 - Web アプリケーションが動作しているサーバーのディレクトリにファイルを解凍します (ユーザーはそのディレクトリにアクセスできる必要があります)。

ステップ 3 - ZIP ファイルを解凍した後、<dir>/<version>/<arch>/ExportTool フォルダから ExportTool を入手できます。例を以下に示します。

<dir>/1.0.0/linux-x64/ExportTool.

ステップ 4 - Reveal の初期化中に、ZIP ファイルを解凍したディレクトリを設定します。以下のようなコードになるはずです:

String exportToolDir = "<dir>";
RevealEngineInitializer.initialize(new InitializeParameterBuilder().
    setExportToolContainerPath(exportToolDir).
    build());

また、以下のようにシステムプロパティ reveal.exportToolContainerPath を通じてディレクトリを指定することもできます:

java -Dreveal.exportToolContainerPath=<dir> -jar target/upmedia-backend-spring.war

エクスポートの構成

ASP.NET​

Java​

Playwright の構成​

Linux 依存性​

ExportTool の手動セットアップ​

ASP.NET

Java

Playwright の構成

Linux 依存性

ExportTool の手動セットアップ