diff --git a/docs/modules/devices/images/cleanup-policies-list.png b/docs/modules/devices/images/cleanup-policies-list.png new file mode 100644 index 000000000..c5e8917bf Binary files /dev/null and b/docs/modules/devices/images/cleanup-policies-list.png differ diff --git a/docs/modules/devices/images/cleanup-policy-remove-apps.png b/docs/modules/devices/images/cleanup-policy-remove-apps.png new file mode 100644 index 000000000..0b90685bd Binary files /dev/null and b/docs/modules/devices/images/cleanup-policy-remove-apps.png differ diff --git a/docs/modules/devices/images/cleanup-policy-selected.png b/docs/modules/devices/images/cleanup-policy-selected.png new file mode 100644 index 000000000..7b5fc519e Binary files /dev/null and b/docs/modules/devices/images/cleanup-policy-selected.png differ diff --git a/docs/modules/devices/images/cleanup-policy-view-teams.png b/docs/modules/devices/images/cleanup-policy-view-teams.png new file mode 100644 index 000000000..e8600ef75 Binary files /dev/null and b/docs/modules/devices/images/cleanup-policy-view-teams.png differ diff --git a/docs/modules/devices/images/new-cleanup-policy-created.png b/docs/modules/devices/images/new-cleanup-policy-created.png new file mode 100644 index 000000000..62b4cc7fe Binary files /dev/null and b/docs/modules/devices/images/new-cleanup-policy-created.png differ diff --git a/docs/modules/devices/nav.adoc b/docs/modules/devices/nav.adoc index 4ece447e1..321729529 100644 --- a/docs/modules/devices/nav.adoc +++ b/docs/modules/devices/nav.adoc @@ -7,6 +7,11 @@ ** xref:local-devices/set-up-device-for-apple-pay.adoc[] +** Cleanup policy + +*** xref:local-devices/cleanup-policy/manage-device-cleanup-policies.adoc[] +*** xref:local-devices/cleanup-policy/cleanup-configurations.adoc[] + ** xref:devices:local-devices/network-payload-capture/index.adoc[] *** xref:devices:local-devices/network-payload-capture/configure-the-host-machine.adoc[] *** xref:devices:local-devices/network-payload-capture/configure-an-ios-device.adoc[] @@ -15,6 +20,5 @@ *** xref:devices:local-devices/network-payload-capture/supported-mime-types.adoc[] * xref:devices:install-an-app.adoc[] -* xref:devices:create-a-device-cleanup-policy.adoc[Create a cleanup policy] * xref:devices:device-metadata.adoc[] * xref:devices:device-ip-addresses.adoc[] diff --git a/docs/modules/devices/pages/local-devices/cleanup-policy/cleanup-configurations.adoc b/docs/modules/devices/pages/local-devices/cleanup-policy/cleanup-configurations.adoc new file mode 100644 index 000000000..5ccb702ca --- /dev/null +++ b/docs/modules/devices/pages/local-devices/cleanup-policy/cleanup-configurations.adoc @@ -0,0 +1,261 @@ += List of cleanup configurations + +Overview of cleanup configurations included in a cleanup policy. + +[NOTE] +==== + +* The configurations are listed by order of execution. + +* Configurations marked with ^*^*^ are always active in any user-created cleanup policy and the _Thorough_ predefined policy, although they are not shown in the _Create_ or _Edit cleanup policy_ dialog. + +* Configurations _not_ marked with ^*^*^ can be selected/deselected in the _Create_ or _Edit cleanup policy_ dialog. + +==== + +== Android + +=== Set Chrome as debug application ^*^*^ + +* Set Chrome as the debug application in Developer options. + +=== Remove device passcode ^*^*^ + +* Remove the device passcode. +* Condition to trigger: the organization uses passcode mode 1 or 2. + +=== Unlock the screen ^*^*^ + +* Unlock the screen. +* Condition to trigger: the organization uses passcode mode 1 or 2. + +=== Clear HTTP proxy on devices ^*^*^ + +* Clear the HTTP proxy settings applied during the NPC session. +* Condition to trigger: when an NPC session ends. + +=== Reset screen brightness to the lowest level ^*^*^ + +* Reset screen brightness to reduce the risk of damaging the screen. +* Not supported on some Chinese device models. + +=== Clear image injection ^*^*^ + +* Clear any injected image. + +=== Set device orientation to portrait ^*^*^ + +* Set the device orientation to portrait mode. + +=== Change system language to English ^*^*^ + +* Change system display language to English. + +=== Remove all non-system applications except for system apps and exempted apps + +* Cleanup option: `All apps installed within a session will be removed`. +* System apps, Kobiton agent apps, and exempted apps are not cleared. +* Supports exemption of apps with specified package name (supports wildcard character \*). Separate entries with command or space. _Example:_ com.sample.app, com.myCompany.* + +image:devices:cleanup-policy-remove-apps.png[width=800,alt="The All apps installed within a session will be removed option with field to specify exempted apps"] + +=== Clear application data (cache) except for system apps + +* Cleanup option: `App’s data will be cleared`. +* Executes only when `All apps installed within a session will be removed` is turned off. + +=== Turn on Wi-Fi + +* Cleanup option: `Device settings will be reset`. + +=== Turn off pocket mode + +* Cleanup option: `Device settings will be reset`. +* Applies only to supported device models. + +=== Enable “Stay Awake” while plugged in + +* Cleanup option: `Device settings will be reset`. +* Keeps the device awake while connected to power. + +=== Enable access to hidden APIs for testing or development ^*^*^ + +* Behavior may vary by device model and OS version. + +=== Reset Time Zone + +* Cleanup option: `Device settings will be reset`. +* Restores the device’s time zone to its current physical location. + +=== Reset Geolocation + +* Cleanup option: `Device settings will be reset`. +* Resets geolocation to the device’s current physical location. + +=== Reset all app states to default + +* Cleanup option: `All apps in the Recent Apps list will return to their starting state`. +* Apps remain visible in the Recent Apps list, but their internal state is reset. +* Screenshots in the Recent Apps list might not update until the app is opened. +* Actual reset behavior depends on each app. + +=== Clear browsing history and data on supported browsers + +* Cleanup option: `Browser apps will have history and browsing data removed`. +* Supported browsers: `Chrome` and `Chrome Beta`. + +=== Remove all accounts from the system + +* Cleanup option: `Signed in accounts will be removed`. +* Removes accounts that grant access to online resources with one-click approval first, then removes remaining accounts individually in the Accounts settings. + +=== Set Navigation bar to buttons + +* Cleanup option: `Turn on the navigation bar`. +* If software navigation buttons are used: +** Samsung: Settings → Display → Navigation Bar → Navigation buttons. +** Google Pixel: Settings → System → Gestures → System Navigation → 3-button navigation. +** Not supported on some brands (for example, Oppo and Xiaomi). + +=== Set Chrome as the default browser + +* Cleanup option: `Set Chrome as the default browser`. + +=== Turn off auto-update in Google Play Store ^*^*^ + +** Open Google Play Store. +** Open Settings from the menu or drawer, depending on account state. +** Navigate to Network Preferences → Auto-update apps → Don’t auto-update apps → Done. + +=== Clear keyboard cache + +* Cleanup option: `Clear the keyboard cache`. +* Switch to the default system keyboard, clears supported keyboard caches (for example, Gboard). +* Clears keyboard clipboard data. + +=== Set up Chrome browser ^*^*^ + +* Opens Chrome and dismisses initial welcome screens. +* Opens Chrome settings, then: +** Disable password saving under “Passwords”. +** Disable translation prompts under “Languages”. + +=== Disable the toolbar on Samsung Keyboard ^*^*^ + +* Hide keyboard shortcut icons on supported Samsung devices. + +== iOS/iPadOS + +=== Remove passcode ^*^*^ + +* Remove device passcode using the unlock token. +* Condition to trigger: the organization uses passcode mode 1 or 2. + +=== Clear HTTP proxy ^*^*^ + +* Clear the HTTP proxy settings applied during the NPC session. +* Condition to trigger: when an NPC session ends. + +=== Set orientation to portrait ^*^*^ + +* Set device orientation to portrait mode. + +=== Set screen brightness to the lowest level ^*^*^ + +* Set screen brightness to the lowest level to avoid damaging the screen. + +=== Reset device language to English ^*^*^ + +* Reset device display language to English. + +=== Remove all non-system applications except system apps and exempted apps + +* Cleanup option: `All apps installed and associated data within a session will be removed`. +* Removes all non-system applications except Kobiton agent apps, apps with bundle IDs starting with `com.apple`, and exempted apps. +* * Supports exemption of apps with specified bundle ID (supports wildcard character \*). Separate entries with command or space. _Example:_ com.sample.app, com.myCompany.* + +image:devices:cleanup-policy-remove-apps.png[width=800,alt="The All apps installed within a session will be removed option with field to specify exempted apps"] + +=== Reset display zoom to Standard + +* Cleanup option: `Device settings will be reset`. +* Applies only to device models that support Display Zoom. + +=== Clean Safari history and data + +* Cleanup option: `Browser apps will have history and browsing data removed` – `Safari`. +* Steps: +** Open Settings → Safari. +** Select Clear History and Website Data. +** Select All History. +** Turn on Close All Tabs. +** Select Clear History. + +=== Remove signed-in mail accounts except Apple ID and iCloud + +* Cleanup option: `Signed in accounts will be removed`. +* Remove accounts for Google, Outlook, Microsoft Exchange, Yahoo, AOL, and similar providers. +* *Note:* This does not remove Apple ID or iCloud accounts. +* Some iOS versions may not remove Yahoo accounts. + +=== Turn on Wi-Fi + +* Cleanup option: `Device settings will be reset`. + +=== Turn on Bluetooth + +* Cleanup option: `Device settings will be reset`. + +=== Turn off Airplane Mode + +* Cleanup option: `Device settings will be reset`. + +=== Turn on Web Inspector for Safari + +* Cleanup option: `Device settings will be reset`. +* Open Settings → Safari → Advanced → Web Inspector. +* Note: This does not enable Remote Automation. + +=== Turn on UI Automation + +* Cleanup option: `Device settings will be reset`. +* Open Settings → Developer → Enable UI Automation. + +=== Turn off Low Power Mode and set Auto-Lock to Never + +* Cleanup option: `Device settings will be reset`. +* Open Settings → Battery → turn off Low Power Mode (to enable the Never option in Auto-Lock). +* Open Settings → Display & Brightness → Auto-Lock → Never. + +=== Turn on Location Services + +* Cleanup option: `Device settings will be reset`. + +=== Turn off AssistiveTouch + +* Cleanup option: `Device settings will be reset`. +* Open Settings → Accessibility → Touch → AssistiveTouch → Off. + +=== Turn off Ringer and Alert sound + +* Cleanup option: `Device settings will be reset`. +* Open Settings → Sound & Haptics → set Ringtone and Alerts volume to 0. + +=== Reset Time Zone + +* Cleanup option: `Device settings will be reset`. +* Open Settings → General → Date & Time → disable Set Automatically. +* Set the time zone to the device’s current location. +* Some time zones may not reset correctly. + +=== Reset Geolocation + +* Cleanup option: `Device settings will be reset`. +* Resets geolocation to the device’s current location. + +=== Reset all app states to default + +* Cleanup option: `All apps in the Recent Apps list will return to their starting state`. +* Apps remain in the Recent Apps list with reset internal state. +* Screenshots in Recent Apps may not update until the app is opened. +* Reset behavior varies by app. \ No newline at end of file diff --git a/docs/modules/devices/pages/local-devices/cleanup-policy/manage-device-cleanup-policies.adoc b/docs/modules/devices/pages/local-devices/cleanup-policy/manage-device-cleanup-policies.adoc new file mode 100644 index 000000000..b3bdde141 --- /dev/null +++ b/docs/modules/devices/pages/local-devices/cleanup-policy/manage-device-cleanup-policies.adoc @@ -0,0 +1,113 @@ += Manage device cleanup policies +:navtitle: Manage device cleanup policies + +A cleanup policy is a set of steps that are performed on a device when a session ends to remove test data and changes in device settings in the session. + +Learn about device cleanup policies management, including creating, editing, removing and assigning to teams or the organization. + +[#_open_the_cleanup_policies_page] +== Open the Cleanup Policies page + +include::profile:partial$open-settings.adoc[] + +Select *Cleanup Policy* to access the Cleanup Policies page. + +image:devices:cleanup-policies-list.png[width=1000,alt="The Cleanup Policies list page"] + +== About the predefined cleanup policies + +At the Cleanup Policies page, there are 2 predefined cleanup policies: + +image:devices:cleanup-policies-list.png[width=1000,alt="The Cleanup Policies list page with the 2 predefined cleanup policies"] + +* *Thorough*: This cleanup policy is equivalent to a user-created policy that has xref:local-devices/cleanup-policy/cleanup-configurations.adoc[all configurations,window=read-later] checked, and performs the most thorough cleanup on a device. + +* *No Cleanup*: This cleanup policy does not perform any cleanup on a device. It is *not* equivalent to a user-created policy without any checked item, as there are still some cleanup configurations enabled for the latter. + +These predefined policies are created by the system and are not editable or removable. + +== Create or edit a cleanup policy + +At the Cleanup Policies page, choose the *Create* button. + +image:devices:cleanup-policies-list.png[width=1000,alt="The Cleanup Policies list page with the Create button"] + +Enter a name and description. + +image:organization:configure-cleanup-policy-closeup.png[width=500,alt="A closeup to cleanup policy configuration modal"] + +Check the configurations you want to add for *both* the Android and iOS tabs. Refer to xref:local-devices/cleanup-policy/cleanup-configurations.adoc[this page,window=read-later] for a list of all configurations. + +NOTE: There are additional configurations not shown here that are always enabled for user-created cleanup policies. Refer to the xref:local-devices/cleanup-policy/cleanup-configurations.adoc[list of configurations,window=read-later] to learn more. + +image:organization:check-policies-closeup.png[width=500,alt="Check the policies you want to add"] + +When you're finished, select *Save*. + +image:organization:cleanup-confirm-popup-closeup.png[width=500,alt="Confirm create new cleanup policies"] + +The new cleanup policy appears in the list. + +image:devices:new-cleanup-policy-created.png[width=1000,alt="The new cleanup policy appears in the list"] + +Select the created cleanup policy's name to open the edit dialog. + +[NOTE] +==== + +The following cannot be edited: + +* Predefined cleanup policies (_Thorough_ and _No Cleanup_). + +* Any cleanup policy that is assigned as default for the organization. + +==== + +Edit the cleanup policy, then choose *Save* to apply the changes. + +IMPORTANT: The created cleanup policy is not active until it is assigned as default for the xref:#_assign_a_cleanup_policy_as_default_for_the_organization[organization] or xref:#_create_and_assign_a_cleanup_policy_as_default_for_the_team[team]. + +== Remove a cleanup policy + +At the Cleanup Policies page, select to highlight a cleanup policy. + +Select the *Remove* button, then confirm the removal in the pop-up. + +image:devices:cleanup-policy-selected.png[width=500,alt="The selected cleanup policy with the Remove button"] + +[NOTE] +==== + +The following cannot be removed: + +* Predefined cleanup policies (_Thorough_ and _No Cleanup_). + +* Any cleanup policy that is assigned as default for the organization. + +After removing a default cleanup policy of one or several teams, the default cleanup policy of the organization will be assigned as default for those teams instead. + +==== + +[#_assign_a_cleanup_policy_as_default_for_the_organization] +== Assign a cleanup policy as default for the organization + +At the Cleanup Policies page, select to highlight a cleanup policy. + +Select the *Mark as default* button, then confirm the selection in the pop-up. + +image:devices:cleanup-policy-selected.png[width=500,alt="The selected cleanup policy with the Mark as default button"] + +After being assigned as the default for the organization, the cleanup policy is applied: + +* At the end of all sessions launched under the organization. + +* After the device restarts or reconnects to the Portal after a disconnection. + +* After the device is released from retain or virtualUSB. + + +[#_create_and_assign_a_cleanup_policy_as_default_for_the_team] +== Create and assign a cleanup policy as default for the team + +include::organization:teams/create-a-device-cleanup-policy.adoc[tag=team_cleanup_policy] + diff --git a/docs/modules/organization/images/configure-cleanup-policy-closeup.png b/docs/modules/organization/images/configure-cleanup-policy-closeup.png index 8647d4b46..d0d6a58e4 100644 Binary files a/docs/modules/organization/images/configure-cleanup-policy-closeup.png and b/docs/modules/organization/images/configure-cleanup-policy-closeup.png differ diff --git a/docs/modules/organization/pages/teams/create-a-device-cleanup-policy.adoc b/docs/modules/organization/pages/teams/create-a-device-cleanup-policy.adoc index edc32868d..f5e4cf6c5 100644 --- a/docs/modules/organization/pages/teams/create-a-device-cleanup-policy.adoc +++ b/docs/modules/organization/pages/teams/create-a-device-cleanup-policy.adoc @@ -1,33 +1,42 @@ -= Create a device cleanup policy -:navtitle: Create a device cleanup policy += Create a device cleanup policy for a team +:navtitle: Create a team cleanup policy Learn how to create a cleanup policy for your team's private devices, so your devices will be cleaned up after a session and ready to be used in the next one. -== Create a cleanup policy +== Create and assign a cleanup policy for a team + +// tag::team_cleanup_policy[] In *Org Management*, select *Teams*, then search for your team. image:organization:select-a-team-context.png[width=1000,alt="Select a Team"] -In your team, select *Settings*, then select *New*. +In your team, select *Settings*, then either select an existing cleanup policy or choose *New* to create a new one. image:organization:select-new-settings-context.png[width=1000,alt="Click New to add a cleanup policy"] -Choose an OS, then enter a name and description. - -[NOTE] -Apple IDs cannot be added to iOS cleanup policies. +If you are creating a new cleanup policy, enter a name and description. image:organization:configure-cleanup-policy-closeup.png[width=500,alt="A closeup to cleanup policy configuration modal"] -Check the policies you want to add. +Check the configurations you want to add for *both* the Android and iOS tabs. Refer to xref:devices:local-devices/cleanup-policy/cleanup-configurations.adoc[this page,window=read-later] for a list of all configurations. + +NOTE: There are additional configurations not shown here that are always enabled for user-created cleanup policies. Refer to the xref:devices:local-devices/cleanup-policy/cleanup-configurations.adoc[list of configurations,window=read-later] to learn more. image:organization:check-policies-closeup.png[width=500,alt="Check the policies you want to add"] -When you're finished, select *Save*. +When you're finished, select *Save*, then confirm the creation in the pop-up. image:organization:cleanup-confirm-popup-closeup.png[width=500,alt="Confirm create new cleanup policies"] -Now your devices will be cleaned up after a session, so they're ready to use in the next session. +Select *Save* one more time to apply the changes. image:organization:click-save-cleanup-context.png[width=1000,alt="Click Save after creating a new cleanup policy"] + +After being assigned as the default for the team, the cleanup policy is applied at the end of all sessions launched under the team. + +In the xref:devices:local-devices/cleanup-policy/manage-device-cleanup-policies.adoc#_open_the_cleanup_policies_page[Cleanup Policies page,window=read-later], you can view all teams assigned to the cleanup policy by selecting *View teams*. + +image:devices:cleanup-policy-view-teams.png[width=1000,alt="A cleanup policy selected with the View teams link and list of assigned teams"] + +// end::team_cleanup_policy[] diff --git a/docs/modules/organization/pages/teams/manage-teams.adoc b/docs/modules/organization/pages/teams/manage-teams.adoc index 4972f6775..1a6c68535 100644 --- a/docs/modules/organization/pages/teams/manage-teams.adoc +++ b/docs/modules/organization/pages/teams/manage-teams.adoc @@ -58,7 +58,7 @@ image:organization:private-test-mode-closeup.png[width=1000,alt="A closeup to Pr When you're finished, select *Save*. [#_cleanup_policy] -=== Set a cleanup policy +=== Set a default cleanup policy In *Settings*, select the dropdown. You can choose a default cleanup policy or xref:organization:teams/create-a-device-cleanup-policy.adoc[create a new one]. Team devices are cleaned up after every session, so they're ready to use for the next one.