web 工具设置

在将工具共享为 web 工具时选择的参数设置可定义客户端应用程序使用它们的方式。 可以在共享时设置最常见且频繁更改的工具参数。 共享该工具之后,可在 ArcGIS Server Manager 中更改不太常见的设置。 一些高级设置只能在 ArcGIS Server Administrator REST API 上进行设置。 很少有 Web 工具(地理处理服务)需要更改高级设置。

设置

以下小节描述了共享 web 工具时可以使用的设置。

常规

以下常规参数设置可用:

参数描述

名称

将共享至门户的 web 工具的名称。 此名称在门户中必须是唯一的,且不能包含空格或特殊字符。 此参数可继承自工具元数据。

摘要

帮助描述文档并使 web 工具可搜索的摘要和标签。 这些参数继承自工具元数据。 共享至 ArcGIS Enterprise 10.9 或更低版本的门户时,需要摘要和标签。

最多可以使用 128 个标签。

标签

版本

将共享至的 ArcGIS EnterpriseArcGIS Server 的版本。 仅当保存地理处理服务Web 工具的离线服务定义时,才会启用此参数。

数据

指定数据将会发生什么:

  • 非 URL 数据 - 控制数据是复制到服务器(变为静态)还是保持由 Web 工具引用。 必须为数据设置服务器数据存储中的匹配条目,才能使用引用注册数据选项。 如果服务器数据存储未设置数据,则将在发布期间复制数据。 这仅在发布为 Web 工具另存为连接的服务定义时适用。 如果将结果另存为离线服务定义且选择引用数据选项,请确保可以引用所有参数数据,因为如果服务器数据存储未设置数据,则没有其他可复制数据的替代方法。
  • URL 数据 - 控制数据在发布期间是保持 URL 形式还是转换为其他数据类型。 在 ArcGIS Pro 3.2 或更高版本中提供此选项。 URL 数据是指不同类型的 Web 图层服务的 URL。 只能配置要素图层要素服务Web 图像图层的要素子图层。 转换要素图层复选框处于选中状态时,参数或工程数据的要素图层或服务将在发布期间转换为要素类。 如果未选中,则会保留要素图层 URL。 系统未提供转换 Web 图像图层 URL 的选项,因为在发布过程中将始终保留 URL。 此选项默认为选中。

有关复制、引用和使用 URL 数据的详细信息

位置

指定将在其中创建 web 工具项目的位置:

  • 文件夹 - 选择或创建将在其中创建 web 工具项目的门户文件夹。 默认文件夹为门户的根目录。
  • 服务器和文件夹 - 对于服务器来说,必须将 Web 工具共享到具有一个或多个联合服务器的门户。 如果门户具有多个联合服务器,则可以指定将发布 web 工具的服务器。 对于文件夹来说,您可以在 ArcGIS Server 站点上选择现有文件夹或创建文件夹。 默认设置为 ArcGIS Server 站点的根。

共享给

指定 web 工具将共享到的用户和群组。 web 工具将始终共享到我的内容。 将 web 工具共享给所有人会使项目变为公开状态;拥有门户网站访问权限的任何人都可以找到并使用您的项目,并且群组的所有者也可以将您的项目包含在其群组内容中。 将 Web 工具共享到 ArcGIS Enterprise 会将 Web 工具与门户中所有有权访问项目的成员共享。 可共享到您当前所属的任何组。

配置

以下配置参数设置可用:

参数描述

上传

控制客户端是否可以将文件上传到服务器以供 web 工具用作输入。 上传操作通常由 web 客户端使用,这些客户端需要一种方式将文件发送至服务器以供处理。 上传操作会在上传完成后返回该文件的唯一 ID,web 应用程序会将此唯一 ID 传递给 web 工具。

此选项默认关闭。 允许向您的服务进行上传可能会造成安全风险。 仅在需要时将其打开。

执行模式

