diff --git a/content/en/docs/2025.3/Guides/cortex-gateway/settings/studio-export.md b/content/en/docs/2025.3/Guides/cortex-gateway/settings/studio-export.md deleted file mode 100644 index 21de622a6..000000000 --- a/content/en/docs/2025.3/Guides/cortex-gateway/settings/studio-export.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -title: "Studio Export" -linkTitle: "Studio Export" -description: "Create {{% ctx %}} Studio Packages by exporting flows." ---- - -{{< workinprogress >}} diff --git a/content/en/docs/2025.3/Guides/cortex-gateway/settings/studio-import.md b/content/en/docs/2025.3/Guides/cortex-gateway/settings/studio-import.md deleted file mode 100644 index 28a685526..000000000 --- a/content/en/docs/2025.3/Guides/cortex-gateway/settings/studio-import.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -title: "Studio Import" -linkTitle: "Studio Import" -description: "Import {{% ctx %}} Studio Packages." ---- - -{{< workinprogress >}} diff --git a/content/en/docs/2025.3/Guides/user-guides/user-interfaces/gateway/Admin/packages/_index.md b/content/en/docs/2025.3/Guides/user-guides/user-interfaces/gateway/Admin/packages/_index.md index 92fae8af2..0e01d59ad 100644 --- a/content/en/docs/2025.3/Guides/user-guides/user-interfaces/gateway/Admin/packages/_index.md +++ b/content/en/docs/2025.3/Guides/user-guides/user-interfaces/gateway/Admin/packages/_index.md @@ -2,5 +2,5 @@ title: "Packages" linkTitle: "Packages" description: "Create and manage packages in {{% ctx %}} Gateway." -weight: 10 +weight: 100 --- diff --git a/content/en/docs/2025.3/Guides/user-guides/user-interfaces/gateway/Admin/studio-export.md b/content/en/docs/2025.3/Guides/user-guides/user-interfaces/gateway/Admin/studio-export.md new file mode 100644 index 000000000..1a87e4355 --- /dev/null +++ b/content/en/docs/2025.3/Guides/user-guides/user-interfaces/gateway/Admin/studio-export.md @@ -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 .studiopkg`, where `` 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" >}} diff --git a/content/en/docs/2025.3/Guides/user-guides/user-interfaces/gateway/Admin/studio-import.md b/content/en/docs/2025.3/Guides/user-guides/user-interfaces/gateway/Admin/studio-import.md new file mode 100644 index 000000000..8240cd138 --- /dev/null +++ b/content/en/docs/2025.3/Guides/user-guides/user-interfaces/gateway/Admin/studio-import.md @@ -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" >}} diff --git a/content/en/docs/2025.3/Tutorials/Administration/package-management.md b/content/en/docs/2025.3/Tutorials/Administration/package-management.md index a4842dcc8..0ab59d22e 100644 --- a/content/en/docs/2025.3/Tutorials/Administration/package-management.md +++ b/content/en/docs/2025.3/Tutorials/Administration/package-management.md @@ -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 %}} diff --git a/content/en/docs/2025.3/Tutorials/Administration/studio-export.md b/content/en/docs/2025.3/Tutorials/Administration/studio-export.md new file mode 100644 index 000000000..2eed6d4d3 --- /dev/null +++ b/content/en/docs/2025.3/Tutorials/Administration/studio-export.md @@ -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" >}} diff --git a/content/en/docs/2025.3/Tutorials/Administration/studio-import.md b/content/en/docs/2025.3/Tutorials/Administration/studio-import.md new file mode 100644 index 000000000..deeb5d6c8 --- /dev/null +++ b/content/en/docs/2025.3/Tutorials/Administration/studio-import.md @@ -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" >}} diff --git a/content/en/docs/2025.3/_shared/install-application-server/multi-server/check-application-services.md b/content/en/docs/2025.3/_shared/install-application-server/multi-server/check-application-services.md index 688a4ddae..d891fc2e6 100644 --- a/content/en/docs/2025.3/_shared/install-application-server/multi-server/check-application-services.md +++ b/content/en/docs/2025.3/_shared/install-application-server/multi-server/check-application-services.md @@ -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" >}} \ No newline at end of file +[CORTEX Service Portal]: {{< url path="Cortex.ServicePortal.MainDoc" >}} diff --git a/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 b/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 index 9f23745d2..24bd808d7 100644 --- a/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 +++ b/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 @@ -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">}} diff --git a/content/en/docs/2025.3/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/install-web-application-server/perform-debugger-installation.md b/content/en/docs/2025.3/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/install-web-application-server/perform-debugger-installation.md index d7fcef1e4..4a1c9902b 100644 --- a/content/en/docs/2025.3/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/install-web-application-server/perform-debugger-installation.md +++ b/content/en/docs/2025.3/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/install-web-application-server/perform-debugger-installation.md @@ -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">}} diff --git a/content/static/2025.3/images/Studio Export.png b/content/static/2025.3/images/Studio Export.png new file mode 100644 index 000000000..738d29224 Binary files /dev/null and b/content/static/2025.3/images/Studio Export.png differ diff --git a/content/static/2025.3/images/Studio Import.png b/content/static/2025.3/images/Studio Import.png new file mode 100644 index 000000000..aa99776c1 Binary files /dev/null and b/content/static/2025.3/images/Studio Import.png differ diff --git a/data/urls.toml b/data/urls.toml index bf67b6fc6..9c1024d33 100644 --- a/data/urls.toml +++ b/data/urls.toml @@ -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/" @@ -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]