You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/en/docs/2025.1/Guides/user-guides/user-interfaces/gateway/Admin/packages/package-version-editor.md
+43-23Lines changed: 43 additions & 23 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -49,18 +49,24 @@ The created {{% ctx %}} Package Version may optionally define Schedules to cause
49
49
50
50
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.
51
51
52
+
See the [Create a New Package Version tutorial][] for a step-by-step guide.
53
+
52
54
#### Publish a Package Version
53
55
54
56
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.
55
57
56
58
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.
57
59
60
+
See the [Publish a Package Version tutorial][] for a step-by-step guide.
61
+
58
62
#### Set As Default Package
59
63
60
64
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.
61
65
62
66
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.
63
67
68
+
See the [Set the Default Package tutorial][] for a step-by-step guide.
69
+
64
70
#### Set As Default Version
65
71
66
72
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
75
81
76
82
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.
77
83
84
+
See the [Set the Default Package Version tutorial][] for a step-by-step guide.
85
+
78
86
#### Unpublish a Package Version
79
87
80
88
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.
81
89
90
+
See the [Unpublish a Package Version tutorial][] for a step-by-step guide.
91
+
82
92
#### Export a Package Version
83
93
84
94
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`.
85
95
86
96
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.
87
97
98
+
See the [Export a Package Version tutorial][] for a step-by-step guide.
99
+
88
100
### Authorisation
89
101
90
102
The Authorisation tab on a package version defines which LDAP groups can execute flows contained in that package version, using Token-based OAuth2 authorisation.
91
103
92
104
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.
93
105
106
+
See the [Set Authorisation on a Package Version tutorial][] for a step-by-step guide.
107
+
94
108
### Schedules
95
109
96
110
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
101
115
102
116
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.
103
117
118
+
See the [Create a Schedule on a Package Version tutorial][] for a step-by-step guide.
119
+
104
120
### Triggers
105
121
106
122
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
129
145
130
146
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.
131
147
148
+
See the [Create a Trigger on a Package Version tutorial][] for a step-by-step guide.
149
+
132
150
### Running Executions
133
151
134
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.
135
153
136
154
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.
137
155
156
+
See the [View and Abort Running Flow Executions tutorial][] for a step-by-step guide.
157
+
138
158
## Remarks
139
159
140
160
### Known Limitations
@@ -148,20 +168,20 @@ Any running flow execution may be aborted by selecting the flow and clicking the
148
168
149
169
### Related Concepts
150
170
151
-
[What is a Package?][]
171
+
*[What is a Package?][]
152
172
153
173
### Related Tutorials
154
174
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]
165
185
166
186
[Authorisation]: {{< ref "#authorisation" >}}
167
187
[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
[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" >}}
0 commit comments