Operation: List Process Execution Steps Detail

The operation List Process Execution Steps Detail outputs all process steps from all processes with a set status.

Example

Input

The adapter expects the following structure as input XML:

XML

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<StepQuery>
	<ProcessInstanceId></ProcessInstanceId>
	<StepFilter>
		<TechnicalName>string</TechnicalName>
		<DisplayName>string</DisplayName>
		<Status>0</Status>
	</StepFilter>
	<Paging offset="0" limit="0" />
	<Period from="2021-09-02T00:00:01Z" to="2021-09-02T17:29:59Z" />?
</StepQuery>

Note:

In the input, at least either the element ProcessInstanceId or Status has to be set.

If ProcessInstanceId is not set, all processes with all process steps will be output.

The following elements are included in the input:

StepQuery

Element	Description
`ProcessInstanceId`	UUID of the process
`StepFilter`	Filters the query for the techincal name, display name and status of the process.
`Paging`	Paging is used to output data in subsets. `Paging` has the following attributes: `offset`: allows to omit a specified number of elements for the query `limit`: limits the number of elements returned from the query, maximum 10,000

Element

Description

ProcessInstanceId

UUID of the process

StepFilter

Filters the query for the techincal name, display name and status of the process.

Paging

Paging is used to output data in subsets.

Paging has the following attributes:

offset: allows to omit a specified number of elements for the query
limit: limits the number of elements returned from the query, maximum 10,000

StepFilter

Element	Description
`TechnicalName`	Technical name of the process module
`DisplayName`	Label of the process module
`Status`	Status value of the process module
`Period`	Time period specification (according to ISO 8601) Required attributes: `from`: Start date of the time period `to`: End date of the time period

Output

The adapter generates an XML document as output:

XML

<?xml version="1.0" encoding="UTF-8"?>
<ProcessExecutionStepsDetail id="e3956772-1e5b-48ce-8b16-e1c208713698">
   <Paginate limit="2" offset="0"/>
   <ProcessSteps>
      <ProcessStep>
         <ActionId>0</ActionId>
         <TechnicalName>Start</TechnicalName>
         <DisplayName>Start</DisplayName>
         <StartedAt>2022-11-04T10:12:25.689216Z</StartedAt>
         <FinishedAt>2022-11-04T10:12:25.690216Z</FinishedAt>
         <Status>0</Status>
         <Time>0</Time>
         <BytesOnPipe>0</BytesOnPipe>
         <DebugMode>true</DebugMode>
      </ProcessStep>
      <ProcessStep>
         <ActionId>4</ActionId>
         <TechnicalName>iXadMan</TechnicalName>
         <DisplayName>URL_Reader_1.fa</DisplayName>
         <StartedAt>2022-11-04T10:12:26.425029Z</StartedAt>
         <FinishedAt>2022-11-04T10:12:26.433028Z</FinishedAt>
         <Status>-1</Status>
         <ExceptionMessage>de.softproject.integration.adapter.urlReader.URLReader from [Module "deployment.x4-7.3.0-SNAPSHOT.ear" from Service Module Loader]</ExceptionMessage>
         <Time>7</Time>
         <BytesOnPipe>0</BytesOnPipe>
         <DebugMode>true</DebugMode>
      </ProcessStep>
   </ProcessSteps>
</ProcessExecutionStepsDetail>

The following elements are included in the output;

Element	Description
`ProcessExecutionStepsDetail`	UUID of the process
`Paginate`	Paginate shows if data is output in subsets. `Pagante` has the following attributes: `limit`: limits the number of elements returned from the query `offset`: omits a specified number of elements
`ProcessSteps`	Enclosing element for `ProcessStep`.
`ProcessStep`	Includes the following elements for the process step: `ActionId` `TechnicalName` `DisplayName` `StartedAt` `FinishedAt` `Status` `ExceptionMessage` `Time` `BytesOnPipe` `DebugMode`
`ActionId`	?
`TechnicalName`	Technical name of the process module
`DisplayName`	Label of the process module
`StartedAt`	Date and time when process module was started.
`FinishedAt`	Date and time when process module was finished.
`Status`	Status value of the process module
`ExceptionMessage`	Outputs the exception message if an exception is thrown.
`Time`	Time elapsed for query in seconds?
`BytesOnPipe`	Bytes used by process module?
`DebugMode`	Indicates whether the process was executed in Debug mode or not.