Workflow Manager (Classic) 自定义步骤—ArcMap

在 Standard 或 Advanced 许可等级下可用。

需要 Workflow Manager 许可。

所有平台库
仅 ArcGIS Pro 和 ArcGIS Desktop 库
仅 ArcGIS Desktop 库
“导入/启动映射项目”步骤

ArcGIS Workflow Manager (Classic) Desktop 提供了多个自定义步骤。每个自定义步骤的源代码都作为开发工具包的一部分提供。以下内容对步骤及其作用进行了概述。

所有平台库

所有平台库包含可在 ArcMap、ArcCatalog、ArcGIS Pro 和 ArcGIS Server 中运行的步骤。以下部分将介绍步骤及其参数以及返回代码。

AddJobHold - JTXSteps.AddJobHold

将保存内容添加到当前作业。

参数

下表中包含步骤参数列表：


参数	描述	参数类型
/holdType:<hold type>	阻停项类型的名称	必需项
/holdComment:<string>	要为阻停项类型添加的注释	可选

返回代码

以下是返回代码列表：

1 = 成功
0 = 失败

CheckAOI - JTXSteps.CheckAOI

检查是否存在当前作业的感兴趣位置 (LOI)。

参数

该步骤不需要任何参数。

返回代码

以下是步骤返回代码列表：

1 = 作业具有 LOI。
2 = 作业不具有 LOI。

CleanUp - JTXSteps.CleanUp

基于参数清理作业。启用管理系统设置，以允许用户删除其他用户所拥有的版本。这将提示您输入用户名和密码。

参数

下表中包含步骤参数列表：


参数	描述	参数类型
/version\|v	清理版本	可选
/mxd\|m	清理 MXD	可选
/attachments\|a	清理附件	可选

返回代码

如果该步骤成功，则该步骤将返回 0。

CloseJob - JTXSteps.CloseJob

将作业作为一个步骤进行关闭，而不是在工作流完成后进行手动操作。

参数

该步骤不需要任何参数。

返回代码

如果该步骤成功，则该步骤将返回 0。

CreateJob - JTXSteps.CreateJob

基于参数创建子作业。

参数

下表中包含步骤参数列表：


参数	描述	参数类型
/jobtypename:<job type name>	作业类型的名称	必需项
/assigngroup:<group to assign to>	将作业分配到的群组	可选
/assignuser:<user to assign to>	将作业分配到的用户	可选

返回代码

如果该步骤成功，则该步骤将返回 0。

CreatePDF - JTXSteps.CreatePDF

创建作业底图的 PDF 文档并将其附加到该作业。

参数

下表中包含步骤参数列表：


参数	描述	参数类型
/initdir:<initial directory>	将用于保存 PDF 的位置。	可选
/noattach	不要将 PDF 附加到作业。	可选
/resolution:<dpi>	PDF 的分辨率。	可选

返回代码

如果该步骤成功，则该步骤将返回 0。

CreateVersion - JTXSteps.CreateVersion

创建作业的版本。版本的保护级别通过下列参数之一指定：Version、Access 或 Scope。该步骤支持传统数据工作空间和要素服务数据工作空间。

参数

下表中包含步骤参数列表：


参数	描述	参数类型
/scope:<public\|private\|protected>	版本的保护级别。默认为 private。	可选

返回代码

如果该步骤成功，则该步骤将返回 0。

ExecuteGPTool - JTXSteps.ExecuteGPTool

在不显示地理处理对话框的情况下运行地理处理工具、模型或脚本。工具的整型输出可用作返回代码以指引工具完成时的工作流路径。

参数

下表中包含步骤参数列表：


参数	描述	参数类型
/toolboxpath:<toolboxpath>	工具箱 .tbx 文件的完整路径和工具名称	必需项
/tool:<tool>	工具箱中工具的显示名称	必需项
/param:<ParamName>:<ParamValue>	工具上要覆盖的参数（可以多次指定）	可选
/attach	可在工具完成运行后将日志附加到作业	可选
/outParam:<parameter name>	要用作返回值的输出参数	可选

返回代码

以下是步骤返回代码列表：

0 = 成功
1 = 取消

ExecuteSQL - JTXSteps.ExecuteSQL

运行 SQL 语句。

参数

下表中包含步骤参数列表：


参数	描述	参数类型
/database:<jtxsystem\|data>	查询将发送到的数据库	必需项
/sql:<sql command>	将发送到数据库的 SQL 查询	必需项

返回代码

如果该步骤成功，则该步骤将返回 0。

ExecuteURL - JTXSteps.ExecuteURL

