Skip to content

Commit f9b12f8

Browse files
author
Donna-Marie Smith
committed
Merge branch 'feature/add-studio-import-export-documentation' of https://github.com/CortexIntelligentAutomation/docs into feature/add-version-control-documentation
2 parents ed67e6c + aa803c5 commit f9b12f8

File tree

29 files changed

+361
-230
lines changed

29 files changed

+361
-230
lines changed

content/en/docs/2025.3/FAQs/_index.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,3 @@ linkTitle: "FAQs"
44
description: "Answers to our most frequently asked questions."
55
weight: 10000
66
---
7-
8-
{{< workinprogress >}}
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
title: "How do I check cluster health?"
3+
linkTitle: "How do I check cluster health?"
4+
description: "Instructions on how to check the health of your cluster."
5+
weight: 100
6+
---
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
title: "Multiple Server with HA"
3+
linkTitle: "Multiple Server with HA"
4+
description: "Instructions on how to check the health of your multiple server cluster."
5+
weight: 1
6+
---
7+
8+
# Check Cluster Health
9+
10+
{{< section "/install-application-server/multi-server/check-application-services.md">}}
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
title: "Single Server without HA"
3+
linkTitle: "Single Server without HA"
4+
description: "Instructions on how to check the health of your single server cluster."
5+
weight: 2
6+
---
7+
8+
# Check Cluster Health
9+
10+
{{< section "/install-application-server/single-server/check-application-services.md">}}
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
title: "How do I import the client certificate?"
3+
linkTitle: "How do I import the client certificate?"
4+
description: "Instructions on how to import the client certificate."
5+
weight: 150
6+
---
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
title: "Multiple Server with HA"
3+
linkTitle: "Multiple Server with HA"
4+
description: "Instructions on how to import the client certificate."
5+
weight: 1
6+
---
7+
8+
# Import Client Certificate
9+
10+
{{< section "/install-application-server/multi-server/import-client-certificate.md">}}
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
title: "Single Server without HA"
3+
linkTitle: "Single Server without HA"
4+
description: "Instructions on how to import the client certificate."
5+
weight: 2
6+
---
7+
8+
# Import Client Certificate
9+
10+
{{< section "/install-application-server/single-server/import-client-certificate.md">}}

content/en/docs/2025.3/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: 10
5+
weight: 100
66
---
Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ weight: 50
99

1010
## Summary
1111

12-
Studio Export is a feature that enables one or more flows to be exported into a Studio Package file, which may be used for archiving purposes, or [importing][Studio Import] flows into another {{% ctx %}} Studio. A Studio Package file may contain a mixture of distinct {{% ctx %}} and {{% ctx %}} 7 flows.
12+
The Studio Export page allows exporting one or more flows into a Studio Package file, which may be used for archiving purposes, or [importing][Studio Import] flows into another {{% ctx %}}.
1313

1414
| | |
1515
|------------------------------|-----------------------------------------------------------------|
@@ -19,23 +19,29 @@ Studio Export is a feature that enables one or more flows to be exported into a
1919

2020
{{< figure src="/images/Studio Export.png" title="Studio Export" >}}
2121

22-
Any flow in the system may be exported; it is not necessary for the administrator to have View or Edit authorisation for the flows to be exported.
22+
## Actions
23+
24+
### Export Flows
2325

2426
Individual flows are selected by clicking the checkbox in the `Export?` column adjacent to the flow to be exported. If a group is selected, then all the flows contained in that group, and any sub-groups, will be implicitly set; any implicitly set may be individually deselected by clicking the checkbox adjacent to the flow.
2527

26-
Clicking `Export` will create the Studio Package from the Master Versions in the Master Repository of the selected flows, including their group hierarchy, and then download the package to the host’s browser as a file named `export.studiopkg` or `export <n>.studiopkg`, where `<n>` represents an integer to avoid naming conflict with other Studio Package files contained in the same folder.
28+
Clicking `Export` checks if selected flows have dependencies. If there are dependencies, an additional page will be shown to allow confirmation that these should be included in the export. By default these are selected but can be deselected. A Studio Package will then be created from the Master Versions in the Master Repository of the selected flows, including their group hierarchy. The package will then be downloaded to the host’s browser as a file named `export.studiopkg` or `export <n>.studiopkg`, where `<n>` represents an integer to avoid naming conflict with other Studio Package files contained in the same folder.
29+
30+
It is not necessary to have View or Edit authorisation for the flows to be exported.
31+
32+
See the [Export Individual Flows][Export Individual Flows tutorial] tutorial for a step-by-step guide.
2733

2834
## Remarks
2935

3036
### Known Limitations
3137

32-
* Any flows that are dependencies of selected flows will not be automatically selected for export.
38+
* The name of the Studio Package file cannot currently be customised.
3339

3440
## See Also
3541

3642
### Related Concepts
3743

38-
TODO
44+
None
3945

4046
### Related Tutorials
4147

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
---
2+
title: "Studio Import"
3+
linkTitle: "Studio Import"
4+
description: "This section includes user guides related to Studio Import in {{% ctx %}} Gateway."
5+
weight: 25
6+
---
7+
8+
# {{% param title %}}
9+
10+
## Summary
11+
12+
The Studio Import page allows importing individual flows, contained in a Studio Package.
13+
14+
| | |
15+
|------------------------------|-----------------------------------------------------------------|
16+
| **Roles Required:** | Admin |
17+
18+
## Anatomy
19+
20+
{{< figure src="/images/Studio Import.png" title="Studio Import" >}}
21+
22+
## Actions
23+
24+
### Favoured Hierarchy
25+
26+
By default, the import favours the `system hierarchy`, and shows how the imported flows will map into the existing hierarchy. If flows to be imported already exist, they will be imported to the same location in the hierarchy; otherwise, any missing groups in the flow hierarchy will be added.
27+
28+
It is possible to favour the `package hierarchy`, and this shows the hierarchy contained in the Studio Package. If flows to be imported already exist, they will be moved to the location specified in the Studio Package, adding any missing groups as necessary; otherwise, the hierarchy specified in the Studio Package will be created when the flows are imported.
29+
30+
### Edit Import Locations
31+
32+
The `Edit import hierarchy` switch enables editing the locations where flows should be imported to. This is useful if the default import location in the [favoured hierarchy][] for one or more flows needs changing.
33+
34+
It is not necessary to have View or Edit authorisation for any flows or groups to view the entire hierarchy.
35+
36+
### Import
37+
38+
Individual flows contained in the Studio Package may be individually selected to be imported; it is not necessary that all the flows contained in the Studio Package are imported.
39+
40+
When the selected flows are imported, they become the Master Version of the flows in the Master Repository, replacing any existing Master Versions.
41+
42+
After importing the flows, it is necessary to check they are correctly configured in Studio Authorisation.
43+
44+
See the [Import Individual Flows][Import Individual Flows tutorial] tutorial for a step-by-step guide.
45+
46+
## Remarks
47+
48+
### Known Limitations
49+
50+
None
51+
52+
## See Also
53+
54+
### Related Concepts
55+
56+
None
57+
58+
### Related Tutorials
59+
60+
* [Import Individual Flows][Import Individual Flows tutorial]
61+
62+
[favoured hierarchy]: {{< ref "#favoured-hierarchy">}}
63+
[Import Individual Flows tutorial]: {{< url path="Cortex.Tutorials.Administration.StudioImport.ImportIndividualFlows" >}}

0 commit comments

Comments
 (0)