Skip to main content

Toolbox

Centralized tools for log collection, debug access, and offline alerts to boost troubleshooting and ensure security.

Updated over 4 months ago

Describe your article to help it get found

Centralized tools for log collection, debug access, and offline alerts to boost troubleshooting and ensure security.

1. Features and Application Objectives

The Toolbox module provides multiple practical features for device operations and security management, covering key capabilities such as log collection and management, debugging permission control, and device online status monitoring. Its goal is to help administrators troubleshoot issues more efficiently, ensure debugging security, and stay informed about device operation status in a timely manner.

Note: This module is currently available only for iMin devices.

Module Components:

Operation Item

Description

Log Tasks

Create, configure, and deploy log collection tasks; set collection scope, delay, or scheduled execution.

Device Logs

View and manage logs uploaded by devices; supports preview and batch download.

My Debugger

Manage debugger accounts and authorization methods; control USB debugging mode access on devices.

Offline Detection

Configure device offline detection policies and notification contacts; supports automatic email alerts.

Typical Use Cases

  • Capture critical device operation data during failures via scheduled log tasks to locate the root cause of anomalies.

  • Prevent unauthorized access in production or after-sales scenarios through USB debugging protection.

  • Enable offline detection for critical business devices to proactively identify and handle network disconnection issues.

  • Centralize device log management to reduce time spent on cross-system searches and data transfers.

2. Log Tasks

Used to create and deploy log collection tasks for devices, supporting two start modes: Delayed and Scheduled. Once executed on the device, the task generates a ZIP log file. On the task list page, you can manage tasks by downloading, retrying, or force terminating them according to their status.

2.1 Create a Log Task

Description

This feature allows you to create new device log collection tasks on the platform and deploy them to target devices for execution. Administrators can set delayed or scheduled execution to quickly obtain log files from the desired time period for troubleshooting when device issues occur.

The log task list supports filtering and locating tasks by device SN, task status, and time range, enabling operations and maintenance teams to quickly manage and track task statuses during bulk device management.

Notes

  • Only one log task can run on a device at any given time. Launching a new task will terminate the existing one.

  • Forcing termination will not generate a log file, and the device will automatically delete any temporary logs generated.

  • It is recommended to execute or schedule a task as soon as the issue occurs to improve log relevance.

  • Downloaded log files are in ZIP format and must be extracted locally for viewing.

  • If a device is unresponsive, you can retry the task but should first check its online status and network connection.

Steps

  1. Access the Task Management Page

    • On the Log Tasks page, click the Create Task button in the top right.

    • The task configuration window will appear, starting the creation process.

  2. Configure Task Parameters

    • Set the execution mode:

      • Delayed Execution: Set a delay time before starting log collection (enter 0 to execute immediately).

      • Scheduled Execution: Select a specific date and time to run the task.

    • End-of-task option: Choose whether to automatically delete the local log file after uploading (optional).

  3. Select Target Devices

    • Filter devices by:

      • Device Name: Enter a name (supports fuzzy search).

      • SN: Enter a serial number (supports fuzzy search).

    • Select the desired devices from the list (multiple selection supported).

  4. Deploy the Task

    • After clicking Publish Task, the task enters In the release status:

      • The system will push the task command to the device for up to 10 minutes.

      • If no acknowledgment is received within 10 minutes, the status changes to No Response.

  5. Task Execution and Status Changes

    • In the release: Task has been sent, waiting for device acknowledgment.

    • In progress: Device has started collecting logs.

    • Done: Task completed, log file uploaded, ready for download.

    • No Response: Device did not respond in time.

    • Force termination: Task terminated by an administrator or system, no log file generated.

  6. View and Follow-up Actions

    • Available actions (depending on status):

      • Force Stop: For In the release or In progress, stop the task immediately.

      • Download: For Done, download the log ZIP file.

      • Retry: For No Response, re-deploy using the original task configuration.

image-20250812204300899

2.2 Download

Description

This feature is used to download the log file uploaded by the device to the local system after the log task has been completed. The downloaded log file will be in a ZIP archive format.

Notes

  • The Download button is available only when the task status is Done.

  • The downloaded log file is in a compressed ZIP format and must be extracted before viewing.

  • It is recommended to store the file securely after downloading for future troubleshooting and record archiving.

  • If the task status is not Done (e.g., "In the release", "In progress", "No Response", "Force termination"), the log file cannot be downloaded.

  • The log file may contain sensitive device operation data; handle it with confidentiality and access control.

