Skip to content

Commit f62cd9d

Browse files
author
Donna-Marie Smith
committed
added initial content for studio import and export
1 parent 461241f commit f62cd9d

File tree

9 files changed

+121
-16
lines changed

9 files changed

+121
-16
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: 10
5+
weight: 100
66
---
Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
---
2+
title: "Studio Export"
3+
linkTitle: "Studio Export"
4+
description: "This section includes user guides related to Studio Export in {{% ctx %}} Gateway."
5+
weight: 50
6+
---
7+
8+
# {{% param title %}}
9+
10+
## Summary
11+
12+
Studio Export is a feature that enables one or more flowsto be exported into a Studio Package file, which may be used for achieving purposes, or importing flows into another CORTEX Studio. A Studio Package file may contain a mixture of distinct CORTEX and CORTEX 7 flows.
13+
14+
| | |
15+
|------------------------------|-----------------------------------------------------------------|
16+
| **Roles Required:** | Admin |
17+
18+
## Anatomy
19+
20+
{{< figure src="/images/Studio Export.png" title="Studio Export" >}}
21+
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.
23+
24+
Individual flows are selected by clicking by clicking 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.
25+
26+
Clicking Export will create the Studio Package from the Master Versions of the selected flows in the Master Repository, including their Group hierarchy, and then download the package to the host’s browser as 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.
27+
28+
## Remarks
29+
30+
### Known Limitations
31+
32+
* Any flows that are dependencies of selected flows will not be automatically selected for export.
33+
34+
## See Also
35+
36+
### Related Concepts
37+
38+
TODO
39+
40+
### Related Tutorials
41+
42+
* [Export Individual Flows][Export Individual Flows tutorial]
43+
44+
[Export Individual Flows tutorial]: {{< url path="Cortex.Tutorials.Administration.StudioExport.ExportIndividualFlows" >}}

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

Lines changed: 33 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,49 @@
22
title: "Studio Import"
33
linkTitle: "Studio Import"
44
description: "This section includes user guides related to Studio Import in {{% ctx %}} Gateway."
5-
weight: 10
5+
weight: 25
66
---
77

88
# {{% param title %}}
99

1010
## Summary
1111

12-
Studio Import is feature that enables individual flows, contained in a Studio Package on the local host, to be imported into {{% ctx %}} Gateway.
12+
Studio Import is a feature that enables individual flows, contained in a Studio Package on the local host, to be imported into {{% ctx %}} Gateway.
1313

1414
| | |
1515
|------------------------------|-----------------------------------------------------------------|
1616
| **Roles Required:** | Admin |
1717

1818
## Anatomy
1919

20+
{{< figure src="/images/Studio Import.png" title="Studio Import" >}}
21+
22+
Individual flows contained in the Studio Package may be individually selected for importing into CORTEX Studio; it is not a requirement that all the flows contained in the Studio Package are imported simultaneously.
23+
24+
By default, the display favours the Group hierarchy of the destination CORTEX Studio, showing how the imported flows will map into the existing system hierarchy. If an imported flow already exists in the destination, the imported flow will map to the same Group in the CORTEX Studio hierarchy. If an imported flow does not exist in the destination, the existing CORTEX Studio hierarchy will be extended using the hierarchy contained the package for that flow.
25+
26+
Alternatively, it is possible to have the display favour the hierarchy contained in the Studio Package, displaying the hierarchy of the Studio Package. If a version of the flows already exists in the destination CORTEX Studio, it will be moved to the hierarchy contained in the Studio Package, extending the destination hierarchy if necessary. If a flow does not exist in the destination CORTEX Studio, the hierarchy of the Studio Package will be created in the destination when the flow is imported.
27+
28+
The ‘Edit import hierarchy’, available for imports favouring the system hierarchy or favouring the package hierarchy, enables any individual imported flows to be assigned to any Group in the hierarchy of the destination CORTEX Studio. The display will show the entire existing hierarchy of the destination CORTEX Studio, extended by any necessary Groups from the Studio Package hierarchy where the imported flows do not already exist on the destination CORTEX Studio; it is not necessary for the administrator to have View or Edit authorisation for any flows to view the entire system Group hierarchy.
29+
30+
When the selected flows from the Studio Package are imported, they will become the Master Version of the flows in the destination Master Repository, replacing any existing Master Versions.
31+
32+
After importing the flows, it is necessary to check the authorisation assigned to imported flows is appropriate for their use.
33+
34+
## Remarks
35+
36+
### Known Limitations
37+
38+
None
39+
40+
## See Also
41+
42+
### Related Concepts
43+
44+
TODO
45+
46+
### Related Tutorials
47+
48+
* [Import Individual Flows][Import Individual Flows tutorial]
49+
50+
[Import Individual Flows tutorial]: {{< url path="Cortex.Tutorials.Administration.StudioImport.ImportIndividualFlows" >}}

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: 1
5+
weight: 100
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: 50
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: 25
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" >}}
190 KB
Loading
348 KB
Loading

