Ссылка на файл `appSettings.json`

Файл appSettings.json является конфигурационным файлом, используемым ArcGIS Documentation Center для хранения настроек приложения. ИТ-администраторы могут создавать и развертывать пользовательский файл 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`

Тип: boolean

Показывает, было ли приложение инициализовано с настройками. Установлено как true после первого завершения мастера конфигурации. ИТ-администраторы могут установить этот параметр как true, чтобы пропустить мастер настройки при первом запуске приложения. Установив параметр init на false, мастер настройки откроется при запуске приложения, поэтому если вы развёртываете пользовательский файл appSettings.json, стоит установить параметр init на true, чтобы мастер настройки не открывался и, возможно, перезаписывал ваши пользовательские настройки.

`allowedHosts`

Тип: string

Указывает, к каким хостам может получить доступ приложение. Используйте эту настройку для управления доступом к сети. Значение можно задать следующим образом:

* (звездочка) чтобы дать доступ всем хостам.
Список конкретных хостов, разделённых запятыми, например, doc.esri.com,example.com. Указывать несколько хостов обычно не обязательно.
Один хост, позволяющий получить доступ только к одному хосту, например doc.esri.com.
Пустая строка ("") для блокировки всего доступа к сети. Это отключает функции, требующие доступа к сети, например, загрузку наборов документации. Возможно, стоит использовать эту настройку, чтобы запретить приложению доступ к интернету. Также вы можете запретить пользователям загружать наборы документации, если вы используете общую корневую папку.

`endpoints`

Тип: object

Содержит URL конечных точек различных сервисов, используемых приложением. Каждая конечная точка имеет свойство url, указывающее URL для этого сервиса. Изменение этих URL обычно не требуется.

Вы можете задать пустые строки для URL конечных точек, чтобы отключить доступ к этим сервисам, но если хотите вообще не дать приложению доступ к интернету, лучше установить параметр allowedHosts как пустую строку, как описано выше.

`endpoints.documentationSets.url`

Тип: string

URL, который приложение использует для вкладки Библиотека, где пользователи могут просматривать и загружать наборы документации. По умолчанию URL — https://doc.esri.com/offline-help/packages/all, который является онлайн-репозиторием наборов документации Esri.

Изменение этого URL обычно не требуется.

Прямой доступ к URL по умолчанию в веб-браузере не покажет наборы документации. Только приложение может получить доступ к URL.

`endpoints.webHelp.url`

Тип: string

URL онлайн-версии документации, которая используется, когда пользователь открывает справку ArcGIS Documentation Center из кнопки Меню > Справка.

Изменение этого URL обычно не требуется.

`endpoints.softwareUpdate.url`

Тип: string

Это свойство в настоящее время не используется приложением.

`webServer`

Тип: object

Содержит настройки для локального веб-сервера, который входит в приложение. К подсвойствам относятся defaultFileNames, portPreferences, portScan и rootFolder, которые описаны более подробно ниже.

`webServer.defaultFileNames`

Тип: array of strings

Указывает имена файлов и типы файлов, которые будут открыты, если конкретный путь не определён. Модификация этого объекта, как правило, не требуется.

Значение по умолчанию равно ["index.html", "default.html"].

`webServer.portPreferences`

Тип: массив объектов со свойствами order и port

Свойство order определяет порядок предпочтений для локального сервера для использования указанного port. Приложение попытается использовать порт сначала с order 0, затем order 1 и 2.

Свойство port указывает номер порта для использования для локального сервера. Стандартные номера портов: 13774, 13322 и 14357.

Если ни один из предпочтительных портов не доступен, приложение автоматически найдёт доступный порт через настройки webServer.portScan.

Если все номера портов одинаковые, приложение попробует только этот номер порта, а затем, если этот порт окажется недоступным, автоматически переключится на поиск доступного порта.

`webServer.portScan`

Тип: object со свойствами minValue, maxValue, и limit

Свойства minValue и maxValue определяют весь диапазон номеров портов для сканирования доступного порта, если предпочтительные порты, определённые в webServer.portPreferences , отсутствуют. Свойство limit определяет, сколько случайных портов стоит попробовать в этом диапазоне, прежде чем сдаться.

Диапазон по умолчанию с 20000 до 30000, а количество попыток по умолчанию — 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: Приложение будет использовать тёмную тему.

Ссылка на файл appSettings.json

appSettings.json структура

appSettings.json параметры

init

allowedHosts

endpoints

endpoints.documentationSets.url

endpoints.webHelp.url

endpoints.softwareUpdate.url

webServer

webServer.defaultFileNames

webServer.portPreferences

webServer.portScan

webServer.rootFolder

language

theme

Связанные разделы