列出工作流程实例

动词：listWorkflowInstances

可从以下位置获取: <Standard>

列出有关先前通过命令创建工作流程实例.
创建的工作流程实例的信息

1. 工作流程是一个过程流控制引擎。工作流程表示 BPMN 文件内的一个流程。

2. 实例表示应处理的项。变量负责接收工作流程执行的数据，将每个任务指定到各自对应的流程。

语法

listWorkflowInstances --workflow(Workflow) [--startdate(DateTime)] [--enddate(DateTime)] [--status(WorkflowInstanceStatuses)] --currenttask(String) [--batchkey(String)] [--businessstatus(String)] [--timeout(TimeSpan)] (List<WorkflowInstance>)=value

输入

脚本	设计器	必需的	AcceptedTypes	Description
--workflow	工作流程	必需的	Workflow	将从其中获取实例列表的“工作流程”类型的变量。此变量是使用装入工作流程命令的工作流程参数生成的。
--startdate	开始日期	可选	日期时间	将要从此列出实例的开始日期。
--enddate	结束日期	可选	日期时间	将要从此列出实例的结束日期。
-- 状态	状态	可选	工作流程实例状态	要列出的实例的系统状态。选项：已取消完成已失败新建正在处理已暂挂
--currenttask	当前任务	仅当“状态”为“已暂挂”时	文本	属于在工作流程中定义的工作流程变量的当前任务的名称。
--batchkey	批处理密钥	可选	文本	在创建批处理命令的键参数中创建的唯一标识，用于将列出的实例分配给组。当前租户内部不能存在两个相同的标识。
--businessstatus	业务状态	可选	文本	用于根据业务规则逻辑识别实例的业务状态。此参数用于在流程内部进行指导，而不干扰脚本的操作。
--timeout	超时	可选	时间范围、数字、文本	要列出的实例批处理的最长等待时间。如果在类型为超时值的参数中未定义任何值，那么执行将使用设置超时值命令定义的上下文时间。如果脚本未使用此命令，那么缺省时间为 5 秒。

输出

脚本	设计器	AcceptedTypes	Description
值	工作流程实例	列表<Workflow Instance>	返回已检索实例的列表。返回实例后，仅填充实例标识属性。要从实例获取所有数据，请使用装入工作流程实例命令，并使用先前获取的实例标识。

示例

在以下情况下，将列出在脚本中创建的所有实例，并显示获取的数量。

defVar --name mappedWorkflow --type Workflow
defVar --name a --type Numeric --value 0
defVar --name workflow --type Workflow
defVar --name workflowInstance --type WorkflowInstance
defVar --name batchInstances --type WorkflowBatch
defVar --name instancesBatch --type List --innertype WorkflowInstance
defVar --name quantity --type Numeric
// Download the following file to run the command.
loadWorkflow --isfromfile  --file "bpmnTestVar.bpmn" --process "Id_f12b1ed6-0ecd-4bf7-b245-9bf31b63e900" --automapvariables  workflow=value
mapWorkflowActivities --workflow ${workflow} --mappings "Task_inc=beginSubroutine" mappedWorkflow=value
createBatch --description "Batch containing Workflow instances" --workflow ${workflow} --key initialBatch --comment "Creates a batch to store Workflow instances" batchInstances=value
goSub --label beginSubroutine
listWorkflowInstances --workflow ${workflow} --status "New" --batchkey initialBatch --timeout 00:00:30 instancesBatch=value
count --collection "${instancesBatch}" quantity=value
logMessage --message "\r\nBatch Name: ${batchInstances}\r\nNumber of Batch Instances:${quantity}" --type "Info"
beginSub --name beginSubroutine
	while --left "${a}" --operator "Less_Than" --right 5
		incrementVar --number ${a}
		createWorkflowInstance --workflow ${workflow} --businessstatus "In Progress" --businessstatusreason "Developing Script" --defaultvalues "a=${a}" --batch ${batchInstances} workflowInstance=value
	endWhile
endSub