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-definitions-grid.md
+4-3Lines changed: 4 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,6 +18,7 @@ The Package Definitions Grid displays a list of existing [{{% ctx %}} Package][W
18
18
The Package Definitions Grid shows the most recently created version of each package; older versions can be viewed by expanding the package definition. Selecting a package version will display it's details in the [Package Version Editor][].
19
19
20
20
The Package Definitions Grid also contains buttons to:
21
+
21
22
*[Create a Package][]
22
23
*[Import a Package][]
23
24
@@ -33,17 +34,17 @@ If a selected flow has dependent flows, the dependent flow will be automatically
33
34
34
35
The package may optionally [define LDAP groups][Authorisation] that can execute flows, [schedules][] to run flows at specific times, and [triggers][] to run flows on receipt of specific SNMP Traps.
35
36
36
-
See the [Create a Packagetutorial][] for a step-by-step guide.
37
+
See the [Create a Package][Create a Package tutorial] tutorial for a step-by-step guide.
37
38
38
39
### Import a Package
39
40
40
-
A {{% ctx %}} Package file, with the extension of `.ctxpkg`, may be imported into any {{% ctx %}} Gateway by clicking the `Import` button and selecting the `.ctxpkg` file to import.
41
+
A {{% ctx %}} Package file, with the extension of `.ctxpkg`, may be imported into any {{% ctx %}} Gateway by clicking the `Import` button and selecting the `.ctxpkg` file to import.
41
42
42
43
If the imported package already exists in {{% ctx %}} Gateway, a new version of that package will be created; if the imported package does not exist, a new package will be created.
43
44
44
45
All the flows contained in the package will be saved in the Master Repository of the destination {{% ctx %}} Gateway as the master versions of those flows; if the imported flows already existed, the imported flows would become the new master versions.
45
46
46
-
See the [Import a Packagetutorial][] for a step-by-step guide.
47
+
See the [Import a Package][Import a Package tutorial] tutorial for a step-by-step guide.
Copy file name to clipboardExpand all lines: content/en/docs/2025.1/Guides/user-guides/user-interfaces/gateway/Admin/packages/package-version-editor.md
+10-10Lines changed: 10 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -49,23 +49,23 @@ 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 Versiontutorial][] for a step-by-step guide.
52
+
See the [Create a New Package Version][Create a New Package Version tutorial] tutorial for a step-by-step guide.
53
53
54
54
#### Publish a Package Version
55
55
56
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.
57
57
58
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.
59
59
60
-
See the [Publish a Package Versiontutorial][] for a step-by-step guide.
60
+
See the [Publish a Package Version][Publish a Package Version tutorial] tutorial for a step-by-step guide.
61
61
62
62
#### Set As Default Package
63
63
64
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.
65
65
66
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.
67
67
68
-
See the [Set the Default Packagetutorial][] for a step-by-step guide.
68
+
See the [Set the Default Package][Set the Default Package tutorial] tutorial for a step-by-step guide.
69
69
70
70
#### Set As Default Version
71
71
@@ -81,29 +81,29 @@ If an unpublished {{% ctx %}} Package Version that was previously set as the Def
81
81
82
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.
83
83
84
-
See the [Set the Default Package Versiontutorial][] for a step-by-step guide.
84
+
See the [Set the Default Package Version][Set the Default Package Version tutorial] tutorial for a step-by-step guide.
85
85
86
86
#### Unpublish a Package Version
87
87
88
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.
89
89
90
-
See the [Unpublish a Package Versiontutorial][] for a step-by-step guide.
90
+
See the [Unpublish a Package Version][Unpublish a Package Version tutorial] tutorial for a step-by-step guide.
91
91
92
92
#### Export a Package Version
93
93
94
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`.
95
95
96
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.
97
97
98
-
See the [Export a Package Versiontutorial][] for a step-by-step guide.
98
+
See the [Export a Package Version][Export a Package Version tutorial] tutorial for a step-by-step guide.
99
99
100
100
### Authorisation
101
101
102
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.
103
103
104
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.
105
105
106
-
See the [Set Authorisation on a Package Versiontutorial][] for a step-by-step guide.
106
+
See the [Set Authorisation on a Package Version][Set Authorisation on a Package Version tutorial] tutorial for a step-by-step guide.
107
107
108
108
### Schedules
109
109
@@ -115,7 +115,7 @@ Any data to be passed to the flow’s input variables is entered using Expressio
115
115
116
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.
117
117
118
-
See the [Create a Schedule on a Package Versiontutorial][] for a step-by-step guide.
118
+
See the [Create a Schedule on a Package Version][Create a Schedule on a Package Version tutorial] tutorial for a step-by-step guide.
119
119
120
120
### Triggers
121
121
@@ -145,15 +145,15 @@ Any data to be passed to the flow’s input variables is entered using Expressio
145
145
146
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.
147
147
148
-
See the [Create a Trigger on a Package Versiontutorial][] for a step-by-step guide.
148
+
See the [Create a Trigger on a Package Version][Create a Trigger on a Package Version tutorial] tutorial for a step-by-step guide.
149
149
150
150
### Running Executions
151
151
152
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.
153
153
154
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.
155
155
156
-
See the [View and Abort Running Flow Executionstutorial][] for a step-by-step guide.
156
+
See the [View and Abort Running Flow Executions][View and Abort Running Flow Executions tutorial] tutorial for a step-by-step guide.
0 commit comments