“运行 Pro GP 工具”步骤用于在 ArcGIS Pro 中运行已配置的工具、Python 脚本或 模型构建器 模型。
运行步骤时,作业切片上将显示启动图标 。 工具启动时,将显示运行中图标 ,表示工具在运行中。
如果使用 ArcGIS Arcade 表达式配置了任意步骤参数,则在工具开始运行之前,这些参数将转换为相应的值。
如果启用了在运行时可见选项,则地理处理窗格中将打开在步骤中配置的工具,用于在运行工具之前定义参数值。 如果已配置默认参数值,则这些值将在运行步骤时显示并且可以覆盖。 如果没有为步骤配置用户请求和步骤帮助值,步骤将在运行时自动完成。
注:
如果从 ArcGIS Arcade 获取的参数值与工具不兼容,则步骤将失败。
运行该步骤时,可以执行以下操作:
- 如果已启用在运行时可见选项,则可以提供参数值,然后可在地理处理窗格中单击运行运行步骤。
- 通过单击取消,可以取消该步骤。
注:
在某些情况下,可能无法在该步骤开始运行之后将其取消。
配置步骤
要配置步骤,请执行以下操作:
- 创建或编辑工作流示意图,以访问步骤库面板。
- 将运行 Pro GP 工具从步骤库面板拖至工作流画布上步骤的连接箭头。
步骤详细信息面板随即出现。
- 在步骤名称文本框中提供步骤的名称。
- 或者,在用户提示文本框中添加您希望在该步骤运行时显示的消息。
如果用户提示包含纯文本和 Arcade 表达式,则需要按如下所示格式化文本:
'This job is currently assigned to ' + JobOwner($Job) + '.'
提示:
单击此输入支持 Arcade 表达式 ,然后选择 ArcGIS Arcade 表达式以将其添加至其关联文本框。
- 选择要在参数部分中运行的工具的类型:
- 系统工具箱 - ArcGIS Pro 随附的地理处理工具以及导入 ArcGIS Pro 工程的工具箱。
- 其他工具箱 - 自定义地理处理工具和脚本
- 执行以下操作之一:
系统工具箱中的工具
在工具箱别名文本框中,键入包含要运行工具的工具箱的工具箱别名。
可在 ArcGIS Pro 文档的工具帮助页面上的 Python 选项卡中找到工具箱别名。
导入 ArcGIS Pro 工程的工具
在工具箱别名文本框中,键入包含要运行工具的工具箱的工具箱别名。
在目录窗格中右键单击工具箱,然后单击属性显示工具箱别名。
自定义地理处理工具和脚本
在工具箱路径文本框中,输入工具箱的完整路径。 工具箱路径还可以引用在文件地理数据库或 企业级地理数据库 中存储的工具箱。 路径在 ArcGIS Pro 中必须可访问。
还可以使用 ArcGIS Arcade 表达式提供动态值。
- 在工具名称文本框中,键入要运行的工具的名称。
注:
如果工具名称文本框中的地理处理工具的名称与 Arcade 函数的名称(例如 Buffer 或 Clip)相匹配,则必须将工具名称括在单引号或双引号中,以免将其评估为 Arcade 表达式。
可在 ArcGIS Pro 文档的工具帮助页面上的 Python 选项卡中找到工具名称。
还可以使用 ArcGIS Arcade 表达式提供动态值。
- (可选)选中在运行时可见复选框允许在 ArcGIS Pro 中运行步骤时设置参数值。
- 单击添加新参数。
- 在参数名称文本框中输入参数的名称。
可在 ArcGIS Pro 文档的地理处理工具帮助页面上的 Python 选项卡中找到工具参数名称。
- (可选)单击显示默认值按钮 定义运行步骤时的参数默认值。
- 选择以下选项之一:
- 值 - 提供静态值。
- Arcade 表达式 - 使用 Arcade 表达式提供动态值。
- 在值或 Arcade 表达式文本框中提供属性的默认值。
- 选择以下选项之一:
- 重复步骤 9 到 11 添加更多参数。
- (可选)键入要在工具完成运行时用作输出值的派生输出参数的名称。
可在 ArcGIS Pro 文档的工具帮助页面上的 Python 选项卡中找到工具派生输出参数。
- (可选)选中附加 GP 日志复选框将工具历史记录另存为作业附件。
注:
选中附加 GP 日志复选框后,工具历史日志的附件 ID 将包含在步骤的输出值中。
- (可选)在文件夹文本框中提供将存储日志的文件夹的名称。
文件夹名称不能包含文件系统路径或特殊字符。 如果未提供文件夹名称,将自动创建名为 General 的文件夹。
注:
文件夹包含在工作流项目中,并且不是文件系统路径。
- 单击选项选项卡。
- 根据需要配置步骤选项。
- 手动 - 手动运行步骤。
- 可选 - 允许完成步骤而无需运行。
- 自动 - 步骤被激活后立即执行。
注:
如果您的工作流示意图配置为自动运行一系列步骤,其中包括“评估数据质量”或“运行 GP 服务”步骤,则在启动步骤序列的用户令牌到期后,尝试自动运行的步骤将失败。 您必须拥有 ArcGIS Workflow Manager Server Advanced 角色的许可才能继续运行其他自动化步骤,而无需手动干预。
- 按计划运行 - 根据您设置的计划运行步骤。
- 手动 - 手动运行步骤。
- 或者,在步骤帮助文本框中提供该步骤的帮助文本。
还可以使用 ArcGIS Arcade 表达式为步骤帮助提供动态值。 如果步骤帮助包含纯文本和 Arcade 表达式,则需要按如下所示格式化文本:
'For further assistance, please contact ' + JobCreator($Job) + '.'
- 或者,单击样式选项卡以更改步骤的形状和颜色。
- 或者,单击关于选项卡并在步骤描述文本框中提供该步骤的描述。
提示:
关于选项卡还包含步骤 ID,可与动态作业属性配合使用以获取步骤的输出。 单击复制步骤 ID 将步骤 ID 复制到剪贴板。
返回值
当该步骤完成时,将存储返回值以指示该步骤的结果。 可以使用路径立即评估返回值,以确定工作流中的后续步骤。 您还可以使用 ArcGIS Arcade 表达式在整个工作流中检索已完成步骤的返回值。 下表列出了该步骤的返回值:
返回值 | 描述 |
---|---|
S000001 | 该步骤成功完成。 |
F000001 | 该步骤未能成功完成。 |
输出值
该步骤完成后,其输出值将被存储,可用于确定工作流所遵循的路径,或者可用作整个工作流中其他步骤的输入。 下表显示了该步骤的输出值:
输出 | 描述 |
---|---|
<DerivedOutputParameterValue> | 返回从工具接收的已配置派生输出值。 |
attachmentId | 返回添加到步骤的附件 ID 数组。 |