Steps

  1. Access the Log Tasks Page

    • Navigate to Toolbox > Log Tasks to view the task list.

    • Optionally, filter target tasks by SN, model, task status, or time range.

  2. Confirm Task Status

    • Locate a task with the status Done in the list.

    • Ensure that the Download button is displayed in the actions column.

  3. Download the Log File

    • Click the Download button.

    • The system will start downloading a ZIP file, named in the format LogTask + Timestamp (Example: LogTask2025-08-12T11-08-07.zip).

    • The file will be saved in the browser’s default download directory.

  4. View Log Content

    • Locate the downloaded ZIP file on your local machine and extract it.

    • Open the log files for analysis and troubleshooting.

2.3 Force Stop

Description

This operation terminates a device log task that is currently in the "In the release" or "In progress" state. Once force terminated, the task will stop immediately and no log files will be generated or uploaded.

Notes

  • This action is irreversible — once executed, the task cannot be resumed.

  • Force termination applies only to tasks in the "In the release" or "In progress" state.

  • Handling results after force termination:

    • In the release: Immediately stop sending task instructions to devices.

    • In progress:

      • Immediately stop task execution.

      • Notify the device to terminate log collection.

      • Delete any locally generated but not yet uploaded log files from the device.

  • Common scenarios for force termination:

    1. The user manually stops the task to terminate log collection.

    2. A new log task is initiated for the same device before the previous one is completed — the old task will be automatically force terminated by the system.

    3. The device reports an abnormal termination (e.g., configured start/end time is earlier than the device system time).

Steps

  1. In the Log Tasks list, locate the target task with a status of "In the release" or "In progress".

  2. Click the Force Stop button.

  3. In the confirmation dialog:

    • Verify that the device SN shown in the prompt is correct.

    • Click Terminate Task to confirm, or click Cancel to abort the operation.

  4. After confirmation:

    • The task status changes to "Force termination".

    • The system stops the log task from being dispatched or executed.

    • (For "In progress" tasks only) The device deletes the current task's local log files.

2.4 Retry

Description

When a log task has the status "No Response", you can use the Retry feature to resend the log collection task, preventing data loss caused by the device not responding in time. The retry operation reissues the task using the original parameters (start time, duration, post-task actions, etc.).

Notes

  • Only tasks with the "No Response" status support the retry operation.

  • Retry will overwrite any existing log task of the same type on the device; any such task will be replaced by the new one.

  • The device must be online to successfully receive the retried task.

  • Retry will not modify other task configurations (e.g., delay/scheduled settings, log retention policy).

Steps

  1. In the Log Tasks list, filter or locate the task record with the "No Response" status.

  2. Click the Retry button next to the corresponding task.

  3. In the confirmation dialog, verify the prompt information (including the device SN).

  4. Click the Retry confirmation button, and the system will reissue the log collection task using the original parameters.

  5. The task status will update to "In the release", waiting for the device to receive and execute it.

3. Device Logs

Description

Centralized view and management of log files proactively uploaded by the device or collected and uploaded through log tasks.

  • Supports searching and locating target log records by SN / Customer Name / Date Range.

  • iMin devices can proactively capture and upload log files via Settings → Labs → Device Logs, suitable for instant troubleshooting.

Notes

  • Log files are saved as ZIP archives, with filenames containing the generation time, for example: LogTask2025-08-12T11-08-07.zip.

  • In the date filter, the end date must be greater than or equal to the start date.

  • Log files may contain sensitive device information — downloading and sharing must comply with data security and privacy regulations.

  • For devices in weak network or offline states, proactively uploaded logs may appear in the list with a delay and will only be viewable/downloadable after successful upload.

Steps

image-20250812204643276

  1. Access the Device Logs page

    • Path: Toolbox → Device Logs

    • The page displays the most recently uploaded log file list by default.

  2. Filter the target log

    • Enter SN in the search bar (supports fuzzy matching).

    • Enter Customer Name (if applicable).

    • Set Start Date – End Date and click Search.

    • Click Reset to clear all filter conditions.

  3. Download log files

    • In the target row, click the Download button to save the log ZIP file locally (filename includes a timestamp for traceability).

    • Unzip locally to view the log contents.

  4. Proactively upload logs from the device (iMin devices)

    • On the device, go to Settings → Labs → Device Logs.

    • Select the required log type (e.g., system logs, trace, bugreport, etc.).

    • Execute capture and upload. After successful upload, the log can be downloaded and viewed on the platform's Device Logs page.

lQLPJwNJIV3ObaHNBDjNB4CwBVqfhGfZjaIIeNYrM0L_AQ_1920_1080

4. My Debuggers

Description

The My Debuggers feature manages the list of authorized personnel who can grant debugging access to devices when USB Debugging Protection is enabled. When USB Debugging Protection is enabled in the KMA device policy, any attempt to enable USB debugging on the device must be verified by an authorized debugger through an email verification code before access is granted, ensuring the security of the debugging process.

