Skip to content

Commit 9d6a23d

Browse files
author
Donna-Marie Smith
committed
Merge branch 'main' of https://github.com/CortexIntelligentAutomation/docs into feature/add-studio-import-export-documentation
2 parents d02a994 + 3c53b10 commit 9d6a23d

File tree

6 files changed

+29
-20
lines changed

6 files changed

+29
-20
lines changed

content/en/docs/2025.1/Guides/user-guides/user-interfaces/gateway/Admin/packages/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,5 @@
22
title: "Packages"
33
linkTitle: "Packages"
44
description: "This section includes user guides related to Package Management in {{% ctx %}} Gateway."
5-
weight: 100
5+
weight: 10
66
---

content/en/docs/2025.1/Guides/user-guides/user-interfaces/gateway/Admin/packages/overview.md

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -37,12 +37,6 @@ The [Package Version Editor][] contains the following tabs:
3737
* [Triggers][] - allows configuration of SNMP triggers to automatically execute flows contained in this package version on receipt of SNMP traps.
3838
* [Running Executions][] - displays a list of running executions of flows in this package version and enables the user to abort them.
3939

40-
## Remarks
41-
42-
### Known Limitations
43-
44-
None
45-
4640
## See Also
4741

4842
### Related Concepts

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

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -117,26 +117,26 @@ See the [Create a Schedule on a Package Version][Create a Schedule on a Package
117117

118118
### Triggers
119119

120-
A trigger allows flow executions to occur on receipt of an SNMP Trap event, passing values to the flow’s [input variables][Input Variables], and if required, the SNMP Trap PDU can be stored in a selected input variable as an object. Multiple triggers can be configured; a trigger can execute a single flow, and a flow can be executed by multiple triggers.
120+
A trigger allows flow executions to occur on receipt of an SNMP Trap, passing values to the flow’s [input variables][Input Variables], and if required, the SNMP Trap PDU can be stored in a selected input variable as an object. Multiple triggers can be configured; a trigger can execute a single flow, and a flow can be executed by multiple triggers.
121121

122-
Each trigger definition consists of a `Name`, which is used to easily identify the trigger, and an optional `Description` to provide additional information. The definition also specifies the `Flow` to be executed as well as a set of conditions that receipt of an SNMP Trap will execute the flow.
122+
Each trigger definition consists of a `Name`, which is used to easily identify the trigger, and an optional `Description` to provide additional information. The definition also specifies the `Flow` to be executed as well as a set of conditions that, on receipt of a matching SNMP Trap, will execute the flow.
123123

124124
The conditions that must be set are:
125125

126-
* The `Device Address` of device sending the SNMP Trap.
126+
* The `Device Address` of the device sending the SNMP Trap.
127127

128-
This can be a single IPv4 address, a list of comma-separated IPv4 addresses, a range of IPv4 addresses, CIDR subnets, or the * symbol to represent any source address.
128+
This can be a single IPv4 address, a list of comma-separated IPv4 addresses, a range of IPv4 addresses, CIDR subnets, or the * symbol to represent any address.
129129
* The `Device Port` of the device sending the SNMP Trap.
130130

131-
This can be a single port, a list of comma-separated ports, a range of ports, or the * symbol to represent any source port.
131+
This can be a single port, a list of comma-separated ports, a range of ports, or the * symbol to represent any port.
132132
* The `Trap OID`.
133133

134134
This can be a single OID, a list of comma-separated OIDs, a range of OIDs, or the * symbol to represent any OID.
135135

136136
* The `SNMP Version`; either: *SNMPv1*, *SNMPv2c*, or *SNMPv3*.
137137
* If *SNMPv1* is selected, a `Community` and `Agent Address` must be configured.
138138
* `Community` can be any value, a list of comma-separated values, or the * symbol to represent any community.
139-
* `Agent Address` matches with the source address contained in the SNMP PDU, and can be a single IPv4 address, a list of comma-separated IPv4 addresses, a range of IPv4 addresses, CIDR subnets, or the * symbol to represent any source address.
139+
* `Agent Address` matches with the device address contained in the SNMP PDU, and can be a single IPv4 address, a list of comma-separated IPv4 addresses, a range of IPv4 addresses, CIDR subnets, or the * symbol to represent any address.
140140
* If *SNMPv2c* is selected, a `Community` must be configured.
141141
* `Community` can be any value, a list of comma-separated values, or the * symbol to represent any community.
142142
* If *SNMPv3* is selected, it is necessary to setup one or more authentication users from the `Configure SNMPv3 Users` hyperlink, above the list of existing SNMP Triggers.
@@ -159,10 +159,10 @@ See the [View and Abort Running Flow Executions][View and Abort Running Flow Exe
159159

160160
### Known Limitations
161161

162-
* Flow versions other than those inherited from the source package version, or the Master Versions stored in the Master Repository, cannot be included in a new package version.
162+
* Only flow versions inherited from the source package version, or the Master Versions stored in the Master Repository, can be included in a new package version.
163163
* New package versions do not retain any of the configured schedules or triggers set on the source version.
164-
* To set the default package, it is necessary to select a published package version; it is not possible to set the default package by selecting a version that is not published even if other versions of the same package are published.
165164
* Exported package versions do not retain any of the configured schedules, triggers or authorisation set on the package version being exported.
165+
* To set the default package, it is necessary to select a published package version; it is not possible to set the default package by selecting a version that is not published even if other versions of the same package are published.
166166
* Currently, a schedule cannot be edited; new schedules can be created, and existing schedules deleted.
167167

168168
## See Also

content/en/docs/2025.1/Reference/Concepts/fundamentals/packages/what-is-a-package.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,10 @@ A {{% ctx %}} Package contains a set of independent or related flows that togeth
1515
Users with the Admin role can use the [{{% ctx %}} Package Management][] feature to manage packages, including [creating][CreatePackage] and [publishing][Publish] them.
1616

1717
## Anatomy of a Package
18-
TODO
19-
{{< figure src="/images/Package Management.png" title="Package Management" >}}
2018

21-
## Package Operations
19+
{{< figure src="/images/Package Management.png" >}}
20+
21+
## Actions
2222

2323
### Creating a Package
2424

@@ -36,7 +36,7 @@ Executions of flows contained within published packages can be triggered via a R
3636

3737
A published package may be set as the [Default Package][], which will be used if the Package Name is not explicitly identified in a REST Request to execute a flow. Additionally, within each package, a published Package Version may be set as the [Default Package Version][]; this will be used if the Package Version is not explicitly identified in a REST Request to execute a flow.
3838

39-
### Other Package Operations
39+
### Other Actions
4040

4141
{{% ctx %}} Package Management also allows for:
4242

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: "Package Management"
33
linkTitle: "Package Management"
44
description: "This section includes tutorials about managing packages on the {{% ctx %}} platform."
5-
weight: 100
5+
weight: 1
66
---
77

88
# {{% param title %}}

data/urls.toml

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -871,8 +871,11 @@
871871
SetDefaultVersion = "/docs/guides/user-guides/user-interfaces/gateway/admin/packages/package-version-editor/#set-as-default-version"
872872
Triggers = "/docs/guides/user-guides/user-interfaces/gateway/admin/packages/package-version-editor/#triggers"
873873
Unpublish = "/docs/guides/user-guides/user-interfaces/gateway/admin/packages/package-version-editor/#unpublish-a-package-version"
874+
<<<<<<< HEAD
874875
[Cortex.Guides.UserGuides.UserInterfaces.Gateway.Admin.StudioImport]
875876
MainDoc = "/docs/guides/user-guides/user-interfaces/gateway/admin/studio-import/"
877+
=======
878+
>>>>>>> 3c53b10c27e802f98baaa247cc86102c90e5e132
876879

877880
[Cortex.Reference]
878881
MainDoc = "/docs/reference/"
@@ -2720,6 +2723,18 @@
27202723
[Cortex.Tutorials.Operations.Overview]
27212724
MainDoc = "/docs/tutorials/Operations/overview"
27222725
UseOperationsOverview = "/docs/tutorials/operations/overview/#using-the-operations-overview"
2726+
Authorisation = "/docs/tutorials/administration/package-management/#set-authorisation-on-a-package-version"
2727+
CreateNewPackageVersion = "/docs/tutorials/administration/package-management/#create-a-new-package-version"
2728+
CreatePackage = "/docs/tutorials/administration/package-management/#create-a-package"
2729+
ExportPackage = "/docs/tutorials/administration/package-management/#export-a-package-version"
2730+
ImportPackage = "/docs/tutorials/administration/package-management/#import-a-package"
2731+
PublishPackage = "/docs/tutorials/administration/package-management/#publish-a-package-version"
2732+
RunningExecutions = "/docs/tutorials/administration/package-management/#view-and-abort-running-flow-executions"
2733+
Schedules = "/docs/tutorials/administration/package-management/#create-a-schedule-on-a-package-version"
2734+
SetDefaultPackage = "/docs/tutorials/administration/package-management/#set-the-default-package"
2735+
SetDefaultPackageVersion = "/docs/tutorials/administration/package-management/#set-the-default-package-version"
2736+
Triggers = "/docs/tutorials/administration/package-management/#create-a-trigger-on-a-package-version"
2737+
UnpublishPackage = "/docs/tutorials/administration/package-management/#unpublish-a-package-version"
27232738

27242739
[Cortex.Website]
27252740
[Cortex.Website.EngageWithUs]

0 commit comments

Comments
 (0)