appSettings.json ファイルの参照

appSettings.json ファイルは、ArcGIS Documentation Center でアプリケーション設定を保存するために使用する構成ファイルです。 IT 管理者はカスタム appSettings.json ファイルを作成およびデプロイして、複数のユーザー向けにアプリを構成できます。 このトピックでは、このファイルのすべての設定について説明します。

appSettings.json の構造

appSettings.json ファイルは次の構造を持つ JSON ファイルです:

{
  "init": <boolean>,
  "allowedHosts": <string>,
  "endpoints": {
    "documentationSets": {
      "url": <string>
    },
    "webHelp": {
      "url": <string>
    },
    "softwareUpdate": {
      "url": <string>
    }
  },
  "webServer": {
    "defaultFileNames": [<string>, ...],
    "portPreferences": [
      {
        "order": <number>,
        "port": <number>
      },
      ...
    ],
    "portScan": {
      "minValue": <number>,
      "maxValue": <number>,
      "limit": <number>
    },
    "rootFolder": <string>
  },
  "language": <string>,
  "theme": <string>

appSettings.json パラメーター

init

• タイプ: ブール値

アプリが設定で初期化されているかどうかを示します。 これは、初めて構成ウィザードが完了した後に true に設定されます。 IT 管理者は、これを true に設定することで、アプリの初回起動時に構成ウィザードをスキップできます。 init を false に設定すると、ユーザーがアプリを起動した際に構成ウィザードが開きます。カスタム appSettings.json ファイルをデプロイする場合は、構成ウィザードが開いてカスタム設定が上書きされることがないように init を true に設定してください。

allowedHosts

• タイプ: string

アプリがアクセスできるホストを指定します。 この設定を使ってネットワーク アクセスを制御します。 次の値に設定できます:

• * (アスタリスク): すべてのホストへのアクセスを許可します。

• 特定のホストのカンマ区切りリスト (doc.esri.com,example.com など)。 一般的に、複数のホストの指定は必要ありません。

• 単一のホスト: 1 つのホスト (doc.esri.com など) のみへのアクセスを許可します。

• 空文字列 (""): すべてのネットワーク アクセスをブロックします。 これにより、ドキュメント セットのダウンロードなど、ネットワーク アクセスが必要な機能が無効化されます。 この設定を使って、アプリがインターネットにアクセスできないようにすることができます。 共有ルート フォルダーを使用している場合は、ユーザーがドキュメント セットをダウンロードできないようにすることもできます。

endpoints

• タイプ: オブジェクト

アプリで使用されるさまざまなサービスの URL エンドポイントを含みます。各エンドポイントには、そのサービスの URL を指定する url プロパティがあります。 一般的に、これらの URL の変更は必要ありません。

エンドポイントの URL に空の文字列を指定することでそれらのサービスへのアクセスを無効にできますが、アプリがインターネットにアクセスできないようにする場合は、上記のように allowedHosts を空の文字列に設定することをおすすめします。

endpoints.documentationSets.url

• タイプ: string

アプリでユーザーがドキュメント セットを参照してダウンロードできる ライブラリー タブに使用される URL です。 デフォルトの URL は、ドキュメント セットの Esri のオンライン リポジトリーである https://doc.esri.com/offline-help/packages/all です。

一般的に、この URL の変更は必要ありません。

Web ブラウザーでデフォルトの URL に直接アクセスしても、ドキュメント セットは表示されません。 この URL にアクセスできるのはアプリだけです。

endpoints.webHelp.url

• タイプ: string

ユーザーが メニュー > ヘルプ ボタンから ArcGIS Documentation Center のヘルプを開く際に使われる、オンライン バージョンのドキュメントの URL です。

一般的に、この URL の変更は必要ありません。

endpoints.softwareUpdate.url

• タイプ: string

このプロパティは現在アプリで使用されていません。

webServer

• タイプ: オブジェクト

アプリに付属しているローカル Web サーバーの設定を含みます。 サブプロパティには defaultFileNames、portPreferences、portScan、rootFolder があり、以下で詳しく説明します。

webServer.defaultFileNames

• タイプ: 文字列の配列

特定のパスが定義されていない場合に開くファイル名とファイル タイプを指定します。 一般的に、このオブジェクトの変更は必要ありません。

デフォルト値は ["index.html", "default.html"] です。

webServer.portPreferences

• タイプ: order および port プロパティを含むオブジェクトの配列

order プロパティは、指定された port をローカル サーバーが使用する優先順位を定義します。 アプリはまず、order が 0 のポート、その後 order が 1 と 2 のポートの使用を試します。

port プロパティはローカル サーバーで使用するポート番号を指定します。 デフォルトのポート番号は 13774、13322、14357 です。

優先ポートがどれも利用できない場合は、アプリが webServer.portScan 設定を使って利用可能なポートを自動的に検索します。

すべてのポート番号が同じである場合、アプリはその 1 つのポート番号だけを試し、そのポートが使用できない場合は、利用可能なポートの自動検索にフォールバックします。

webServer.portScan

• タイプ: minValue、maxValue、limit プロパティを含むオブジェクト

minValue および maxValue プロパティは、webServer.portPreferences で定義された優先ポートが利用できない場合に、利用可能なポートをスキャンするためのポート番号の包含範囲を定義します。 limit プロパティは、その範囲内で中止するまでに試してみるランダムなポートの数を定義します。

デフォルトの範囲は 30000 ～ 20000 で、デフォルトの試行回数は 10 です。

単一のフォールバック ポートに制限するには、minValue と maxValue を同じポート番号に設定し、limit を 1 に設定します。

webServer.rootFolder

• タイプ: string

ドキュメント セットがダウンロードおよびアクセスされるルート フォルダーを指定します。 これはローカル パスまたはネットワーク パスにすることができます。 デフォルト値は C:\\Users\\<username>\\Documents\\ArcGIS\\DocCenter\\rootFolder で、<username> は Windows のユーザー名です。

共有ルート フォルダーのネットワーク パスを指定するには、UNC 形式 (\\\\<server_name>\\<folder_path>) を使用します。 たとえば、Polaris という名前のサーバーに、ドキュメント セットが格納される共有ルート フォルダー doc_share\arcgis_docsets がある場合は \\\\Polaris\\doc_share\\arcgis_docsets になります。

language

• タイプ: string

アプリのインターフェイスの表示言語を指定します。 有効な値は、下記の言語コードです。

• de: ドイツ語

• en: 英語

• es: スペイン語

• fr: フランス語

• ja: 日本語

• ru: ロシア語

• zh-CN: 簡体字中国語

表示言語はダウンロードされたドキュメント セットの言語と異なる場合があります。 たとえば、ユーザーはアプリのインターフェイスを英語で表示し、日本語のドキュメント セットをダウンロードすることができます。

表示言語に基づいて、アプリ内のドキュメント セットのリストにはデフォルトのフィルターが適用されます。 たとえば、表示言語が英語の場合、アプリにはデフォルトで英語コンテンツのドキュメント セットのみが表示されます。 ユーザーはフィルターを解除して、他の言語のドキュメント セットを表示およびダウンロードできます。

theme

• タイプ: string

アプリのインターフェイスのテーマを指定します。 有効な値は次のとおりです:

• Theme.Auto: アプリはオペレーティング システムのテーマと同じテーマを使用します。 ユーザーが Windows のテーマをライトに設定している場合、アプリはライト テーマを使用します。 ユーザーが Windows のテーマをダークに設定している場合、アプリはダーク テーマを使用します。

• Theme.Light: アプリはライト テーマを使用します。

• Theme.Dark: アプリはダーク テーマを使用します。

関連トピック

• アプリの構成 (IT 管理者)

• 構成ウィザードを使用したアプリの構成

• アプリケーション状態ファイル