Skip to content

Commit f9d1d8e

Browse files
author
Donna-Marie Smith
committed
Extended Running Executions documentation
1 parent aa060c2 commit f9d1d8e

File tree

9 files changed

+119
-38
lines changed

9 files changed

+119
-38
lines changed

content/en/docs/2025.9/Guides/user-guides/user-interfaces/gateway/Admin/packages/package-version-editor.md

Lines changed: 72 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -149,11 +149,48 @@ See the [Create a Trigger on a Package Version][Create a Trigger on a Package Ve
149149

150150
### Running Executions
151151

152-
The Running Executions tab displays a list of currently running flow executions for the selected package version. Each row in the list is a distinct flow execution, and identifies the `Flow Name`, its `Execution Id`, the time the execution `Started At`, and the `Duration` of that execution; the `Duration` is updated at 10 second intervals.
152+
{{< figure src="/images/Package Version Editor - Running Executions.png" title="Running Executions Grid" >}}
153153

154-
Any running flow execution may be aborted by selecting the flow and clicking the `Stop the execution` icon. The flow execution will be stopped immediately.
154+
The Running Executions tab displays a list of currently running flow executions for the selected package version. Each row in the list is a distinct flow execution, and identifies:
155155

156-
See the [View and Abort Running Flow Executions][View and Abort Running Flow Executions tutorial] tutorial for a step-by-step guide.
156+
* `Flow Name` - the name of the flow being executed.
157+
* `Execution Id` - the unique execution ID for this flow.
158+
* `Parent Execution Id` - the Execution ID of the flow that initiated the execution of this flow. If this flow was not initiated by another flow the Parent Execution Id is blank.
159+
* `Root Execution Id` - the Execution ID of the initial flow to be executed. If this flow is the initially executed flow, its Execution Id will be also the Root Execution Id. If this flow execution was initiated by another flow, if will share the same Root Execution Id to that of the parent flow.
160+
* `Started At` - the date and time when this flow started executing.
161+
* `Duration` - the current duration of the flow in seconds; the Duration is updated at 10 second intervals.
162+
* `Executing On` - identifies the node executing this flow. It has the format of `<Installation>.<Host Name> (<IPv4 Address)`, `<Installation>` is a custom text string specified at the time of installation, `<Host Name>` is the name of the host server, and `<IPv4 Address>` is the IP address configured on the host’s network adaptor.
163+
* `Debugged By`– identifies the user that has attached to this flow to debug it in {{% ctx %}} Gateway. This will be blank if a user is not attached to the flow.
164+
165+
#### Filter Running Executions
166+
167+
Flows may be filtered by entering text into the search field of any column to form a partial text match with the displayed data.
168+
169+
Note: The `Started At` column must be filtered using the date-time format of `yyyy-MM-ddThh:mm:ss`. A partial match of digits used in the `Started At` filter may be used.
170+
171+
See the [View Running Executions][View Running Executions tutorial] tutorial for a step-by-step guide.
172+
173+
#### Group, Sort and Aggregate Running Executions
174+
175+
The {{< image src="/images/Package Version Editor - Filter Options.png" >}} icon to the right of each column name reveals a menu enabling the executing flows to be grouped, sorted, or have an aggregation function applied the column’s data.
176+
177+
See the [View Running Executions][View Running Executions tutorial] tutorial for a step-by-step guide.
178+
179+
#### Stop Running Executions
180+
181+
Any running flow execution may be aborted by selecting the flow and clicking the {{< image src="/images/Package Version Editor - Stop Execution.png" >}} icon. The flow execution will be stopped immediately.
182+
183+
Multiple executions may be stopped simultaneously by selecting the executions by holding down the Ctrl or Shift key and clicking the executions to select, then clicking the `Stop the execution` icon.
184+
185+
See the [Stop Running Executions][Stop Running Executions tutorial] tutorial for a step-by-step guide.
186+
187+
#### Debug Running Executions
188+
189+
A running execution may be debugged in {{% ctx %}} Gateway by selecting the execution in the Running Executions grid and clicking the {{< image src="/images/Package Version Editor - Attach to Execution.png" >}} icon; all dependent running executions will also be automatically attached to the same {{% ctx %}} Gateway session, which will open in a new window.
190+
191+
To abort debugging in {{% ctx %}} Gateway, detach the execution by clicking the {{< image src="/images/Package Version Editor - Detach from Execution.png" >}} icon. Any paused executions in {{% ctx %}} Gateway will immediately continue running. If any changes have been made to the executing flow whilst debugging in {{% ctx %}} Gateway, these changes will persist for this execution only after the execution has been detached.
192+
193+
See the [Debug Running Executions][Debug Running Executions tutorial] tutorial for a step-by-step guide.
157194

158195
## Remarks
159196

@@ -173,16 +210,23 @@ See the [View and Abort Running Flow Executions][View and Abort Running Flow Exe
173210

174211
### Related Tutorials
175212

176-
* [Create a New Package Version][Create a New Package Version tutorial]
177-
* [Publish a Package Version][Publish a Package Version tutorial]
178-
* [Set the Default Package][Set the Default Package tutorial]
179-
* [Set the Default Package Version][Set the Default Package Version tutorial]
180-
* [Unpublish a Package Version][Unpublish a Package Version tutorial]
181-
* [Export a Package Version][Export a Package Version tutorial]
182-
* [Set Authorisation on a Package Version][Set Authorisation on a Package Version tutorial]
183-
* [Create a Schedule on a Package Version][Create a Schedule on a Package Version tutorial]
184-
* [Create a Trigger on a Package Version][Create a Trigger on a Package Version tutorial]
185-
* [View and Abort Running Flow Executions][View and Abort Running Flow Executions tutorial]
213+
* [Definition][Definition tutorials]
214+
* [Create a New Package Version][Create a New Package Version tutorial]
215+
* [Publish a Package Version][Publish a Package Version tutorial]
216+
* [Set the Default Package][Set the Default Package tutorial]
217+
* [Set the Default Package Version][Set the Default Package Version tutorial]
218+
* [Unpublish a Package Version][Unpublish a Package Version tutorial]
219+
* [Export a Package Version][Export a Package Version tutorial]
220+
* [Authorisation][Authorisation tutorials]
221+
* [Set Authorisation on a Package Version][Set Authorisation on a Package Version tutorial]
222+
* [Schedules][Schedules tutorials]
223+
* [Create a Schedule on a Package Version][Create a Schedule on a Package Version tutorial]
224+
* [Triggers][Triggers tutorials]
225+
* [Create a Trigger on a Package Version][Create a Trigger on a Package Version tutorial]
226+
* [Running Executions][Running Executions tutorials]
227+
* [View Running Executions][View Running Executions tutorial]
228+
* [Stop Running Executions][Stop Running Executions tutorial]
229+
* [Debug Running Executions][Debug Running Executions tutorial]
186230

187231
[Authorisation]: {{< ref "#authorisation" >}}
188232
[Create New Version]: {{< ref "#create-a-new-package-version" >}}
@@ -196,18 +240,26 @@ See the [View and Abort Running Flow Executions][View and Abort Running Flow Exe
196240
[Triggers]: {{< ref "#triggers" >}}
197241
[Unpublish]: {{< ref "#unpublish-a-package-version" >}}
198242

243+
[Authorisation tutorials]: {{< url path="Cortex.Tutorials.Administration.PackageManagement.Authorisation" >}}
199244
[Create a New Package Version tutorial]: {{< url path="Cortex.Tutorials.Administration.PackageManagement.CreateNewPackageVersion" >}}
200-
[Create a Schedule on a Package Version tutorial]: {{< url path="Cortex.Tutorials.Administration.PackageManagement.Schedules" >}}
201-
[Create a Trigger on a Package Version tutorial]: {{< url path="Cortex.Tutorials.Administration.PackageManagement.Triggers" >}}
245+
[Create a Schedule on a Package Version tutorial]: {{< url path="Cortex.Tutorials.Administration.PackageManagement.CreateSchedules" >}}
246+
[Create a Trigger on a Package Version tutorial]: {{< url path="Cortex.Tutorials.Administration.PackageManagement.CreateTriggers" >}}
247+
[Debug Running Executions tutorial]: {{< url path="Cortex.Tutorials.Administration.PackageManagement.DebugRunningExecutions" >}}
248+
[Definition tutorials]: {{< url path="Cortex.Tutorials.Administration.PackageManagement.Definition" >}}
202249
[Export a Package Version tutorial]: {{< url path="Cortex.Tutorials.Administration.PackageManagement.ExportPackage" >}}
203-
[Expression Editor]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.PropertyEditors.ExpressionEditor.MainDoc" >}}
204-
[Import]: {{< url path="Cortex.Guides.UserGuides.UserInterfaces.Gateway.Admin.Packages.PackageDefinitionsGrid.Import" >}}
205-
[Input Variables]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Variables.WhatIsAVariable.FlowInputVariable" >}}
206250
[Publish a Package Version tutorial]: {{< url path="Cortex.Tutorials.Administration.PackageManagement.PublishPackage" >}}
207-
[Set Authorisation on a Package Version tutorial]: {{< url path="Cortex.Tutorials.Administration.PackageManagement.Authorisation" >}}
251+
[Running Executions tutorials]: {{< url path="Cortex.Tutorials.Administration.PackageManagement.RunningExecutions" >}}
252+
[Schedules tutorials]: {{< url path="Cortex.Tutorials.Administration.PackageManagement.Schedules" >}}
253+
[Set Authorisation on a Package Version tutorial]: {{< url path="Cortex.Tutorials.Administration.PackageManagement.SetAuthorisation" >}}
208254
[Set the Default Package tutorial]: {{< url path="Cortex.Tutorials.Administration.PackageManagement.SetDefaultPackage" >}}
209255
[Set the Default Package Version tutorial]: {{< url path="Cortex.Tutorials.Administration.PackageManagement.SetDefaultPackageVersion" >}}
256+
[Stop Running Executions tutorial]: {{< url path="Cortex.Tutorials.Administration.PackageManagement.StopRunningExecutions" >}}
257+
[Triggers tutorials]: {{< url path="Cortex.Tutorials.Administration.PackageManagement.Triggers" >}}
210258
[Unpublish a Package Version tutorial]: {{< url path="Cortex.Tutorials.Administration.PackageManagement.UnpublishPackage" >}}
211-
[View and Abort Running Flow Executions tutorial]: {{< url path="Cortex.Tutorials.Administration.PackageManagement.RunningExecutions" >}}
259+
[View Running Executions tutorial]: {{< url path="Cortex.Tutorials.Administration.PackageManagement.ViewRunningExecutions" >}}
260+
261+
[Expression Editor]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.PropertyEditors.ExpressionEditor.MainDoc" >}}
262+
[Import]: {{< url path="Cortex.Guides.UserGuides.UserInterfaces.Gateway.Admin.Packages.PackageDefinitionsGrid.Import" >}}
263+
[Input Variables]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Variables.WhatIsAVariable.FlowInputVariable" >}}
212264
[Package Definitions Grid]: {{< url path="Cortex.Guides.UserGuides.UserInterfaces.Gateway.Admin.Packages.PackageDefinitionsGrid.MainDoc" >}}
213265
[What is a Package?]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Packages.WhatIsAPackage.MainDoc" >}}

content/en/docs/2025.9/Guides/user-guides/user-interfaces/gateway/ops/overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ To view Service Fabric Explorer, the Service Fabric client certificate must be {
3131

3232
#### Running Executions
3333

34-
This tile displays the current number of [Running Executions][]. The {{< image src="/images/GoTo.png" >}} icon navigates to the [Package Management][Package Management] feature, to provide a breakdown of running executions by package version and flow.
34+
This tile displays the current number of [Running Executions][], including any child executions. The {{< image src="/images/GoTo.png" >}} icon navigates to the [Package Management][Package Management] feature, to provide a breakdown of running executions by package version and flow.
3535

3636
### Filters
3737

content/en/docs/2025.9/Tutorials/Administration/package-management.md

Lines changed: 35 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -7,50 +7,72 @@ weight: 200
77

88
# {{% param title %}}
99

10-
## Create a Package
10+
## Package Definitions Grid
11+
12+
### Create a Package
1113

1214
{{< scribe title="How_to_Create_a_New_CORTEX_Package_Definition" id="T_4G1ik0QPmBX9Za6m4WsA" >}}
1315

14-
## Import a Package
16+
### Import a Package
1517

1618
{{< scribe title="How_to_Import_a_CORTEX_Package_File" id="2uhQbG_rTomCCVJTcCjN8A" >}}
1719

18-
## Create a New Package Version
20+
## Package Version Editor
21+
22+
### Definition
23+
24+
#### Create a New Package Version
1925

2026
{{< scribe title="How_to_Create_a_New_Version_of_a_CORTEX_Package" id="D9ugVBuYQiiialecvXbVVQ" >}}
2127

22-
## Publish a Package Version
28+
#### Publish a Package Version
2329

2430
{{< scribe title="How_to_Publish_a_CORTEX_Package" id="1Qd2iu1RRpKyoCCzzf6wpQ" >}}
2531

26-
## Set the Default Package
32+
#### Set the Default Package
2733

2834
{{< scribe title="How_to_Set_the_Default_Package" id="XS8ged-jSKC7gR4UXAKPgQ" >}}
2935

30-
## Set the Default Package Version
36+
#### Set the Default Package Version
3137

3238
{{< scribe title="How_to_Set_the_Default_Package_Version_for_a_CORTEX_Package" id="cfuXBngKRkmSPdA81juTbA" >}}
3339

34-
## Unpublish a Package Version
40+
#### Unpublish a Package Version
3541

3642
{{< scribe title="How_to_Unpublish_a_CORTEX_Package" id="gl8v5p__R3OlB8oLB9m28w" >}}
3743

38-
## Export a Package Version
44+
#### Export a Package Version
3945

4046
{{< scribe title="How_to_Export_a_CORTEX_Package_Version" id="roziXdU1TqST2d9a2IDOxA" >}}
4147

42-
## Set Authorisation on a Package Version
48+
### Authorisation
49+
50+
#### Set Authorisation on a Package Version
4351

4452
{{< scribe title="How_to_Set_Flow_Execution_Authorisation_on_a_CORTEX_Package" id="s9ZN9efvTrCgJQQH2aTGsw" >}}
4553

46-
## Create a Schedule on a Package Version
54+
### Schedules
55+
56+
#### Create a Schedule on a Package Version
4757

4858
{{< scribe title="How_to_Create_a_Schedule_on_a_CORTEX_Package" id="PmxB9BveTb6DIqhaI4AWTA" >}}
4959

50-
## Create a Trigger on a Package Version
60+
### Triggers
61+
62+
#### Create a Trigger on a Package Version
5163

5264
{{< scribe title="How_to_Create_a_Trigger_on_a_CORTEX_Package" id="z6CwThFVTHSRdL1mAMFPsQ" >}}
5365

54-
## View and Abort Running Flow Executions
66+
### Running Executions
67+
68+
#### View Running Executions
69+
70+
{{< scribe title="View_Published_Running_Executions" id="OrKFGSI6TT6gfeG9-UjuVQ" >}}
71+
72+
#### Stop Running Executions
73+
74+
{{< scribe title="Stop_Published_Running_Executions" id="6iA_QdvgTwuddrtmszbXTw" >}}
75+
76+
#### Debug Running Executions
5577

56-
{{< scribe title="How_to_View_and_Abort_Running_Flow_Executions_Using_CORTEX_Package_Management" id="Dgi3cpo4TZ-G426w6GEkUQ" >}}
78+
{{< scribe title="Debug_Published_Running_Executions_in_CORTEX_Gateway" id="znO622WqQj28lFD6mulotw" >}}
499 Bytes
Loading
783 Bytes
Loading
297 Bytes
Loading
434 KB
Loading
242 Bytes
Loading

data/urls.toml

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3129,18 +3129,25 @@
31293129
CheckLicenseConsumption = "/docs/tutorials/administration/license-consumption/#check-license-consumption"
31303130
[Cortex.Tutorials.Administration.PackageManagement]
31313131
MainDoc = "/docs/tutorials/administration/package-management"
3132-
Authorisation = "/docs/tutorials/administration/package-management/#set-authorisation-on-a-package-version"
3132+
Authorisation = "/docs/tutorials/administration/package-management/#authorisation"
31333133
CreateNewPackageVersion = "/docs/tutorials/administration/package-management/#create-a-new-package-version"
31343134
CreatePackage = "/docs/tutorials/administration/package-management/#create-a-package"
3135+
CreateSchedules = "/docs/tutorials/administration/package-management/#create-a-schedule-on-a-package-version"
3136+
CreateTriggers = "/docs/tutorials/administration/package-management/#create-a-trigger-on-a-package-version"
3137+
DebugRunningExecutions = "/docs/tutorials/administration/package-management/#debug-running-executions"
3138+
Definition = "/docs/tutorials/administration/package-management/#definition"
31353139
ExportPackage = "/docs/tutorials/administration/package-management/#export-a-package-version"
31363140
ImportPackage = "/docs/tutorials/administration/package-management/#import-a-package"
31373141
PublishPackage = "/docs/tutorials/administration/package-management/#publish-a-package-version"
3138-
RunningExecutions = "/docs/tutorials/administration/package-management/#view-and-abort-running-flow-executions"
3139-
Schedules = "/docs/tutorials/administration/package-management/#create-a-schedule-on-a-package-version"
3142+
RunningExecutions = "/docs/tutorials/administration/package-management/#running-executions"
3143+
Schedules = "/docs/tutorials/administration/package-management/#schedules"
3144+
SetAuthorisation = "/docs/tutorials/administration/package-management/#set-authorisation-on-a-package-version"
31403145
SetDefaultPackage = "/docs/tutorials/administration/package-management/#set-the-default-package"
31413146
SetDefaultPackageVersion = "/docs/tutorials/administration/package-management/#set-the-default-package-version"
3142-
Triggers = "/docs/tutorials/administration/package-management/#create-a-trigger-on-a-package-version"
3147+
StopRunningExecutions = "/docs/tutorials/administration/package-management/#stop-running-executions"
3148+
Triggers = "/docs/tutorials/administration/package-management/#triggers"
31433149
UnpublishPackage = "/docs/tutorials/administration/package-management/#unpublish-a-package-version"
3150+
ViewRunningExecutions = "/docs/tutorials/administration/package-management/#view-running-executions"
31443151
[Cortex.Tutorials.Administration.StudioAuthorisation]
31453152
MainDoc = "/docs/tutorials/administration/studio-authorisation"
31463153
ManageFlowAccess = "/docs/tutorials/administration/studio-authorisation/#manage-flow-access"

0 commit comments

Comments
 (0)