在不显示浏览器的情况下打开 URL 以显示响应。例如，可以将地理处理服务或任何其他 Web 服务作为工作流步骤运行。

参数

下表中包含步骤参数列表：


参数	描述	参数类型
/url:<url>	要打开的 URL	必需项
/timeout:<timeout in seconds>	请求的超时，以秒为单位	可选
/proxy:<proxy>	要使用的代理服务器	可选
/addjobcomment	通过响应向作业添加评论	可选
/postdata:<data to post>	打开 URL 时要发送的数据	可选

返回代码

如果该步骤成功，则该步骤将返回 200。

ExecuteWorkflow - JTXSteps.ExecuteWorkflow

运行与作业类型关联的另一个工作流。

参数

下表中包含步骤参数列表：


参数	描述	参数类型
/jobtype:<job type name>	作业类型的名称。	必需项
/donotuseaoi	不使用作业 AOI。	必需项
/donotuseversion	不使用作业版本。	可选
/donotcopyactivities	不会将活动复制到父作业的历史记录中。	可选

返回代码

如果该步骤成功，则该步骤将返回 0。

ReturnValue - JTXSteps.ReturnValue

检索传递的扩展属性或令牌的值，该值作为工作流中下一个路径的返回代码。

参数

下表中包含步骤参数列表：


参数	描述	参数类型
/value:<extended properties field>	您要从中检索返回值的扩展属性字段	必需项

返回代码

该步骤将返回指定扩展属性字段的值。

ReassignJob - JTXSteps.ReassignJob

重新分配作业。

参数

下表中包含步骤参数列表：


参数	描述	参数类型
/assignType:<user\|group>	将作业重新分配到用户或群组。	必需项
/assignTo:<user or group name>	将作业分配到的用户或群组	必需项

返回代码

如果该步骤成功，则该步骤将返回 0。

SendNotification - JTXSteps.SendNotification

发送参数指定类型的通知。

参数

下表中包含步骤参数列表：


参数	描述	参数类型
/notifType:<type>	要发送的通知类型	必需项

返回代码

如果该步骤成功，则该步骤将返回 0。

SetVersion - JTXSteps.SetVersion

将作业版本设置为命名的版本。例如，将作业版本设置为“质量控制版本”以验证在版本中提交的编辑内容。如果没有 step 参数，则作业版本将重置为原始版本。该步骤支持传统数据工作空间和要素服务数据工作空间。

参数

下表中包含步骤参数列表：


参数	描述	参数类型
/version:<versionName>	用作作业版本的版本	可选

返回代码

如果该步骤成功，则该步骤将返回 0。

UpdateExtentFeatureClass - JTXSteps.UpdateExtentFeatureClass

使用作业信息来更新要素类以使状态可见。

参数

下表中包含步骤参数列表：


参数	描述	参数类型
/fclass:<fully qualified feature class name>	要更新的要素类（必须在数据地理数据库中）	必需项
/jobfield:<field name>	将在其中存储作业 ID 的字段	可选
/datefield:<field name>	将在其中存储日期和时间的字段	可选

返回代码

如果该步骤成功，则该步骤将返回 0。

VersionExists - JTXSteps.VersionExists

检查是否已存在作业的地理数据库版本。该步骤支持传统数据工作空间和要素服务数据工作空间。

参数

该步骤不需要任何参数。

返回代码

以下是步骤返回代码列表：

1 = 存在版本
2 = 不存在版本
3 = 未选择数据工作空间

仅 ArcGIS Pro 和 ArcGIS Desktop 库

仅 ArcGIS Pro 和 ArcGIS Desktop 库包含只能在 ArcGIS Pro、ArcMap 和 ArcCatalog 中运行的步骤。以下部分将介绍步骤及其参数以及返回代码。

AddAttachments - JTXDesktopSteps.AddAttachments

将链接式、嵌入式及 URL 附件添加到作业。

参数

该步骤不需要任何参数。

返回代码

以下是返回代码列表：

1 = 成功
0 = 失败

CreateJobAdvanced - JTXDesktopSteps.CreateJobAdvanced

创建一个作业并允许您定义与该作业的父/子依赖关系。创建子作业时，起始日期、截止日期、数据工作空间和优先级将会从父作业中复制，而作业分配将会从作业类型默认属性中复制（如果未在步骤参数中指定具体值）。该步骤支持使用传统数据工作空间和要素服务数据工作空间来创建作业的版本。如果使用要素服务数据工作空间设置子作业，则父版本只能为 sde.Default。

参数

下表中包含步骤参数列表：