指定客户端(使用 web 工具的应用程序)如何与 web 工具进行交互以及如何获取输出。 web 工具设置为同步时,客户端将等待任务完成。 通常,同步服务会快速运行完成(几秒钟内)。 如果设置为异步,则运行服务通常需要较长的时间,并且客户端必须定期检查服务器以确定服务是否已完成,如果已完成,则获取结果。 使用异步任务的 Web 应用程序必须已实施逻辑,才能在运行完成后检查任务状态并处理结果。

查看地图图像图层中的输出

发布 web 工具时,可以以地图图像形式来查看输出。 地图图像在服务器上创建,并以图像形式(带有样式信息的 .tiff 文件)传输回客户端。 地图图像的符号系统、标注、透明度和其他属性与最初发布时的 ArcGIS Pro 会话中的输出图层完全相同。 以下是使用在地图图像图层中查看输出的原因:

  • 如果工具输出大量的要素而且客户端必须进行符号化和绘制,那么对于该客户端来说,接收地图图像可能会更迅速。
  • 由于数据分布的原因,您不希望向客户端发送任何要素,而仅仅是发送地图图像。
  • 工具的结果是一个不可传输的数据集,例如网络或拓扑。 向客户端发送输出的唯一方法是使用地图图像。
注:

只有在 Web 工具设置为异步时,才能使用输出地图图像。

将 web 工具发布到 Kubernetes 时,此参数不受支持。

消息级别

可按如下步骤将不同级别的信息返回给已运行 web 工具的客户端:

  • - 不会向客户端返回任何地理处理消息,只有操作是成功还是失败的指示。 这是默认设置。
  • 错误 - 仅向客户端返回产生错误的工具消息。
  • 警告 - 向客户端返回所有工具错误消息和警告消息。
  • 信息 - 向客户端返回操作产生的所有工具消息。
警告:

所有消息,无论级别如何,都可能包含数据集路径和名称,这可能会带来安全风险。 信息级别会更加详细且通常包含数据集路径和名称的参考。 通常,在开发阶段返回消息,而在生产阶段将其关闭。

返回的最大记录数

服务可以返回给客户端的最大结果数。 将此值设成一个较大数值意味着 GIS 服务器可处理发送大量的个人记录或要素给客户端。 如果您不希望返回任何要素,请将此值设为 0(零)。 通常情况下,只有当您启用在地图图像图层中查看输出时才将此值设为零。

共享 web 工具之后,可在 ArcGIS Server Manager 中修改上述参数设置(不包括摘要和标签)。 可在门户的共享 web 工具的项目页面中更新此描述信息。

内容

以下设置只能在发布 web 工具时进行修改。

添加工具

要将工具从地理处理历史记录添加至现有 web 工具,请单击内容选项卡上的添加工具按钮 添加工具。 要移除工具,请单击工具名称并选择移除

配置工具属性

要配置工具属性,请单击工具名称旁的编辑按钮 配置工具属性

属性描述

名称

工具的名称。 默认值基于工具元数据。

描述

工具的描述。 描述无法从工具元数据继承。 如果描述为空白,请提供描述,每次从历史共享时描述都将保留。

可以为每个参数配置以下属性:

属性描述

名称

参数的名称和描述。 两个属性分别继承自工具元数据的参数名称和描述。 您可以在此处修改它们,而不会影响原始工具的元数据。

描述

类型

参数类型定义了客户端是否必须给出一个值以使工具成功运行。 在内容选项卡中,只能将可选参数改为必要参数。 为了将必要参数改为可选参数,请退出共享窗格,编辑工具属性,然后再次运行工具以创建新结果。

保持数据类型为复合

仅当参数为复合数据类型时,此属性才可用。 用于指定参数是否将发布为复合数据类型(选中)。 默认情况下取消选中该项。

输入模式

指定客户端将向任务输入要素的方式。 有关 GUI 设计和用法,请参阅参数的输入模式

  • 用户定义值 - 客户端将提供参数的值。
  • 选择列表 - 系统将提供字符串列表(选择列表),客户端必须从选择列表中选择一个或多个字符串。 根据输入的数据类型,字符串可以是图层名称或简单关键字选项。
  • 常量 - 将使用您在创建结果时为参数提供的值。 由于该值为常量,所以客户端无法对其进行更改,因此在发布服务时该值不会成为任务参数。
  • 混合模式:用户定义和选项列表 - 仅适用于复合或值表参数。 可以为复合中的每种数据类型或值表中每列的每种数据类型配置输入模式。 如果任何数据类型不支持选择列表,则仅用户定义的选项可用于配置。

