Skip to content

Commit bce62f4

Browse files
author
Donna-Marie Smith
committed
Merge branch 'feature/add-operations-overview-documentation' of https://github.com/CortexIntelligentAutomation/docs into feature/add-studio-import-export-documentation
2 parents 685eeba + 56e30f0 commit bce62f4

File tree

20 files changed

+283
-171
lines changed

20 files changed

+283
-171
lines changed

‎content/en/docs/2025.3/FAQs/_index.md‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,3 @@ linkTitle: "FAQs"
44
description: "Answers to our most frequently asked questions."
55
weight: 10000
66
---
7-
8-
{{< workinprogress >}}

‎content/en/docs/2025.3/FAQs/check-cluster-health/_index.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
title: "How do I check cluster health?"
3+
linkTitle: "How do I check cluster health?"
4+
description: "Instructions on how to check the health of your cluster."
5+
weight: 100
6+
---

‎content/en/docs/2025.3/FAQs/check-cluster-health/multi-server-with-ha.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
title: "Multiple Server with HA"
3+
linkTitle: "Multiple Server with HA"
4+
description: "Instructions on how to check the health of your multiple server cluster."
5+
weight: 1
6+
---
7+
8+
# Check Cluster Health
9+
10+
{{< section "/install-application-server/multi-server/check-application-services.md">}}

‎content/en/docs/2025.3/FAQs/check-cluster-health/single-server-without-ha.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
title: "Single Server without HA"
3+
linkTitle: "Single Server without HA"
4+
description: "Instructions on how to check the health of your single server cluster."
5+
weight: 2
6+
---
7+
8+
# Check Cluster Health
9+
10+
{{< section "/install-application-server/single-server/check-application-services.md">}}

‎content/en/docs/2025.3/FAQs/import-client-certificate/_index.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
title: "How do I import the client certificate?"
3+
linkTitle: "How do I import the client certificate?"
4+
description: "Instructions on how to import the client certificate."
5+
weight: 150
6+
---

‎content/en/docs/2025.3/FAQs/import-client-certificate/multi-server-with-ha.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
title: "Multiple Server with HA"
3+
linkTitle: "Multiple Server with HA"
4+
description: "Instructions on how to import the client certificate."
5+
weight: 1
6+
---
7+
8+
# Import Client Certificate
9+
10+
{{< section "/install-application-server/multi-server/import-client-certificate.md">}}

‎content/en/docs/2025.3/FAQs/import-client-certificate/single-server-without-ha.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
title: "Single Server without HA"
3+
linkTitle: "Single Server without HA"
4+
description: "Instructions on how to import the client certificate."
5+
weight: 2
6+
---
7+
8+
# Import Client Certificate
9+
10+
{{< section "/install-application-server/single-server/import-client-certificate.md">}}

‎content/en/docs/2025.3/Guides/user-guides/user-interfaces/gateway/ops/_index.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,5 @@
22
title: "Ops"
33
linkTitle: "Ops"
44
description: "This section includes user guides related to the Operations section in {{% ctx %}} Gateway."
5-
weight: 10
5+
weight: 5
66
---

‎content/en/docs/2025.3/Guides/user-guides/user-interfaces/gateway/ops/overview.md‎

