Skip to content

Feature/add studio import export documentation #204

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 57 commits into from
Apr 24, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
57 commits
Select commit Hold shift + click to select a range
711090f
Created initial 2025.1 Doc
cortex-lp Dec 10, 2024
98ced0a
Updated CIP deployment document to include deployment of web.config w…
cortex-sr Dec 10, 2024
e6e0e97
Merge pull request #187 from CortexIntelligentAutomation/feature/2426…
cortex-sr Dec 11, 2024
ea5c5ec
Feature/32544 simplify installation process and unblock required inst…
Cortex-DMS Jan 22, 2025
0f91ecd
Feature/create 2024.11 to 2025.1 upgrade guide (#189)
Cortex-DMS Jan 29, 2025
2dd7608
Initial structure for new documentation
Feb 6, 2025
4cb3b95
Merge branch 'main' of https://github.com/CortexIntelligentAutomation…
Feb 24, 2025
6800b3a
Merge branch 'main' of https://github.com/CortexIntelligentAutomation…
Feb 24, 2025
b7fde8e
Added initial content for Package Management
Feb 27, 2025
0bbf8db
modified links
Feb 27, 2025
5acfdee
Changes following 2nd PO review
Mar 3, 2025
5428334
modifications following 2nd PO Review
Mar 3, 2025
c955db4
Moved Upgrade Guides into new structure from 2025.1
Mar 3, 2025
2fb3fe4
Further refinements and removal of old tutorials that are being replaced
Mar 3, 2025
39df133
Modified screen shots for consistency
Mar 5, 2025
bc32a11
Added initial Operations Overview documentation
Mar 5, 2025
2d6ce20
Added Links
Mar 5, 2025
feddfde
Modified image labels
Mar 5, 2025
422cd5d
added title to Package Management Tutorials
Mar 5, 2025
59c52e8
added initial anatomy for What is a Package?
Mar 5, 2025
07aebc0
Merge branch 'feature/new-documentation-structure-for-guides' of http…
Mar 5, 2025
461241f
added initial structure
Mar 5, 2025
f62cd9d
added initial content for studio import and export
Mar 5, 2025
de213e6
Modified content
Mar 6, 2025
7f2fc00
Made images clearer
Mar 6, 2025
8ae1dbd
Merge branch 'feature/new-documentation-structure-for-guides' of http…
Mar 6, 2025
d201696
Resized Image
Mar 6, 2025
ba377e7
Merge branch 'feature/add-operations-overview-documentation' of https…
Mar 6, 2025
d02a994
Resized images
Mar 6, 2025
871bfbd
Created 2025.3 Release Branch
Mar 18, 2025
9d6db87
Updated Supported Versions
Mar 18, 2025
fc32114
Merge branch 'main' of https://github.com/CortexIntelligentAutomation…
Mar 19, 2025
1539bea
Merge branch '2025.3' of https://github.com/CortexIntelligentAutomati…
Mar 19, 2025
878a977
Moved into 2025.3
Mar 19, 2025
796dbec
Excluded .Net download link from HTML Check due to 403 errors
Mar 19, 2025
77b2822
Excluded 2024.1 from HTML check
Mar 19, 2025
9d6a23d
Merge branch 'main' of https://github.com/CortexIntelligentAutomation…
Mar 19, 2025
2323ab2
Merge branch 'feature/add-operations-overview-documentation' of https…
Mar 19, 2025
da8d4d3
Moved into 2025.3
Mar 19, 2025
cb69803
Merged urls.toml
Mar 19, 2025
7e37bac
excluded external Scribe link from HTML test
Mar 19, 2025
780b2a0
fixed incorrectly merged urls.toml
Mar 19, 2025
052819b
Updated structure of Studio Import
Mar 26, 2025
685eeba
Reformatted structure
Mar 26, 2025
e055c82
Modified following review
Mar 31, 2025
56e30f0
Added initial import client certificate FAQ
Mar 31, 2025
bce62f4
Merge branch 'feature/add-operations-overview-documentation' of https…
Mar 31, 2025
a71af37
altered ordering
Mar 31, 2025
aa803c5
Reviewed with PO
Apr 1, 2025
03ba577
Merge branch 'main' of https://github.com/CortexIntelligentAutomation…
Apr 23, 2025
724bdc0
corrected merge issues
Apr 23, 2025
3892052
Corrected further Merge issues
Apr 23, 2025
7f02d5c
made changes to remove old content and update TOC partial to show all…
Apr 23, 2025
1fe3aa7
fixed incorrect heading levels
Apr 23, 2025
1c65d66
Merge branch 'main' of https://github.com/CortexIntelligentAutomation…
Apr 24, 2025
2970120
updated page descriptions
Apr 24, 2025
7c8ba30
Modified descriptions of pages
Apr 24, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view

This file was deleted.

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@
title: "Packages"
linkTitle: "Packages"
description: "Create and manage packages in {{% ctx %}} Gateway."
weight: 10
weight: 100
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
---
title: "Studio Export"
linkTitle: "Studio Export"
description: "Export flows from {{% ctx %}} Gateway."
weight: 50
---

# {{% param title %}}

## Summary

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 %}}.

