diff --git a/docs/modules/devices/images/device-modal-restart.png b/docs/modules/devices/images/device-modal-restart.png new file mode 100644 index 000000000..a0537c5e7 Binary files /dev/null and b/docs/modules/devices/images/device-modal-restart.png differ diff --git a/docs/modules/devices/images/device-modal-retained.png b/docs/modules/devices/images/device-modal-retained.png new file mode 100644 index 000000000..747adbb7b Binary files /dev/null and b/docs/modules/devices/images/device-modal-retained.png differ diff --git a/docs/modules/devices/pages/manage-devices.adoc b/docs/modules/devices/pages/manage-devices.adoc index 8e5f057d1..e754b4472 100644 --- a/docs/modules/devices/pages/manage-devices.adoc +++ b/docs/modules/devices/pages/manage-devices.adoc @@ -12,7 +12,7 @@ image:devices:select-devices-context.png[width=1000,alt="Select Devices tab on K After you xref:devices:search-for-a-device.adoc[search for a device], select the *vertical ellipses* to open the device overview. -image:devices:manage-device-context.png[width=,alt=""] +image:devices:manage-device-context.png[width=800,alt="A device with the vertical ellipses selected in the Device list"] == Manage the device @@ -20,7 +20,7 @@ image:devices:manage-device-context.png[width=,alt=""] To rename the device, enter a new name and select *Save*. Optionally, check the box to apply this name to all similar devices. -image:devices:edit-device-name-closeup.png[width=400,alt="A closeup to rename the device"] +image:devices:edit-device-name-closeup.png[width=500,alt="A closeup to rename the device"] === Favorite the device @@ -47,9 +47,44 @@ image:devices:config-section-context.png[width=500,alt=" A context of Use Config === Retain the device -To prevent others from using the device in a test session, select *Retain*, then choose either *1 hour*, *2 hours*, *4 hours*, *8 hours*, *24 hours*, or *Unlimited*. +image:devices:retain-device-closeup.png[width=500,alt="A closeup to Retain status for device"] -image:devices:retain-device-closeup.png[width=400,alt="A closeup to Retain status for device"] +To reserve a device for exclusive use for a set period of time, select the *Retain* drop-down and choose a duration. Available options are typically _1 hour, 2 hours, 4 hours, 8 hours, 24 hours,_ or _Unlimited_. + +Once a device is retained, its status changes to *Retained*, and the countdown displays the remaining time along with the email address of the user who retained it. Be sure to release the retain when you are finished using the device. + +[NOTE] +The cleanup policy (if activated) does not run in between sessions when a device is Retained. + +=== Cancel retain + +image:devices:device-modal-retained.png[width=500,alt="A status showing that the device is retained for 1 hour with the cancel retain button"] + +To release a device from being retained, select the *x* next to the retain status and confirm that you want to remove the retain. + +[NOTE] +A retain can be canceled either by the user who created the retain or by any user with the role permission to xref:organization:roles/user-roles-and-permissions.adoc#_cancel_retain[cancel retains,window=read-later]. + +[#_restart_private_device] +=== Restart private device + +To restart a private device, select *Restart*. + +[NOTE] + +==== + +* Only users with the xref:organization:roles/user-roles-and-permissions.adoc#_org_setting_reboot_private_device[reboot private device,window=read-later] permission can see this option. + +* This option is only available for Private devices. To restart a Public device, submit a support ticket to Kobiton with the device UDID. + +==== + +[IMPORTANT] +Confirm that no one is using the device as restart begins immediately after you select the button. + + +image:devices:device-modal-restart.png[width=500,alt="The Restart button in the manage device screen"] === Automation settings diff --git a/docs/modules/organization/images/other-settings.png b/docs/modules/organization/images/other-settings.png new file mode 100644 index 000000000..159d167e8 Binary files /dev/null and b/docs/modules/organization/images/other-settings.png differ diff --git a/docs/modules/organization/nav.adoc b/docs/modules/organization/nav.adoc index 9ce4d11bc..b09f45e40 100644 --- a/docs/modules/organization/nav.adoc +++ b/docs/modules/organization/nav.adoc @@ -38,4 +38,6 @@ ** xref:organization:sso-authentication/use-onelogin.adoc[] ** xref:organization:sso-authentication/use-ping.adoc[] +* xref:organization:other-settings.adoc[] + * xref:organization:transfer-your-organization.adoc[] diff --git a/docs/modules/organization/pages/other-settings.adoc b/docs/modules/organization/pages/other-settings.adoc new file mode 100644 index 000000000..a4bb8dfdc --- /dev/null +++ b/docs/modules/organization/pages/other-settings.adoc @@ -0,0 +1,64 @@ += Configure other organization settings +:navtitle: Other settings + +Learn how to configure additional settings for your organization. + +== Access other organization settings + +include::profile:partial$open-settings.adoc[] + +Select *Other Settings*. + +image:other-settings.png[width=800,alt="The Other Settings page in Organization Settings"] + +== Available settings + +=== Video and screenshot recording for in-house devices after ending a session + +* _Capture the video in a manual session_: Enable/disable video capturing for manual sessions. The captured video can be accessed from the Session Overview. + +* _Capture the screenshot in a manual session_: Enable/disable screenshot capturing for manual sessions. The captured screenshots can be downloaded during the manual session or viewed and downloaded in Session Explorer. + +[NOTE] +These settings take precedence over any video or screenshot-capture configuration in the `dc.ini` file on the Mac mini host. + +=== XML tree in Manual session + +* _Show only important layers in XML tree_: Enable/disable the display of layers that are marked as important for accessibility in Manual sessions on Android devices. + +* _Show Android's Navigation bar and Status bar layer_: Enable or disable display of the Navigation and Status bar layers in Manual sessions on Android devices. + +=== Kobiton Re-signing Process + +* _App signing using Kobiton Certificate (iOS)_: Enable/disable the use of Kobiton app re-signing for iOS/iPadOS devices in all session types. + +[IMPORTANT] +==== + +When enabled, *all* apps installed on *all* iOS/iPadOS devices in the organization will be re-signed by Kobiton. + +For Hybrid and Standalone/On-Prem customers, deviceShare must be xref:device-lab-management:deviceShare/install-update-deviceshare.adoc[installed,window=read-later] and valid xref:device-lab-management:ios-devices/import-ios-signing-certificates-and-provisioning-profiles.adoc#_import_developer_certificates_and_provisioning_profiles_to_deviceshare[developer certificates/provisioning profiles,window=read-later] must be imported to deviceShare to use Kobiton re-signing. + +==== + +=== Default access for newly uploaded apps + +Choose the default access level for newly uploaded apps in the Kobiton App Repo: + +* _All users in the organization can access._ + +* _Only the uploader can access._ + +[#_device_retention] +=== Device Retention + +* _Allow unlimited retention_: Controls whether the Unlimited option is available when retaining devices for the whole organization. + +=== Other settings + +* _Show "Public Devices" Tab in Device List page_: Controls whether the Public Devices tab is displayed in the Device List. + +[WARNING] +Ensure that your organization is not using any public devices before disabling this setting. + +* _Show option to launch device with WebRTC debug panel_: Controls whether to display the option to launch a manual session with the WebRTC debug panel, which is a tool to troubleshoot issues related to Lightning mode. diff --git a/docs/modules/organization/pages/roles/user-roles-and-permissions.adoc b/docs/modules/organization/pages/roles/user-roles-and-permissions.adoc index b8dff2d73..081c12523 100644 --- a/docs/modules/organization/pages/roles/user-roles-and-permissions.adoc +++ b/docs/modules/organization/pages/roles/user-roles-and-permissions.adoc @@ -13,7 +13,7 @@ The owner of the Kobiton account is given xref:_permissions[all user permissions === ADMIN -The ADMIN role must be assigned by the Organization Owner or another ADMIN. ADMINs are given xref:_permissions[all user permissions]. +The ADMIN role must be assigned by the Organization Owner or another ADMIN. ADMINs are given xref:_permissions[all user permissions] and permissions to manage all devices in the organization in the settings. === MEMBER @@ -86,6 +86,12 @@ Allows a user to end another user's test session. Allows a user to change session details and delete sessions. +[#_cancel_retain] === `soft_book.terminate_other_soft_book` -Allows a user to remove a reservation from any device. +Allows a user to remove the retention of any device by any user. + +[#_org_setting_reboot_private_device] +=== `org_setting.reboot_private_device` + +Allows a user without the `ADMIN` predefined role to restart assigned devices from the xref:devices:manage-devices.adoc#_restart_private_device[manage device,window=read-later] page.