data/urls.toml

Lines changed: 18 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2695,18 +2695,24 @@
26952695
MainDoc = "/docs/tutorials/administration"
26962696
[Cortex.Tutorials.Administration.PackageManagement]
26972697
MainDoc = "/docs/tutorials/administration/package-management"
2698-
Authorisation = "/docs/tutorials/administration/package-management/#set-authorisation-on-a-package-version"
2699-
CreateNewPackageVersion = "/docs/tutorials/administration/package-management/#create-a-new-package-version"
2700-
CreatePackage = "/docs/tutorials/administration/package-management/#create-a-package"
2701-
ExportPackage = "/docs/tutorials/administration/package-management/#export-a-package-version"
2702-
ImportPackage = "/docs/tutorials/administration/package-management/#import-a-package"
2703-
PublishPackage = "/docs/tutorials/administration/package-management/#publish-a-package-version"
2704-
RunningExecutions = "/docs/tutorials/administration/package-management/#view-and-abort-running-flow-executions"
2705-
Schedules = "/docs/tutorials/administration/package-management/#create-a-schedule-on-a-package-version"
2706-
SetDefaultPackage = "/docs/tutorials/administration/package-management/#set-the-default-package"
2707-
SetDefaultPackageVersion = "/docs/tutorials/administration/package-management/#set-the-default-package-version"
2708-
Triggers = "/docs/tutorials/administration/package-management/#create-a-trigger-on-a-package-version"
2709-
UnpublishPackage = "/docs/tutorials/administration/package-management/#unpublish-a-package-version"
2698+
Authorisation = "/docs/tutorials/administration/package-management/#set-authorisation-on-a-package-version"
2699+
CreateNewPackageVersion = "/docs/tutorials/administration/package-management/#create-a-new-package-version"
2700+
CreatePackage = "/docs/tutorials/administration/package-management/#create-a-package"
2701+
ExportPackage = "/docs/tutorials/administration/package-management/#export-a-package-version"
2702+
ImportPackage = "/docs/tutorials/administration/package-management/#import-a-package"
2703+
PublishPackage = "/docs/tutorials/administration/package-management/#publish-a-package-version"
2704+
RunningExecutions = "/docs/tutorials/administration/package-management/#view-and-abort-running-flow-executions"
2705+
Schedules = "/docs/tutorials/administration/package-management/#create-a-schedule-on-a-package-version"
2706+
SetDefaultPackage = "/docs/tutorials/administration/package-management/#set-the-default-package"
2707+
SetDefaultPackageVersion = "/docs/tutorials/administration/package-management/#set-the-default-package-version"
2708+
Triggers = "/docs/tutorials/administration/package-management/#create-a-trigger-on-a-package-version"
2709+
UnpublishPackage = "/docs/tutorials/administration/package-management/#unpublish-a-package-version"
2710+
[Cortex.Tutorials.Administration.StudioImport]
2711+
MainDoc = "/docs/tutorials/administration/studio-import"
2712+
ImportIndividualFlows = "/docs/tutorials/administration/studio-import/#import-individual-flows"
2713+
[Cortex.Tutorials.Administration.StudioExport]
2714+
MainDoc = "/docs/tutorials/administration/studio-export"
2715+
ExportIndividualFlows = "/docs/tutorials/administration/studio-export/#export-individual-flows"
27102716
[Cortex.Tutorials.Operations]
27112717
MainDoc = "/docs/tutorials/Operations"
27122718
[Cortex.Tutorials.Operations.Overview]

0 commit comments

Comments
 (0)