flowChartRunInfo
| Namespace: |
(default namespace) |
| XML Schema: |
ns0.xsd |
Contains information about a flow chart run. A flow chart run is the time it
takes for any execution flow to cross a pre-defined starting point in a flow
chart until any execution flow crosses a pre-defined ending point in the same
flow chart.
By default, the start of a run occurs when a flow chart first begins
executing, and the end of a run occurs when a flow chart is completely
finished and deleted from the engine.
In other words, by default, a run constitutes the lifetime of a flow chart.
However, for finer-grained reporting, set an explicit start and end of a
run.
XML
Elements
| name (type) |
min/max
occurs |
description |
|
runId (long)
|
1/1 |
Returns the last PK of this flow chart run.
|
|
flowChartName (string)
|
0/1 |
Returns the name of the flow chart with which this run is associated.
|
|
startOfRun (dateTime)
|
0/1 |
Returns the timestamp for the commencement of this flow chart run. Does not
return null.
|
|
enterOfRun (dateTime)
|
0/1 |
Returns the timestamp for the commencement of this flow chart run. Does not
return null.
|
|
endOfRun (dateTime)
|
0/1 |
Returns the timestamp for the completion of this flow chart run. If this
flow chart run has not completed yet, returns null.
|
|
runTime (long)
|
1/1 |
Returns the difference between the start-of-run and end-of-run timestamps
in milliseconds.
|
|
averageRunTime (long)
|
1/1 |
Returns the average length of execution time in milliseconds for all runs
in the specified namespace. A -1 is returned if no runs are found.
|
|
averageRunTimeFormatted (string)
|
0/1 |
Returns the formatted average length of execution time in milliseconds for all runs
in the specified namespace. A -1 is returned if no runs are found.
|
|
finishedPrematurely (boolean)
|
1/1 |
Indicates whether this flow chart was removed from the engine before the
flow chart run finished.
|
|
actions/action (actionHistoryInfo)
|
0/unbounded |
Returns list of ActionHistoryInfo.
|
|
startOfRunFormatted (string)
|
0/1 |
Returns the formatted timestamp for the commencement of this flow chart run. Does not
return null.
|
|
enterOfRunFormatted (string)
|
0/1 |
|
|
endOfRunFormatted (string)
|
0/1 |
Returns the formatted timestamp for the completion of this flow chart run. If this
flow chart run has not completed yet, returns null.
|
|
runTimeFormatted (string)
|
0/1 |
Returns the formatted difference between the start-of-run and end-of-run timestamps
in milliseconds.
|
JSON
| property |
type |
description |
| runId |
runId (long)
|
Returns the last PK of this flow chart run.
|
| flowChartName |
flowChartName (string)
|
Returns the name of the flow chart with which this run is associated.
|
| startOfRun |
startOfRun (dateTime)
|
Returns the timestamp for the commencement of this flow chart run. Does not
return null.
|
| enterOfRun |
enterOfRun (dateTime)
|
Returns the timestamp for the commencement of this flow chart run. Does not
return null.
|
| endOfRun |
endOfRun (dateTime)
|
Returns the timestamp for the completion of this flow chart run. If this
flow chart run has not completed yet, returns null.
|
| runTime |
runTime (long)
|
Returns the difference between the start-of-run and end-of-run timestamps
in milliseconds.
|
| averageRunTime |
averageRunTime (long)
|
Returns the average length of execution time in milliseconds for all runs
in the specified namespace. A -1 is returned if no runs are found.
|
| averageRunTimeFormatted |
averageRunTimeFormatted (string)
|
Returns the formatted average length of execution time in milliseconds for all runs
in the specified namespace. A -1 is returned if no runs are found.
|
| finishedPrematurely |
finishedPrematurely (boolean)
|
Indicates whether this flow chart was removed from the engine before the
flow chart run finished.
|
| actions |
array of actions/action (actionHistoryInfo)
|
Returns list of ActionHistoryInfo.
|
| startOfRunFormatted |
startOfRunFormatted (string)
|
Returns the formatted timestamp for the commencement of this flow chart run. Does not
return null.
|
| enterOfRunFormatted |
enterOfRunFormatted (string)
|
|
| endOfRunFormatted |
endOfRunFormatted (string)
|
Returns the formatted timestamp for the completion of this flow chart run. If this
flow chart run has not completed yet, returns null.
|
| runTimeFormatted |
runTimeFormatted (string)
|
Returns the formatted difference between the start-of-run and end-of-run timestamps
in milliseconds.
|