インストール ガイド

ArcGIS Experience Builder は、モダンな Web アプリ構築のための新しいビルダーで、コードを記述することなく Web アプリケーションを作成することができます。豊富なウィジェット セットから必要なツールを選択したり、独自のテンプレートをデザインしたり、2D コンテンツや 3D コンテンツを操作したりすることができます。Developer Edition (開発者向けエディション)は、これらの機能に加え、ウィジェットやテーマを独自に開発するなどのアプリをカスタマイズするためのフレームワークを提供します。また、作成したアプリケーションをダウンロードして、Web サーバーなどの独自のサーバーにホストすることが可能です。

ArcGIS Experience Builder (Developer Edition) で使用されている技術は、ArcGIS Maps SDK for JavaScript 4.x に加えて、React + Redux といったフレームワークや Bootstrap 4 などのコンポーネントライブラリ等を使用しています。開発に必要な情報は ArcGIS Experience Builder (Developer Edition) のコア コンセプト (Core concepts) を参照してください。

インストール

ArcGIS Experience Builder (Developer Edition) は、ArcGIS Online および ArcGIS Enterprise 10.6 以降をサポートしています。
Experience Builder (Developer Edition) は server と client の 2 つのサービスを使用しています。

  • server サービス
    • Experience Builder (Developer Edition) の本体を起動します。
  • client サービス
    • 独自のウィジェットやテーマを開発するためには client サービスを使用する必要があります。通常、server サービスを起動することで、Experience Builder (Developer Edition) を動作させることはできますが、開発したウィジェットなどを配置したり、デバッグするには、client サービスを起動しておく必要があります。

両方のサービスを実行しておくことで、Experience Builder での更新を自動的に反映することができます。
ここでは、Experience Builder (Developer Edition) の server と client のインストール手順について説明します。また、インターネットに接続していない環境で Experience Builder をインストールする必要がある場合は、offlineでのインストール手順を参照してください。

Server インストール

1. Client ID の作成

はじめに Client ID を作成する必要があります。Client ID は、このあとの server サービスを起動して立ち上がるアプリケーションで指定します。 Client ID の作成は、ArcGIS Developers 、もしくは ArcGIS Online/ArcGIS Enterprise を使用して作成します。ご使用の環境に応じて作成を行ってください。

1-1. ArcGIS Developers を使用した Client ID の作成

ArcGIS Developers を使用している場合は、以下の手順を行います。

インストール手順については Esri が公開しているインストール動画 (英語)でも確認することができます。

  1. ArcGIS Developers にサイン インします。
  2. サイン イン後にダッシュボードが表示されますので OAuth 2.0 タブをクリックします。
  3. + New Application をクリックし、アプリケーションの詳細を入力して、新しいアプリケーションを登録します。
  4. Redirect URLs のセクションまでスクロール ダウンします。
  5. + Add URI をクリックして、https://localhost:3001/ を追加します。
  6. Client ID は、このあとの手順で使用するため、コピーなどをして控えておきます。

1-2. ArcGIS Online/ArcGIS Enterprise を使用した Client ID の作成

ArcGIS Online または ArcGIS Enterprise を使用している場合は、以下の手順を行います。

※ インストール手順については Esri が公開しているインストール動画 (英語)でも確認することができます。

  1. ArcGIS Online または ArcGIS Enterprise ポータルにログインし、コンテンツ ページの マイ コンテンツ タブに移動して、新しいアイテム をクリックし、アプリケーション を選択します。
  2. アプリケーション タイプ で 他のアプリケーション を選択します。
  3. ダイアログボックスで、以下のパラメータを入力し、保存 をクリックします。
    • タイトル - 例えば、Experience Builder credentials などの任意のタイトルをを入力します。
    • フォルダー - アイテムを保存する任意のフォルダーを選択します。
    • タグ - Experience Builder のような内容を入力します。
    • サマリー - アイテムのサマリーを入力します。

  1. 設定 タブをクリックします。アプリケーションの登録の項目までスクロールして、更新 をクリックします。
  2. 登録情報 ダイアログ ボックスで、次のように、リダイレクト URI に https://localhost:3001/ と入力し、追加をクリックして、更新 をクリックします。アプリケーション ID は、このあとの手順で使用するため、コピーなどをして控えておきます。

2. server サービスのインストール

Client ID の作成が完了したら以下の手順で server サービスのインストールを行います。

