Deployments
Overview
A Deployment is the task responsible for sending and uploading a configuration into a device group. Even though configurations are available to all sites in the account, deployments are tasks which are limited to the site they are created in. Deployments can only initiate if the devices of the target device group fulfill the default deployment criteria:
•each device must have more than 20% battery power,
•each device must have more than 20% WWAN/WLAN network coverage,
•each device must either have App Desktop open OR if an MCL application is running, that application must be idle for more than 1 minute.
To access the Deployments sub-module, click (in the Control Panel) and, in the resulting row below, click
.
The image below illustrates the "Deployment Plans" page that is accessed when clicking .
This page displays the deployments created in the current site. This information has four "view modes" which work as filters: All, Current & Planned, Planned and With Errors.
View Modes
To select the most appropriate view, click (located below the deployment icon) to access the "Mode" drop-down box and select one of the available options.
Each view displays the deployments that meet the view's criteria. To ensure the viewing of all deployments, select "All".
View Mode: All
This "view mode" displays all the site's deployments with the following information:
Status |
Possible deployment statuses: Planned - no device included in the target device group has received the assigned configuration. Active - no device included in the target device group has received the assigned configuration but the deployment reached the scheduled installation date. Started - at least one device of the specified device group has received the assigned configuration. The deployment maintains this status until a new deployment is assigned to the target device group. Archived - the deployment was archived because another deployment, with a more recent configuration version, was created. Canceled - the deployment had reached an "active" status but was deleted/canceled.
If there is a problem with a deployment's execution, the corresponding progress bar will turn brown. Use the "With Errors" view to identify all the failed deployments and correct them. For more detailed info on the error(s), check the device's history (see Device Details - History - DPL tab) and perform the necessary corrections.
Ex: When an ongoing deployment (with a "Started" status) is erased, MCL-Mobility Platform retrieves the latest archived deployment, regardless of its success/failure. If you consistently remove any archived failed deployments, this system fail-safe will only retrieve successful deployments. |
Date |
The deployment's planned date and time. |
Plan Name |
The deployment's name (displayed in light blue). Provides direct t access to the corresponding "Deployment Plan Details" page. See Deployment Plan Details. |
Group |
The target device group for the deployment (displayed in light blue). Provides direct access to a "Devices" page with all the devices included in that device group. See Devices. |
Configuration |
The name of the configuration being deployed. |
Ver. |
The version of the configuration being deployed. |
Mode |
The selected deployment mode: Full - refers to the "Full Install" deployment mode. Inc - refers to the "Incremental" deployment mode. |
Devices |
The number of devices included in the target device group of an ongoing or archived deployment. Therefore, if the deployment has not started, there is no information. |
Progress |
The number of devices where the deployment has been completed with success. The progress bar refers to the deployment's evolution within the target device group. If the progress bar changes its color to brown, it means the deployment was not successfully completed. |
View Mode: Current & Planned
This "view mode" displays the planned and ongoing/active deployments (in light blue) and corresponding information:
Status |
Possible statuses for "current and planned" deployments: Planned - no device included in the target device group has received the assigned configuration. Active - no device included in the target device group has received the assigned configuration but the deployment reached the scheduled installation date. Started - at least one device of the specified device group has received the assigned configuration. The deployment maintains this status until a new deployment is assigned to the target device group. |
Date |
The deployment's planned date and time. |
Plan Name |
The deployment's name (displayed in light blue). Provides direct t access to the corresponding "Deployment Plan Details" page. See Deployment Plan Details. |
Group |
The target device group for the deployment (displayed in light blue). Provides direct access to a "Devices" page with all the devices included in that device group. See Devices. |
Configuration |
The name of the configuration being deployed. |
Ver. |
The version of the configuration being deployed. |
Mode |
The selected deployment mode: Full - refers to the "Full Install" deployment mode. Inc - refers to the "Incremental" deployment mode. |
Devices |
The number of devices included in the target device group of an ongoing or archived deployment. Therefore, if the deployment has not started, there is no information. |
Progress |
The number of devices where the deployment has been completed with success. The evolution bar refers to the deployment's progress within the target device group. If the progress bar's color changes to brown, it means that the deployment has failed. The corresponding deployment will also be displayed in the "With Errors" view. |
View Mode: Planned
This view only displays scheduled deployments (which have not occurred yet) with the following information:
Status |
Planned - The deployment has not started yet, no device included in the target device group has received the assigned configuration. |
Date |
The deployment's planned date and time. |
Plan Name |
The deployment's name (displayed in light blue). Provides direct t access to the corresponding "Deployment Plan Details" page. See Deployment Plan Details. |
Group |
The target device group for the deployment (displayed in light blue). Provides direct access to a "Devices" page with all the devices included in that device group. See Devices. |
Configuration |
The name of the configuration being deployed. |
Ver. |
The version of the configuration being deployed. |
Mode |
The selected deployment mode: Full - refers to the "Full Install" deployment mode. Inc - refers to the "Incremental" deployment mode. |
Devices |
The number of devices included in the target device group of an ongoing deployment or archived deployment. Therefore, at this stage, there is no information. |
Progress |
There is no progress information (the deployment has not started). |
View Mode: With Errors
The "With Errors" view only displays deployments that were not successful along with the following information:
Status |
Active/Started - The status of the deployment when it failed. |
Date |
The deployment's planned date and time. |
Plan Name |
The deployment's name (displayed in light blue). Provides direct t access to the corresponding "Deployment Plan Details" page. See Deployment Plan Details. |
Group |
The target device group for the deployment (displayed in light blue). Provides direct access to a "Devices" page with all the devices included in that device group. See Devices. |
Configuration |
The name of the configuration being deployed. |
Ver. |
The version of the configuration being deployed. |
Mode |
The selected deployment mode: Full - refers to the "Full Install" deployment mode. Inc - refers to the "Incremental" deployment mode. |
Devices |
The number of devices included in the target device group of the ongoing deployment. |
Progress |
The number of devices where the deployment has failed. The color brown of the progress bar indicates that the deployment has failed. |
A failed deployment requires the user to execute corrective measures or it will keep on trying to execute.
For more detailed info on the error(s), check the device's history (see Device Details - History - DPL tab) and perform the necessary corrections.
If you create a new deployment (a deployment with a corrected configuration), the failed deployment will be archived (with an "Archived with Errors" status) as soon as the new deployment initiates. We recommend you erase the archived failed deployment to avoid future issues.
Ex: When an ongoing deployment (with a "Started" status) is erased, MCL-Mobility Platform retrieves the latest archived deployment, regardless of its success/failure. If you consistently remove any archived failed deployments, this system fail-safe will only retrieve successful deployments.
The "Deployment Plans" page also offers the following options:
Use these buttons to control how many items are displayed at a time. Click one of the options (10 items per page/20 items per page/50 items per page/100 items per page).
Use this button to export a list with the deployments in view. Proceed as follows:
Since the export only includes the information on current display, make sure the page is displaying the intended deployments before you begin the export. To select the most appropriate view, click
(located below the Deployment icon) to access the "Mode" drop-down box and select one of the available options.
a. Click .
b. Click .
The deployment list is exported with an Excel file format.
The conclusion of the export operation depends on the web browser used. You should be able to save the Excel file in your PC or open it directly after the download.
Click this button to refresh the page's information.
Use the buttons, included in this bar, to organize the listed items of the corresponding column:
•by ascending order.
• by descending order.
Click this button to select all the listed items on display. In this case, the deployments.
Available Operations
To create a deployment, use the button. For more detailed information, see Creating a Deployment.
To delete/cancel a deployment, use the button. For more detailed information, see Deleting/Canceling Deployments.
This chapter includes all the aspects associated to deployments (the creation/planning, viewing and canceling of this specific task). The table below refers the user profiles that have access to the described operations:
Keep in mind that the Account Administrator and/or the Site Manager, at a lower level, can restrict other users' access rights. This user guide is presenting all the possibilities in terms of access.
Topic/Operations |
Description |
User access |
---|---|---|
View/edit the details of a deployment. |
Account Administrator Site Manager Site User |
|
Create a deployment of existing configurations (see Creating a Configuration) to specific device groups. |
Account Administrator Site Manager Site User |
|
Define a date/time for a deployment to start. |
Account Administrator Site Manager Site User |
|
Edit deployments with a "Planned" and/or "Active" status. Once the deployment starts ("Started" status), it will NOT be possible to edit it. |
Account Administrator Site Manager Site User |
|
If required, cancel a deployment. |
Account Administrator Site Manager Site User |