请参阅 SharePoint 在工作流上设置的启动和关联属性的概述。
注意
自 2020 年 8 月 1 日起,SharePoint 2010 工作流已对新租户停用,并于 2020 年 11 月 1 日从现有租户中删除。 如果你使用的是 SharePoint 2010 工作流,我们建议迁移到 Power Automate 或其他支持的解决方案。 有关详细信息,请参阅 SharePoint 2010 工作流停用。
当您启动工作流时,SharePoint 会自动设置一些支持工作流的关联和启动属性。 如下表所列。 属性集的设置会有所不同,这取决于是 网站 工作流还是 列表 工作流。 这些差异会在列表中标识出来。
使用工作流对象模型关联和启动工作流,请遵循以下准则:
- 若要对 列表 工作流创建关联,请使用 PublishSubscriptionForList 方法。
- 若要对 网站 工作流创建关联,请使用 PublishSubscription 方法。
- 若要启动 列表 工作流,请使用 StartWorkflowOnListItem 方法。
- 若要启动网站工作流,请使用 StartWorkflow 方法。
注意
WorkflowSubscriptionService 类中包含两种用于关联工作流的方法,WorkflowInstanceService 类中包含两种用于启动工作流的方法。
关联属性
调用 PublishSubscription 时,将设置关联属性的值。 关联属性值是关联级属性,这意味着给定关联的所有工作流实例具有相同的属性值。 您可以使用 GetConfigurationValue 活动检索工作流本身的关联属性值。
以下是在调用 PublishSubscription 时,默认情况下对 列表 和 网站 工作流设置的关联属性列表。
- AssociationTitle
- AssociatorUserId
- LayoutsFolder
- ParentContentTypeId()
- HistoryListId*
- TaskListId*
- FormData*
- SharePointWorkflowContext.Subscription.EventSourceId*
- SharePointWorkflowContext.Subscription.EventType*
- SharePointWorkflowContext.Subscription.DisplayName*
- SharePointWorkflowContext.Subscription.Id*
- SharePointWorkflowContext.Subscription.Name*
- SharePointWorkflowContext.Subscription.CreatedDate*
重要: 使用星号 (*) 标记的属性未在工作流 API 中定义,因此只需使用其字符串值即可访问它们。
对于列表工作流,还有四个在调用 PublishSubscriptionForList(WorkflowSubscription, Guid) 时默认设置的关联属性。
重要
标有星号 (*) 的属性不在工作流 API 中进行定义,因此访问它们只需使用它们的字符串值。
注意
可以使用关联表单添加自定义关联属性。
启动属性
启动属性是外部变量,这些变量的值是在启动工作流时设置的,即调用 StartWorkflow 时。 但要注意,使用 ExternalVariableValue 活动在工作流实例中运行时可更新这些属性值。 可以使用 Properties 从工作流外部检索外部变量的值。
外部变量的值特定于每个工作流实例(与所有工作流实例共享相同属性值的关联属性不同)。
所有工作流实例(列表和网站)都有一些外部变量,默认情况下,这些变量在调用 StartWorkflow 时设置:
列表工作流实例具有一些额外的外部变量,在调用 StartWorkflowOnListItem 时默认设置这些变量:
注意
可以使用启动表单添加自定义启动属性。