Skip to content

Commit 6afcce1

Browse files
authored
Feature/add additional admin user guides (#216)
1 parent aa987d1 commit 6afcce1

File tree

20 files changed

+272
-34
lines changed

20 files changed

+272
-34
lines changed

assets/scss/_content.scss

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -185,12 +185,11 @@
185185
}
186186

187187
>.scribe-video {
188-
max-width: 640px;
189188
width: 100%;
190189
animation: fadeIn 2s;
191190

192191
iframe {
193-
height: 640px;
192+
height: 700px;
194193
width: 100%;
195194
aspect-ratio: 16 / 9;
196195
border-radius: 5px;

content/en/docs/2025.3/Guides/cortex-gateway/settings/license-consumption.md

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

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

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

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

Lines changed: 0 additions & 7 deletions
This file was deleted.
Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
---
2+
title: "License Consumption"
3+
linkTitle: "License Consumption"
4+
description: "View the license consumption in {{% ctx %}} Gateway."
5+
weight: 80
6+
---
7+
8+
# {{% param title %}}
9+
10+
## Summary
11+
12+
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.
13+
14+
## Anatomy
15+
16+
{{< figure src="/images/License Consumption.png" title="License Consumption" >}}
17+
18+
## Actions
19+
20+
### View License Consumption
21+
22+
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:
23+
24+
* [Start Flow][]
25+
* [End Flow][]
26+
* [Start Workspace][]
27+
* [End Workspace][]
28+
* [Wireless Receiver][]
29+
* [Wireless Sender][]
30+
* [Workspace][]
31+
* [Handle Flow Exception Workspace][]
32+
33+
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.
34+
35+
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.
36+
37+
See the [Check License Consumption][Check License Consumption tutorial] tutorial for a step-by-step guide.
38+
39+
## Remarks
40+
41+
### Known Limitations
42+
43+
None
44+
45+
## See Also
46+
47+
### Related Concepts
48+
49+
None
50+
51+
### Related Tutorials
52+
53+
* [Check License Consumption][Check License Consumption tutorial]
54+
55+
[Check License Consumption tutorial]: {{< url path="Cortex.Tutorials.Administration.LicenseConsumption.CheckLicenseConsumption" >}}
56+
[End Flow]: {{< url path="Cortex.Reference.Blocks.Flows.EndFlow.EndFlow.MainDoc" >}}
57+
[End Workspace]: {{< url path="Cortex.Reference.Blocks.Workspaces.EndWorkspace.EndWorkspace.MainDoc" >}}
58+
[Handle Flow Exception Workspace]: {{< url path="Cortex.Reference.Blocks.Exceptions.HandleFlow.HandleFlowException.MainDoc" >}}
59+
[Start Flow]: {{< url path="Cortex.Reference.Blocks.Flows.StartFlow.StartFlow.MainDoc" >}}
60+
[Start Workspace]: {{< url path="Cortex.Reference.Blocks.Workspaces.StartWorkspace.StartWorkspace.MainDoc" >}}
61+
[Wireless Receiver]: {{< url path="Cortex.Reference.Blocks.Wireless.WirelessReceiver.WirelessReceiver.MainDoc" >}}
62+
[Wireless Sender]: {{< url path="Cortex.Reference.Blocks.Wireless.WirelessSender.WirelessSender.MainDoc" >}}
63+
[Workspace]: {{< url path="Cortex.Reference.Blocks.Workspaces.Workspace.Workspace.MainDoc" >}}
Lines changed: 101 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,101 @@
1+
---
2+
title: "Studio Authorisation"
3+
linkTitle: "Studio Authorisation"
4+
description: "Configure access to flows in {{% ctx %}} Gateway."
5+
weight: 50
6+
---
7+
8+
# {{% param title %}}
9+
10+
## Summary
11+
12+
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.
13+
14+
| | |
15+
|------------------------------|-----------------------------------------------------------------|
16+
| **Roles Required:** | Admin |
17+
18+
## Anatomy
19+
20+
{{< figure src="/images/Studio Authorisation.png" title="Studio Authorisation" >}}
21+
22+
The LDAP Groups that may be granted access are limited to those assigned the `Studio` role in LDAP Authorisation.
23+
24+
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.
25+
26+
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.
27+
28+
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.
29+
30+
## Actions
31+
32+
### View
33+
34+
If an LDAP group is given `View` permissions on a flow, the members of the LDAP group can:
35+
36+
* View the flow
37+
* Debug the flow
38+
39+
If an LDAP Group is given `View` permissions on a group, the members of that LDAP group can:
40+
41+
* View all descendent groups and flows
42+
* Debug all descendent flows
43+
44+
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.
45+
46+
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.
47+
48+
See the [Manage Flow Access][Manage Flow Access tutorial] tutorial for a step-by-step guide.
49+
50+
### Edit
51+
52+
If an LDAP group is given `Edit` permissions on a flow, the members of the LDAP group can:
53+
54+
* View the flow
55+
* Debug the flow
56+
* Edit the flow
57+
* Move the flow
58+
* Rename the flow
59+
* Delete the flow
60+
* Commit changes to the flow
61+
* Get the master version of the flow
62+
63+
If an LDAP Group is given `Edit` permissions on a group, the members of that LDAP group can:
64+
65+
* Create new flows and groups within the group
66+
* View all descendent flows and groups
67+
* Debug all descendent flows
68+
* Edit all descendent flows
69+
* Move all descendent flows
70+
* Rename all descendent flows
71+
* Delete all descendent flows
72+
* Commit changes to all descendent flows
73+
* Get the master version of all descendent flows
74+
75+
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.
76+
77+
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.
78+
79+
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.
80+
81+
See the [Manage Flow Access][Manage Flow Access tutorial] tutorial for a step-by-step guide.
82+
83+
## Remarks
84+
85+
### Known Limitations
86+
87+
* The state of whether a permission is granted explicitly or implicitly is not persisted between the page being closed and reopened.
88+
89+
## See Also
90+
91+
### Related Concepts
92+
93+
None
94+
95+
### Related Tutorials
96+
97+
* [Manage Flow Access][Manage Flow Access tutorial]
98+
99+
[Edit]: {{< ref "#edit">}}
100+
[View]: {{< ref "#view">}}
101+
[Manage Flow Access tutorial]: {{< url path="Cortex.Tutorials.Administration.StudioAuthorisation.ManageFlowAccess" >}}

content/en/docs/2025.3/Guides/user-guides/user-interfaces/gateway/Admin/studio-export.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: "Studio Export"
33
linkTitle: "Studio Export"
44
description: "Export flows from {{% ctx %}} Gateway."
5-
weight: 50
5+
weight: 60
66
---
77

88
# {{% param title %}}
Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
---
2+
title: "Studio Hierarchy"
3+
linkTitle: "Studio Hierarchy"
4+
description: "Move flows in {{% ctx %}} Gateway."
5+
weight: 70
6+
---
7+
8+
# {{% param title %}}
9+
10+
## Summary
11+
12+
The Studio Hierarchy page is used to move one or more flows from one group to another.
13+
14+
## Anatomy
15+
16+
{{< figure src="/images/Studio Hierarchy.png" title="Studio Hierarchy" >}}
17+
18+
Only flows with [`Edit`][Edit] permissions for the current user are displayed in the Studio Hierarchy grid.
19+
20+
## Actions
21+
22+
### Move Flows
23+
24+
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.
25+
26+
If a group is selected, then only the flows contained in that group are moved to another group; not the group itself.
27+
28+
Once all the necessary flows have been moved, the changes can be committed using the `Commit` button.
29+
30+
See the [Manage Flow Hierarchy][Manage Flow Hierarchy tutorial] tutorial for a step-by-step guide.
31+
32+
## Remarks
33+
34+
### Known Limitations
35+
36+
* 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.
37+
38+
## See Also
39+
40+
### Related Concepts
41+
42+
None
43+
44+
### Related Tutorials
45+
46+
* [Manage Flow Hierarchy][Manage Flow Hierarchy tutorial]
47+
48+
[Edit]: {{< url path="Cortex.Guides.UserGuides.UserInterfaces.Gateway.Admin.StudioAuthorisation.Edit" >}}
49+
[Manage Flow Hierarchy tutorial]: {{< url path="Cortex.Tutorials.Administration.StudioHierarchy.ManageFlowHierarchy" >}}

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: "Studio Import"
33
linkTitle: "Studio Import"
44
description: "Import flows into {{% ctx %}} Gateway."
5-
weight: 25
5+
weight: 40
66
---
77

88
# {{% param title %}}

content/en/docs/2025.3/Guides/user-guides/user-interfaces/gateway/Admin/version-control.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ The Version Control page displays the flow hierarchy for the current user, indic
1515

1616
{{< figure src="/images/Version Control.png" title="Version Control" >}}
1717

18-
Only flows with Edit permissions for the current user are displayed in the Version Control grid.
18+
Only flows with [`Edit`][Edit] permissions for the current user are displayed in the Version Control grid.
1919

2020
## Actions
2121

@@ -35,7 +35,7 @@ See the [Use Version Control][Use Version Control tutorial] tutorial for a step-
3535

3636
### Known Limitations
3737

38-
* Parent groups must also have edit permissions, in addition to the flows, otherwise the group and flows contained within it will not be displayed.
38+
* 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.
3939

4040
## See Also
4141

@@ -47,4 +47,5 @@ None
4747

4848
* [Use Version Control][Use Version Control tutorial]
4949

50+
[Edit]: {{< url path="Cortex.Guides.UserGuides.UserInterfaces.Gateway.Admin.StudioAuthorisation.Edit" >}}
5051
[Use Version Control tutorial]: {{< url path="Cortex.Tutorials.Administration.VersionControl.UseVersionControl" >}}

0 commit comments

Comments
 (0)