| | |
|------------------------------|-----------------------------------------------------------------|
| **Roles Required:** | Admin |

## Anatomy

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

## Actions

### Export Flows

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.

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.

It is not necessary to have View or Edit authorisation for the flows to be exported.

See the [Export Individual Flows][Export Individual Flows tutorial] tutorial for a step-by-step guide.

## Remarks

### Known Limitations

* The name of the Studio Package file cannot currently be customised.

## See Also

### Related Concepts

None

### Related Tutorials

* [Export Individual Flows][Export Individual Flows tutorial]

[Export Individual Flows tutorial]: {{< url path="Cortex.Tutorials.Administration.StudioExport.ExportIndividualFlows" >}}
[Studio Import]: {{< url path="Cortex.Guides.UserGuides.UserInterfaces.Gateway.Admin.StudioImport.MainDoc" >}}
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
---
title: "Studio Import"
linkTitle: "Studio Import"
description: "Import flows into {{% ctx %}} Gateway."
weight: 25
---

# {{% param title %}}

## Summary

The Studio Import page allows importing one or more flows, contained in a Studio Package.

| | |
|------------------------------|-----------------------------------------------------------------|
| **Roles Required:** | Admin |

## Anatomy

{{< figure src="/images/Studio Import.png" title="Studio Import" >}}

## Actions

### Favoured Hierarchy

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.

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.

### Edit Import Locations

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.

It is not necessary to have View or Edit authorisation for any flows or groups to view the entire hierarchy.

### Import

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.

When the selected flows are imported, they become the Master Version of the flows in the Master Repository, replacing any existing Master Versions.

After importing the flows, it is necessary to check they are correctly configured in Studio Authorisation.

See the [Import Individual Flows][Import Individual Flows tutorial] tutorial for a step-by-step guide.

## Remarks

### Known Limitations

None

## See Also

### Related Concepts

None

### Related Tutorials

* [Import Individual Flows][Import Individual Flows tutorial]

[favoured hierarchy]: {{< ref "#favoured-hierarchy">}}
[Import Individual Flows tutorial]: {{< url path="Cortex.Tutorials.Administration.StudioImport.ImportIndividualFlows" >}}
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: "Package Management"
linkTitle: "Package Management"
description: "This section includes tutorials about managing packages on the {{% ctx %}} platform."
weight: 1
weight: 200
---

# {{% param title %}}
Expand Down
12 changes: 12 additions & 0 deletions content/en/docs/2025.3/Tutorials/Administration/studio-export.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
title: "Studio Export"
linkTitle: "Studio Export"
description: "This section includes tutorials about exporting individual flows."
weight: 100
---

# {{% param title %}}

## Export Individual Flows

{{< scribe title="How_to_use_Studio_Export_to_Export_Individual_Flows" id="eHoR7gKNR_qsvU8Qoa73KA" >}}
12 changes: 12 additions & 0 deletions content/en/docs/2025.3/Tutorials/Administration/studio-import.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
title: "Studio Import"
linkTitle: "Studio Import"
description: "This section includes tutorials about importing individual flows."
weight: 50
---

# {{% param title %}}

## Import Individual Flows

{{< scribe title="How_to_use_Studio_Import_to_Import_Individual_Flows" id="kNzevcaURRexdsZKtpg_Ew" >}}
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,4 @@ If no useful message can be seen here, the service log files may contain more in

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

