diff --git a/assets/scss/_content.scss b/assets/scss/_content.scss index d59134b7e..19617ddce 100644 --- a/assets/scss/_content.scss +++ b/assets/scss/_content.scss @@ -185,12 +185,11 @@ } >.scribe-video { - max-width: 640px; width: 100%; animation: fadeIn 2s; iframe { - height: 640px; + height: 700px; width: 100%; aspect-ratio: 16 / 9; border-radius: 5px; diff --git a/content/en/docs/2025.3/Guides/cortex-gateway/settings/license-consumption.md b/content/en/docs/2025.3/Guides/cortex-gateway/settings/license-consumption.md deleted file mode 100644 index fdb2d879d..000000000 --- a/content/en/docs/2025.3/Guides/cortex-gateway/settings/license-consumption.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -title: "License Consumption" -linkTitle: "License Consumption" -description: "Review current license consumption of flows in master." ---- - -{{< workinprogress >}} diff --git a/content/en/docs/2025.3/Guides/cortex-gateway/settings/studio-authorisation.md b/content/en/docs/2025.3/Guides/cortex-gateway/settings/studio-authorisation.md deleted file mode 100644 index 58ecac5b6..000000000 --- a/content/en/docs/2025.3/Guides/cortex-gateway/settings/studio-authorisation.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -title: "Studio Authorisation" -linkTitle: "Studio Authorisation" -description: "Assign access rights to flows based on security groups." ---- - -{{< workinprogress >}} diff --git a/content/en/docs/2025.3/Guides/cortex-gateway/settings/studio-hierarchy.md b/content/en/docs/2025.3/Guides/cortex-gateway/settings/studio-hierarchy.md deleted file mode 100644 index 27a09993e..000000000 --- a/content/en/docs/2025.3/Guides/cortex-gateway/settings/studio-hierarchy.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -title: "Studio Hierarchy" -linkTitle: "Studio Hierarchy" -description: "Manage the location of flows in the Flow Hierarchy." ---- - -{{< workinprogress >}} diff --git a/content/en/docs/2025.3/Guides/user-guides/user-interfaces/gateway/Admin/license-consumption.md b/content/en/docs/2025.3/Guides/user-guides/user-interfaces/gateway/Admin/license-consumption.md new file mode 100644 index 000000000..8d4c6a924 --- /dev/null +++ b/content/en/docs/2025.3/Guides/user-guides/user-interfaces/gateway/Admin/license-consumption.md @@ -0,0 +1,63 @@ +--- +title: "License Consumption" +linkTitle: "License Consumption" +description: "View the license consumption in {{% ctx %}} Gateway." +weight: 80 +--- + +# {{% param title %}} + +## Summary + +The License Consumption page is used to view the license consumption for the current platform and the minimum license requirement to support the current usage. + +## Anatomy + +{{< figure src="/images/License Consumption.png" title="License Consumption" >}} + +## Actions + +### View License Consumption + +Every functional block connected to a Start Flow block adds one to the license consumption, except for the following blocks, which do not impact the license consumption: + +* [Start Flow][] +* [End Flow][] +* [Start Workspace][] +* [End Workspace][] +* [Wireless Receiver][] +* [Wireless Sender][] +* [Workspace][] +* [Handle Flow Exception Workspace][] + +The License Consumption details are shown in a tabular format, where each flow’s license consumption is aggregated and shown as a total against its parent group. Groups may be expanded to show the license consumption of each individual flow. + +The `Breakdown` switch expands the table to additionally show the flow usage and the number of functional blocks used in each flow. In {{% ctx %}} all flows will have a count of 1 in the `Usage` column. + +See the [Check License Consumption][Check License Consumption tutorial] tutorial for a step-by-step guide. + +## Remarks + +### Known Limitations + +None + +## See Also + +### Related Concepts + +None + +### Related Tutorials + +* [Check License Consumption][Check License Consumption tutorial] + +[Check License Consumption tutorial]: {{< url path="Cortex.Tutorials.Administration.LicenseConsumption.CheckLicenseConsumption" >}} +[End Flow]: {{< url path="Cortex.Reference.Blocks.Flows.EndFlow.EndFlow.MainDoc" >}} +[End Workspace]: {{< url path="Cortex.Reference.Blocks.Workspaces.EndWorkspace.EndWorkspace.MainDoc" >}} +[Handle Flow Exception Workspace]: {{< url path="Cortex.Reference.Blocks.Exceptions.HandleFlow.HandleFlowException.MainDoc" >}} +[Start Flow]: {{< url path="Cortex.Reference.Blocks.Flows.StartFlow.StartFlow.MainDoc" >}} +[Start Workspace]: {{< url path="Cortex.Reference.Blocks.Workspaces.StartWorkspace.StartWorkspace.MainDoc" >}} +[Wireless Receiver]: {{< url path="Cortex.Reference.Blocks.Wireless.WirelessReceiver.WirelessReceiver.MainDoc" >}} +[Wireless Sender]: {{< url path="Cortex.Reference.Blocks.Wireless.WirelessSender.WirelessSender.MainDoc" >}} +[Workspace]: {{< url path="Cortex.Reference.Blocks.Workspaces.Workspace.Workspace.MainDoc" >}} diff --git a/content/en/docs/2025.3/Guides/user-guides/user-interfaces/gateway/Admin/studio-authorisation.md b/content/en/docs/2025.3/Guides/user-guides/user-interfaces/gateway/Admin/studio-authorisation.md new file mode 100644 index 000000000..64631ad27 --- /dev/null +++ b/content/en/docs/2025.3/Guides/user-guides/user-interfaces/gateway/Admin/studio-authorisation.md @@ -0,0 +1,101 @@ +--- +title: "Studio Authorisation" +linkTitle: "Studio Authorisation" +description: "Configure access to flows in {{% ctx %}} Gateway." +weight: 50 +--- + +# {{% param title %}} + +## Summary + +The Studio Authorisation page is used to configure access to flows within {{% ctx %}} Gateway. Each flow can be set to have [`View`][View] or [`Edit`][Edit] permissions assigned to LDAP Groups that exist in the Active Directory server configured in LDAP Connection for {{% ctx %}} Gateway, or no access permissions at all. + +| | | +|------------------------------|-----------------------------------------------------------------| +| **Roles Required:** | Admin | + +## Anatomy + +{{< figure src="/images/Studio Authorisation.png" title="Studio Authorisation" >}} + +The LDAP Groups that may be granted access are limited to those assigned the `Studio` role in LDAP Authorisation. + +Permissions are set either explicitly or implicitly. Explicitly set permissions are assigned by the user performing an explicit action to set that item’s permissions, whereas implicitly set permissions are assigned automatically by the user explicitly setting the permissions on a parent group. + +Permissions are explicitly set by setting the checkbox in either the [View][] or [Edit][] columns of the appropriate LDAP Group for the flow or group to which the permissions are to be assigned. Permissions are explicitly removed by clearing the checkbox. + +If an item is explicitly set with [`Edit`][Edit] permissions, then that item will also be implicitly set with [`View`][View] permissions. Explicitly setting an item with [`View`][View] permissions does not implicitly set it with Edit permissions. + +## Actions + +### View + +If an LDAP group is given `View` permissions on a flow, the members of the LDAP group can: + +* View the flow +* Debug the flow + +If an LDAP Group is given `View` permissions on a group, the members of that LDAP group can: + +* View all descendent groups and flows +* Debug all descendent flows + +If a group has `View` permissions either explicitly set or implicitly set, then its child groups and flows will have their `View` permissions implicitly set. + +If a group has its `View` permissions removed, then all its child groups and flows will have their `View` permissions removed, regardless of whether they were set explicitly or implicitly. + +See the [Manage Flow Access][Manage Flow Access tutorial] tutorial for a step-by-step guide. + +### Edit + +If an LDAP group is given `Edit` permissions on a flow, the members of the LDAP group can: + +* View the flow +* Debug the flow +* Edit the flow +* Move the flow +* Rename the flow +* Delete the flow +* Commit changes to the flow +* Get the master version of the flow + +If an LDAP Group is given `Edit` permissions on a group, the members of that LDAP group can: + +* Create new flows and groups within the group +* View all descendent flows and groups +* Debug all descendent flows +* Edit all descendent flows +* Move all descendent flows +* Rename all descendent flows +* Delete all descendent flows +* Commit changes to all descendent flows +* Get the master version of all descendent flows + +If a group has `Edit` permissions explicitly set, then its child groups and flows will be implicitly set with both `Edit` and [`View`][View] permissions. + +If a group has its `Edit` permissions removed, then all its child groups and flows will have their `Edit` permissions removed, regardless of whether they were set explicitly or implicitly. + +If a flow is explicitly set with `Edit` permissions, then any parent groups, which have not been explicitly set with [`View`][View] permissions, will be implicitly set with [`View`][View] permissions. + +See the [Manage Flow Access][Manage Flow Access tutorial] tutorial for a step-by-step guide. + +## Remarks + +### Known Limitations + +* The state of whether a permission is granted explicitly or implicitly is not persisted between the page being closed and reopened. + +## See Also + +### Related Concepts + +None + +### Related Tutorials + +* [Manage Flow Access][Manage Flow Access tutorial] + +[Edit]: {{< ref "#edit">}} +[View]: {{< ref "#view">}} +[Manage Flow Access tutorial]: {{< url path="Cortex.Tutorials.Administration.StudioAuthorisation.ManageFlowAccess" >}} 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 index 1a87e4355..36b39b1dd 100644 --- 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 @@ -2,7 +2,7 @@ title: "Studio Export" linkTitle: "Studio Export" description: "Export flows from {{% ctx %}} Gateway." -weight: 50 +weight: 60 --- # {{% param title %}} diff --git a/content/en/docs/2025.3/Guides/user-guides/user-interfaces/gateway/Admin/studio-hierarchy.md b/content/en/docs/2025.3/Guides/user-guides/user-interfaces/gateway/Admin/studio-hierarchy.md new file mode 100644 index 000000000..bd0feb06d --- /dev/null +++ b/content/en/docs/2025.3/Guides/user-guides/user-interfaces/gateway/Admin/studio-hierarchy.md @@ -0,0 +1,49 @@ +--- +title: "Studio Hierarchy" +linkTitle: "Studio Hierarchy" +description: "Move flows in {{% ctx %}} Gateway." +weight: 70 +--- + +# {{% param title %}} + +## Summary + +The Studio Hierarchy page is used to move one or more flows from one group to another. + +## Anatomy + +{{< figure src="/images/Studio Hierarchy.png" title="Studio Hierarchy" >}} + +Only flows with [`Edit`][Edit] permissions for the current user are displayed in the Studio Hierarchy grid. + +## Actions + +### Move Flows + +After selecting the flows that are to be moved, right-click on the group where the selected flows will be moved to, and select the `Move selected items to this Group` from the context menu. The display will be updated to show the resultant hierarchy, with the flows to be moved but not yet committed identified with an asterisk (*) in the `Results` column of the grid. + +If a group is selected, then only the flows contained in that group are moved to another group; not the group itself. + +Once all the necessary flows have been moved, the changes can be committed using the `Commit` button. + +See the [Manage Flow Hierarchy][Manage Flow Hierarchy tutorial] tutorial for a step-by-step guide. + +## Remarks + +### Known Limitations + +* Parent groups must also have [`Edit`][Edit] permissions, in addition to the flows, otherwise the group and flows contained within it will not be displayed. + +## See Also + +### Related Concepts + +None + +### Related Tutorials + +* [Manage Flow Hierarchy][Manage Flow Hierarchy tutorial] + +[Edit]: {{< url path="Cortex.Guides.UserGuides.UserInterfaces.Gateway.Admin.StudioAuthorisation.Edit" >}} +[Manage Flow Hierarchy tutorial]: {{< url path="Cortex.Tutorials.Administration.StudioHierarchy.ManageFlowHierarchy" >}} 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 index 8240cd138..f3a80f7df 100644 --- 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 @@ -2,7 +2,7 @@ title: "Studio Import" linkTitle: "Studio Import" description: "Import flows into {{% ctx %}} Gateway." -weight: 25 +weight: 40 --- # {{% param title %}} diff --git a/content/en/docs/2025.3/Guides/user-guides/user-interfaces/gateway/Admin/version-control.md b/content/en/docs/2025.3/Guides/user-guides/user-interfaces/gateway/Admin/version-control.md index 72677249e..a19e8abe5 100644 --- a/content/en/docs/2025.3/Guides/user-guides/user-interfaces/gateway/Admin/version-control.md +++ b/content/en/docs/2025.3/Guides/user-guides/user-interfaces/gateway/Admin/version-control.md @@ -15,7 +15,7 @@ The Version Control page displays the flow hierarchy for the current user, indic {{< figure src="/images/Version Control.png" title="Version Control" >}} -Only flows with Edit permissions for the current user are displayed in the Version Control grid. +Only flows with [`Edit`][Edit] permissions for the current user are displayed in the Version Control grid. ## Actions @@ -35,7 +35,7 @@ See the [Use Version Control][Use Version Control tutorial] tutorial for a step- ### Known Limitations -* Parent groups must also have edit permissions, in addition to the flows, otherwise the group and flows contained within it will not be displayed. +* Parent groups must also have [`Edit`][Edit] permissions, in addition to the flows, otherwise the group and flows contained within it will not be displayed. ## See Also @@ -47,4 +47,5 @@ None * [Use Version Control][Use Version Control tutorial] +[Edit]: {{< url path="Cortex.Guides.UserGuides.UserInterfaces.Gateway.Admin.StudioAuthorisation.Edit" >}} [Use Version Control tutorial]: {{< url path="Cortex.Tutorials.Administration.VersionControl.UseVersionControl" >}} diff --git a/content/en/docs/2025.3/Reference/Glossary/f-j.md b/content/en/docs/2025.3/Reference/Glossary/f-j.md index c422f93d8..bbdb47beb 100644 --- a/content/en/docs/2025.3/Reference/Glossary/f-j.md +++ b/content/en/docs/2025.3/Reference/Glossary/f-j.md @@ -31,7 +31,7 @@ For more detailed information about flows, see [Fundamentals > Flows][]. A flow developer is a user that has been granted permissions to develop [flows][] in [{{% ctx %}} Studio][CORTEX Studio]. -For more detailed information about granting permissions to develop [flows][], see [{{% ctx %}} Studio > Authorisation][CORTEX Studio > Authorisation]. +For more detailed information about granting permissions to develop [flows][], see [Studio Authorisation][Studio Authorisation]. ### Folder @@ -252,7 +252,7 @@ See [What is JSON][What is Json (W3)] for more information. [collection]: {{< url path="Cortex.Reference.Concepts.WorkingWith.Collections.MainDoc" >}} [Collections > Indexes]: {{< url path="Cortex.Reference.Concepts.WorkingWith.Collections.Indexes.MainDoc" >}} -[CORTEX Studio > Authorisation]: {{< url path="Cortex.Guides.Gateway.Settings.StudioAuthorisation.MainDoc" >}} +[Studio Authorisation]: {{< url path="Cortex.Guides.UserGuides.UserInterfaces.Gateway.Admin.StudioAuthorisation.MainDoc" >}} [Int16]: {{< url path="Cortex.Reference.DataTypes.Numbers.Int16.MainDoc" >}} [Int32]: {{< url path="Cortex.Reference.DataTypes.Numbers.Int32.MainDoc" >}} diff --git a/content/en/docs/2025.3/Tutorials/Administration/license-consumption.md b/content/en/docs/2025.3/Tutorials/Administration/license-consumption.md new file mode 100644 index 000000000..70bef38b7 --- /dev/null +++ b/content/en/docs/2025.3/Tutorials/Administration/license-consumption.md @@ -0,0 +1,12 @@ +--- +title: "License Consumption" +linkTitle: "License Consumption" +description: "This section includes tutorials about checking the license consumption." +weight: 80 +--- + +# {{% param title %}} + +## Check License Consumption + +{{< scribe title="How_to_Check_the_License_Consumption_using_CORTEX_Studio" id="Os9puelFRv6pHzcY8HgzJg" >}} diff --git a/content/en/docs/2025.3/Tutorials/Administration/studio-authorisation.md b/content/en/docs/2025.3/Tutorials/Administration/studio-authorisation.md new file mode 100644 index 000000000..212f1936c --- /dev/null +++ b/content/en/docs/2025.3/Tutorials/Administration/studio-authorisation.md @@ -0,0 +1,12 @@ +--- +title: "Studio Authorisation" +linkTitle: "Studio Authorisation" +description: "This section includes tutorials about management of flow access." +weight: 50 +--- + +# {{% param title %}} + +## Manage Flow Access + +{{< scribe title="How_to_Manage_Access_to_Flows_using_Studio_Authorisation" id="jtyNjnwZT862BQVl2KLskQ" >}} diff --git a/content/en/docs/2025.3/Tutorials/Administration/studio-export.md b/content/en/docs/2025.3/Tutorials/Administration/studio-export.md index 2eed6d4d3..f8987799d 100644 --- a/content/en/docs/2025.3/Tutorials/Administration/studio-export.md +++ b/content/en/docs/2025.3/Tutorials/Administration/studio-export.md @@ -2,7 +2,7 @@ title: "Studio Export" linkTitle: "Studio Export" description: "This section includes tutorials about exporting individual flows." -weight: 100 +weight: 60 --- # {{% param title %}} diff --git a/content/en/docs/2025.3/Tutorials/Administration/studio-hierarchy.md b/content/en/docs/2025.3/Tutorials/Administration/studio-hierarchy.md new file mode 100644 index 000000000..685987024 --- /dev/null +++ b/content/en/docs/2025.3/Tutorials/Administration/studio-hierarchy.md @@ -0,0 +1,12 @@ +--- +title: "Studio Hierarchy" +linkTitle: "Studio Hierarchy" +description: "This section includes tutorials about managing the flow hierarchy." +weight: 70 +--- + +# {{% param title %}} + +## Manage Flow Hierarchy + +{{< scribe title="How_to_use_Studio_Hierarchy" id="7DuT-9DETw6OzXRq37oMGQ" >}} diff --git a/content/en/docs/2025.3/Tutorials/Administration/studio-import.md b/content/en/docs/2025.3/Tutorials/Administration/studio-import.md index deeb5d6c8..85ab3883d 100644 --- a/content/en/docs/2025.3/Tutorials/Administration/studio-import.md +++ b/content/en/docs/2025.3/Tutorials/Administration/studio-import.md @@ -2,7 +2,7 @@ title: "Studio Import" linkTitle: "Studio Import" description: "This section includes tutorials about importing individual flows." -weight: 50 +weight: 40 --- # {{% param title %}} diff --git a/content/static/2025.3/images/License Consumption.png b/content/static/2025.3/images/License Consumption.png new file mode 100644 index 000000000..bcd70432d Binary files /dev/null and b/content/static/2025.3/images/License Consumption.png differ diff --git a/content/static/2025.3/images/Studio Authorisation.png b/content/static/2025.3/images/Studio Authorisation.png new file mode 100644 index 000000000..23bd1578d Binary files /dev/null and b/content/static/2025.3/images/Studio Authorisation.png differ diff --git a/content/static/2025.3/images/Studio Hierarchy.png b/content/static/2025.3/images/Studio Hierarchy.png new file mode 100644 index 000000000..a9bae0d27 Binary files /dev/null and b/content/static/2025.3/images/Studio Hierarchy.png differ diff --git a/data/urls.toml b/data/urls.toml index 9f4b5d42e..158a9b0d3 100644 --- a/data/urls.toml +++ b/data/urls.toml @@ -495,7 +495,6 @@ MainDoc = "/docs/getting-started/cloud/add-observability-to-innovation/grafana/install-promtail/configure-promtail" [Cortex.GettingStarted.Cloud.AddObservabilityToInnovation.Grafana.TryItOut] MainDoc = "/docs/getting-started/cloud/add-observability-to-innovation/grafana/try-it-out/" - [Cortex.Guides] MainDoc = "/docs/guides/" [Cortex.Guides.Studio] @@ -925,10 +924,12 @@ 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.StudioAuthorisation] + MainDoc = "/docs/guides/user-guides/user-interfaces/gateway/admin/studio-authorisation/" + Edit = "/docs/guides/user-guides/user-interfaces/gateway/admin/studio-authorisation/#edit" [Cortex.Guides.UserGuides.UserInterfaces.Gateway.Admin.StudioImport] MainDoc = "/docs/guides/user-guides/user-interfaces/gateway/admin/studio-import/" - -[Cortex.Reference] + [Cortex.Reference] MainDoc = "/docs/reference/" [Cortex.Reference.Apis] MainDoc = "/docs/reference/Apis/" @@ -2750,6 +2751,9 @@ MainDoc = "/docs/tutorials/" [Cortex.Tutorials.Administration] MainDoc = "/docs/tutorials/administration" + [Cortex.Tutorials.Administration.LicenseConsumption] + MainDoc = "/docs/tutorials/administration/license-consumption" + CheckLicenseConsumption = "/docs/tutorials/administration/license-consumption/#check-license-consumption" [Cortex.Tutorials.Administration.PackageManagement] MainDoc = "/docs/tutorials/administration/package-management" Authorisation = "/docs/tutorials/administration/package-management/#set-authorisation-on-a-package-version" @@ -2764,12 +2768,18 @@ 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.StudioAuthorisation] + MainDoc = "/docs/tutorials/administration/studio-authorisation" + ManageFlowAccess = "/docs/tutorials/administration/studio-authorisation/#manage-flow-access" [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.Administration.StudioHierarchy] + MainDoc = "/docs/tutorials/administration/studio-hierarchy" + ManageFlowHierarchy = "/docs/tutorials/administration/studio-hierarchy/#manage-flow-hierarchy" [Cortex.Tutorials.Administration.VersionControl] MainDoc = "/docs/tutorials/administration/version-control" UseVersionControl = "/docs/tutorials/administration/version-control/#use-version-control"