diff --git a/assets/images/smartui-automation-dashboard/smartui-tab-overview.jpeg b/assets/images/smartui-automation-dashboard/smartui-tab-overview.jpeg new file mode 100644 index 000000000..803c13aa2 Binary files /dev/null and b/assets/images/smartui-automation-dashboard/smartui-tab-overview.jpeg differ diff --git a/docs/smartui-automation-dashboard.md b/docs/smartui-automation-dashboard.md index 82d4cba04..d4d287afe 100644 --- a/docs/smartui-automation-dashboard.md +++ b/docs/smartui-automation-dashboard.md @@ -2,7 +2,7 @@ id: smartui-automation-dashboard title: SmartUI in the Automation Dashboard sidebar_label: SmartUI in Automation Dashboard -description: View, group, and review your SmartUI visual regression results directly inside the Automation Dashboard, without switching products. Every test run that captures SmartUI screenshots now has a dedicated SmartUI tab for in-context triage. +description: View, group, and review SmartUI visual regression results directly inside the Automation Dashboard, without switching products. Every test run that captures SmartUI screenshots now has a dedicated SmartUI tab for in-context triage. keywords: - SmartUI - Automation Dashboard @@ -49,15 +49,13 @@ import BrandName, { BRAND_URL } from '@site/src/component/BrandName'; # SmartUI in the Automation Dashboard -**Visual regression results, right where your tests run.** - --- ## What this feature is -You can now view, group, and review your SmartUI visual regression results directly inside the Automation Dashboard, without switching products. +Users can now view, group, and review their SmartUI visual regression results directly inside the Automation Dashboard, without switching products. -Every automation test run that captures SmartUI screenshots now has a dedicated **SmartUI tab** alongside the existing All Commands, Logs, Networks, and Meta Data tabs. From that tab you can see the build's screenshots, their comparison status, group them by test, and jump straight into SmartUI for a full review when you need to. +Every automation test run that captures SmartUI screenshots now has a dedicated **SmartUI tab** alongside the existing All Commands, Logs, Networks, and Meta Data tabs. From that tab users can see the build's screenshots, their comparison status, group them by test, and jump straight into SmartUI for a full review when they need to. This works across **Web Automation** and **App Automation**. @@ -67,7 +65,7 @@ This works across **Web Automation** and **App Automation**. Until now, understanding why a visual test failed meant working across two separate places: -1. You'd see a test fail in the Automation Dashboard, then +1. Users would see a test fail in the Automation Dashboard, then 2. Open SmartUI separately, find the matching build, and triage the screenshots there. For teams running large suites, that context-switching added up to significant manual triage overhead: repetitive, slow, and disconnected from the automation run that produced the results. @@ -76,7 +74,7 @@ This feature closes that gap. The visual results live next to the test that gene --- -## What you gain +## What users gain | Before | Now | |---|---| @@ -91,7 +89,9 @@ This feature closes that gap. The visual results live next to the test that gene ### 1. SmartUI tab in the test view -Open any test in the Automation Dashboard and select the **SmartUI tab**. You'll see the associated Project and Build, a total screenshot count, and a status roll-up showing how many screenshots are new, changed, approved, or rejected. +Open any test in the Automation Dashboard and select the **SmartUI tab**. Users will see the associated Project and Build, a total screenshot count, and a status roll-up showing how many screenshots are new, changed, approved, or rejected. + +SmartUI tab in the Automation Dashboard test view showing the build summary, screenshot count, status counts, and a screenshot grid alongside the test video ### 2. Grid and List views @@ -103,13 +103,13 @@ Organize screenshots by automation suite or test name so related screenshots sta ### 4. Deep link into SmartUI -The **View in SmartUI** link on a build takes you straight to the full SmartUI experience for that build. +The **View in SmartUI** link on a build takes users straight to the full SmartUI experience for that build. --- ## How to use it -1. Open the **Automation Dashboard** and select the test you want to inspect. +1. Open the **Automation Dashboard** and select the test the user wants to inspect. 2. In the test detail view, click the **SmartUI tab** (next to Meta Data). 3. Review the build summary at the top: Project, Build, screenshot count, and status counts. 4. Choose **Grid** or **List** view using the toggle on the screenshots panel. @@ -120,27 +120,23 @@ The **View in SmartUI** link on a build takes you straight to the full SmartUI e ## Availability and access - The feature appears as a tab in the test view for any test that has associated SmartUI screenshots; tests without SmartUI data won't show SmartUI content. -- It is rolled out progressively. If you don't see the SmartUI tab and expect to, your account may not yet be enabled — contact your account team or support. +- It is rolled out progressively. If the user does not see the SmartUI tab and expects to, their account may not yet be enabled — contact the account team or support. - Requires an active SmartUI project linked to the automation run. -:::note For QA leads and technical users -Rollout is controlled by a feature flag and a SmartUI project capability on the account. Availability also depends on environment configuration being in place for your region. If a specific account needs it enabled ahead of general rollout, raise it with your account team. -::: - --- ## Tips and known behavior -- **Real Device sessions:** Screenshots are matched to your test even when a session identifier isn't present, so results display reliably for Real Device runs. -- **Mixed runs:** App Automation and Web-Automation-with-Real-Device tests each route to their correct dashboard when you follow a deep link. -- For the cleanest grouping, use consistent, descriptive test names in your automation suite — these are what the **Group by test** view uses to cluster screenshots. +- **Real Device sessions:** Screenshots are matched to the user's test even when a session identifier isn't present, so results display reliably for Real Device runs. +- **Mixed runs:** App Automation and Web-Automation-with-Real-Device tests each route to their correct dashboard when the user follows a deep link. +- For the cleanest grouping, use consistent, descriptive test names in the automation suite — these are what the **Group by test** view uses to cluster screenshots. --- ## FAQ **Do I need to change my test scripts to use this?** -No. If your automation run already captures SmartUI screenshots, they'll appear in the SmartUI tab automatically. +No. If the user's automation run already captures SmartUI screenshots, they'll appear in the SmartUI tab automatically. **Is this a replacement for the SmartUI product?** No, it's an embedded view for fast, in-context triage. For the full diff viewer, baseline management, and ignore-region tools, use **View in SmartUI** to open the complete experience. @@ -149,8 +145,8 @@ No, it's an embedded view for fast, in-context triage. For the full diff viewer, Yes. The integration supports Web Automation, App Automation, and Real Device sessions. **Why don't I see the SmartUI tab on a particular test?** -That test likely has no associated SmartUI screenshots, or the feature isn't yet enabled for your account. Check that a SmartUI project is linked to the run, and reach out to support if needed. +That test likely has no associated SmartUI screenshots, or the feature isn't yet enabled for the user's account. Check that a SmartUI project is linked to the run, and reach out to support if needed. --- -Need help getting this enabled for your account? Contact your TestMu AI account team or support. +Need help getting this enabled for an account? Contact the TestMu AI account team or support.