[CORTEX Service Portal]: {{< url path="Cortex.ServicePortal.MainDoc" >}}
[CORTEX Service Portal]: {{< url path="Cortex.ServicePortal.MainDoc" >}}
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ If Windows Defender is not running on the server, ensure that the [Antivirus Exc
1. Open a web browser.
1. {{< section "/install-application-server/single-server/check-application-services.md">}}

# Preserve installation files
## Preserve installation files

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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ If Windows Defender is not running on the server, ensure that the [Antivirus Exc
1. Open a web browser.
1. {{< section "/install-application-server/single-server/check-application-services.md">}}

# Preserve installation files
## Preserve installation files

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

Expand Down
Binary file added content/static/2025.3/images/Studio Export.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added content/static/2025.3/images/Studio Import.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
32 changes: 20 additions & 12 deletions data/urls.toml
Original file line number Diff line number Diff line change
Expand Up @@ -941,6 +941,8 @@
SetDefaultVersion = "/docs/guides/user-guides/user-interfaces/gateway/admin/packages/package-version-editor/#set-as-default-version"
Triggers = "/docs/guides/user-guides/user-interfaces/gateway/admin/packages/package-version-editor/#triggers"
Unpublish = "/docs/guides/user-guides/user-interfaces/gateway/admin/packages/package-version-editor/#unpublish-a-package-version"
[Cortex.Guides.UserGuides.UserInterfaces.Gateway.Admin.StudioImport]
MainDoc = "/docs/guides/user-guides/user-interfaces/gateway/admin/studio-import/"

[Cortex.Reference]
MainDoc = "/docs/reference/"
Expand Down Expand Up @@ -2766,18 +2768,24 @@
MainDoc = "/docs/tutorials/administration"
[Cortex.Tutorials.Administration.PackageManagement]
MainDoc = "/docs/tutorials/administration/package-management"
Authorisation = "/docs/tutorials/administration/package-management/#set-authorisation-on-a-package-version"
CreateNewPackageVersion = "/docs/tutorials/administration/package-management/#create-a-new-package-version"
CreatePackage = "/docs/tutorials/administration/package-management/#create-a-package"
ExportPackage = "/docs/tutorials/administration/package-management/#export-a-package-version"
ImportPackage = "/docs/tutorials/administration/package-management/#import-a-package"
PublishPackage = "/docs/tutorials/administration/package-management/#publish-a-package-version"
RunningExecutions = "/docs/tutorials/administration/package-management/#view-and-abort-running-flow-executions"
Schedules = "/docs/tutorials/administration/package-management/#create-a-schedule-on-a-package-version"
SetDefaultPackage = "/docs/tutorials/administration/package-management/#set-the-default-package"
SetDefaultPackageVersion = "/docs/tutorials/administration/package-management/#set-the-default-package-version"
Triggers = "/docs/tutorials/administration/package-management/#create-a-trigger-on-a-package-version"
UnpublishPackage = "/docs/tutorials/administration/package-management/#unpublish-a-package-version"
Authorisation = "/docs/tutorials/administration/package-management/#set-authorisation-on-a-package-version"
CreateNewPackageVersion = "/docs/tutorials/administration/package-management/#create-a-new-package-version"
CreatePackage = "/docs/tutorials/administration/package-management/#create-a-package"
ExportPackage = "/docs/tutorials/administration/package-management/#export-a-package-version"
ImportPackage = "/docs/tutorials/administration/package-management/#import-a-package"
PublishPackage = "/docs/tutorials/administration/package-management/#publish-a-package-version"
RunningExecutions = "/docs/tutorials/administration/package-management/#view-and-abort-running-flow-executions"
Schedules = "/docs/tutorials/administration/package-management/#create-a-schedule-on-a-package-version"
SetDefaultPackage = "/docs/tutorials/administration/package-management/#set-the-default-package"
SetDefaultPackageVersion = "/docs/tutorials/administration/package-management/#set-the-default-package-version"
Triggers = "/docs/tutorials/administration/package-management/#create-a-trigger-on-a-package-version"
UnpublishPackage = "/docs/tutorials/administration/package-management/#unpublish-a-package-version"
[Cortex.Tutorials.Administration.StudioImport]
MainDoc = "/docs/tutorials/administration/studio-import"
ImportIndividualFlows = "/docs/tutorials/administration/studio-import/#import-individual-flows"
[Cortex.Tutorials.Administration.StudioExport]
MainDoc = "/docs/tutorials/administration/studio-export"
ExportIndividualFlows = "/docs/tutorials/administration/studio-export/#export-individual-flows"
[Cortex.Tutorials.Operations]
MainDoc = "/docs/tutorials/Operations"
[Cortex.Tutorials.Operations.Overview]
Expand Down