Show TOC

ProcessDefinitionLocate this document in the navigation structure

The ProcessDefinition entity allows you to use the header data of a process definition.

Attributes and Filters

You can use the attributes from the following table to request process definition details from an SAP Business Suite system.

Attribute

Description

Filter Operator

Example

ProcessDefinitionID

ID used to uniquely identify a process definition within a process platform. It is unique across process definition versions

EQ

$Filter = ProcessDefinitionID EQ ‘Cross_Client_QV6_002~001’

Version

Version of a process definition

EQ

$Filter = Version EQ ‘001’

Status

Status of a process definition. Possible values are designOnly, inProduction, and current.

EQ

$Filter = Status EQ ‘3’

ProcessFamilyID

ID used to uniquely identify a process family

EQ

$Filter = ProcessFamilyID EQ ‘Sales_Order1’

ProcessOrchestrationType

Definition type of a process

EQ

$Filter = ProcessOrchestrationType EQ ‘BUILTIN’

ShortDescription

Additional information of a process definition

SubStringOf

$Filter = SUBSTRINGOF(‘Model’, ShortDescription)

StartsWith

$Filter = STARTSWITH(ShortDescription, ‘POC’)

EndsWith

$Filter = ENDSWITH(ShortDescription, ‘Delivery’)

Navigation

From the ProcessDefinition entity, you can navigate to other related entities (see below) and retrieve the required details:

  • ProcessStepDefinition

  • KpiDefinition

  • ProcessContextDefinition

  • Process

BPMN2 Representation

You can access a process definition in BPMN2 representation using the following URL:

http://<sever>:<port>/sap/opu/odata/iwpgw/pgw;o=<system alias>/ProcessDefinitionCollection('<process definition ID>')/$value?