参数	描述	参数类型
/jobtypename:<job type name>	作业类型的名称。	必需项
/assigngroup:<group to assign to>	将作业分配到的群组。	可选
/assignuser:<username to assign to>	将作业分配到的用户。	可选
/dependThisStep	创建一个依赖项，并在此步骤中阻停当前作业。	可选
/dependNextStep	创建一个依赖项，并阻停将在工作流的下一步中阻停的当前作业。	可选
/dependStatus:<Status Type Name>	依赖项状态类型的名称（将阻停当前作业，直到新作业达到此状态为止）。	可选
/useparentaoi	将当前作业的 AOI 用作新作业的 AOI。	可选
/aoiOverlapFeatureClassName:<fully qualified feature class name >	根据当前作业的 AOI 和指定要素类之间的重叠创建新的作业。	可选
/numberJobs:<number of jobs to create>	要创建的默认作业数。	可选
/createVersionSetting:<the version to use as the parent version>	创建新作业时要使用的版本。	可选
/assignVersionSetting:<the existing version the job will be assigned to>	创建新作业时要使用的现有版本。	可选
/setExtendedProps:<ChildJobFullyQualifiedExtendedPropertiesTableName.FieldName=[JOBEX:ParentJobFullyQualifiedExtendedPropertiesTableName.FieldName]>; <ChildJobFullyQualifiedExtendedPropertiesTableName.FieldName=[JOBEX:ParentJobFullyQualifiedExtendedPropertiesTableName.FieldName]>;...	创建新作业时，扩展属性值将设置为当前作业的扩展属性值之一（由 JTX 令牌指定）或给定的字符串值。要设置多个扩展属性值，请用分号分隔每个条目。	可选
/dueDate:<due date of the new job>	新作业的截止日期。	可选
/jobDuration:<duration of the new job>	新作业的持续时间。	可选
/child	将新作业创建为现有作业的子作业	可选

返回代码

以下是返回代码列表：

0 = 成功
1 = 失败

DefineAOI - JTXDesktopSteps.DefineAOI

显示允许用户定义感兴趣位置的工具。

参数

该步骤不需要任何参数。

返回代码

以下是返回代码列表：

1 = 成功
0 = 失败

EditExtendedProperties - JTXDesktopSteps.EditExtendedProperties

将作业的一对一 (1-1) 扩展属性以弹出表单的形式显示，以便定义所需的属性。工作流中可多次执行该步骤，从而在工作流的不同阶段打开不同的扩展属性。这样便能够只选择在弹出表单中显示为作业类型配置的某些扩展属性。可通过打开参数编辑器或在参数框中输入来选择扩展属性。所有选定属性都将应用作业类型中所设置的属性，如可见、可编辑等。如果未指定参数，则在运行步骤后将显示针对作业类型选择的所有扩展属性。参数编辑器将包含为资料档案库中全部作业类型配置的所有表和字段；但是，如果选择未针对作业类型配置的属性，则在弹出表单中将不会显示这些属性。参数由扩展属性表名称和字段名称组成。例如，如果要显示 RequestorInformation 表中的 RequestorName<fieldName> 字段，则参数将是 /Property: RequestorInformation.RequestorName。

参数

下表中包含步骤参数列表：


参数	描述	参数类型
/Property:<Property Name>	扩展属性表名称和字段名称	必需项

返回代码

如果该步骤成功，则该步骤将返回 1。

导入/启动映射项目 - JTXDesktopSteps.LaunchArcMap

启动 ArcGIS Pro 或 ArcMap，转至作业版本的资源图层，然后将地图缩放到感兴趣的作业位置。

参数

有关步骤参数的详细信息，请参阅“导入/启动映射项目”步骤部分。

返回代码

如果该步骤成功，则该步骤将返回 0。

LaunchGPTool - JTXDesktopSteps.LaunchGPTool

从工作流中运行地理处理工具。工具的整型输出可用作返回代码以指引工具完成时的工作流路径。

参数

下表中包含步骤参数列表：


参数	描述	参数类型
/toolboxpath:<toolboxpath>	工具箱 .tbx 文件的完整路径和工具名称	可选
/toolbox:<toolbox>	工具箱的名称（如果在系统工具箱中）	可选
/tool:<tool>	工具箱中工具的显示名称	必需项
/param:<ParamName>:<ParamValue>	工具上要覆盖的参数（可以多次指定）	可选
/attach	可在工具完成运行后将日志附加到作业	可选
/license:<enum value>	应用于运行该工具的任何其他许可的许可代码	可选
/outParam:<parameter name>	要用作返回值的输出参数	可选

