摘要
有时组织需要在完全断开连接的环境下工作,在这种环境中,他们无法访问外部的 internet。 其他组织可能处于连接状态,但需要在您自己的基础架构上托管 ArcGIS Survey123 网站和/或 Survey123 REST API。
Survey123 REST API 用于将您的调查配置转换为表单以在 Survey123 应用程序(外业应用程序/web 表单)中使用,例如已连接的创建的 .xlsx 文件或网站创建的配置。 另一方面,网站提供了创建和管理调查与查看和分析收集的数据的功能。 这两个组件是分开的,但它们会一起工作以提供 ArcGIS Survey123 网站 (https://survey123.arcgis.com) 中所示的功能。
包含哪些内容
Survey123 REST API 和网站的本地安装将启用从 Survey123 Connect 或您自己基础架构上的网站创建和发布调查。 这将提供 ArcGIS Survey123 网站的大多数完整功能,但值得注意的是,报告 API 还不能在本地托管。
有哪些要求
需要从 My Esri 网站下载安装程序文件。 以下安装步骤仅适用于 Windows 安装。 同时需要的还有 ArcGIS Enterprise 门户管理员凭据,以及 web 服务器的管理员权限。 Survey123 网站安装程序可作为门户实例部署在同一台计算机上,也可以安装在独立 web 服务器上。 虽然已安装的 Survey123 网站已在 ArcGIS Enterprise 门户 10.5.1 及更高版本中成功测试,但初始版本仅正式支持 10.7 及更高版本。
过程
安装
Windows:
将下载的文件解压缩到所需的计算机,然后运行 Setup.exe。 接受主协议,选择安装位置,然后单击安装。 此过程可最多花费大约 30 分钟。 此过程完成后,请单击完成退出安装程序。
Linux:
警告: 必须在 Unix 计算机上提取此处包含的存档文件。 如果在 Windows 计算机上执行此操作,则其将失去正确运行安装程序所需的权限,并且可能会更改某些文件名大小写。
- 在终端中使用命令 gunzip [filename].tar.gz,后跟 tar xf [filename].tar,在要安装 Survey123 网站的计算机上提取 .tar.gz 文件的内容。
- 提取内容后,在终端中运行 ./Setup,接受主协议,选择安装位置,然后单击安装。 该过程可能需要大约 5-10 分钟。 此过程完成后,请单击完成退出安装程序。
安装后配置
根据 ArcGIS Enterprise 环境的不同,配置已安装的 Survey123 网站的步骤也有所不同。 请参阅下面的相关部分。注: 您的浏览器可能会遇到安全警告。 接受并继续访问网站,这可以通过在安装后配置证书来解决
注: 在运行安装后配置之前,请备份 config.json 文件(默认位置为 C:\Program Files\ArcGIS\Survey123website)。 如果安装配置不正确,则可以使用此文件来还原并重新启动(或对现有 config.json 进行手动编辑)。
具有内置身份验证的 ArcGIS Enterprise
通过在安装计算机上打开 https://localhost:5443/share/post-install.html 来运行安装后配置。
安装后配置显示了类似调查的向导来编辑 config.json 文件。 这将配置以下各项:
- 默认 ArcGIS Portal URL(默认指向 ArcGIS Online 的安装)
- ArcGIS Portal 管理凭据(需要设置重定向 Portal 登录的 URI)
- ArcGIS JavaScript API(需要断开连接的环境)
- HTTP 端口
- SSL 证书
- Survey123 网站托管 URL(这是托管 Survey123 网站的计算机的 http 或 https URL - 切记添加端口号)。 这是作为 redirectURI 添加到 Portal 以允许登录。
- 断开连接的环境的设置。 在“是否在没有 Internet 访问的断开连接的环境中安装 Survey123 网站?”问题中选择是。设置 Survey123 组织属性,以防止 Survey123 Connect 拨打 internet 电话(用于教程视频、Twitter 和 Geonet 等)。
确认设置并单击提交将更新 config.json 文件,
- 它也将证书文件倒入到 ~ArcGIS\Survey123website\server\dist\cert\ 文件夹
- 追加 Survey123 网站主机 URL 作为到 survey123hub AppID 的 redirectURI。
- 更新 Survey123 组织属性(basemapsGroupQuery、showCommunityContent 和 showTutorialContent)
在文本编辑器中打开 config.json 文件以查看更新的设置。
具有 Windows 身份验证的 ArcGIS Enterprise (IWA)
- 如果 Survey123 网站未与 ArcGIS Enterprise 安装在相同的主机 URL 上,请参阅以下手动运行安装后配置部分。
- 如果 Survey123 网站与 ArcGIS Enterprise 安装在相同的主机 URL 上,则允许在浏览器中使用 ArcGIS Enterprise (IWA) 登录凭据。请转到以下安装后配置的 URL:
https://<survey123website.domain >:5443/share/post-install.html
这将允许 ArcGIS Enterprise (IWA) 登录凭据可以在浏览器中使用。
安装后配置将会设置以上列出的所有内容,但需要 ArcGIS Enterprise 管理员手动将 Survey123 网站主机 URL:https://<survey123website.domain>:5443 添加为 Portal 的 redirectURI,以允许登录:
- 登录门户管理 REST 接口,例如:
- https://portal_webadaptorhost.domain /portal_webadaptorname/portaladmin
- 转到安全性 > OAuth > 获取应用程序信息,然后输入应用程序 ID survey123hub,然后单击获取应用程序信息。
- 复制响应的内容。
- 返回到 OAuth,然后转至“更新应用程序信息”。
- 将复制的响应粘贴到输入框中,确保将用于访问 Survey123 网站的 URL 添加到 redirectURI 列表中,然后单击“更新应用程序”。如果要设置反向代理访问点,则可能将包括反向代理访问点,例如:
- https://survey123website.domain /survey123
- 重复步骤 2 以确认您的附加 redirectURI 已成功添加到列表中。
手动运行安装后配置
- 将证书文件(.pfx 或 .pem)复制到 cert 文件夹进行安装,例如:
- ~\ArcGIS\Survey123website\server\dist\cert\
- 如果使用 .pfx 文件,您需要通过向已安装的 Survey123 REST API 发出请求加密密码。 然后,响应可复制到 config.json 文件(请参阅下文)。
- 通过使用 encrypt?text= 参数将 .pfx 密码扩展到 API URL 可以完成操作,例如:
- https://<survey123website.domain>:5443/api/encrypt?text=<your_pfx_password>
- 响应的格式为:{"result":"a6c2812bed063dd9be"},仅需复制结果 a6c2812bed063dd9be 以供稍后在 config.json 文件中使用。
- ArcGIS Enterprise 管理员需要手动添加 Survey123 网站主机 URL,例如:
- https://<survey123website.domain>:5443 - 这是 Portal 的 redirectURI。 请参阅上一部分中的步骤 1 到 5。
- 检查 Portal 是否限制可通过跨域资源共享 (CORS) 连接到 ArcGIS REST API 的域:
- 以管理员身份登录到 ArcGIS Enterprise,转至组织 > 设置 > 安全性 > 允许原点组。 默认情况下,将允许所有的域,即此处的列表中没有 URL。 如果您已限制域,请将 Survey123 主机 URL 添加到列表中。
- 单击添加,然后添加 Survey123 网站主机 URL。 例如:
- https://<survey123website.domain >:5443
- 单击添加域。 这使您的 Survey123 web 应用程序域可以通过 (CORS) 连接到 ArcGIS REST API。
- 在文本编辑器中打开 config.json。 它可以在 Survey123 网站的根文件夹中找到,例如:~\ArcGIS\Survey123website
- 根据需要更新以下参数:
- portalUrl:ArcGIS Enterprise URL,例如:https://portal_webadaptorhost.domain.com/portal_webadaptorname
- arcgisJsAPi3Url:ArcGIS JavaScript v3.x API URL,例如:https://portal_webadaptorhost.domain.com/portal_webadaptorname/jsapi/jsapi/init.js
- arcgisJsApiUrl:ArcGIS JavaScript v4.x API URL,例如:https://portal_webadaptorhost.domain.com/portal_webadaptorname/jsapi/jsapi4/init.js
- httpPort:Survey123 网站 HTTP 端口(默认为 5080)
- https.port:Survey123 网站 HTTP 端口(默认为 5443)
- https.cert:Survey123 网站 HTTPS Base64 Ascii 服务器证书 (.pem) 的路径(默认为 "./server/dist/cert/cert.pem")。
- https.key:Survey123 网站 HTTPS Base64 Ascii 服务器证书密钥 (.pem) 的路径(默认为 "./server/dist/cert/key.pem")。
- https.pfx:Survey123 网站 HTTPS 二进制证书文件 (.pfx) 的路径,例如:"./server/dist/cert/your_certificate.pfx"
- https.passphrase:Survey123 网站 HTTPS 二进制证书的加密密码。 请使用上述 https://<survey123website.domain>:5443/api/encrypt?text=<your_pfx_password> 的结果以获取加密的密码。
- 保存 config.json 文件。
- 重新启动 ArcGIS Survey123 网站 Windows 服务和 Linux 上的 survey123 服务以使更改生效。