Skip to content

Commit 9481ee2

Browse files
authored
Add studio import/export documentation (#204)
1 parent e3aeafb commit 9481ee2

File tree

14 files changed

+163
-31
lines changed

14 files changed

+163
-31
lines changed

content/en/docs/2025.3/Guides/cortex-gateway/settings/studio-export.md

Lines changed: 0 additions & 7 deletions
This file was deleted.

content/en/docs/2025.3/Guides/cortex-gateway/settings/studio-import.md

Lines changed: 0 additions & 7 deletions
This file was deleted.

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: "Create and manage packages in {{% ctx %}} Gateway."
5-
weight: 10
5+
weight: 100
66
---
Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
---
2+
title: "Studio Export"
3+
linkTitle: "Studio Export"
4+
description: "Export flows from {{% ctx %}} Gateway."
5+
weight: 50
6+
---
7+
8+
# {{% param title %}}
9+
10+
## Summary
11+
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 %}}.
13+
14+
| | |
15+
|------------------------------|-----------------------------------------------------------------|
16+
| **Roles Required:** | Admin |
17+
18+
## Anatomy
19+
20+
{{< figure src="/images/Studio Export.png" title="Studio Export" >}}
21+
22+
## Actions
23+
24+
### Export Flows
25+
26+
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.
27+
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.
33+
34+
## Remarks
35+
36+
### Known Limitations
37+
38+
* The name of the Studio Package file cannot currently be customised.
39+
40+
## See Also
41+
42+
### Related Concepts
43+
44+
None
45+
46+
### Related Tutorials
47+
48+
* [Export Individual Flows][Export Individual Flows tutorial]
49+
50+
[Export Individual Flows tutorial]: {{< url path="Cortex.Tutorials.Administration.StudioExport.ExportIndividualFlows" >}}
51+
[Studio Import]: {{< url path="Cortex.Guides.UserGuides.UserInterfaces.Gateway.Admin.StudioImport.MainDoc" >}}
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: "Import flows into {{% ctx %}} Gateway."
5+
weight: 25
6+
---
7+
8+
# {{% param title %}}
9+
10+
## Summary
11+
12+
The Studio Import page allows importing one or more 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" >}}

content/en/docs/2025.3/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: 1
5+
weight: 200
66
---
77

88
# {{% param title %}}
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
title: "Studio Export"
3+
linkTitle: "Studio Export"
4+
description: "This section includes tutorials about exporting individual flows."
5+
weight: 100
6+
---
7+
8+
# {{% param title %}}
9+
10+
## Export Individual Flows
11+
12+
{{< scribe title="How_to_use_Studio_Export_to_Export_Individual_Flows" id="eHoR7gKNR_qsvU8Qoa73KA" >}}
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
title: "Studio Import"
3+
linkTitle: "Studio Import"
4+
description: "This section includes tutorials about importing individual flows."
5+
weight: 50
6+
---
7+
8+
# {{% param title %}}
9+
10+
## Import Individual Flows
11+
12+
{{< scribe title="How_to_use_Studio_Import_to_Import_Individual_Flows" id="kNzevcaURRexdsZKtpg_Ew" >}}

content/en/docs/2025.3/_shared/install-application-server/multi-server/check-application-services.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,4 +28,4 @@ If no useful message can be seen here, the service log files may contain more in
2828

2929
If no solution can be found, please contact [{{% ctx %}} Service Portal][CORTEX Service Portal] for further assistance.
3030

31-
[CORTEX Service Portal]: {{< url path="Cortex.ServicePortal.MainDoc" >}}
31+
[CORTEX Service Portal]: {{< url path="Cortex.ServicePortal.MainDoc" >}}

content/en/docs/2025.3/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/installation/install-web-application-server/perform-debugger-installation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ If Windows Defender is not running on the server, ensure that the [Antivirus Exc
5050
1. Open a web browser.
5151
1. {{< section "/install-application-server/single-server/check-application-services.md">}}
5252

53-
# Preserve installation files
53+
## Preserve installation files
5454

5555
{{< section "/preserve-installation-files.md">}}
5656

0 commit comments

Comments
 (0)