diff --git a/docs/modules/automation-testing/nav.adoc b/docs/modules/automation-testing/nav.adoc index 3691eda70..a5876352a 100644 --- a/docs/modules/automation-testing/nav.adoc +++ b/docs/modules/automation-testing/nav.adoc @@ -13,6 +13,7 @@ ** xref:automation-testing:scripting/add-image-injection-to-appium-script.adoc[] ** xref:automation-testing:scripting/run-applitools-eyes-script.adoc[] ** xref:automation-testing:scripting/obfuscate-private-data-in-appium-script.adoc[] +** xref:automation-testing:scripting/add-action-groups-in-appium-script.adoc[] ** xref:automation-testing:scripting/migrate-to-java-client-9_2_2.adoc[] ** xref:automation-testing:scripting/launch-work-profile-app-android.adoc[] diff --git a/docs/modules/automation-testing/pages/capabilities/add-flexcorrect.adoc b/docs/modules/automation-testing/pages/capabilities/add-flexcorrect.adoc index 70195faa4..7061fa47a 100644 --- a/docs/modules/automation-testing/pages/capabilities/add-flexcorrect.adoc +++ b/docs/modules/automation-testing/pages/capabilities/add-flexcorrect.adoc @@ -52,4 +52,4 @@ public static DesiredCapabilities getIPhone11ProIOS146DesiredCapabilities() { When you're finished, save your changes. Now `flexCorrect` will automatically select the correct elements, even when you run your script on different devices. [NOTE] -After a session, you can check xref:session-explorer:manage-sessions.adoc[how many elements were corrected]. +After a session, you can check xref:session-explorer:analytics/review-test-result-analysis.adoc#_test_result_analysis_overview[how many elements were corrected,window=read-later]. diff --git a/docs/modules/automation-testing/pages/get-a-session-id/using-the-kobiton-portal.adoc b/docs/modules/automation-testing/pages/get-a-session-id/using-the-kobiton-portal.adoc index 3e94dfec7..79c55b742 100644 --- a/docs/modules/automation-testing/pages/get-a-session-id/using-the-kobiton-portal.adoc +++ b/docs/modules/automation-testing/pages/get-a-session-id/using-the-kobiton-portal.adoc @@ -13,4 +13,4 @@ Use one or more xref:session-explorer:search-for-a-session.adoc#_search_for_a_se Once you find a session, you can copy its session ID from the *ID* column directly, or select the session ID to open the session overview and copy the session ID from there. In the session overview, you can also verify the contents of the session before you use the session ID anywhere. -image:automation-testing:session-overview-view-id-context.png[width=1000,alt="Session Overview to verify the content of the session"] +image:session-explorer:session-overview-context.png[width=1000,alt="Session Overview to verify the content of the session"] diff --git a/docs/modules/automation-testing/pages/scripting/add-action-groups-in-appium-script.adoc b/docs/modules/automation-testing/pages/scripting/add-action-groups-in-appium-script.adoc new file mode 100644 index 000000000..3f260eeb3 --- /dev/null +++ b/docs/modules/automation-testing/pages/scripting/add-action-groups-in-appium-script.adoc @@ -0,0 +1,141 @@ += Add action groups in Appium script +:navtitle: Add action groups in Appium script + +To enhance test analysis, you can group related Appium actions. Grouping actions can help in troubleshooting by marking specific phases of a test and aligning them with your testing objectives. + +== Action group Appium setting + +To add actions within your script, use the following Appium setting to assign actions to a specific group. + +[options="header"] +|======================= +|Appium setting | Description | Default value +| `kobiton:setGroup` | Set this field to any string value to assign actions to a group, using that value as the group name. | `''` (blank) +|======================= + +== Add action group + +Before starting a test action, use the `Update Settings` Appium command to set `'kobiton:setGroup'` to a string. + +.Example (JavaScript) +[source,javascript] + +await driver.updateSettings({'kobiton:setGroup': 'Test case A5423'}) + +Using the `updateSettings` command, all actions will be added to the group. To assign subsequent actions to a different group, execute the command again with the new group name. + +== Examples + +Below is a complete JavaScript example using `wd` that demonstrates how actions are organized into two distinct groups: `Test login` and `Test home page`. + +.Example (JavaScript) +[source,javascript] + +---- +import 'babel-polyfill' +import 'colors' +import wd from 'wd' +import {assert} from 'chai' + +const username = process.env.KOBITON_USERNAME +const apiKey = process.env.KOBITON_API_KEY +const deviceUdid = process.env.KOBITON_DEVICE_UDID +const protocol = 'https' +const host = 'api.kobiton.com' + +if (!username || !apiKey || !deviceUdid) { + console.log('Error: Environment variables KOBITON_USERNAME, KOBITON_API_KEY or KOBITON_DEVICE_UDID are required to execute script') + process.exit(1) +} + +const kobitonServerConfig = {protocol, host, auth: `${username}:${apiKey}`} + +const desiredCaps = { + sessionName: 'Automation test action groups', + sessionDescription: 'An automation test with action groups', + udid: deviceUdid, + noReset: true, + fullReset: false, + browserName: 'chrome', + autoWebview: 'true', +} + +let driver + +function sleep(ms) { + return new Promise((resolve) => setTimeout(resolve, ms)) +} + +describe('Android Web sample', () => { + before(async () => { + driver = wd.promiseChainRemote(kobitonServerConfig) + + driver.on('status', (info) => { + console.log(info.cyan) + }) + driver.on('command', (meth, path, data) => { + console.log(' > ' + meth.yellow, path.grey, data || '') + }) + driver.on('http', (meth, path, data) => { + console.log(' > ' + meth.magenta, path, (data || '').grey) + }) + + try { + await driver.init(desiredCaps) + } + catch (err) { + if (err.data) { + console.error(`init driver: ${err.data}`) + } + throw err + } + }) + + it('should perform a simple login', async () => { + await driver.settings() + + //Start adding actions to group 'Test login' + await driver.updateSettings({'kobiton:setGroup': 'Test login'}) + + // Send username and password to log in. + await driver.get('https://the-internet.herokuapp.com/login') + .waitForElementByName('username') + .sendKeys('tomsmith') + .sleep(1000) + .waitForElementByName('password') + .sendKeys('SuperSecretPassword!') + .sleep(3000) + .keys(wd.SPECIAL_KEYS.Enter) + + // Login completes. Start adding actions to group 'Test home page' + await driver.updateSettings({'kobiton:setGroup': 'Test home page'}) + await driver.settings() + + await driver.get('https://the-internet.herokuapp.com/') + await sleep(2000) + await driver.title() + + }) + + after(async () => { + if (driver != null) { + try { + await driver.quit() + } + catch (err) { + console.error(`quit driver: ${err}`) + } + } + }) +}) +---- + +== Grouped actions in Session Explorer + +You can review grouped actions in the xref:session-explorer:analytics/use-the-session-timeline.adoc#_action_groups_timeline[Session Explorer timeline]. + +== Limitations/Notes + +* Only supported in Xium and Appium 2 Basic automation sessions. + +* After adding action group, setting the group name to empty assigns the subsequent commands to the previous group. diff --git a/docs/modules/automation-testing/pages/scripting/auto-generate-an-appium-script.adoc b/docs/modules/automation-testing/pages/scripting/auto-generate-an-appium-script.adoc index dc35751b0..e279e76c5 100644 --- a/docs/modules/automation-testing/pages/scripting/auto-generate-an-appium-script.adoc +++ b/docs/modules/automation-testing/pages/scripting/auto-generate-an-appium-script.adoc @@ -10,9 +10,9 @@ Learn how to generate an Appium script from a manual session, so you can start b [#_export_your_script] == Export your script -After creating the baseline session, search for your session, open the session overview, and select *Automated test case*. +After creating the baseline session, search for your session, open Session Explorer, and select *Convert to Test Case*. -image:automation-testing:export-appium-script-context.png[width=1200, alt="The automated test case for the selected session."] +image:test-management:convert-test-case.png[width=1200, alt="The Convert to Test Case for the selected session."] Next, select the *Export Appium Script* icon. If you don't see an icon, check if your session xref:test-management:remediation/index.adoc[requires remediation]. @@ -44,4 +44,4 @@ This section lists all programming languages and test frameworks available for g * Java - TestNG * Java - JUnit * NodeJS - Mocha -* C# - NUnit \ No newline at end of file +* C# - NUnit diff --git a/docs/modules/devices/images/select-analyse-response-times-context.png b/docs/modules/devices/images/select-analyse-response-times-context.png deleted file mode 100644 index 95a66cd8d..000000000 Binary files a/docs/modules/devices/images/select-analyse-response-times-context.png and /dev/null differ diff --git a/docs/modules/devices/images/select-analyze-response-time-context.png b/docs/modules/devices/images/select-analyze-response-time-context.png new file mode 100644 index 000000000..a6854e6d6 Binary files /dev/null and b/docs/modules/devices/images/select-analyze-response-time-context.png differ diff --git a/docs/modules/devices/images/select-sessions-closeup.png b/docs/modules/devices/images/select-sessions-closeup.png index 7aa26c3ff..782d32eeb 100644 Binary files a/docs/modules/devices/images/select-sessions-closeup.png and b/docs/modules/devices/images/select-sessions-closeup.png differ diff --git a/docs/modules/devices/partials/network-payload-capture/launch-session-explorer.adoc b/docs/modules/devices/partials/network-payload-capture/launch-session-explorer.adoc index fe5536cbe..e62ba5ee3 100644 --- a/docs/modules/devices/partials/network-payload-capture/launch-session-explorer.adoc +++ b/docs/modules/devices/partials/network-payload-capture/launch-session-explorer.adoc @@ -1,20 +1,17 @@ -After your session, select *Sessions*. +In Kobiton, select *Sessions*. -image:select-sessions-closeup.png[width=1000,alt="Select Sessions tab"] +image:session-explorer:select-sessions-closeup.png[width=150,alt="Select Sessions tab"] -Search for your session, then select the *Session ID*. +xref:session-explorer:search-for-a-session.adoc[Find a session], then select the session in the search result. -[NOTE] -Learn more about xref:session-explorer:search-for-a-session.adoc[searching for a session]. +image:session-explorer:search-session-id-closeup.png[width=1000,alt="Search for a session ID"] -image:search-your-session-id-closeup.png[width=1000,alt="Search for your session ID"] +Once you select your session, Session Explorer appears. -Select *Explorer*. +image:session-explorer:select-explorer-context.png[width=1000,alt="Select Explorer tab"] -image:select-explorer-context.png[width=1000,alt="Select Explorer tab"] +From the dropdown, choose *Response Time Analysis*. -Select the dropdown and choose *Observer Request / Response Payloads* or *Analyze Response Times*. - -image:select-analyse-response-times-context.png[width=1000,alt="Select Observe Request/ Response Payloads or Analyze Response Times"] +image:devices:select-analyze-response-time-context.png[width=1000,alt="Select Response Time Analysis"] Now you can xref:session-explorer:analytics/review-network-payload-data.adoc[review network payload data] in Session Explorer. diff --git a/docs/modules/integrations/images/jira-create-ticket-button.png b/docs/modules/integrations/images/jira-create-ticket-button.png index cb9179995..8d29c7743 100644 Binary files a/docs/modules/integrations/images/jira-create-ticket-button.png and b/docs/modules/integrations/images/jira-create-ticket-button.png differ diff --git a/docs/modules/integrations/images/jira-create-ticket-context.png b/docs/modules/integrations/images/jira-create-ticket-context.png index 3c4c677fa..6d5a562b8 100644 Binary files a/docs/modules/integrations/images/jira-create-ticket-context.png and b/docs/modules/integrations/images/jira-create-ticket-context.png differ diff --git a/docs/modules/integrations/images/jira-create-ticket-integration.png b/docs/modules/integrations/images/jira-create-ticket-integration.png index 6d37b0240..5d9f0fac0 100644 Binary files a/docs/modules/integrations/images/jira-create-ticket-integration.png and b/docs/modules/integrations/images/jira-create-ticket-integration.png differ diff --git a/docs/modules/integrations/pages/jira/create-a-jira-ticket.adoc b/docs/modules/integrations/pages/jira/create-a-jira-ticket.adoc index 979afc623..b871dfdd1 100644 --- a/docs/modules/integrations/pages/jira/create-a-jira-ticket.adoc +++ b/docs/modules/integrations/pages/jira/create-a-jira-ticket.adoc @@ -15,9 +15,7 @@ image:session-explorer:search-bar-session-criteria-context.png[width=1000,alt="S Select a session. -image:session-explorer:session-search-context.png[width=1000,alt="A context of Session page in Kobiton portal"] - -If you have not logged into Jira, select **Jira Integration** from **Session Overview** or **Session Explorer**. +If you have not logged into Jira, select **Jira Integration** from **Session Explorer**. image:jira-create-ticket-integration.png[width=500,alt="The Jira Integration button in Session Overview"] @@ -27,7 +25,7 @@ After logging in, select **Jira ticket**, then **Create** in **Session Overview* image:integrations:jira-create-ticket-button.png[width="500",alt="Select Jira ticket and then Create in Session Overview"] -Fill out the *Project*, *Issue Type*, and *Title*. A link to the session and other session details are prepopulated in the Description. +Fill out the *Project*, *Issue Type*, and *Title*. A link to the session and other session details are prepopulated in the *Description*. image:integrations:jira-create-ticket-context.png[width="500",alt="Fill out required fields in the create ticket screen then select Create"] diff --git a/docs/modules/scriptless-automation/pages/run-scriptless-with-the-kobiton-portal.adoc b/docs/modules/scriptless-automation/pages/run-scriptless-with-the-kobiton-portal.adoc index 03295ade3..1c4992e03 100644 --- a/docs/modules/scriptless-automation/pages/run-scriptless-with-the-kobiton-portal.adoc +++ b/docs/modules/scriptless-automation/pages/run-scriptless-with-the-kobiton-portal.adoc @@ -19,9 +19,9 @@ image:session-explorer:search-session-id-closeup.png[width=1000,alt="Session sea [NOTE] For more information, see xref:session-explorer:session-metadata.adoc[]. -Select *Automated Test Case*. +Select *Convert to Test Case*. If you've already created a test case for the session, select *View Test Case*. -image:scriptless-automation:scriptless-automated-test-case-button.png[width=1000,alt="The session overview page with the Automated Test Case button"] +image:test-management:convert-test-case.png[width=1000,alt="The Session Explorer page with the Convert to Test Case button"] Select *Rerun*. diff --git a/docs/modules/scriptless-automation/pages/scriptless-requirements.adoc b/docs/modules/scriptless-automation/pages/scriptless-requirements.adoc index 2c7e2cd59..3bfe34cdb 100644 --- a/docs/modules/scriptless-automation/pages/scriptless-requirements.adoc +++ b/docs/modules/scriptless-automation/pages/scriptless-requirements.adoc @@ -7,7 +7,7 @@ Learn about the requirements to convert a manual or automation session into Auto // tag::supported-actions[] -Only certain actions are supported for scriptless baseline sessions. Refer to the following table while running your tests: +Only certain actions are supported for Scriptless baseline sessions. Refer to the following table while running your tests: [cols="1,1,1,1"] |=== @@ -75,7 +75,7 @@ _Only English is supported, excluding the emoji keyboard._ | | -|Pin to zoom +|Pinch to zoom | | | @@ -123,4 +123,4 @@ The following requirements pertain to the application(s) installed and/or opened * Must not contain CAPTCHA verification flow. -* Must enable `.setWebContentDebuggingEnable` for Android apps. If this configuration is disabled, Kobiton cannot access the HTML source of the application. Visit https://developer.chrome.com/docs/devtools/remote-debugging/webviews/#configure_webviews_for_debugging[this link] for more information. \ No newline at end of file +* Must enable `.setWebContentDebuggingEnable` for Android apps. If this configuration is disabled, Kobiton cannot access the HTML source of the application. Visit https://developer.chrome.com/docs/devtools/remote-debugging/webviews/#configure_webviews_for_debugging[this link] for more information. diff --git a/docs/modules/session-explorer/images/appium-inspector-context.png b/docs/modules/session-explorer/images/appium-inspector-context.png index e5fe1507e..d8722d32e 100644 Binary files a/docs/modules/session-explorer/images/appium-inspector-context.png and b/docs/modules/session-explorer/images/appium-inspector-context.png differ diff --git a/docs/modules/session-explorer/images/appium-inspector-select-element.png b/docs/modules/session-explorer/images/appium-inspector-select-element.png index d83687439..3478c1ae4 100644 Binary files a/docs/modules/session-explorer/images/appium-inspector-select-element.png and b/docs/modules/session-explorer/images/appium-inspector-select-element.png differ diff --git a/docs/modules/session-explorer/images/attributes-context.png b/docs/modules/session-explorer/images/attributes-context.png index e2eef34c9..efa5735d8 100644 Binary files a/docs/modules/session-explorer/images/attributes-context.png and b/docs/modules/session-explorer/images/attributes-context.png differ diff --git a/docs/modules/session-explorer/images/battery-closeup.png b/docs/modules/session-explorer/images/battery-closeup.png index 2e093566a..aa1aaf8f8 100644 Binary files a/docs/modules/session-explorer/images/battery-closeup.png and b/docs/modules/session-explorer/images/battery-closeup.png differ diff --git a/docs/modules/session-explorer/images/capture-payload-indicator.png b/docs/modules/session-explorer/images/capture-payload-indicator.png index 960010fad..24f16acc7 100644 Binary files a/docs/modules/session-explorer/images/capture-payload-indicator.png and b/docs/modules/session-explorer/images/capture-payload-indicator.png differ diff --git a/docs/modules/session-explorer/images/color-contrast-context.png b/docs/modules/session-explorer/images/color-contrast-context.png index 7430e5c91..a5ca8a897 100644 Binary files a/docs/modules/session-explorer/images/color-contrast-context.png and b/docs/modules/session-explorer/images/color-contrast-context.png differ diff --git a/docs/modules/session-explorer/images/content-labeling-context.png b/docs/modules/session-explorer/images/content-labeling-context.png index 5974b8e29..0bb18f12a 100644 Binary files a/docs/modules/session-explorer/images/content-labeling-context.png and b/docs/modules/session-explorer/images/content-labeling-context.png differ diff --git a/docs/modules/session-explorer/images/copy-crash-log-context.png b/docs/modules/session-explorer/images/copy-crash-log-context.png index b45936389..50796fb2e 100644 Binary files a/docs/modules/session-explorer/images/copy-crash-log-context.png and b/docs/modules/session-explorer/images/copy-crash-log-context.png differ diff --git a/docs/modules/session-explorer/images/copy-link-closeup.png b/docs/modules/session-explorer/images/copy-link-closeup.png index 42172b792..0d0f89124 100644 Binary files a/docs/modules/session-explorer/images/copy-link-closeup.png and b/docs/modules/session-explorer/images/copy-link-closeup.png differ diff --git a/docs/modules/session-explorer/images/cpu-closeup.png b/docs/modules/session-explorer/images/cpu-closeup.png index 072d23874..a60060d9b 100644 Binary files a/docs/modules/session-explorer/images/cpu-closeup.png and b/docs/modules/session-explorer/images/cpu-closeup.png differ diff --git a/docs/modules/session-explorer/images/date-range-context.png b/docs/modules/session-explorer/images/date-range-context.png index 615719537..11cd434dc 100644 Binary files a/docs/modules/session-explorer/images/date-range-context.png and b/docs/modules/session-explorer/images/date-range-context.png differ diff --git a/docs/modules/session-explorer/images/device-info-closeup.png b/docs/modules/session-explorer/images/device-info-closeup.png deleted file mode 100644 index 3711c0ef4..000000000 Binary files a/docs/modules/session-explorer/images/device-info-closeup.png and /dev/null differ diff --git a/docs/modules/session-explorer/images/download-inventory-context.png b/docs/modules/session-explorer/images/download-inventory-context.png index fb5c68978..fb46d5f97 100644 Binary files a/docs/modules/session-explorer/images/download-inventory-context.png and b/docs/modules/session-explorer/images/download-inventory-context.png differ diff --git a/docs/modules/session-explorer/images/download-screenshot-closeup.png b/docs/modules/session-explorer/images/download-screenshot-closeup.png index a971a0f6f..b0678f8b3 100644 Binary files a/docs/modules/session-explorer/images/download-screenshot-closeup.png and b/docs/modules/session-explorer/images/download-screenshot-closeup.png differ diff --git a/docs/modules/session-explorer/images/edit-session-description-context.png b/docs/modules/session-explorer/images/edit-session-description-context.png index 69f1b24d5..7ad4f2c5c 100644 Binary files a/docs/modules/session-explorer/images/edit-session-description-context.png and b/docs/modules/session-explorer/images/edit-session-description-context.png differ diff --git a/docs/modules/session-explorer/images/edit-session-name-context.png b/docs/modules/session-explorer/images/edit-session-name-context.png deleted file mode 100644 index 3c86f2e53..000000000 Binary files a/docs/modules/session-explorer/images/edit-session-name-context.png and /dev/null differ diff --git a/docs/modules/session-explorer/images/expand-dropdown-to-see-details.png b/docs/modules/session-explorer/images/expand-dropdown-to-see-details.png index c15704467..a490abdf6 100644 Binary files a/docs/modules/session-explorer/images/expand-dropdown-to-see-details.png and b/docs/modules/session-explorer/images/expand-dropdown-to-see-details.png differ diff --git a/docs/modules/session-explorer/images/hover-attribute-closeup.png b/docs/modules/session-explorer/images/hover-attribute-closeup.png index 1b0f4cf0f..314f31747 100644 Binary files a/docs/modules/session-explorer/images/hover-attribute-closeup.png and b/docs/modules/session-explorer/images/hover-attribute-closeup.png differ diff --git a/docs/modules/session-explorer/images/inspect-elements-context.png b/docs/modules/session-explorer/images/inspect-elements-context.png index da3550dd5..573cdf6b0 100644 Binary files a/docs/modules/session-explorer/images/inspect-elements-context.png and b/docs/modules/session-explorer/images/inspect-elements-context.png differ diff --git a/docs/modules/session-explorer/images/issue description-context.png b/docs/modules/session-explorer/images/issue description-context.png deleted file mode 100644 index 269bcd26f..000000000 Binary files a/docs/modules/session-explorer/images/issue description-context.png and /dev/null differ diff --git a/docs/modules/session-explorer/images/issue-arrows.png b/docs/modules/session-explorer/images/issue-arrows.png new file mode 100644 index 000000000..f20eebc3c Binary files /dev/null and b/docs/modules/session-explorer/images/issue-arrows.png differ diff --git a/docs/modules/session-explorer/images/issue-marker-context.png b/docs/modules/session-explorer/images/issue-marker-context.png deleted file mode 100644 index 36dbbb72a..000000000 Binary files a/docs/modules/session-explorer/images/issue-marker-context.png and /dev/null differ diff --git a/docs/modules/session-explorer/images/jump-to-step-npc-closeup.png b/docs/modules/session-explorer/images/jump-to-step-npc-closeup.png index b60d5f2c7..0167a41b6 100644 Binary files a/docs/modules/session-explorer/images/jump-to-step-npc-closeup.png and b/docs/modules/session-explorer/images/jump-to-step-npc-closeup.png differ diff --git a/docs/modules/session-explorer/images/launch-device-logs.png b/docs/modules/session-explorer/images/launch-device-logs.png new file mode 100644 index 000000000..a17f2059d Binary files /dev/null and b/docs/modules/session-explorer/images/launch-device-logs.png differ diff --git a/docs/modules/session-explorer/images/launch-session-explorer-context.png b/docs/modules/session-explorer/images/launch-session-explorer-context.png deleted file mode 100644 index 2f0c6f234..000000000 Binary files a/docs/modules/session-explorer/images/launch-session-explorer-context.png and /dev/null differ diff --git a/docs/modules/session-explorer/images/logs-closeup.png b/docs/modules/session-explorer/images/logs-closeup.png index 250bb50d2..eecf64c53 100644 Binary files a/docs/modules/session-explorer/images/logs-closeup.png and b/docs/modules/session-explorer/images/logs-closeup.png differ diff --git a/docs/modules/session-explorer/images/logs-last-mile-speed.png b/docs/modules/session-explorer/images/logs-last-mile-speed.png index 81dae48ee..60e53c434 100644 Binary files a/docs/modules/session-explorer/images/logs-last-mile-speed.png and b/docs/modules/session-explorer/images/logs-last-mile-speed.png differ diff --git a/docs/modules/session-explorer/images/memory-closeup.png b/docs/modules/session-explorer/images/memory-closeup.png index b52e28dc2..0f13df246 100644 Binary files a/docs/modules/session-explorer/images/memory-closeup.png and b/docs/modules/session-explorer/images/memory-closeup.png differ diff --git a/docs/modules/session-explorer/images/move-screen-closeup.png b/docs/modules/session-explorer/images/move-screen-closeup.png deleted file mode 100644 index c51a02a65..000000000 Binary files a/docs/modules/session-explorer/images/move-screen-closeup.png and /dev/null differ diff --git a/docs/modules/session-explorer/images/move-through-issues-closeup.png b/docs/modules/session-explorer/images/move-through-issues-closeup.png deleted file mode 100644 index e526c97ff..000000000 Binary files a/docs/modules/session-explorer/images/move-through-issues-closeup.png and /dev/null differ diff --git a/docs/modules/session-explorer/images/network-closeup.png b/docs/modules/session-explorer/images/network-closeup.png index 64d69e690..d6ab515d9 100644 Binary files a/docs/modules/session-explorer/images/network-closeup.png and b/docs/modules/session-explorer/images/network-closeup.png differ diff --git a/docs/modules/session-explorer/images/observe-request.png b/docs/modules/session-explorer/images/observe-request.png index b21a73850..cf53b004f 100644 Binary files a/docs/modules/session-explorer/images/observe-request.png and b/docs/modules/session-explorer/images/observe-request.png differ diff --git a/docs/modules/session-explorer/images/play_pause-closeup.png b/docs/modules/session-explorer/images/play_pause-closeup.png deleted file mode 100644 index 3e183158e..000000000 Binary files a/docs/modules/session-explorer/images/play_pause-closeup.png and /dev/null differ diff --git a/docs/modules/session-explorer/images/previous-next-closeup.png b/docs/modules/session-explorer/images/previous-next-closeup.png index 8b37590aa..17ed201f7 100644 Binary files a/docs/modules/session-explorer/images/previous-next-closeup.png and b/docs/modules/session-explorer/images/previous-next-closeup.png differ diff --git a/docs/modules/session-explorer/images/previous-next.png b/docs/modules/session-explorer/images/previous-next.png deleted file mode 100644 index 8b37590aa..000000000 Binary files a/docs/modules/session-explorer/images/previous-next.png and /dev/null differ diff --git a/docs/modules/session-explorer/images/recording-closeup.png b/docs/modules/session-explorer/images/recording-closeup.png deleted file mode 100644 index 8377065ba..000000000 Binary files a/docs/modules/session-explorer/images/recording-closeup.png and /dev/null differ diff --git a/docs/modules/session-explorer/images/red-dot-context.png b/docs/modules/session-explorer/images/red-dot-context.png deleted file mode 100644 index 503b9cc17..000000000 Binary files a/docs/modules/session-explorer/images/red-dot-context.png and /dev/null differ diff --git a/docs/modules/session-explorer/images/refresh-inventory-closeup.png b/docs/modules/session-explorer/images/refresh-inventory-closeup.png index e973eb66b..4106c242a 100644 Binary files a/docs/modules/session-explorer/images/refresh-inventory-closeup.png and b/docs/modules/session-explorer/images/refresh-inventory-closeup.png differ diff --git a/docs/modules/session-explorer/images/review-device-log-copied-context.png b/docs/modules/session-explorer/images/review-device-log-copied-context.png index e4df9547b..ac62ec2de 100644 Binary files a/docs/modules/session-explorer/images/review-device-log-copied-context.png and b/docs/modules/session-explorer/images/review-device-log-copied-context.png differ diff --git a/docs/modules/session-explorer/images/review-device-logs-filter-closeup.png b/docs/modules/session-explorer/images/review-device-logs-filter-closeup.png index b50f8f1b0..0c99149cd 100644 Binary files a/docs/modules/session-explorer/images/review-device-logs-filter-closeup.png and b/docs/modules/session-explorer/images/review-device-logs-filter-closeup.png differ diff --git a/docs/modules/session-explorer/images/review-device-logs-search-closeup.png b/docs/modules/session-explorer/images/review-device-logs-search-closeup.png index 3434d4876..1dc82659e 100644 Binary files a/docs/modules/session-explorer/images/review-device-logs-search-closeup.png and b/docs/modules/session-explorer/images/review-device-logs-search-closeup.png differ diff --git a/docs/modules/session-explorer/images/review-system-metrics-context.png b/docs/modules/session-explorer/images/review-system-metrics-context.png index f572e5e9d..b399a721e 100644 Binary files a/docs/modules/session-explorer/images/review-system-metrics-context.png and b/docs/modules/session-explorer/images/review-system-metrics-context.png differ diff --git a/docs/modules/session-explorer/images/search-bar-closeup.png b/docs/modules/session-explorer/images/search-bar-closeup.png index f422c0463..fd2b25c96 100644 Binary files a/docs/modules/session-explorer/images/search-bar-closeup.png and b/docs/modules/session-explorer/images/search-bar-closeup.png differ diff --git a/docs/modules/session-explorer/images/search-session-id-closeup.png b/docs/modules/session-explorer/images/search-session-id-closeup.png index 7ae73b76d..2a051d82f 100644 Binary files a/docs/modules/session-explorer/images/search-session-id-closeup.png and b/docs/modules/session-explorer/images/search-session-id-closeup.png differ diff --git a/docs/modules/session-explorer/images/see-package-name-size-npc-context.png b/docs/modules/session-explorer/images/see-package-name-size-npc-context.png index 617d76df0..97e486e4d 100644 Binary files a/docs/modules/session-explorer/images/see-package-name-size-npc-context.png and b/docs/modules/session-explorer/images/see-package-name-size-npc-context.png differ diff --git a/docs/modules/session-explorer/images/select-a-session-context.png b/docs/modules/session-explorer/images/select-a-session-context.png index de9e1e57d..1eebbde2a 100644 Binary files a/docs/modules/session-explorer/images/select-a-session-context.png and b/docs/modules/session-explorer/images/select-a-session-context.png differ diff --git a/docs/modules/session-explorer/images/select-analyze-response-time-context.png b/docs/modules/session-explorer/images/select-analyze-response-time-context.png index aea419b75..a6854e6d6 100644 Binary files a/docs/modules/session-explorer/images/select-analyze-response-time-context.png and b/docs/modules/session-explorer/images/select-analyze-response-time-context.png differ diff --git a/docs/modules/session-explorer/images/select-explorer-context.png b/docs/modules/session-explorer/images/select-explorer-context.png index 9730c6770..421a3c7a7 100644 Binary files a/docs/modules/session-explorer/images/select-explorer-context.png and b/docs/modules/session-explorer/images/select-explorer-context.png differ diff --git a/docs/modules/session-explorer/images/select-red-dots-context.png b/docs/modules/session-explorer/images/select-red-dots-context.png index 5e738ad2c..887ab2cb4 100644 Binary files a/docs/modules/session-explorer/images/select-red-dots-context.png and b/docs/modules/session-explorer/images/select-red-dots-context.png differ diff --git a/docs/modules/session-explorer/images/select-session-context.png b/docs/modules/session-explorer/images/select-session-context.png deleted file mode 100644 index ca3a2ae67..000000000 Binary files a/docs/modules/session-explorer/images/select-session-context.png and /dev/null differ diff --git a/docs/modules/session-explorer/images/select-session-id-context.png b/docs/modules/session-explorer/images/select-session-id-context.png deleted file mode 100644 index 1c07b024a..000000000 Binary files a/docs/modules/session-explorer/images/select-session-id-context.png and /dev/null differ diff --git a/docs/modules/session-explorer/images/select-sessions-closeup.png b/docs/modules/session-explorer/images/select-sessions-closeup.png index 8586692f9..782d32eeb 100644 Binary files a/docs/modules/session-explorer/images/select-sessions-closeup.png and b/docs/modules/session-explorer/images/select-sessions-closeup.png differ diff --git a/docs/modules/session-explorer/images/select-sessions-context.png b/docs/modules/session-explorer/images/select-sessions-context.png deleted file mode 100644 index 1ea47a1c0..000000000 Binary files a/docs/modules/session-explorer/images/select-sessions-context.png and /dev/null differ diff --git a/docs/modules/session-explorer/images/session-explorer-accessibility-validation.png b/docs/modules/session-explorer/images/session-explorer-accessibility-validation.png index d9a3f9b8f..2c64d2de6 100644 Binary files a/docs/modules/session-explorer/images/session-explorer-accessibility-validation.png and b/docs/modules/session-explorer/images/session-explorer-accessibility-validation.png differ diff --git a/docs/modules/session-explorer/images/session-explorer-automated-test-case-context.png b/docs/modules/session-explorer/images/session-explorer-automated-test-case-context.png deleted file mode 100644 index 19d62a09b..000000000 Binary files a/docs/modules/session-explorer/images/session-explorer-automated-test-case-context.png and /dev/null differ diff --git a/docs/modules/session-explorer/images/session-explorer-timeline-group-actions.png b/docs/modules/session-explorer/images/session-explorer-timeline-group-actions.png new file mode 100644 index 000000000..ea888aa59 Binary files /dev/null and b/docs/modules/session-explorer/images/session-explorer-timeline-group-actions.png differ diff --git a/docs/modules/session-explorer/images/session-info-closeup.png b/docs/modules/session-explorer/images/session-info-closeup.png deleted file mode 100644 index ad271621c..000000000 Binary files a/docs/modules/session-explorer/images/session-info-closeup.png and /dev/null differ diff --git a/docs/modules/session-explorer/images/session-overview-context copy.png b/docs/modules/session-explorer/images/session-overview-context copy.png deleted file mode 100644 index b9971c8ee..000000000 Binary files a/docs/modules/session-explorer/images/session-overview-context copy.png and /dev/null differ diff --git a/docs/modules/session-explorer/images/session-overview-context.png b/docs/modules/session-explorer/images/session-overview-context.png index 98953c82c..b624d8540 100644 Binary files a/docs/modules/session-explorer/images/session-overview-context.png and b/docs/modules/session-explorer/images/session-overview-context.png differ diff --git a/docs/modules/session-explorer/images/session-overview-execution-history.png b/docs/modules/session-explorer/images/session-overview-execution-history.png new file mode 100644 index 000000000..35525b09a Binary files /dev/null and b/docs/modules/session-explorer/images/session-overview-execution-history.png differ diff --git a/docs/modules/session-explorer/images/session-overview-test-result-analysis.png b/docs/modules/session-explorer/images/session-overview-test-result-analysis.png new file mode 100644 index 000000000..fb4d0bc51 Binary files /dev/null and b/docs/modules/session-explorer/images/session-overview-test-result-analysis.png differ diff --git a/docs/modules/session-explorer/images/session-overview.png b/docs/modules/session-explorer/images/session-overview.png deleted file mode 100644 index 2fdd338b3..000000000 Binary files a/docs/modules/session-explorer/images/session-overview.png and /dev/null differ diff --git a/docs/modules/session-explorer/images/session-search-context.png b/docs/modules/session-explorer/images/session-search-context.png index 6ab2160a4..8f5acd6a9 100644 Binary files a/docs/modules/session-explorer/images/session-search-context.png and b/docs/modules/session-explorer/images/session-search-context.png differ diff --git a/docs/modules/session-explorer/images/session-tags-context.png b/docs/modules/session-explorer/images/session-tags-context.png index bdb685ab1..b4c61e14f 100644 Binary files a/docs/modules/session-explorer/images/session-tags-context.png and b/docs/modules/session-explorer/images/session-tags-context.png differ diff --git a/docs/modules/session-explorer/images/system-metrics-temperature.png b/docs/modules/session-explorer/images/system-metrics-temperature.png new file mode 100644 index 000000000..cd6e6c218 Binary files /dev/null and b/docs/modules/session-explorer/images/system-metrics-temperature.png differ diff --git a/docs/modules/session-explorer/images/test-steps-closeup.png b/docs/modules/session-explorer/images/test-steps-closeup.png deleted file mode 100644 index 99e20e145..000000000 Binary files a/docs/modules/session-explorer/images/test-steps-closeup.png and /dev/null differ diff --git a/docs/modules/session-explorer/images/timeline-context.png b/docs/modules/session-explorer/images/timeline-context.png deleted file mode 100644 index 7a1422462..000000000 Binary files a/docs/modules/session-explorer/images/timeline-context.png and /dev/null differ diff --git a/docs/modules/session-explorer/images/touch-target-size-context.png b/docs/modules/session-explorer/images/touch-target-size-context.png index 10c2188c0..40617262c 100644 Binary files a/docs/modules/session-explorer/images/touch-target-size-context.png and b/docs/modules/session-explorer/images/touch-target-size-context.png differ diff --git a/docs/modules/session-explorer/images/view-crash-logs-context.png b/docs/modules/session-explorer/images/view-crash-logs-context.png index baec6d9e2..679abbb00 100644 Binary files a/docs/modules/session-explorer/images/view-crash-logs-context.png and b/docs/modules/session-explorer/images/view-crash-logs-context.png differ diff --git a/docs/modules/session-explorer/images/view-details-accessbility-validation-context.png b/docs/modules/session-explorer/images/view-details-accessbility-validation-context.png index fb5c1cdd8..457c186bb 100644 Binary files a/docs/modules/session-explorer/images/view-details-accessbility-validation-context.png and b/docs/modules/session-explorer/images/view-details-accessbility-validation-context.png differ diff --git a/docs/modules/session-explorer/images/view-test-step-context.png b/docs/modules/session-explorer/images/view-test-step-context.png index 297e74261..2844c319a 100644 Binary files a/docs/modules/session-explorer/images/view-test-step-context.png and b/docs/modules/session-explorer/images/view-test-step-context.png differ diff --git a/docs/modules/session-explorer/images/webview-closeup.png b/docs/modules/session-explorer/images/webview-closeup.png deleted file mode 100644 index 5a8cb13c7..000000000 Binary files a/docs/modules/session-explorer/images/webview-closeup.png and /dev/null differ diff --git a/docs/modules/session-explorer/images/yellow-dot-context.png b/docs/modules/session-explorer/images/yellow-dot-context.png deleted file mode 100644 index fd9e51d89..000000000 Binary files a/docs/modules/session-explorer/images/yellow-dot-context.png and /dev/null differ diff --git a/docs/modules/session-explorer/images/yellow-dots-on-timeline-context.png b/docs/modules/session-explorer/images/yellow-dots-on-timeline-context.png deleted file mode 100644 index 5419a7c58..000000000 Binary files a/docs/modules/session-explorer/images/yellow-dots-on-timeline-context.png and /dev/null differ diff --git a/docs/modules/session-explorer/images/zoom.png b/docs/modules/session-explorer/images/zoom.png index 44ea0ebaa..f1af660b3 100644 Binary files a/docs/modules/session-explorer/images/zoom.png and b/docs/modules/session-explorer/images/zoom.png differ diff --git a/docs/modules/session-explorer/nav.adoc b/docs/modules/session-explorer/nav.adoc index a18b4bb9f..6ecb06927 100644 --- a/docs/modules/session-explorer/nav.adoc +++ b/docs/modules/session-explorer/nav.adoc @@ -4,6 +4,7 @@ * xref:session-explorer:manage-sessions.adoc[] * xref:analytics/index.adoc[] +** xref:session-explorer:analytics/review-test-result-analysis.adoc[] ** xref:session-explorer:analytics/use-the-session-timeline.adoc[] ** xref:session-explorer:analytics/reinspect-appium-elements.adoc[] ** xref:session-explorer:analytics/review-network-payload-data.adoc[] diff --git a/docs/modules/session-explorer/pages/analytics/index.adoc b/docs/modules/session-explorer/pages/analytics/index.adoc index 553c93436..601ac6f21 100644 --- a/docs/modules/session-explorer/pages/analytics/index.adoc +++ b/docs/modules/session-explorer/pages/analytics/index.adoc @@ -1,13 +1,18 @@ = Session Explorer analytics :navtitle: Analytics -You can use Session Explorer to reinspect Appium elements, review network payload data, use the session timeline, and more. +Kobiton's Session Explorer provides powerful insights into your mobile testing sessions. You can use Session Explorer to +inspect Appium elements, review network payload data, analyze detailed device logs, and +more. With a session timeline and video replays for step-by-step troubleshooting, it enables faster issue +identification and efficient app performance optimization. + == In this section +* xref:session-explorer:analytics/review-test-result-analysis.adoc[] * xref:session-explorer:analytics/use-the-session-timeline.adoc[] * xref:session-explorer:analytics/reinspect-appium-elements.adoc[] * xref:session-explorer:analytics/review-network-payload-data.adoc[] * xref:session-explorer:analytics/review-system-metrics.adoc[] * xref:session-explorer:analytics/review-crash-logs.adoc[] -* xref:session-explorer:analytics/review-device-logs.adoc[] +* xref:session-explorer:analytics/review-device-logs.adoc[] \ No newline at end of file diff --git a/docs/modules/session-explorer/pages/analytics/reinspect-appium-elements.adoc b/docs/modules/session-explorer/pages/analytics/reinspect-appium-elements.adoc index 214694bda..88b4d31dc 100644 --- a/docs/modules/session-explorer/pages/analytics/reinspect-appium-elements.adoc +++ b/docs/modules/session-explorer/pages/analytics/reinspect-appium-elements.adoc @@ -26,8 +26,6 @@ image:session-explorer:refresh-inventory-closeup.png[width=500,alt="A closeup to By default, WebView is set to `NATIVE_APP`. To filter the XML hierarchy by a different WebView, select the dropdown and choose a different option. -image:session-explorer:webview-closeup.png[width=500,alt="A closeup to webview with default is NATIVE_APP"] - To filter the XML hierarchy by a label, xPath, or xPath attribute, enter your string into the search bar. image:session-explorer:search-bar-closeup.png[width=500,alt="A closeup to search bar in the Appium Inspector"] @@ -54,6 +52,6 @@ image:session-explorer:hover-attribute-closeup.png[width=500,alt="Hover over a s === Download all XML data -To download the current XML hierarchy as an `.xml` file, select the *Download Inventory* icon. +To download the current XML hierarchy as an `.xml` file, select the *Download inventory* icon. image:session-explorer:download-inventory-context.png[width=1000,alt="A context to Download inventory of Appium Inspector"] diff --git a/docs/modules/session-explorer/pages/analytics/review-crash-logs.adoc b/docs/modules/session-explorer/pages/analytics/review-crash-logs.adoc index 596d9998f..7b447f12e 100644 --- a/docs/modules/session-explorer/pages/analytics/review-crash-logs.adoc +++ b/docs/modules/session-explorer/pages/analytics/review-crash-logs.adoc @@ -7,15 +7,20 @@ Learn how to review crash logs after your test session so you can troubleshoot c include::session-explorer:partial$launch-session-explorer.adoc[] +[#_review_the_crash_logs] == Review the crash logs -To review crash logs, select *View Crash Logs*. +To review crash logs: + +1. Select the *Crash* validation in the *Test Results Analysis*. +2. Select a *red marker* from the timeline. +3. Choose *View Details*. image:session-explorer:view-crash-logs-context.png[width=1000,alt="Users can view crash logs from Session Explorer"] -To copy the logs to your clipboard, select the *Copy* icon. +To download the logs, select the *Download* icon. -image:session-explorer:copy-crash-log-context.png[width=1000,alt="Crash log to be copied"] +image:session-explorer:copy-crash-log-context.png[width=1000,alt="Download the crash log"] [NOTE] You can also xref:session-explorer:manage-sessions.adoc#_download_session_logs[download device or crash logs] from the session overview. diff --git a/docs/modules/session-explorer/pages/analytics/review-device-logs.adoc b/docs/modules/session-explorer/pages/analytics/review-device-logs.adoc index 0e17913f3..b584b8771 100644 --- a/docs/modules/session-explorer/pages/analytics/review-device-logs.adoc +++ b/docs/modules/session-explorer/pages/analytics/review-device-logs.adoc @@ -7,21 +7,21 @@ Learn how to review device logs after your test session so you can search for sp include::session-explorer:partial$launch-session-explorer.adoc[] -Select *Review Device Logs*. +Select *Device Logs*. -image:session-explorer:launch-session-explorer-context.png[width=1000,alt="A context to Session Explorer launched"] +image:session-explorer:launch-device-logs.png[width=1000,alt="Device Logs selected in Session Explorer"] == Review the device logs === Filter the device logs -By default, the log filter is set to *All*. To filter the logs by a message type, select the dropdown and choose *Notice*, *Info*, *Warning*, or *Error*. +By default, the log filter is set to *All*. To filter the logs by a message type, select the dropdown and choose *Debug*, *Info*, *Verbal*, *Warning*, or *Error*. -image:session-explorer:review-device-logs-filter-closeup.png[width=500,alt="A closeup to the filter of Review Device Log feature"] +image:session-explorer:review-device-logs-filter-closeup.png[width=250,alt="A closeup to the filter of Review Device Log feature"] To filter the logs by a specific message, enter your string into the search bar. -image:session-explorer:review-device-logs-search-closeup.png[width=500,alt="A closeup to the filter of Review Device Log feature"] +image:session-explorer:review-device-logs-search-closeup.png[width=1000,alt="A closeup to the filter of Review Device Log feature"] === Copy device logs diff --git a/docs/modules/session-explorer/pages/analytics/review-network-payload-data.adoc b/docs/modules/session-explorer/pages/analytics/review-network-payload-data.adoc index ac19a8baf..5e09bf71b 100644 --- a/docs/modules/session-explorer/pages/analytics/review-network-payload-data.adoc +++ b/docs/modules/session-explorer/pages/analytics/review-network-payload-data.adoc @@ -5,7 +5,7 @@ Learn how to review network payload capture data after your test session so you == Before you start -You'll need to complete a xref:manual-testing:local-devices/capture-network-payload-data.adoc[manual session] _or_ an xref:automation-testing:local-devices/capture-network-payload-data.adoc[automation session] with network payload capture enabled. +You'll need to complete a xref:manual-testing:local-devices/capture-network-payload-data.adoc[manual session,window=read-later] _or_ an xref:automation-testing:local-devices/capture-network-payload-data.adoc[automation session,window=read-later] with network payload capture enabled. == Launch Session Explorer @@ -16,13 +16,16 @@ Next, review xref:_review_payload_data[payload data] or xref:_review_response_ti [#_review_payload_data] == Review payload data -In Session Explorer, select *Observe Request / Response Payloads*. +In Session Explorer, select *Device Network Payloads*. -image:observe-request.png[width=1000,alt="Select Observe Request/ Response Payloads"] +image:observe-request.png[width=1000,alt="Select Device Network Payloads"] + +[NOTE] +Only xref:manual-testing:local-devices/capture-network-payload-data.adoc[manual] and xref:automation-testing:local-devices/capture-network-payload-data.adoc[automation] sessions that were run with a custom configuration on a xref:devices:local-devices/network-payload-capture/index.adoc#_set_up[NPC-enabled devices] can have network payload data. In the session timeline, select a *purple marker* to see the list of payloads sent and received during that time. -image:capture-payload-indicator.png[width=1000,alt="Capture payload indicator"] +image:capture-payload-indicator.png[width=500,alt="Capture payload indicator"] The package name and size are listed in the *Response* row. @@ -35,9 +38,9 @@ image:expand-dropdown-to-see-details.png[width=1000,alt="Select Request or Respo [#_review_response_times] == Review response times -In Session Explorer, select *Analyze response times*. +In Session Explorer, select *Response Time Analysis*. -image:select-analyze-response-time-context.png[width=1000,alt="Select Analyze response time"] +image:select-analyze-response-time-context.png[width=1000,alt="Select Response Time Analysis"] In the graph, select a *green* or *red* marker. diff --git a/docs/modules/session-explorer/pages/analytics/review-system-metrics.adoc b/docs/modules/session-explorer/pages/analytics/review-system-metrics.adoc index fbcd02902..3d9485e7f 100644 --- a/docs/modules/session-explorer/pages/analytics/review-system-metrics.adoc +++ b/docs/modules/session-explorer/pages/analytics/review-system-metrics.adoc @@ -1,7 +1,7 @@ = Review system metrics :navtitle: Review system metrics -Learn how to review system metrics after your test session, so you can check your test device's memory, CPU, network, and battery usage. +Learn how to review system metrics after your test session, so you can check your test device's memory, CPU, network, battery usage, and temperature. [IMPORTANT] ==== @@ -12,7 +12,7 @@ System metrics are not yet supported on iOS 17 and later. include::session-explorer:partial$launch-session-explorer.adoc[] -Select *Review System Metrics*. +Select *System Metrics*. image:session-explorer:review-system-metrics-context.png[width=1000,alt="A context to Review System Metrics in Session Explorer"] @@ -22,22 +22,28 @@ image:session-explorer:review-system-metrics-context.png[width=1000,alt="A conte To review device memory usage during the test session, select the dropdown and choose *Memory*. -image:session-explorer:memory-closeup.png[width=500,alt="A closeup to Memory section of Review System Metrics"] +image:session-explorer:memory-closeup.png[width=1000,alt="A closeup to Memory section of Review System Metrics"] === Review CPU usage To review device CPU usage during the test session, select the dropdown and choose *CPU*. -image:session-explorer:cpu-closeup.png[width=500,alt="A closeup to CPU section of Review System Metrics"] +image:session-explorer:cpu-closeup.png[width=1000,alt="A closeup to CPU section of System Metrics"] == View network usage To review the number of bytes the device sent and received over the network during the test session, select the dropdown and choose *Network*. -image:session-explorer:network-closeup.png[width=500,alt="A closeup to Network section of Review System Metrics"] +image:session-explorer:network-closeup.png[width=1000,alt="A closeup to Network section of System Metrics"] === Review battery usage To review the device battery drain and usage during the test session, select the dropdown and choose *Battery Drain*. -image:session-explorer:battery-closeup.png[width=500,alt="A closeup to Battery Drain section of Review System Metrics"] +image:session-explorer:battery-closeup.png[width=1000,alt="A closeup to Battery Drain section of System Metrics"] + +=== Review temperature + +To review your device's temperature during a testing session to ensure optimal performance and prevent overheating, select the dropdown and choose *Temperature*. + +image:session-explorer:system-metrics-temperature.png[width=1000,alt="A closeup to Temperature section of System Metrics"] diff --git a/docs/modules/session-explorer/pages/analytics/review-test-result-analysis.adoc b/docs/modules/session-explorer/pages/analytics/review-test-result-analysis.adoc new file mode 100644 index 000000000..f842291fc --- /dev/null +++ b/docs/modules/session-explorer/pages/analytics/review-test-result-analysis.adoc @@ -0,0 +1,39 @@ += Review test result analysis +:navtitle: Review test result analysis + +Learn how to review the test result analysis after your test session so you can identify and analyze validation issues detected by the AI. + +== Open the device logs + +include::session-explorer:partial$launch-session-explorer.adoc[] + +*Test Result Analysis* is the default option that displays when you first land on the Session Explorer page. + +== Test result analysis overview + +The Test Result Analysis overview has the following information: + +image:session-overview-test-result-analysis.png[width=800,alt="The Test Result Analysis overview table in Session Explorer"] + +* *Validation Type*: types of validation that were detected in the session. The following types are available: +** Crash \(C): available in all sessions. +** Accessibility (A): available in all sessions. +** Response time \(R): only available for sessions with the _Network Payload Capture_ configuration enabled. +** Appium self-healing (S): only available for automation sessions with _flexCorrect_ enabled. + +* *AI Progress*: whether the AI has finished analyzing all the test steps. + +* *Screens*: the number of screens (test steps) that have at least 1 issue belonging to the validation type. + +* *Issues*: the number of issues that occurred belonging to the validation type. + +* *View all*: here you can hide/show all available validation types, or hide/show individual validation types on the session timeline. + +[#_start_analysis] +== Start analysis + +From the Test Result Analysis overview, you can start further analysis by selecting *Start Analysis*. + +All the issues of validation types that were not hidden from the overview will be displayed one by one in detail. You can use the arrow icons to navigate through them. + +Alternatively, you can select the validation icon in the xref:session-explorer:analytics/use-the-session-timeline.adoc#_view_validation_issues[session timeline,window=read-later] to view an issue's details. \ No newline at end of file diff --git a/docs/modules/session-explorer/pages/analytics/use-the-session-timeline.adoc b/docs/modules/session-explorer/pages/analytics/use-the-session-timeline.adoc index 147c76756..b6a37295b 100644 --- a/docs/modules/session-explorer/pages/analytics/use-the-session-timeline.adoc +++ b/docs/modules/session-explorer/pages/analytics/use-the-session-timeline.adoc @@ -13,7 +13,7 @@ include::session-explorer:partial$launch-session-explorer.adoc[] To scrub the timeline and look for a test step or issue, use the slider to zoom in and out of the timeline. -image:session-explorer:zoom.png[width=1000,alt="A closeup to Zoom function on the timeline"] +image:session-explorer:zoom.png[width=250,alt="A closeup to Zoom function on the timeline"] === Review a test step @@ -23,8 +23,6 @@ image:view-test-step-context.png[width=1000,alt="View test steps on the timeline To go to the next or previous step, select the *Next* or *Previous* icon, or use your keyboard's arrow keys. -image:session-explorer:previous-next-closeup.png[width=1000,alt="A closeup to Previous & Next button on the timeline"] - === Get a test step ID To get a test step ID, select the test step in the timeline, then select the *Copy ID* icon. @@ -33,7 +31,7 @@ image:session-explorer:copy-command-id-closeup.png[width=1000,alt="A closeup to === Get a link to a test step -To get a link to a test step, select the test step in the timeline, then select the *Copy Link* icon. +To get a link to a test step, select the test step in the timeline, then select the *Copy link to test step* icon. image:session-explorer:copy-link-closeup.png[width=1000,alt="A closeup to copy link function on the timeline"] @@ -43,15 +41,38 @@ To download a screenshot, select a test step in the timeline, then select the *D image:session-explorer:download-screenshot-closeup.png[width=500,alt="Download button to download screenshot of the selected step"] -=== View accessibility issues +[#_view_validation_issues] +=== View validation issues + +To view a validation issue that was flagged during your session, select a *validation icon* in the timeline. Depending on the session, the possible validation icons are: -To view an accessibility issue automatically flagged during your session, select a *yellow marker* in the timeline. +* *A*: Accessibility +* *C*: Crash +* *R*: Response time (for _Network Payload Capture_ sessions) +* *S*: Appium self-healing (for automation sessions with _flexCorrect_ enabled) -image:yellow-dots-on-timeline-context.png[width=1000,alt="Yellow dots on the timeline showing Accessibility Validation"] +image:session-explorer-accessibility-validation.png[width=250,alt="Icons on the timeline showing Accessibility Validation"] Then, select *View Details*. image:view-details-accessbility-validation-context.png[width=1000,alt=After select View Details button, users are directed to Accessibility Validation issues window] [NOTE] -Learn more about xref:session-explorer:validations/validate-accessibility.adoc[accessibility validation]. + +==== + +Learn more about: + +* xref:session-explorer:validations/validate-accessibility.adoc[Accessibility validation,window=read-later] +* xref:session-explorer:analytics/review-crash-logs.adoc#_review_the_crash_logs[Crash log,window=read-later] +* xref:session-explorer:analytics/review-network-payload-data.adoc#_review_response_times[Response time,window=read-later] +* xref:automation-testing:capabilities/add-flexcorrect.adoc[flexCorrect (Appium self-healing),window=read-later] + +==== + +[#_action_groups_timeline] +=== Action groups in timeline + +In the Session Explorer timeline, you can see visually distinct groupings of related Appium commands as xref:automation-testing:scripting/add-action-groups-in-appium-script.adoc[defined in your test script]. Each group created using `'kobiton:stepGroup'` is represented as a labeled section within the timeline, offering clear segmentation of test steps. + +image:session-explorer-timeline-group-actions.png[width=1000,alt="Actions grouping in the timeline"] diff --git a/docs/modules/session-explorer/pages/custom-search-queries.adoc b/docs/modules/session-explorer/pages/custom-search-queries.adoc index b844e9f15..885e4f333 100644 --- a/docs/modules/session-explorer/pages/custom-search-queries.adoc +++ b/docs/modules/session-explorer/pages/custom-search-queries.adoc @@ -116,9 +116,20 @@ Returns all sessions using devices with this screen resolution. resolution:720x1080 # Returns all sessions using a device with a 720x1080 screen resolution. ---- +[#_session_tag] +=== `session_tag:` + +You can search for sessions using a specific tag. + +.Example +[source,plaintext] +---- +session_tag:login-flow # Find all sessions with the tag `login-flow`. +---- + === `status:` -Returns all sessions matching this status. For more information, see xref:session-explorer:search-for-a-session.adoc#_use_session_tags[Session tags]. +Returns all sessions matching this status. For more information, see xref:session-explorer:search-for-a-session.adoc#_use_session_status_or_type[Session tags]. .Example [source,plaintext] diff --git a/docs/modules/session-explorer/pages/index.adoc b/docs/modules/session-explorer/pages/index.adoc index b4a903788..25b9835e1 100644 --- a/docs/modules/session-explorer/pages/index.adoc +++ b/docs/modules/session-explorer/pages/index.adoc @@ -1,9 +1,14 @@ = Session Explorer :navtitle: Session Explorer -Analyze sessions and validations in Session Explorer. +Session Explorer helps you thoroughly analyze test sessions and perform key validations to ensure the quality of +your app. You can inspect each session in detail, reviewing interaction logs, network data, and element attributes to +troubleshoot issues and optimize test performance. Session Explorer also lets you validate critical aspects +of your app, such as UI design consistency, accessibility compliance, and overall functionality. -image:view-test-step-context.png[width=1000,alt="The Session Explorer page"] +Session Explorer helps you identify issues early and efficiently, improve app quality, and deliver a seamless user experience. + +image:select-explorer-context.png[width=1000,alt="The Session Explorer page"] == In this section diff --git a/docs/modules/session-explorer/pages/manage-sessions.adoc b/docs/modules/session-explorer/pages/manage-sessions.adoc index eee89b74b..1d4a10ded 100644 --- a/docs/modules/session-explorer/pages/manage-sessions.adoc +++ b/docs/modules/session-explorer/pages/manage-sessions.adoc @@ -7,27 +7,21 @@ Learn how to manage sessions so you can rename a session, change the session des In Kobiton, select *Sessions*. -image:select-sessions-closeup.png[width=1000,alt="Select Sessions tab"] +image:select-sessions-closeup.png[width=150,alt="Select Sessions tab"] xref:session-explorer:search-for-a-session.adoc[Search for a session], then select the session ID to open the session overview. image:search-session-id-closeup.png[width=1000,alt="Search for a session ID"] -From the Session Overview window, users can view below mentioned information. +From the **Session Overview**, you can view session info, video, device info, logs, and more. -image:session-overview-context copy.png[width=1000,alt="A context to Session Overview"] +image:session-overview-context.png[width=1000,alt="A context to Session Overview"] == Manage the session -=== Rename the session +=== Edit the session info -To rename the session, select the *Edit* icon beneath *Session Name*, then enter a new name. You can also change this xref:manual-testing:change-manual-session-settings.adoc[during a test session]. - -image:edit-session-name-context.png[width=1000,alt="Edit a session name"] - -=== Change session description - -To change the session description, select the *Edit* icon beneath *Session Description*, then enter a new description. You can also change this xref:manual-testing:change-manual-session-settings.adoc[during a test session]. +To rename the session or change the description, select *Edit Info*. You can also change this xref:manual-testing:change-manual-session-settings.adoc[during a test session]. image:edit-session-description-context.png[width=1000,alt="Edit a session description"] @@ -40,9 +34,9 @@ image:session-explorer:logs-closeup.png[width=400,alt="Logs section in Session O === Download last mile speed test logs [NOTE] -Last mile speed test log is only available for Cloud and Hybrid (Cloud Customer-hosted) deployments +Last mile speed test log is only available for Cloud and Hybrid (Cloud Customer-hosted) deployments. -To download the last mile speed test logs, select *Last Mile Speed Result*. +To download the last mile speed test logs, select *View Last Mile Speed Result Logs*. image:session-explorer:logs-last-mile-speed.png[width=500,alt="Last mile speed result section in Session Overview"] @@ -68,4 +62,29 @@ The Applitools Eyes status is also displayed from the session list. You can ente image:session-explorer:applitools-session-list.png[width:500,alt="The Applitools Eyes status in Session Overview"] -==== \ No newline at end of file +==== + +=== View the execution history for tagged sessions + +Session Overview includes an Execution History section for sessions with tags, allowing you to see the status, device, and OS information for up to five related sessions. + +To view the execution history of tagged sessions: + +. Go to *Session Overview* for any tagged session. + +. Scroll to the *Execution History* section. + +. You’ll see the last five sessions with the same tag, including: + +** Session statuses (e.g., passed, failed) + +** Device and OS information + +** Details like Session ID and Creation Date when hovering over a session + +image:session-overview-execution-history.png[width=600,alt="The Execution History by Tag section under Session Overview"] + +[NOTE] +If the current session is not one of the five most recent sessions, you’ll see an ellipsis (…) indicating that additional sessions exist but aren’t shown in this view. + +Clicking on a tag name in the Execution History section will open the Session List, automatically filtered to show all sessions associated with that tag. diff --git a/docs/modules/session-explorer/pages/search-for-a-session.adoc b/docs/modules/session-explorer/pages/search-for-a-session.adoc index 545cc9a39..0cf8d806f 100644 --- a/docs/modules/session-explorer/pages/search-for-a-session.adoc +++ b/docs/modules/session-explorer/pages/search-for-a-session.adoc @@ -1,7 +1,7 @@ = Search for a session :navtitle: Search for a session -Learn how to search for a session so you can review the session timeline, analyze previous sessions, run Scriptless Automation, and more. +Learn how to search for a session so you can review the session steps and insights, create Test Cases, and more. == Open Sessions @@ -23,7 +23,7 @@ image:session-explorer:saved-search-context.png[width=1000,alt="Choose saved sea To search for a session within a specific date range, select *From* and *To*, then choose a date for each. -image:date-range-context.png[width=1000,alt="Select date range to filter sessions"] +image:date-range-context.png[width=750,alt="Select date range to filter sessions"] === Using the search bar @@ -31,14 +31,14 @@ To search for a session using session metadata, select the search bar and enter image:search-bar-session-criteria-context.png[width=1000,alt="Search for sessions using metadata criteria"] -[#_use_session_tags] -=== Using session tags +[#_use_session_status_or_type] +=== Using session status or type -To search for a session using session tags, select the search bar, then choose from the list of tags. +To search for a session using session status or type, select the search bar, then choose from the list of statuses and types. -image:session-explorer:session-tags-context.png[width=500,alt="Sessions with Failed tag"] +image:session-explorer:session-tags-context.png[width=500,alt="Sessions with Failed status"] -The following table contains a list of all session tags: +The following table contains a list of all session statuses/types: [cols="1,3"] |==== @@ -83,3 +83,9 @@ The following table contains a list of all session tags: |Mixed |Sessions combining manual and automation testing during a single session. |==== + +=== Using session tags + +Use the `session:tag` xref:custom-search-queries.adoc#_session_tag[custom search query] to search sessions using specific tags, making it simple to locate related sessions within the sessions list. + +The search suggestions displays your five most recent tags used within the selected time range, helping you find relevant sessions quickly. diff --git a/docs/modules/session-explorer/pages/validations/index.adoc b/docs/modules/session-explorer/pages/validations/index.adoc index 337eb4b74..07da26cb0 100644 --- a/docs/modules/session-explorer/pages/validations/index.adoc +++ b/docs/modules/session-explorer/pages/validations/index.adoc @@ -1,7 +1,10 @@ = Session Explorer validations :navtitle: Validations -You can use Session Explorer to validate your app or website's UI design or user accessibility, including touch target size, color contrast, and more. +With Session Explorer, you can validate key aspects of your app or website's UI design and user accessibility to ensure +it meets usability standards. This includes checking touch target sizes to ensure they are easy to interact with, verifying +color contrast ratios to maintain readability for all users, and reviewing the layout to confirm it aligns with design +guidelines. Access Session Explorer's validation features to ensure your app provides an inclusive experience for all users. == In this section diff --git a/docs/modules/session-explorer/pages/validations/validate-accessibility.adoc b/docs/modules/session-explorer/pages/validations/validate-accessibility.adoc index 3618e15c3..97feb9b50 100644 --- a/docs/modules/session-explorer/pages/validations/validate-accessibility.adoc +++ b/docs/modules/session-explorer/pages/validations/validate-accessibility.adoc @@ -7,9 +7,9 @@ Learn how to validate your app or website for accessibility by finding and fixin include::session-explorer:partial$launch-session-explorer.adoc[] -Select a *yellow marker* in the session timeline. +Select a *green marker* in the session timeline. -image:session-explorer-accessibility-validation.png[width=500, alt="The yellow dot indicating accessibility validations with a View Details button"] +image:session-explorer-accessibility-validation.png[width=250, alt="The green dot indicating accessibility validations with a View Details button"] Select *View Details*. @@ -41,15 +41,11 @@ image:session-explorer:content-labeling-context.png[width=1000,alt="A context to Each screenshot is flagged with one or more issues related to the xref:_select_an_issue_type[current issue type]. The total number of screenshots for this issue type is located beneath the screenshot pane. Use the *Next* and *Previous* icons to select a specific screenshot. -image:session-explorer:yellow-dot-context.png[width=1000,alt="A context to yellow dots on the timeline and the screen"] - [#_select_an_issue] == Select an issue The total number of issues flagged on the xref:_select_a_screenshot[selected screenshot] is located at the top of the issue pane. Use the *Next* and *Previous* icons to select an issue on the currently selected screenshot. -image:session-explorer:yellow-dot-context.png[width=1000,alt="A context to yellow dots on the timeline and the screen"] - == Review the issue Each issue contains a description with a link to the related link:https://developer.apple.com/design/human-interface-guidelines/accessibility[Apple] or link:https://www.google.com/accessibility/for-developers/[Google] accessibility guideline. Use the following information to review the xref:_select_an_issue[selected issue]. diff --git a/docs/modules/session-explorer/partials/launch-session-explorer.adoc b/docs/modules/session-explorer/partials/launch-session-explorer.adoc index a5926c9c2..8dbd5f41f 100644 --- a/docs/modules/session-explorer/partials/launch-session-explorer.adoc +++ b/docs/modules/session-explorer/partials/launch-session-explorer.adoc @@ -2,12 +2,12 @@ In Kobiton, select *Sessions*. -image:session-explorer:select-sessions-closeup.png[width=1000,alt="Select Sessions tab"] +image:session-explorer:select-sessions-closeup.png[width=150,alt="Select the Sessions tab"] -xref:session-explorer:search-for-a-session.adoc[Find a session], then select the session in the search result. +xref:session-explorer:search-for-a-session.adoc[Find a session], then select the session in the search results. image:session-explorer:search-session-id-closeup.png[width=1000,alt="Search for a session ID"] -At the session details page, select the *Explorer* tab. +Once you select your session, the *Session Explorer* page will appear. -image:session-explorer:select-explorer-context.png[width=1000,alt="Select Explorer tab"] \ No newline at end of file +image:session-explorer:select-explorer-context.png[width=1000,alt="Select the Explorer tab"] diff --git a/docs/modules/session-explorer/partials/select-sessions-context.png b/docs/modules/session-explorer/partials/select-sessions-context.png deleted file mode 100644 index bc534ac92..000000000 Binary files a/docs/modules/session-explorer/partials/select-sessions-context.png and /dev/null differ diff --git a/docs/modules/test-management/images/convert-test-case.png b/docs/modules/test-management/images/convert-test-case.png new file mode 100644 index 000000000..9bbaecebe Binary files /dev/null and b/docs/modules/test-management/images/convert-test-case.png differ diff --git a/docs/modules/test-management/pages/create-a-test-case.adoc b/docs/modules/test-management/pages/create-a-test-case.adoc index 8d3c434b8..849f61b41 100644 --- a/docs/modules/test-management/pages/create-a-test-case.adoc +++ b/docs/modules/test-management/pages/create-a-test-case.adoc @@ -16,9 +16,9 @@ In *Sessions*, xref:session-explorer:search-for-a-session.adoc[search for a sess image:search-for-a-session-context.png[width=1000,alt="Select Sessions and search for a session"] -Select *Automated Test Case*. +Select *Convert to Test Case*. -image:select-automated-test-case-context.png[width=1000,alt="Select Automated Test Case"] +image:convert-test-case.png[width=1000,alt="Select Convert to Test Case"] If your test case has any issues, you'll need to xref:remediation/annotate-a-test-step.adoc[annotate your flagged test steps] first. When your test case is good to go, you'll see the following message: diff --git a/docs/modules/test-management/pages/manage-test-steps.adoc b/docs/modules/test-management/pages/manage-test-steps.adoc index 3b3b6f72b..2bfadda27 100644 --- a/docs/modules/test-management/pages/manage-test-steps.adoc +++ b/docs/modules/test-management/pages/manage-test-steps.adoc @@ -13,9 +13,9 @@ In *Sessions*, xref:session-explorer:search-for-a-session.adoc[search for a sess image:select-a-session-context.png[width=1000,alt="Search and select a session"] -Select *Automation Test Case*. +Select *Convert to Test Case*. -image:select-automated-test-case-context.png[width=1000,alt="Select Automated Test Case"] +image:convert-test-case.png[width=1000,alt="Select Convert to Test Case"] == Manage the test step diff --git a/docs/modules/test-management/pages/remediation/annotate-a-test-step.adoc b/docs/modules/test-management/pages/remediation/annotate-a-test-step.adoc index c76d6c5ae..56088430e 100644 --- a/docs/modules/test-management/pages/remediation/annotate-a-test-step.adoc +++ b/docs/modules/test-management/pages/remediation/annotate-a-test-step.adoc @@ -13,9 +13,9 @@ In *Sessions*, xref:session-explorer:search-for-a-session.adoc[search for a sess image:select-a-session-context.png[width=1000,alt="Search and select a session"] -Select *Automation Test Case*. +Select *Convert to Test Case*. -image:select-automated-test-case-context.png[width=1000,alt="Select Automated Test Case"] +image:convert-test-case.png[width=1000,alt="Select Convert to Test Case"] If one of your test steps were flagged, you'll see a warning similar to the following: diff --git a/docs/modules/test-management/pages/validation/text-validation.adoc b/docs/modules/test-management/pages/validation/text-validation.adoc index 628c68505..f940c2986 100644 --- a/docs/modules/test-management/pages/validation/text-validation.adoc +++ b/docs/modules/test-management/pages/validation/text-validation.adoc @@ -3,7 +3,7 @@ Scriptless Automation highlights the exact character differences between the baseline and the screenshot. For example, in the image below, discrepancies in spacing arise from varying screen resolutions across two devices. -image:scriptless-automation:text-assertion.png[width=1000,alt="Text validation"] +image:scriptless-automation:text-assertion.png[width=500,alt="Text validation"] You can submit a remediation, ensuring you don't face this validation in future runs. diff --git a/ui-bundle-docs/partials/head-info.hbs b/ui-bundle-docs/partials/head-info.hbs index 07efba14d..c1cd3afc5 100644 --- a/ui-bundle-docs/partials/head-info.hbs +++ b/ui-bundle-docs/partials/head-info.hbs @@ -10,7 +10,7 @@ {{/with}} {{/unless}} {{#with page.description}} - + {{/with}} {{#with page.keywords}} diff --git a/ui-bundle-widget/partials/head-info.hbs b/ui-bundle-widget/partials/head-info.hbs index 2b1071cbf..d5307ca8c 100644 --- a/ui-bundle-widget/partials/head-info.hbs +++ b/ui-bundle-widget/partials/head-info.hbs @@ -10,7 +10,7 @@ {{/with}} {{/unless}} {{#with page.description}} - + {{/with}} {{#with page.keywords}}