Experience Builder は、Node.js を使用します。長期サポート (LTS) バージョン v12 以上がサポートされています。お使いの OS に対応した最新の Node.js LTS バージョンをダウンロードしてインストールを行ってください。

  1. Experience Builder (Developer Edition) の ZIP ファイルをローカルにダウンロードして、解凍します。
    ※ ダウンロードページでサイン イン ページが表示される場合は、ArcGIS Developers 開発者アカウント（あるいは ArcGIS Online 組織向けプランのアカウント）のユーザー名およびパスワードを入力しサイン インします。
  2. コマンド プロンプト、またはターミナル ウィンドウを開き、Experience Builder の /server ディレクトリに cd コマンドで移動して npm ci と入力し、Enter キーを押して、必要なモジュールをインストールします。
    ※ npm ci でのインストールは初回のみになります。次回以降は Experience Builder (Devloper Edition) の起動のみになりますので、npm start で実行します。
  3. npm start と入力して server を起動します。

カスタムポートを使用するには、次のようにオプションとしてポートを指定します。： npm start -- --port 81 --https_port 443 .

サブディレクトリ（例：https://localhost:3001/subfolder）でサーバーを実行するには、次のように path オプションを指定します： npm start -- --path /subfolder .

  1. 次の URL https://localhost:3001/ を指定して Experience Builder をブラウザで開きます。

Experience Builder は、Node.js の自己署名証明書を使用して HTTPS をサポートしています。この証明書を信頼して Experience Builder を実行することもできますし、独自の証明書を使用することもできます。独自の証明書を使用するには、server/cert ディレクトリのこれら 2 つのファイル server.key と server.cert を置き換えます。また、次のように証明書ファイル (server.cert および server.key) が存在するフォルダへのカスタムパスを指定することもできます。：npm start – –cert_folder <フォルダパス>

  1. ポータルの URL には ArcGIS Online または ArcGIS Enterprise の組織サイトの URL を指定し、クライアント ID には「1-1. ArcGIS Developers を使用した Client ID の作成」で作成した client ID」、または「1-2. ArcGIS Online/ArcGIS Enterpriseを使用した Client ID の作成」で作成したアプリケーション ID を指定します。
    すべてを指定したらサイン インをクリックします。

Safari で、PKI、Kerberos、IWA、または LDAP 認証タイプを使用して Experience Builder Developer Edition にサインインするには、Safari の開発メニューにある「Cross-Origin Restrictions を無効にする」を選択する必要があります。

サイン インをクリックすると、以下のように「権限のリクエスト画面」、もしくは、「ArcGIS ログイン画面」が表示されます。

● 権限のリクエスト画面 権限のリクエスト画面は、使用しているブラウザですでに ArcGIS Online などにログインしているため、ログインした組織のアカウントが表示されます。許可をクリックすることで、Experience Builder の初期画面が表示されます。もし、他のアカウントでサイン インする場合は、別のアカウントでサイン インをクリックしてください。以下の ArcGIS ログイン画面が起動しますので、目的のユーザー名、パスワードを入力してサイン インします。

● ArcGIS ログイン画面 使用しているブラウザで ArcGIS Online などにログインしていない場合は、ArcGIS ログイン画面が表示されます。目的のユーザー名、パスワードを入力してサイン インをクリックしてください。認証に成功すると、Experience Builder の初期画面が表示されます。

6. 次のステップで client インストールを行います。

Client インストール

Experience Builder の開発では、ローカルの Experience Builder で使用しているカスタム ウィジェットやテーマをバンドルしてロードするため webpack を起動する必要があります。webpack を起動するために client サービスをインストールする必要があります。

  1. コマンド プロンプト、またはターミナル ウィンドウを開き、Experience Builder の /client ディレクトリに cd コマンドで移動して npm ci と入力し、Enter キーを押して、必要なモジュールをインストールします。
    ※ npm ci でのインストールは初回のみになります。次回以降は Experience Builder (Devloper Edition) の起動のみになりますので、npm start で実行します。
    ※ npm ci でのインストール時は Visual Studio C++ Build Tools と Python が端末上にある必要があります。
  2. npm start と入力して client を起動します。
    ※ client のサービスを起動することで、カスタム ウィジェットやテーマは https://localhost:3001 で表示した Experience Builder 上で使用することが可能となります。

/client/your-extensions ディレクトリに新しいファイルやフォルダを作成した場合は、client サービスの再起動が必要になります。

同じマシンで複数のバージョンの Developer edition を持つことができます。お使いのマシンがシステム要件を満たしていることを確認してください。

Offline インストール

  • インターネットに繋がらない環境では、ArcGIS API JavaScript (JSAPI) CDN にアクセスすることはできません。このシナリオでは、JSAPI をダウンロードしてローカルにインストールする必要があります。

  • Experience Builder は、Node.js 12+.x 以上のバージョンで動作します。
    Experience Builder のインストール環境に Node.js (v12+.x) をダウンロードしてインストールを行います。

