Skip to main content

配置 ArcGIS Documentation Center(IT 管理员)

安装 ArcGIS Documentation Center 后,下一步是配置该应用程序。IT 管理员可以通过向每个用户的计算机部署 appSettings.json 文件来配置该应用程序。 此文件供应用程序用于存储用户可修改的参数。 该文件位于用户的 %LocalAppData%\ESRI\ArcGISDocCenter 文件夹中。

重要信息:

用户可以通过应用程序中菜单 > 设置 下的选项修改并覆盖其中的许多设置。

为多个用户配置应用程序的常规步骤如下:

  1. 创建 appSettings.json 文件

  2. 将该文件部署到每个用户系统上的 %LocalAppData%\ESRI\ArcGISDocCenter 目录中。

重要信息:

'appSettings.json' 文件可能已经存在于用户的系统中。 该文件卸载过程中文件不会自动删除,以保存用户设置以供后续安装使用。 用户也可以在首次打开应用程序时创建该文件。 您可以删除现有文件,或者用自定义文件覆盖。

创建 appSettings.json 文件

通过执行以下操作来创建用于管理 Doc Center 设置的文件:

  1. 创建一个名为 appSettings.json的文件。

  2. 将以下内容复制并粘贴到该文件中:

    {
      "init": true,
      "allowedHosts": "*",
      "endpoints": {
        "documentationSets": {
          "url": "https://doc.esri.com/offline-help/packages/all"
        },
        "webHelp": {
          "url": "https://doc.esri.com/en/arcgis-doc-center/"
        },
        "softwareUpdate": {
          "url": "https://doc.esri.com/offline-help/installer/"
        }
      },
      "webServer": {
        "defaultFileNames": [
          "index.html",
          "default.html"
        ],
        "portPreferences": [
          {
            "order": 0,
            "port": 13774
          },
          {
            "order": 1,
            "port": 13322
          },
          {
            "order": 2,
            "port": 14357
          }
        ],
        "portScan": {
          "minValue": 20000,
          "maxValue": 60000,
          "limit": 10
        },
        "rootFolder": "\\\\<server_name>\\<folder_path>"
      },
      "language": "en",
      "theme": "Theme.Auto"
    }
    
  3. 通过修改 webServer 下的 rootFolder 更改根文件夹,如下所示:

    "rootFolder": "\\\\<server_name>\\<folder_path>"
    

    例如,名为 Polaris 的服务器有一个共享根文件夹 arcgis_documentation,文档集将存储在其中:

    "rootFolder": "\\\\Polaris\\arcgis_documentation"
    

    此例子使用共享根文件夹,但您也可以为根文件夹指定本地路径,比如典型的默认位置:C:\\Users\\<username>\\Documents\\ArcGIS\\DocCenter\\rootFolder,其中 <username> 是 Windows 用户名。

  4. (可选)通过修改 webServer 下的 portPreferences 为本地帮助 Web 服务器设置静态端口,如下所示:

     "portPreferences": [
       {
         "order": 0,
         "port": <first_port_number>
       },
       {
         "order": 1,
         "port": <second_port_number>
       },
       {
         "order": 2,
         "port": <third_port_number>
       }
     ],
    

    其中 port 是可用的端口号,order 是这些端口被使用时从零开始的序列号。 以下示例将所有三个端口都设置为自定义端口号:

     "portPreferences": [
       {
         "order": 0,
         "port": 13445
       },
       {
         "order": 1,
         "port": 13447
       },
       {
         "order": 2,
         "port": 13449
       }
     ],
    
    注:

    默认端口号按顺序分别为:13774、13322 和 14357。

    如果所有端口号都相同,应用程序只会尝试该端口号,如果该端口不可用,则会自动寻找可用的端口。 您也可以将端口范围限制为单个数字,从而将回退端口限定为单个端口。 有关此方面的详细信息,请参阅 appSettings.json 参考。

appSettings.json 示例

下方显示了 appSettings.json 文件的示例。 该示例使用了默认端口号,但添加了一个自定义根文件夹。 有关完整设置列表的信息,请参阅 appSettings.json 参考。

{
  "init": true,
  "allowedHosts": "*",
  "endpoints": {
    "documentationSets": {
      "url": "https://doc.esri.com/offline-help/packages/all"
    },
    "webHelp": {
      "url": "https://doc.esri.com/en/arcgis-doc-center/"
    },
    "softwareUpdate": {
      "url": "https://doc.esri.com/offline-help/installer/"
    }
  },
  "webServer": {
    "defaultFileNames": [
      "index.html",
      "default.html"
    ],
    "portPreferences": [
      {
        "order": 0,
        "port": 13774
      },
      {
        "order": 1,
        "port": 13322
      },
      {
        "order": 2,
        "port": 14357
      }
    ],
    "portScan": {
      "minValue": 20000,
      "maxValue": 60000,
      "limit": 10
    },
    "rootFolder": "\\\\Tycho\\doc_share\\arcgis_docsets"
  },
  "language": "en",
  "theme": "Theme.Auto"
}