Lines changed: 140 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,140 @@
1+
---
2+
title: "Overview"
3+
linkTitle: "Overview"
4+
description: "Summary and Anatomy of the Operations Overview."
5+
weight: 10
6+
---
7+
8+
# {{% param title %}}
9+
10+
## Summary
11+
12+
The Operations Overview shows a synopsis of the current platform status, and a graphical display of the flow execution statistics.
13+
14+
## Anatomy
15+
16+
{{< figure src="/images/Operations Overview.png" title="Operations Overview" >}}
17+
18+
### Current Status
19+
20+
#### License Consumption
21+
22+
This tile displays the current License Consumption. The {{< image src="/images/GoTo.png" >}} icon navigates to the License Consumption feature, to provide visibility of the license consumption by group and by flow.
23+
24+
#### Cluster Health
25+
26+
This tile displays the current Cluster Health. The {{< image src="/images/GoTo.png" >}} icon opens a new browser tab and navigates to the [Service Fabric Explorer][], which allows [inspection and management][Check Cluster Health] of the cluster.
27+
28+
{{% alert title="Note" %}}
29+
To view the Service Fabric Explorer, the Service Fabric certificate must be installed as a client certificate on the machine from which you are browsing.
30+
{{% /alert %}}
31+
32+
#### Running Executions
33+
34+
This tile displays the current number of [Running Executions][]. The {{< image src="/images/GoTo.png" >}} icon navigates to the [Package Management][Package Management] feature, to provide a breakdown of running executions by package version and flow.
35+
36+
### Filters
37+
38+
#### Package Names
39+
40+
This filter displays the packages that have executions during the [Time Period][] selected. One or more packages can be selected, the default is `All`.
41+
42+
If a Package Name is selected that does not contain a previously selected Package Version, then all Package Versions for the selected Package Name will be automatically selected.
43+
44+
#### Package Versions
45+
46+
This filter displays the package versions that have executions during the [Time Period][] selected. One or more package versions can be selected, the default is `All`. This filter will only include package versions for the packages selected in the [Package Names][] filter.
47+
48+
If a Package Version is selected that does not contain a previously selected flow, then all flows for the selected Package Version will be automatically selected.
49+
50+
#### Flows
51+
52+
This filter displays the flows that have executions during the [Time Period][] selected. One or more flows can be selected, the default is `All`. This filter will only include flows for the package versions and packages selected in the [Package Versions][] and [Package Names][] filters.
53+
54+
{{% alert title="Note" %}}
55+
When any of the above filters are changed, a `Refresh Data` button will appear that must be clicked to apply the filters.
56+
{{% /alert %}}
57+
58+
#### Time Period
59+
60+
This filter displays a set of pre-defined periods to filter the data by:
61+
62+
| Time Period | Start of Period | End of Period | Interval |
63+
|---------------------|------------------------------|-----------------------|----------|
64+
| Today (so far) | Today at 00:00:00 | Now | 1 hour |
65+
| Yesterday | Yesterday at 00:00:00 | Yesterday at 23:59:59 | 1 hour |
66+
| This week (so far) | Monday at 00:00:00 | Now | 1 hour |
67+
| Last day | Now - 24 hours | Now | 1 hour |
68+
| Last 2 days | Now - 48 hours | Now | 1 hour |
69+
| Last 3 days | Now - 72 hours | Now | 1 hour |
70+
| Last 5 days | Now - 120 hours | Now | 1 hour |
71+
| Last 7 days | Now - 168 hours | Now | 1 hour |
72+
| This month (so far) | 1st day of month at 00:00:00 | Now | 1 day |
73+
| Last month | Now - 1 month | Now | 1 day |
74+
| Last 3 months | Now - 3 months | Now | 1 day |
75+
| Last 6 months | Now - 6 months | Now | 1 day |
76+
| Last 12 months | Now - 12 months | Now | 1 day |
77+
78+
#### Refresh
79+
80+
This button, located next to the [Time Period][] filter, refreshes the filters and then the data displayed.
81+
82+
### Flows
83+
84+
#### Success Rate
85+
86+
Success Rate represents the percentage of flow executions that completed successfully.
87+
88+
The value displayed is the average success rate for the selected time period, rounded down to the nearest whole percentage point.
89+
90+
The graph displays the trend of flow execution success rate during the selected time period.
91+
92+
#### Completed
93+
94+
Completed represents the number of flow executions that completed successfully or errored.
95+
96+
The value displayed is the total number of flow executions that completed during the selected time period.
97+
98+
The graph displays the trend of completed flow executions during the selected time period.
99+
100+
#### Errored
101+
102+
Errored represents the number of flow executions that errored; this includes executions that have been stopped in the [Running Executions] tab of the [Package Management][] feature.
103+
104+
The value displayed is the total number of flow executions that errored during the selected time period.
105+
106+
The graph displays the trend of errored flow executions during the selected time period.
107+
108+
#### Duration
109+
110+
Duration represents the time taken in seconds for flow executions to have completed successfully or errored.
111+
112+
The value displayed is the average flow execution duration during the selected time period.
113+
114+
The graph displays the trend of average flow execution duration during the selected time period.
115+
116+
## Remarks
117+
118+
### Known Limitations
119+
120+
None
121+
122+
## See Also
123+
124+
### Related Concepts
125+
126+
None
127+
128+
### Related Tutorials
129+
130+
* [Using the Operations Overview][Using the Operations Overview tutorial]
131+
132+
[Package Names]: {{< ref "#package-names" >}}
133+
[Package Versions]: {{< ref "#package-versions" >}}
134+
[Time Period]: {{< ref "#time-period" >}}
135+
136+
[Check Cluster Health]: {{< url path="Cortex.Faqs.CheckClusterHealth">}}
137+
[Package Management]: {{< url path="Cortex.Guides.UserGuides.UserInterfaces.Gateway.Admin.Packages.Overview.MainDoc" >}}
138+
[Running Executions]: {{< url path="Cortex.Guides.UserGuides.UserInterfaces.Gateway.Admin.Packages.PackageVersionEditor.RunningExecutions" >}}
139+
[Service Fabric Explorer]: {{< url path="Cortex.Reference.Glossary.P-T.ServiceFabricExplorer" >}}
140+
[Using the Operations Overview tutorial]: {{< url path="Cortex.Tutorials.Operations.Overview.UseOperationsOverview" >}}

‎content/en/docs/2025.3/Guides/user-guides/user-interfaces/gateway/ops/overview/_index.md‎

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

0 commit comments

Comments
 (0)