返回代码

以下是步骤返回代码列表：

0 = 成功
1 = 取消

SelectDataWorkspace - JTXDesktopSteps.SelectDataWorkspace

显示一个表单，允许您从预配置数据工作空间的列表中选择作业的数据工作空间。

参数

该步骤不需要任何参数。

返回代码

以下是返回代码列表：

1 = 成功
0 = 失败

仅 ArcGIS Desktop 库

仅 ArcGIS Desktop 库包含只能在 ArcMap 和 ArcCatalog 中运行的步骤。以下部分将介绍步骤及其参数以及返回代码。

CopyFile - JTXDesktopSteps.CopyFile

将文件从一个位置复制到另一个位置。

参数

下表中包含步骤参数列表：


参数	描述	参数类型
/src:<source file path>	要复制的文件	可选
/dest:<destination file path>	要复制的文件的目标	可选
/title:<file title>	要复制的文件的标题	可选

返回代码

如果该步骤成功，则该步骤将返回 0。

“导入/启动映射项目”步骤

在下表中详细说明了无参数的“导入/启动映射项目”步骤的预期行为。

此表说明了随 Workflow Manager (Classic) 一同提供的“导入/启动映射项目”步骤的预期行为。
是否已定义作业类型地图文档？	使用数据工作空间和版本启动映射项目	使用数据工作空间而不使用版本启动映射项目	在不使用数据工作空间的情况下启动映射项目
是	ArcMap 使用定义的地图文档打开。基于要素类的简称为作业版本提供图层资源。地图将缩放至感兴趣区域。注：简称是要素类名称，而不是完全限定名称。例如，应该是 Streets，而不是 NIS.Streets。另请注意，无论底图最初是如何定义的，都应为任何短名称匹配项提供资源。	这与存在版本时的情形相同，只是数据工作空间的默认版本可用于提供图层资源。	未对图层源进行任何更改。地图缩放至 LOI。
否	以空白文档打开 ArcMap。在这种情况下，因为不存在任何地图，因此无法提供任何图层资源。将图层添加到地图后，Workflow Manager 工具条上的添加数据按钮会将您直接带到作业的已定义版本或所选数据工作空间的默认版本。	这与存在版本时的情形相同。	以空白文档打开 ArcMap。 Workflow Manager 工具条上的添加数据按钮不可用。如果存在作业的 LOI，则可以使用缩放至 LOI 工具。

底图图层不会重嵌到由 Workflow Manager (Classic) 打开的地图中。

参数描述

“导入/启动映射项目”步骤提供了许多可选参数，您无需编写代码便可根据需要使用它们来自定义该步骤的执行。

使用默认行为配置启动 ArcMap 对话框 — 将显示已配置了默认行为的启动 ArcMap 参数编辑器和步骤类型“执行”选项卡。

注：

地图中的图层必须引用 Workflow Manager (Classic) 系统内数据工作空间中的数据，这样才能重定向版本和用户连接信息。如果地图图层引用来自 Workflow Manager (Classic) 系统内数据工作空间的数据，但未对作业指定作业版本，则地图图层将重定向到数据工作空间的默认数据库版本。在下列情景中不会重定向地图图层：

如果未定义作业地图，则会打开空白地图，原因是没有可重嵌的图层。
如果将步骤配置为仅更改版本，同时作业地图图层不来自数据工作空间，则这些图层将显示为具有损坏数据源的图层。
如果图层不来自数据工作空间，同时在作业类型属性中被选定为用于重定向，则这些图层将显示为具有损坏数据源的图层。
如果图层不来自数据工作空间，同时在作业类型属性中未被选定为用于重定向，则这些图层将重定向至默认数据库版本。

了解有关地图和版本化的详细信息