This feature supports the following operations:

  1. Add Debugger – Enter the debugger’s name and email, and complete verification via an email code.

  2. Edit Debugger Information – Update the debugger’s name or email.

  3. Delete Debugger – Remove an existing debugger from the authorized list.

Feature Integration

  • The My Debuggers feature works in conjunction with KMA Device Policy → Permission Settings → USB Debugging Protection.

  • When USB Debugging Protection is enabled, if a user on an iMin device goes to Settings → System → Developer Options → USB Debugging and attempts to turn it on, the system will prompt for a debugger email. The debugger will receive a verification code via email, and only after successful verification will debugging mode be enabled.

Notes

  1. Unique Debugger Email – The same email cannot be added for multiple debugger entries.

  2. Email Validity – The debugger must use a valid email to receive verification codes; otherwise, authorization cannot be completed.

  3. Policy Dependency – If USB Debugging Protection is not enabled in the KMA device policy, the My Debuggers feature will not take effect.

  4. Immediate Effect – Changes to debugger information take effect immediately without requiring a device restart.

Steps

1. Add Debugger

  • On the My Debuggers page, click Add Debugger.

  • Enter the debugger’s Name and Email Address.

  • Click Send Email Verification Code, and enter the received code before it expires.

  • Click Submit to complete the addition.

image-20250812204752170

2. Edit Debugger

  • In the debugger list, find the target debugger and click Edit.

  • Update the name or email (email changes require re-verification).

  • Click Save.

image-20250812204805329

3. Delete Debugger

  • In the debugger list, find the target debugger and click Delete.

  • In the confirmation pop-up, click Confirm to remove the debugger from the authorized list.

5. Offline Detection

Description

The Offline Detection feature is designed to periodically check the online status of devices during specified business hours. When a device is detected offline, the system sends email notifications to designated contacts so that business personnel can promptly take action and restore normal device operations.

This feature supports the following operations:

  1. Create Policy – Configure up to three non-overlapping detection time periods per policy, set detection frequency, target devices, and notification rules.

  2. View Policy Details – Check the configured time periods, detection frequency, associated devices, and notification emails.

  3. View Detection Records – Review the results of each detection, including details of offline devices and notification logs.

  4. Edit Policy – Modify the time periods, detection parameters, target devices, and notification rules for existing policies.

  5. Enable/Disable Policy – Quickly control whether an offline detection policy is active.

  6. Delete Policy – Remove a detection policy that is no longer needed.

5.1 Create Policy

Description

The Create Policy function is used to define offline detection rules. The system will periodically check the online status of specified devices or device groups, and when offline devices are detected, alerts will be sent based on the configured notification settings. This ensures that device operations remain under control and issues can be addressed in a timely manner.

The function allows you to set detection periods, detection intervals, notification methods, and recipients. Detection targets can be set by individual devices or device groups.

Notes

  1. Detection Periods

    • Multiple time ranges can be configured, and the system will only run offline detection within these periods.

    • Detection periods must be set according to the selected time zone.

  2. Detection Interval & Notification Rules

    • Minimum interval options: 5/10/15/30/60 minutes; maximum interval cannot exceed 1 hour.

    • Supports two record modes:

      • Every Detection Record – Records and sends a notification each time the device is detected offline.

      • Single Offline Record – Sends a notification the first time a device is detected offline, and will not send further notifications until the device is detected online again.

  3. Notification Method

    • Currently supports email notifications; at least one valid email address must be configured.

    • Email addresses must be in a valid format; otherwise, the policy cannot be saved.

  4. Detection Targets

    • Supports adding detection ranges by device group or individual device.

    • Selecting a device group includes all devices in that group in the detection scope.

  5. Policy Activation

    • The policy becomes active immediately after creation.

    • The detection status can be toggled on/off from the policy list.

  6. Other Rules

    • If a device is detected offline, the system will check again after the set detection interval to confirm the status.

    • If the device comes back online before the end of the detection period, no further offline alerts will be sent.

Steps

  1. On the Offline Detection page, click Create Policy.

  2. Fill in Basic Information:

    • Enter a policy name (required, up to 256 characters).

    • Select the Location and Time Zone for the policy.

    • Set one or more Detection Periods (required).

  3. Click Next to configure Detection Settings:

    • Set detection status (Enable/Disable).

    • Set the detection interval (required).

    • Select detection targets (device groups or individual devices) and mark the target(s).

    • Configure recording/notification rules.

    • Select the notification method and add notification email(s) (required).

    • Fill in remarks (optional).

  4. Click Submit to save the policy. The system will execute detection tasks within the configured time periods.

5.2 Details

Description

The Details function allows you to view the complete configuration information of an offline detection policy, including its basic information, detection settings, target devices, and notification methods. This feature helps users quickly verify the policy's activation status, detection scope, and alert notification recipients, enabling efficient management or adjustments when needed.