将数据类型转换为字符串

此属性仅适用于面积单位数据类型。 用于指定面积单位是否将转换为字符串数据类型(选中)或者发布为面积单位(未选中)。 默认情况下取消选中该项。

移除默认值

ArcGIS Pro 3.3 起,如果选中该项,则将在发布过程中移除在运行该工具时使用的默认值。 默认情况下取消选中该项。

默认值

工具的默认值由工具运行时指定的参数值决定。 要添加或更改参数的默认值,请使用相应的参数再次运行该工具。

仅使用默认图层

此属性仅适用于选择列表输入模式。 用于指定是否仅在此复选框下的列表视图中选中运行该工具时使用的选项(已选中)。 默认情况下取消选中该项。

几何类型

此属性仅适用于要素。 几何类型来自用于创建结果的输入和输出要素。 无法在内容选项卡上进行修改。 您必须使用指定几何类型的要素重新运行该工具,并共享该操作所创建的结果。

方案

此属性仅适用于要素和表。 方案是构造作为工具输入的要素时客户端必须提供的字段(属性)列表。 该字段列表与用作结果创建工具的输入或输出的图层或数据集相同。

以下配置参数适用于整个工具:

参数描述

添加可选输出要素服务参数

可选输出参数,用于指定当使用 web 工具时是否可将输出另存为要素服务(已选中)。 仅当以异步模式发布为 web 工具时,才支持此参数。 否则,此参数不适用于配置。 默认选中该选项。

移除所有默认值

ArcGIS Pro 3.3 起,如果选中该项,则将移除在运行该工具时使用的所有默认值,并且将自动选中以上工具参数配置中的移除默认值复选框。 默认取消选中该项

ArcGIS Server Manager 设置

只能在 ArcGIS Server Manager 中修改以下各小节中的参数设置。 发布服务后,还可以在 ArcGIS Server Manager 中修改上述配置设置。

注:

修改以下任何设置将导致服务重启。

参数

可用的参数设置如下:

参数描述

集群

服务运行的集群。 仅当 ArcGIS Server 参与集群时,才能修改此设置。

目录

当运行该工具时,服务器用于写入文件的目录。

功能

可用的功能参数设置如下:

参数描述

WPS

对地理处理服务启用 WPS 功能,使其他客户端能够通过 OGC 标准协议连接并使用工具。

了解有关 WPS 的详细信息

池化

可用的池化参数设置如下:

参数描述

实例数

服务的最小实例数和最大实例数。 默认值为 1(最小值)和 2(最大值)。 将最小值设为 0 将减少系统资源;实例将根据客户端请求启动。

客户端可使用服务的最长时间

一个服务能被使用的最长时间(以秒计)。 对于长时间运行的地理处理任务,可能需要将默认值增加 600 秒(10 分钟)。 或者,可以缩短此时间以确保客户端不会利用这些服务。

客户端获取服务需等待的最长时间

客户端在超时之前将等待连接到实例的最长时间(以秒为单位)。 当所有实例都在忙于处理请求时,随后的请求将排队。 如果在实例变为可用状态之前超时,则任务会失败。 默认值为 60 秒(1 分钟)。

空闲实例可持续运行的最长时间

实例在池收缩之前将继续处于活动状态的最长时间(以秒为单位)。 对于所有超出最小实例数且未被使用的实例,一旦达到最长空闲时间,即会被关闭。

进程

可用的进程参数设置如下:

参数描述

回收

控制回收服务的频率和时间。 从午夜开始,默认频率为每 24 小时一次。

与在低隔离或高隔离环境中都可运行的其他服务类型不同,地理处理服务只在高隔离环境中运行。