Experience Builder の機能強化や新機能をサポートするために、最新版の ArcGIS API JavaScript をインストールすることが推奨されています。Esri が公開しているオフライン インストール動画（英語）](https://youtube.com/watch?v=1rO1cZNEr0E) を参照してください。ホストされた JSAPI のために、サーバーで CORS サポートを設定することが推奨されます。例えば、Windows OS の場合、HTTPSレスポンスヘッダーにAccess-Control-Allow-Original アクションを追加することができます。

  1. Experience Builder (Developer Edition) の ZIP ファイルをローカルにダウンロードして、解凍します。
  2. Experience Builder (Developer Edition) 用の npm-cache zip をローカルにダウンロードして、解凍します。
  3. コマンド プロンプト(例えば、Windows OS c:\Users\exbuser)、またはターミナル(例えば、macOS /Users/installExB)で、ユーザーフォルダを開き、npm config get cache と入力します。
  4. npm config get cache の実行で表示された npm-cache のフォルダのパスをコピーして、そのディレクトリを Windows のエクスプローラーか Mac の場合は Finder で開きます。
  5. ダウンロードした Experience Builder (Developer Edition) 用 の npm-cache ディレクトリをコピーして、4 で参照しているディレクトリに貼り付けます。
  6. コマンド プロンプト、またはターミナル ウィンドウを開き、Experience Builder インストールの client ディレクトリに cd コマンドで移動して、npm install --offline と入力して Enter キーを押します。
  7. 別のコマンド プロンプト、またはターミナル ウィンドウを開き、Experience Builder インストールの server ディレクトリに cd コマンドで移動して、npm install -- offline と入力して Enter キーを押します。
  8. Experience Builder の client ディレクトリを以下のパス <install folder>/client/dist で開きます。
  9. 変数 ARCGIS_JS_API_URL をローカルで JSAPI を参照している URL に更新する必要が4箇所あります。例えば、以下の各ファイルで var ARCGIS_JS_API_URL = 'https://js.arcgis.com/4.16/' を var ARCGIS_JS_API_URL = 'https://exb.esri.com/4.16/' に置き換えてください。
    • <install folder>/client/dist/index.html
    • <install folder>/client/dist/experience/index.html
    • <install folder>/client/dist/template/index.html
    • <install folder>/client/dist/builder/index.html
  10. コマンド プロンプト、またはターミナル ウィンドウを開き、Experience Builder のインストール先の client ディレクトリに cd コマンドで移動して、npm start と入力して client サービスを起動します。
  11. コマンド プロンプト、またはターミナル ウィンドウを開き、Experience Builder のインストール先の server ディレクトリに cd コマンドで移動して、npm start と入力して server サービスを起動します。

Experience Builder (Developer Edition) を使用するために Client ID が必要になります。Client ID を作成するために ArcGIS Online または ArcGIS Enterprise に接続します。

ここでは、ArcGIS Online または ArcGIS Enterprise を使用した Client ID の作成手順について示します。

  1. ArcGIS Online または ArcGIS Enterprise ポータルにログインし、コンテンツ ページの マイ コンテンツ タブに移動して、新しいアイテム をクリックし、アプリケーション を選択します。

  2. アプリケーション タイプ で 他のアプリケーション を選択します。

  3. ダイアログボックスで、以下のパラメータを入力し、保存 をクリックします。

    • タイトル - 例えば、Experience Builder credentials などの任意のタイトルをを入力します。
    • フォルダー - アイテムを保存する任意のフォルダーを選択します。
    • タグ - Experience Builder のような内容を入力します。
    • サマリー - アイテムのサマリーを入力します。

  4. 設定 タブをクリックします。アプリケーションの登録の項目までスクロールして、更新 をクリックします。

  5. 登録情報 ダイアログ ボックスで、次のように、リダイレクト URI に https://localhost:3001/ と入力し、追加をクリックして、更新 をクリックします。アプリケーション ID は、このあとの手順で使用するため、コピーなどをして控えておきます。

  6. 次の URL https://localhost:3001/ を指定して Experience Builder をブラウザで開きます。

  7. ポータルの URL には、ArcGIS Online または ArcGIS Enterprise の組織サイトの URL を指定し、5. で作成した アプリケーション ID を指定します。すべてを指定したらサイン インをクリックします。

  8. サイン イン後の流れについては、2. server サービスのインストールのステップ5 以降を参照してください。

Windows サービスとしてインストール

  1. お使いの OS に対応した最新の Node.js LTSバージョンをダウンロードし、インストールしてください。

  2. Windows のコマンドプロンプトを管理者権限で開きます。

  3. Experience Builder の /server ディレクトリにディレクトリを変更 (cd) します。

  4. npm ci コマンドを実行し、依存関係をインストールします。

  5. npm run install-windows-service のコマンドを実行します。

  6. Windows サービスアプリを開き、Experience Builder サービス（デフォルト名：exb-server）を起動します。

  7. Experience Builder サービスを削除するには、 npm run uninstall-windows-service というコマンドを実行します。