Deployment View
¶
HOWTO video on Deployment View
Figure 1
Upon login, the user will reach the Deployment View as seen above in Figure 1.
In general, Deployment View is where a user can update a single target device or small groups of target devices and also observe a number of statuses and other information. The following describes the purpose of the different containers within the Deployment View.
- Filters: Only specific target devices will be displayed using simple filters, custom filters, or by filter status.
- Targets: Target devices will be listed here based on the currently applied filter(s).
- Distributions: Drag and drop pre-configured distribution sets (one or more updates) to a single target device or group of target devices.
- Filter by Tag: Only specific Distributions will be displayed by applying Tags.
- Action History: Displays each software update event for the selected Target Device. There are five fields of data: Active, Distribution set, Date and Time, Status, Forced and Actions.
Note
Updating the selected target device(s) to a specific distribution is done by drag-and-drop.
Filters¶
Figure 2
If a filter has greyed out, this means that the particular filter has been enabled/selected.
Create/Update a Tag (Targets)¶
Clicking the gear icon will allow the user to either create a new, or update a current Simple Filter. Simple Filters can be applied to Target Device or Rollout parameters.
Close¶
Clicking the close icon will close the container.
Filter¶
To open the Filters container again, click the filter icon in the Targets container.
To filter Target Devices by Status, click on a color icon in the Filter by Status section. In Figure 2, Green is selected.
-
Green - Synchronized
-
Yellow - Pending
-
Red - Error
-
Blue - Registered
-
Dark Blue - Overdue
Custom Filters can also be created by clicking: Custom Filter.
Targets¶
Figure 3
Search¶
Clicking the Search icon will enable the user to query by any string inside the container.
Add (Plus icon)¶
By clicking the Plus icon, the user can configure a New Target.
This is a manual procedure to create one target device at a time before it connects for the first time to Update Factory.
Security Token (aka targetToken)¶
From each specific device, you can retrieve information like the Security Token (aka targetToken), as seen here:
At this point, you can insert the Security Token into the devices' ufConf.conf.
Note
Each Security Token is intended for a unique device.
Bulk Upload¶
For situations where you may have more than one device that you want to create in advance, you will use the Bulk Upload tool. Click the icon above, and then at the bottom of the next popup window, click the Bulk Upload button:
This open a browse window where you will need to provide a CSV formatted file, with the following format:
Controller_id_1,targetName1
Controller_id_2,targetName2
...
...
Expand / Shrink Container¶
Clicking the Expand icon will increase the size of the particular container. To go back to the small size, the user can click the Shrink icon.
Edit Target Device Info¶
Clicking the Edit icon in the lower container allows the user to make changes to a Target Device’s Name and Description.
Delete a Target Device¶
Dragging a Target Device to the Drop here to delete icon, will set the Target Device to delete. Additionally, confirmation is required.
Distributions¶
Figure 4
Search¶
Clicking the Search icon will enable the user to query by any string inside the container.
Shrink / Expand Container¶
Clicking the Expand icon will increase the size of the particular container. To go back to the small size, the user can click the Shrink icon.
Edit Distribution info¶
Clicking the Edit icon in the lower container allows the user to make changes to the currently selected Distribution including: Type, Name, Version, Description and whether the particular Distribution is a Required Migration Step.
Edit Metadata¶
Clicking the Manage Metadata icon in the lower Container allows the user to make changes to Meta data regarding the currently selected Distribution.
Filter¶
To open the Filter by tag container, click the filter icon in the Distributions container.
Filter by tag¶
Figure 5
Create/Update a Tag (Distributions)¶
The Gear icon is used for editing Tags for distributions.
Close¶
The Close icon will close the Filter by tag container.
If a Tag has greyed text, this means that the tag is selected/enabled.
Confirm Assignment¶
Once you finish dragging a distribution to a device, a new popup window appears titled: Confirm Assignment. Here, you have the option on how and/or when you prefer to cause the device to be updated using one of three options: Forced, Soft or Time Forced. These options behave as follows:
- Forced: Apply immediately the distribution to the chosen device, (as soon as the device polls next)
- Soft: Provide a popup window on the target device for a user or technician to click "OK" to accept the update.
- Time Forced: Apply the distribution to the chosen device at a certain date and time.
By enabling the Use maintenance window option, the user can apply the distribution on a repeat schedule.
Schedule¶
The Schedule field uses what are called "cron expressions", which define firing schedules. For example: "At 10:00pm every Sunday through Wednesday" (0 0 22 ? * SUN-WED
) or "At 1:45am every last Friday of the month" (0 45 1 ? * 6L
).
Schedule Format¶
A cron expression is a string comprised of 6 or 7 fields separated by white space. Fields can contain any of the allowed values, along with various combinations of the allowed special characters for that field. The fields are as follows:
Seconds | Mandatory | Allowed Values | Allowed Special Characters |
---|---|---|---|
Seconds | YES | 0-59 | , - * / |
Minutes | YES | 0-59 | , - * / |
Hours | YES | 0-23 | , - * / |
Day of month | YES | 1-31 | , - * ? / L W |
Month | YES | 0-11 or JAN-DEC | , - * / |
Day of Week | YES | 1-7 or SUN-SAT | , - * ? / L # |
Year | NO | empty, 1970-2099 | , - * / |
Duration¶
The duration of the maintenance window in hh:mm:ss format.
Time Zone (from GMT)¶
Here you can define the timezone based on GMT.