Skip to content

Commit 5428334

Browse files
author
Donna-Marie Smith
committed
modifications following 2nd PO Review
1 parent 5acfdee commit 5428334

File tree

2 files changed

+46
-26
lines changed

2 files changed

+46
-26
lines changed

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

Lines changed: 43 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -49,18 +49,24 @@ The created {{% ctx %}} Package Version may optionally define Schedules to cause
4949

5050
The new {{% ctx %}} Package Version does not retain any of the flow execution authorisation, schedules, nor any triggers set on the source {{% ctx %}} Package Version.
5151

52+
See the [Create a New Package Version tutorial][] for a step-by-step guide.
53+
5254
#### Publish a Package Version
5355

5456
When a {{% ctx %}} Package Version is published it is distributed to the execution nodes. The first execution of a flow on a node will cause the flow to be compiled, cached and executed on that node.
5557

5658
Published {{% ctx %}} Package Versions may be explicitly set as the Default Version for that {{% ctx %}} Package, meaning that a REST Request to execute a flow from that published {{% ctx %}} Package Version does not have to specify the Package Version.
5759

60+
See the [Publish a Package Version tutorial][] for a step-by-step guide.
61+
5862
#### Set As Default Package
5963

6064
The Default Package specifies which {{% ctx %}} Package will be used to execute flows if the execution REST Request omits the Package Name specifying the {{% ctx %}} Package to use. There is only one Default Package for each {{% ctx %}} system.
6165

6266
The Default Package can be set on any {{% ctx %}} Package that has a published {{% ctx %}} Package Version. If all the {{% ctx %}} Package Versions associated with the Default Package are unpublished, the Default Package remains unchanged.
6367

68+
See the [Set the Default Package tutorial][] for a step-by-step guide.
69+
6470
#### Set As Default Version
6571

6672
The Default Version specifies which {{% ctx %}} Package Version will be used to execute flows if the execution REST Request omits the Package Version specifying the {{% ctx %}} Package Version to use. Every {{% ctx %}} Package will have a Default Version set, either implicitly or explicitly.
@@ -75,22 +81,30 @@ If an unpublished {{% ctx %}} Package Version that was previously set as the Def
7581

7682
If all the {{% ctx %}} Package Versions of a {{% ctx %}} Package are unpublished and then a Package is republished, it will become implicitly set as the Default Version, even if it was explicitly set as the Default Version before unpublishing.
7783

84+
See the [Set the Default Package Version tutorial][] for a step-by-step guide.
85+
7886
#### Unpublish a Package Version
7987

8088
When a {{% ctx %}} Package Version is unpublished, it is removed from all the execution nodes and flow execution cannot be started for any flows in that package; however, any currently running executions from that Package Version will continue to completion. When all instances of an executing flow in an unpublished package have completed, the cache of the compiled flow discarded.
8189

90+
See the [Unpublish a Package Version tutorial][] for a step-by-step guide.
91+
8292
#### Export a Package Version
8393

8494
Any {{% ctx %}} Package Version can be exported to a file, which can be used for importing the package to another {{% ctx %}} Gateway or for archiving purposes. The export file is automatically downloaded from the browser and has the file name of `<Package Name>.ctxpkg`.
8595

8696
The exported file contains the {{% ctx %}} Package Version definition, and the flow definitions contained in the package. Any authorisation, schedules or triggers set on the {{% ctx %}} Package Version are not included in the exported file.
8797

98+
See the [Export a Package Version tutorial][] for a step-by-step guide.
99+
88100
### Authorisation
89101

90102
The Authorisation tab on a package version defines which LDAP groups can execute flows contained in that package version, using Token-based OAuth2 authorisation.
91103

92104
The list of Active Directory objects displayed to define flow execution authorisation is filtered by the Base DNs configured in LDAP Connection for {{% ctx %}} Gateway.
93105

106+
See the [Set Authorisation on a Package Version tutorial][] for a step-by-step guide.
107+
94108
### Schedules
95109

96110
A schedule causes a flow execution at a predetermined time, optionally passing values to the flow’s input variables. A single flow may be triggered by several different schedules, and several different schedules may trigger several flows.
@@ -101,6 +115,8 @@ Any data to be passed to the flow’s input variables is entered using Expressio
101115

102116
Creating a new package version will not inherit the schedule configuration from the source package version. Similarly, exporting a package version will not include the package’s Schedule in the {{% ctx %}} Package file.
103117

118+
See the [Create a Schedule on a Package Version tutorial][] for a step-by-step guide.
119+
104120
### Triggers
105121

106122
A trigger causes a flow execution on receipt of an SNMP Trap event, optionally passing static values to the flow’s input variables, and if required, the SNMP Trap PDU can be stored in a selected input variable as an object. A single flow may be executed by several different triggers, and several different triggers may initiate the execution of several flows.
@@ -129,12 +145,16 @@ Any data to be passed to the flow’s input variables is entered using Expressio
129145

130146
Creating a new package version will not inherit the trigger configuration from the source package version. Similarly, exporting a package version will not include the package’s trigger configuration in the {{% ctx %}} Package file.
131147

148+
See the [Create a Trigger on a Package Version tutorial][] for a step-by-step guide.
149+
132150
### Running Executions
133151

134152
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.
135153

136154
Any running flow execution may be aborted by selecting the flow and clicking the `Stop the execution` icon. The flow execution will be immediately stopped.
137155

156+
See the [View and Abort Running Flow Executions tutorial][] for a step-by-step guide.
157+
138158
## Remarks
139159

140160
### Known Limitations
@@ -148,20 +168,20 @@ Any running flow execution may be aborted by selecting the flow and clicking the
148168

149169
### Related Concepts
150170

151-
[What is a Package?][]
171+
* [What is a Package?][]
152172

153173
### Related Tutorials
154174

155-
* [Create a New Version of a {{% ctx %}} Package][]
156-
* [Publish a {{% ctx %}} Package][]
157-
* [Set the Default Package][]
158-
* [Set the Default Package Version for a {{% ctx %}} Package][]
159-
* [Unpublish a {{% ctx %}} Package][]
160-
* [Export a {{% ctx %}} Package Version][]
161-
* [Set Flow Execution Authorisation on a {{% ctx %}} Package][]
162-
* [Create a Schedule on a {{% ctx %}} Package][]
163-
* [Create a Trigger on a {{% ctx %}} Package][]
164-
* [View and Abort Running Executions using {{% ctx %}} Package Management][]
175+
* [Create a New Package Version][Create a New Package Version tutorial]
176+
* [Publish a Package Version][Publish a Package Version tutorial]
177+
* [Set the Default Package][Set the Default Package tutorial]
178+
* [Set the Default Package Version][Set the Default Package Version tutorial]
179+
* [Unpublish a Package Version][Unpublish a Package Version tutorial]
180+
* [Export a Package Version][Export a Package Version tutorial]
181+
* [Set Authorisation on a Package Version][Set Authorisation on a Package Version tutorial]
182+
* [Create a Schedule on a Package Version][Create a Schedule on a Package Version tutorial]
183+
* [Create a Trigger on a Package Version][Create a Trigger on a Package Version tutorial]
184+
* [View and Abort Running Flow Executions][View and Abort Running Flow Executions tutorial]
165185

166186
[Authorisation]: {{< ref "#authorisation" >}}
167187
[Create New Version]: {{< ref "#create-a-new-package-version" >}}
@@ -170,20 +190,20 @@ Any running flow execution may be aborted by selecting the flow and clicking the
170190
[Publish]: {{< ref "#publish-a-package-version" >}}
171191
[Running Executions]: {{< ref "#running-executions" >}}
172192
[Schedules]: {{< ref "#schedules" >}}
173-
[Set As Default Package]: {{< ref "#set-default-package" >}}
174-
[Set As Default Version]: {{< ref "#set-default-package-version" >}}
193+
[Set As Default Package]: {{< ref "#set-as-default-package" >}}
194+
[Set As Default Version]: {{< ref "#set-as-default-version" >}}
175195
[Triggers]: {{< ref "#triggers" >}}
176196
[Unpublish]: {{< ref "#unpublish-a-package-version" >}}
177197

178-
[Create a New Version of a {{% ctx %}} Package]: {{< url path="Cortex.Tutorials.Administration.PackageManagement.CreateNewPackageVersion" >}}
179-
[Create a Schedule on a {{% ctx %}} Package]: {{< url path="Cortex.Tutorials.Administration.PackageManagement.Schedules" >}}
180-
[Create a Trigger on a {{% ctx %}} Package]: {{< url path="Cortex.Tutorials.Administration.PackageManagement.Triggers" >}}
181-
[Export a {{% ctx %}} Package Version]: {{< url path="Cortex.Tutorials.Administration.PackageManagement.ExportPackage" >}}
182-
[Publish a {{% ctx %}} Package]: {{< url path="Cortex.Tutorials.Administration.PackageManagement.PublishPackage" >}}
183-
[Set Flow Execution Authorisation on a {{% ctx %}} Package]: {{< url path="Cortex.Tutorials.Administration.PackageManagement.Authorisation" >}}
184-
[Set the Default Package]: {{< url path="Cortex.Tutorials.Administration.PackageManagement.SetDefaultPackage" >}}
185-
[Set the Default Package Version for a {{% ctx %}} Package]: {{< url path="Cortex.Tutorials.Administration.PackageManagement.SetDefaultPackageVersion" >}}
186-
[Unpublish a {{% ctx %}} Package]: {{< url path="Cortex.Tutorials.Administration.PackageManagement.UnpublishPackage" >}}
187-
[View and Abort Running Executions using {{% ctx %}} Package Management]: {{< url path="Cortex.Tutorials.Administration.PackageManagement.RunningExecutions" >}}
198+
[Create a New Package Version tutorial]: {{< url path="Cortex.Tutorials.Administration.PackageManagement.CreateNewPackageVersion" >}}
199+
[Create a Schedule on a Package Version tutorial]: {{< url path="Cortex.Tutorials.Administration.PackageManagement.Schedules" >}}
200+
[Create a Trigger on a Package Version tutorial]: {{< url path="Cortex.Tutorials.Administration.PackageManagement.Triggers" >}}
201+
[Export a Package Version tutorial]: {{< url path="Cortex.Tutorials.Administration.PackageManagement.ExportPackage" >}}
202+
[Publish a Package Version tutorial]: {{< url path="Cortex.Tutorials.Administration.PackageManagement.PublishPackage" >}}
203+
[Set Authorisation on a Package Version tutorial]: {{< url path="Cortex.Tutorials.Administration.PackageManagement.Authorisation" >}}
204+
[Set the Default Package tutorial]: {{< url path="Cortex.Tutorials.Administration.PackageManagement.SetDefaultPackage" >}}
205+
[Set the Default Package Version tutorial]: {{< url path="Cortex.Tutorials.Administration.PackageManagement.SetDefaultPackageVersion" >}}
206+
[Unpublish a Package Version tutorial]: {{< url path="Cortex.Tutorials.Administration.PackageManagement.UnpublishPackage" >}}
207+
[View and Abort Running Flow Executions tutorial]: {{< url path="Cortex.Tutorials.Administration.PackageManagement.RunningExecutions" >}}
188208
[Package Definitions Grid]: {{< url path="Cortex.Guides.UserGuides.UserInterfaces.Gateway.Admin.Packages.PackageDefinitionsGrid.MainDoc" >}}
189209
[What is a Package?]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Packages.WhatIsAPackage.MainDoc" >}}

data/urls.toml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2582,13 +2582,13 @@
25822582
[Cortex.Tutorials.Administration.PackageManagement]
25832583
MainDoc = "/docs/tutorials/administration/package-management"
25842584
Authorisation = "/docs/tutorials/administration/package-management/#set-authorisation-on-a-package-version"
2585-
CreateNewPackageVersion = "/docs/tutorials/administration/package-management/#create-a-new-version-of-a-cortex-package"
2585+
CreateNewPackageVersion = "/docs/tutorials/administration/package-management/#create-a-new-package-version"
25862586
CreatePackage = "/docs/tutorials/administration/package-management/#create-a-package"
25872587
ExportPackage = "/docs/tutorials/administration/package-management/#export-a-package-version"
25882588
ImportPackage = "/docs/tutorials/administration/package-management/#import-a-package"
25892589
PublishPackage = "/docs/tutorials/administration/package-management/#publish-a-package-version"
2590-
RunningExecutions = "/docs/tutorials/administration/package-management/#view-and-abort-running-executions"
2591-
Schedules = "/docs/tutorials/administration/package-management/#create-a-Schedule-on-a-package-version"
2590+
RunningExecutions = "/docs/tutorials/administration/package-management/#view-and-abort-running-flow-executions"
2591+
Schedules = "/docs/tutorials/administration/package-management/#create-a-schedule-on-a-package-version"
25922592
SetDefaultPackage = "/docs/tutorials/administration/package-management/#set-the-default-package"
25932593
SetDefaultPackageVersion = "/docs/tutorials/administration/package-management/#set-the-default-package-version"
25942594
Triggers = "/docs/tutorials/administration/package-management/#create-a-trigger-on-a-package-version"

0 commit comments

Comments
 (0)