描述性名称	参数示例	行为
缩放至 LOI	`/aoifactor:3` 或 `/nozoomloi`	在默认行为下，地图将被平移到作业的 AOI 并按照因子 1 缩放至形状几何。也可选择使用 /nozoomloi 选项，不平移或缩放地图。或者，可以使用 /aoifactor 参数，以更大的缩放因子缩放至 AOI。缩放因子对 POI 不起作用。如果是单个 POI，则地图将缩放至 1:2000；如果有多个 POI，则地图将缩放至这些 POI 的范围。
不更改任何连接信息。	`/norepoint`	如果未使用 /norepoint，则默认行为会将地图中的所有图层更改为当前数据工作空间或更改为作业版本。
仅更改作业数据工作空间的版本。	`/changeversiononly`	如果选择使用 /changeversiononly 选项，则作业类型地图文档中的图层版本将发生更改。数据用户和连接信息将保持最初的配置不变。来自数据库工作空间的所有图层都将被重定向，无论在作业类型属性中是否将其选定为用于重定向。如果图层不来自数据工作空间，则这些图层将显示为具有损坏数据源的图层。注：使用个人登录帐户时，此选项不会重嵌地图图层，这些图层将指向默认版本。
保存 MXD。	`/nosavemxd`	如果未使用 /nosavemxd 参数，默认行为会将作业的地图文档保存在 Workflow Manager (Classic) 数据库中。因此，每当使用工作流中的这一步骤打开作业的地图文档时，都将检索数据库中上次保存的地图。然而，如果选择使用 /nosavemxd 选项，Workflow Manager (Classic) 数据库中则不会保存作业的地图文档。因此，如果更改作业地图的范围并将其关闭，则不会保存新范围，且下一次打开地图时仍会使用原始范围。注： ArcMap 在每次关闭地图时都会显示保存地图的消息，但是在使用 /nosavemxd 的情况下，即使您在 ArcMap 消息中单击是，也不会保存地图。如果地图文档很大，则可能需要调整 MAXBLOBSIZE SDE 配置设置。此选项还允许您在 ArcMap 中切换作业，而无需清除地图文档。
将数据框裁剪至 AOI。	`/cliptoaoi`	如果未使用 /cliptoaoi 参数，则默认行为会在可查看的地图文档中显示所有数据。如果使用 /cliptoaoi 选项，则作业的地图文档中的数据框将裁剪成 AOI 的形状。注：这不会创建对图层的定义查询。地图图层中的所有要素仍可通过其各自的表进行访问。
等待 ArcMap 关闭（暂停 Workflow Manager (Classic)）。	`/nowait`	如果未使用 /nowait 参数，则默认的 Workflow Manager (Classic) 应用程序行为会在运行 ArcMap 进程时隐藏。这意味着，用户无法在使用 ArcMap 时与 Workflow Manager (Classic) 应用程序进行交互。如果使用 /nowait 选项，则会在单独进程中启动 ArcMap，从而允许用户在运行 ArcMap 时与 Workflow Manager (Classic) 应用程序进行交互。注：此选项已添加，因为工作流步骤的异步启动进程选项不适用于自定义步骤对象。
使用现有 ArcMap 会话。	`/useexisting`	如果未配置 /useexisting 参数，则默认行为是在执行该步骤时打开一个新的 ArcMap 会话。在使用 /useexisting 选项的情况下，如果 ArcMap 会话在运行该步骤时处于打开状态，则 Workflow Manager (Classic) 将在该现有会话中打开作业的地图文档。如果没有处于打开状态的 ArcMap 会话，则 Workflow Manager (Classic) 将打开一个新会话。
将 MXD 存储于共享位置。	`/mxdfolder:"D:\Data\JTXMapDocuments"`	在默认行为下，不会配置任何备用位置，且作业的地图文档将存储在 Workflow Manager (Classic) 数据库中。如果地图文档很大，则可能需要调整 MAXBLOBSIZE SDE 配置设置。如果选择将地图文档存储在备用位置，则 Workflow Manager (Classic) 便不会将地图文档保存在数据库中，而是将其保存在该备用位置，以供今后使用。
使用备选 MXD。	`/mxd:"D:\Data\JTXTemplates\Editing.mxd"`	在默认行为下，该步骤将作业类型的默认地图文档用作 LaunchArcMap 的底图文档。如果选择使用此选项，Workflow Manager (Classic) 将加载为参数配置的地图文档或模板。注： ArcGIS Pro 地图 (.mapx) 可作为备选 MXD 用于为 ArcGIS Pro 配置的步骤。
运行 ArcMap 命令。	`/guid:esriArcMapUI.AddDataCommand`	加载完 ArcMap 后，将运行指定命令。
加载任务助手工作流。	`/taworkflow:"LotSplit"`	如果已配置此参数，则在 ArcMap 打开后，Workflow Manager (Classic) 将打开已配置的“任务助手”工作流。传入的工作流名称是存储在 Workflow Manager (Classic) 系统中的“任务助手”工作流的别名。通过添加附加的 /taworkflow 条目或通过在参数编辑器中选择工作流，可传入多个工作流。
将任务助手历史存储于作业历史中。	`/storetahistory`	如果已配置此参数，则“任务助手”工作流会默认添加到作业历史中。仍可以选择使用 Workflow Manager (Classic) 工具将其附加为文本文件。