Steps

image-20250812205231076

  1. On the Offline Detection page, locate the policy you want to view and click the Details button in the corresponding row.

  2. The system will open the policy details page, displaying the following sections:

    • Basic Information – Policy name, location, time zone, detection periods.

    • Detection Settings – Detection status, detection interval, recording/notification rules.

    • Detection Devices – Target devices listed by group or as individual entries, including device name and serial number.

    • Notification Methods – Notification type (email), email recipient list, and remarks.

  3. Review the configuration details as needed and decide whether to return to the list page to edit or perform other actions.

5.3 Monitoring Records

Description

The Detection Records feature provides a centralized view of the execution results of a specified offline detection policy within its configured detection periods. It displays the total number of devices checked, the number of offline devices, as well as detailed information on offline devices and corresponding notification records. This feature enables users to trace device offline events and notification history, ensuring timely awareness of device status and the ability to take corrective actions.

Notes

  1. Only data from created and executed offline detection policies is displayed.

  2. Records are sorted in reverse chronological order and can be filtered by detection period, device SN, and other parameters.

  3. Offline device details include device SN, model, offline time, offline duration, and whether a notification was triggered.

  4. Notification records display the notification method, recipient email addresses, and sending status.

Steps

  1. In the Offline Detection module, click the Monitoring Records button next to the target policy.

  2. In the list, review the execution results for each detection period, including total devices checked and the number of offline devices.

  3. Click Details to open the Offline Devices tab, where you can view specific offline device information.

  4. Switch to the Notification Records tab to review details of notifications triggered during the detection.

  5. Use the top search bar to filter historical detection records based on desired criteria.

5.4 Edit

Description

The Edit function allows you to modify all details of an existing offline detection policy, including the policy name, detection time periods, associated devices (or device groups), detection intervals, notification methods, email lists, and remarks. This feature is useful when the policy requirements change or when monitoring settings need optimization, ensuring that the policy continues to operate effectively under the latest business needs.

Notes

  1. Editing will directly affect the execution rules of the current policy and will take effect immediately upon saving. Please verify all changes before submitting.

  2. When adjusting detection time periods, ensure the total duration aligns with business needs to avoid monitoring gaps.

  3. Modifying the detection interval or notification rules may affect the frequency of email alerts and the timeliness of notifications.

  4. Editing a policy will not delete existing detection records, but future records will be generated according to the new configuration.

  5. When updating the email list, ensure the addresses are valid and that recipients have permission to receive alert emails.

Steps

  1. In the Offline Detection list, locate the policy you want to modify and click the Edit button.

  2. In the Basic Information tab, you can update:

    • Policy name

    • Location

    • Time zone

    • Detection time periods (add, delete, or adjust)

  3. Click Next to enter the Detection Configuration tab and adjust:

    • Detection status (Enable/Disable)

    • Detection interval

    • Detection devices (select by device group or individual devices)

    • Recording/notification rules

    • Notification method and email list

    • Remarks

  4. Once all changes are made, click Save to apply.

  5. After the system confirms the save, the new configuration takes effect immediately.

5.5 Detection Status – Enable/Disable

Description

This function allows you to quickly control the operational status of an offline detection policy. When enabled, the system will periodically check the online status of devices according to the policy settings and execute the notification rules if any device is found offline. When disabled, the system will pause detection and stop sending notifications for that policy.

Notes

  • Changes to the detection status take effect immediately; no additional save action is required.

  • Disabling a policy does not delete its configuration; it can be re-enabled later.

  • While a policy is disabled, the system will not perform offline checks or generate notification records.

Steps

  1. In the Offline Detection list, locate the policy whose detection status you want to change.

  2. In the Detection Status column, toggle the switch to:

    • On (Green): Enable the offline detection policy.

    • Off (Gray): Disable the offline detection policy.

  3. The system will immediately apply the change and update the detection status.

5.6 Delete

Description

Used to delete an existing offline detection policy. Deleting a policy removes the policy and its detection schedule. The system will no longer monitor the online status of devices associated with that policy and will stop sending related offline notification emails.

Notes

  • This action is irreversible. Ensure the policy is no longer needed before deletion.

  • After deletion, past detection records will remain in the system and can still be viewed in the Detection Records section.

  • If you need to enable the same detection logic again, you must create and configure a new policy.

Steps

  1. In the Offline Detection list, locate the policy you want to delete.

  2. Click the Actions button on the right side of the policy row and select Delete.

  3. The system will display a Confirm Delete dialog box with the prompt: "Are you sure you want to delete this?".

  4. Click Confirm to complete deletion, or Cancel to abort the action.

Did this answer your question?