Skip to content

Commit b7fde8e

Browse files
author
Donna-Marie Smith
committed
Added initial content for Package Management
1 parent 6800b3a commit b7fde8e

File tree

15 files changed

+489
-70
lines changed

15 files changed

+489
-70
lines changed

.gitignore

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
1-
docs/
2-
!docs/CNAME
3-
public/
4-
resources/
1+
/content/en/docs/latest/
2+
/content/static/latest/
3+
/content/static/**/*.dtmp
4+
/content/static/**/*.bkp
5+
/content/static/**/*.crswap
6+
/content/static/lunr-index.json
7+
!/docs/CNAME
8+
/docs/
9+
/public/
10+
/resources/
511
node_modules/
612
tech-doc-hugo
7-
content/en/docs/latest/
8-
content/static/latest/
9-
content/static/**/*.dtmp
10-
content/static/**/*.bkp
11-
content/static/**/*.crswap
12-
content/static/lunr-index.json
13+
old-tutorials.md

assets/scss/_content.scss

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -184,6 +184,19 @@
184184
}
185185
}
186186

187+
>.scribe-video {
188+
max-width: 640px;
189+
width: 100%;
190+
animation: fadeIn 2s;
191+
192+
iframe {
193+
height: 640px;
194+
width: 100%;
195+
aspect-ratio: 16 / 9;
196+
border-radius: 5px;
197+
}
198+
}
199+
187200
br {
188201
content: " ";
189202
display: block;
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: "Packages"
33
linkTitle: "Packages"
4-
description: "This section includes user guides related to Packages in {{% ctx %}} Gateway."
4+
description: "This section includes user guides related to Package Management in {{% ctx %}} Gateway."
55
weight: 10
66
---
Lines changed: 43 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,64 @@
11
---
22
title: "Overview"
33
linkTitle: "Overview"
4-
description: "Summary and Anatomy of Package Management screen - To be refined"
4+
description: "Summary and Anatomy of Package Management"
55
weight: 1
66
---
77

88
# {{% param title %}}
99

1010
## Summary
11-
Summary of the package management page
11+
12+
The Package Management page allows you to manage [{{% ctx %}} packages][What is a Package?], including creating and publishing them.
1213

1314
| | |
1415
|------------------------------|-----------------------------------------------------------------|
1516
| **Roles Required:** | Admin |
1617

1718
## Anatomy
18-
Diagram of the section
19+
20+
{{< figure src="/images/Package Management.png" title="Package Management" >}}
21+
22+
The Package Management page displays a list of existing {{% ctx %}} Package definitions in the [Package Definitions Grid][], showing the most recently created version of each package; older versions can be viewed by expanding the package definition.
23+
24+
Selecting a package version will display it in the [Package Version Editor][]; the Definition tab will be selected, displaying the flows it contains and buttons to:
25+
26+
* [Export][] the selected package version to a {{% ctx %}} Package file.
27+
* [Create New Version][] of the package based on the selected package version.
28+
* [Publish][] or [Unpublish][] the package version to the {{% ctx %}} Execution Services.
29+
* [Set As Default Package][] enabling flows to be executed from all versions of this package without specifying the package name in the execution REST Request.
30+
* [Set As Default Version][] enabling flows to be executed from the package version without specifying the package version in the execution REST Request.
31+
32+
The [Package Version Editor][] contains the following tabs:
33+
34+
* [Definition][] - displays the flows contained in this package version.
35+
* [Authorisation][] - allows the selection of LDAP groups authorised to execute flows contained in this package version.
36+
* [Schedules][] – allows configuration of schedules to automatically execute flows contained in this package version at defined times or intervals.
37+
* [Triggers][] - allows configuration of SNMP triggers to automatically execute flows contained in this package version on receipt of SNMP traps.
38+
* [Running Executions][] - displays a list of running executions of flows in this package version and enables the user to abort them.
1939

2040
## See Also
2141

2242
### Related Concepts
23-
e.g. link to fundamentals/concepts to what is a??
43+
44+
[What is a Package?][]
2445

2546
### Related Tutorials
26-
e.g. links to Scribe tutorials
47+
48+
[Package Management][]
49+
50+
[Authorisation]: {{< url path="Cortex.Guides.UserGuides.UserInterfaces.Gateway.Admin.Packages.PackageVersionEditor.Authorisation" >}}
51+
[Create New Version]: {{< url path="Cortex.Guides.UserGuides.UserInterfaces.Gateway.Admin.Packages.PackageVersionEditor.CreateNewVersion" >}}
52+
[Definition]: {{< url path="Cortex.Guides.UserGuides.UserInterfaces.Gateway.Admin.Packages.PackageVersionEditor.Definition" >}}
53+
[Export]: {{< url path="Cortex.Guides.UserGuides.UserInterfaces.Gateway.Admin.Packages.PackageVersionEditor.Export" >}}
54+
[Package Definitions Grid]: {{< url path="Cortex.Guides.UserGuides.UserInterfaces.Gateway.Admin.Packages.PackageDefinitionsGrid.MainDoc" >}}
55+
[Package Management]: {{< url path="Cortex.Tutorials.Administration.PackageManagement.MainDoc" >}}
56+
[Package Version Editor]: {{< url path="Cortex.Guides.UserGuides.UserInterfaces.Gateway.Admin.Packages.PackageVersionEditor.MainDoc" >}}
57+
[Publish]: {{< url path="Cortex.Guides.UserGuides.UserInterfaces.Gateway.Admin.Packages.PackageVersionEditor.Publish" >}}
58+
[Running Executions]: {{< url path="Cortex.Guides.UserGuides.UserInterfaces.Gateway.Admin.Packages.PackageVersionEditor.RunningExecutions" >}}
59+
[Schedules]: {{< url path="Cortex.Guides.UserGuides.UserInterfaces.Gateway.Admin.Packages.PackageVersionEditor.Schedules" >}}
60+
[Set As Default Package]: {{< url path="Cortex.Guides.UserGuides.UserInterfaces.Gateway.Admin.Packages.PackageVersionEditor.SetDefaultPackage" >}}
61+
[Set As Default Version]: {{< url path="Cortex.Guides.UserGuides.UserInterfaces.Gateway.Admin.Packages.PackageVersionEditor.SetDefaultVersion" >}}
62+
[Triggers]: {{< url path="Cortex.Guides.UserGuides.UserInterfaces.Gateway.Admin.Packages.PackageVersionEditor.Triggers" >}}
63+
[Unpublish]: {{< url path="Cortex.Guides.UserGuides.UserInterfaces.Gateway.Admin.Packages.PackageVersionEditor.Unpublish" >}}
64+
[What is a Package?]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Packages.WhatIsAPackage.MainDoc" >}}

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

Lines changed: 46 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,19 +8,59 @@ weight: 10
88
# {{% param title %}}
99

1010
## Summary
11-
Summary of the package definitions grid
11+
12+
The Package Definitions Grid displays a list of existing [{{% ctx %}} Package][What is a Package?] definitions.
1213

1314
## Anatomy
14-
Diagram of the section
15+
16+
{{< figure src="/images/Package Definitions Grid.png" title="Package Definitions Grid" >}}
17+
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+
20+
The Package Definitions Grid also contains buttons to:
21+
* [Create a Package][]
22+
* [Import a Package][]
23+
24+
## Actions
25+
26+
### Create a Package
27+
28+
A new package is created by clicking the `Add Package Definition` button, supplying a Package Name and selecting the flows to be included in the package.
29+
30+
The Package Name must be unique and can only contain alphanumeric characters, hyphens and underscores. The flows added to the package definition are the Master Versions of the flows contained in the Master Repository (most recently committed flow version).
31+
32+
If a selected flow has dependent flows, the dependent flow will be automatically selected for inclusion in the package; dependent flows cannot be manually deselected for inclusion; this ensures packages contain all required dependencies.
33+
34+
The package may optionally define LDAP groups that can execute flows, schedules to run flows at specific times, and triggers to run flows on receipt of specific SNMP Traps.
35+
36+
### Import a Package
37+
38+
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.
39+
40+
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.
41+
42+
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.
1543

1644
## Remarks
17-
e.g any specific comments that are needed e.g. if it cant communicate then warnings are displayed
45+
1846
### Known Limitations
19-
e.g document any known limitations
47+
48+
* Flow versions other than the master versions stored in the Master Repository cannot be included in a new package.
49+
2050
## See Also
2151

2252
### Related Concepts
23-
e.g. link to fundamentals/concepts to what is a??
53+
54+
[What is a Package?][]
2455

2556
### Related Tutorials
26-
e.g. links to Scribe tutorials
57+
58+
* [How to Create a New {{% ctx %}} Package Definition][]
59+
* [How to Import a {{% ctx %}} Package File][]
60+
61+
[Create a Package]: {{< ref "#create-a-package" >}}
62+
[How to Create a New {{% ctx %}} Package Definition]: {{< url path="Cortex.Tutorials.Administration.PackageManagement.CreatePackage" >}}
63+
[How to Import a {{% ctx %}} Package File]: {{< url path="Cortex.Tutorials.Administration.PackageManagement.ImportPackage" >}}
64+
[Import a Package]: {{< ref "#import-a-package" >}}
65+
[Package Version Editor]: {{< url path="Cortex.Guides.UserGuides.UserInterfaces.Gateway.Admin.Packages.PackageVersionEditor.MainDoc" >}}
66+
[What is a Package?]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Packages.WhatIsAPackage.MainDoc" >}}

0 commit comments

Comments
 (0)