Monitor Operations

This tutorial describes how to monitor operations.

An operation is the action that's performed on a target device set in a campaign. When a campaign is executed, it results in multiple operations generated for each device included in the campaign.

Monitor Operations

To monitor operations:

1. Login to the Knox E-FOTA Advanced portal.
2. Go to: Campaign Management > Operations.

The following details are displayed:

• Device ID—International Mobile Equipment Identity number (IMEI).
• Start Date—Start date and time the operation was created.
• Model—Device model number and vendor.
• Campaign Action—Action set when the campaign was created.
• Campaign name—Campaign name indicated when the campaign was created.
• Update Content—Content set to be updated, for example: the target software, profile name, or client configuration.
• Status—Operation status.

  There are two main types of operation statuses:

  1. Completed status—Completed or closed operation statuses. The following are possible statuses:
     • Canceled—The user canceled the operation, or the server canceled the operation to prioritize an urgent server-initiated operation. Urgent operations include Deploy Selected Software Versions, Get Client Logs, Update All Software to the Latest Version, or Update Selected Software to the Latest Version.
     • Failed—The operation failed. This may be due to device problems, failed installation, network connectivity failures, configuration failures, portal issues, problems with the update files or a locked device.
     • Not Reported—The download package (DP) was successfully downloaded, but the device hasn't sent a report to the server. 
     • Partially Updated—The update was partially downloaded to the device.
     • Rejected—The device user declined the update.
     • Success—The operation was successful.
     • Timed Out—The campaign period has ended, and the device wasn't able to connect to the server or hasn't submitted a report to the server.
     • Up-to-date—All devices on the operation have the latest updates.
  2. Ongoing (Running) status—The latest ongoing or running operation status. The following are possible statuses:
     • DD sent—The device has received the deployment descriptor (DD) and is awaiting the next status.
     • DL canceled—The download was canceled.
     • DL Session Deferred—The device package (DP) download was postponed.
     • DL Session Failed—The device failed to download the update file.
     • DL Session Interrupted—The download was interrupted. This may be due to network issues, the user pausing the download or client-side issues.
     • DL Session Resumed—The download has resumed after an interruption.
     • DL Session Started—The download has started.
     • DL in Progress—The download is in progress. This status may include the percent completed.
     • DM Session Started—The device management (DM) session started on the device.
     • DM Session in Progress—The device management (DM) session is currently in progress.
     • Failed - Waiting for Retry—A failed operation will retry if the maximum limit for retries hasn't been reached and the campaign remains active.
     • In Progress—An action is in progress.
     • Installation Canceled—The download package installation was cancelled.
     • Installation Completed (DP)—The download package was successfully installed on the device.
     • Installation Completed (Update File)—The update file was successfully installed on the device.
     • Installation Deferred—Installation of a download package or update file was deferred.
     • Installation Started (DP)—The download package has started to install on the device.
     • Installation Started (Update File)—The update file has started to install on the device.
     • Partially Updated - Waiting for Retry—Part of the update was successfully downloaded, and will retry if the maximum limit of retries hasn't been reached and the campaign remains active.
     • Pending—The operation remains pending. This may be because the campaign start date and time is yet to occur, the server initiated messages has yet to be triggered or the device has yet to start the device management (DM) session.
     • Push Notification Received—The device has received the push notification.
     • Rejected - waiting for Retry—The operation has been rejected, and will retry if the maximum limit for retries hasn't been reached and the campaign remains active.
     • Running—Filter all operations that are currently running.
     • Server Initiated Message in Progress—The server-initiated campaign was triggered and the device management (DM) session has yet to begin.
     • Waiting for User DL Confirm—Waiting to receive download confirmation from the device user.
     • Waiting for User Install Confirm—Waiting to receive installation confirmation from the device user. Installation phases include: Pre-install, install, and post-install.

  NOTE—When initiating an operation to push an update file, a missing delta update file can result in a -7032 error. For more details on troubleshooting operational statuses, see Knox E-FOTA Advanced Error Codes.
• Status Info—Additional details related to the operation's status.
• Retry #—Indicates the number of times the campaign has set the operation to retry.
• Domain—Domain name indicated when the campaign was created.
• Actions—Actions performed on the specific operation.

  Options include:

  • Stop—Stops a running or pending operation. Selecting this sets the Status to "Canceled".
    • Delete—Appears for operations with either of the following statuses: "Canceled" or "Completed". This action deletes the operation from the operations list.
  • Get Data Package—Enabled when the admin selects Get the Client Log when a campaign is executed.

Operation details

You can click the arrow beside the device ID to view additional details related to the operation.

Learn more about the details outlined:

• Operation ID—Unique identifier of the operation. You can use this to apply a filter on the operations list.
• Campaign ID—ID generated when the campaign was executed.
• Campaign Run ID—A campaign generates a Campaign ID when executed, and since campaigns can be set to retry operations if a push update fails, each retry also generates a Campaign Run ID. Note that there can be more than one Campaign Run ID generated per campaign.
• End date—End date and time of the operation, specified under Campaign period when the campaign was created.
• Update Content—Displays the software's name for software updates, or displays the success/fail status for device configuration pushes.
• Device inventory—Displays ID, name, vendor, version and variant details for software updates, or success/fail status for device configuration pushes.
• Dependent Group—Lists the software, vendor, and version detail.
• Updates—Displays the source and target version for software updates, or displays the FOTA device configuration.
• Creation User—Displays the user name of the admin that created the operation.
• DP retrieved from cache?—Displays true or false, depending on whether deployment packages were reused from the Knox E-FOTA Advanced portal cache.
• Campaign Initiator—Displays the user name of the admin that created the campaign.
• Download Time Slot—Displays the time range set by the admin for the device to download updates when the campaign was created.
• Wi-Fi Only Expiration Date & time—Displays when the Wi-Fi only restriction expires.
• Data download over mobile network—Displays Yes if downloads over a mobile network is allowed. Otherwise this displays No.
• Max data downloaded over mobile network—Displays the maximum download size (in megabytes) permitted for download over a mobile network.
• Network load—Displays the allowable data quota downloaded per time frame (in minutes or hours). This is set in campaign when customizing network options for network balancing.
• Update Start Time—Displays the update start time set by the admin when the campaign was created.
• Critical Update—Displays Yes if the critical update option was selected when the campaign was created. Otherwise, this displays No.
• Silent Update—Displays Yes if the silent update option was selected when the campaign was created. Otherwise, this displays No.
• Server Initiated Campaign—Displays Yes if the operation includes a server initiated message sent to device users. Otherwise this displays No.
• Policy ID—Policy ID associated with the operations.

Filter operations

You can apply search filters to operations to narrow down what's displayed on the operations list. This is useful when generating specific export reports.

To set a filter on the operations list:

1. Go to Campaign Management > Operations.
2. Specify your desired filters.
3. Optionally, select Filters for export only if the filters are for the purpose of generating an export. This ensures the filter is only applied until the export is generated, after which its automatically cleared after the specified date.
4. Click Apply.

To clear the filters, be sure to click Reset if the Filters for export only wasn't selected.

Generate an Export Report

When setting a filter on the operations list, you can apply the filter for export purposes only, which is useful when generating a specific export report. Note that during installation, you can configure the system to send the report to an email or shared directory.

To generate a CSV file export report:

1. Go to Campaign Management > Operations.
2. Specify your desired filters.
3. Optionally, select Filters for export only if the filters are for the purpose of generating an export. This ensures the filter is only applied until the export is generated, after which its automatically cleared after the specified date.
4. Click Apply.
5. Click Export.

   

 

Share it: