Create a Deployment
Complete the following steps to deploy a published package:
1. In the navigation pane under Deployments, click DEPLOYMENT > Create Deployment. The Create Deployment page opens, containing the following sections: Package Information, Deployment Information, Asset Information, and Notifications.
2. Verify that the package you want to deploy is displayed in the Package Information field. This field displays the most recently created or selected package. If you want to deploy a different package, click Switch Package icon and select the package from the Find Packages For Deployment page. For more information, see Find Packages for Deployment.
3. Expand the Deployment Information section. Select the type of deployment: One Time (the default) or Perpetual. Enter the required information for the deployment type. For more information, see the One-Time Deployment and Perpetual Deployment sections at the end of this topic.
4. Expand the Asset Information section to access the asset search functionality and select the assets for this deployment. For more information, see Saved Asset Searches.
5. Optionally, you can expand the Notifications section to set up notifications for the deployment. For more information, see Notifications.
6. Click Start to start the deployment. The Start button is enabled after the required information has been provided in the Deployment Information section, there is a a value of at least 1 for the Total Target Assets field, and all sections are collapsed.
After the deployment has been started, you can track its status. For more information, see Track Package Deployment.
One-Time Deployment 
A one-time deployment is typically used for a single instance or event. The deployment is not intended to be updated after it has been installed.
When you are creating a one-time deployment, complete the following steps in the Deployment Information section:
1. From the Type field, select One Time.
2. Enter a name for the deployment in the Name field.
3. Optionally, you can select the Test or Reinstall checkboxes:
If you want the deployment to be a test deployment, select the Test checkbox. When Test is selected, you can enter a name and description for the deployment; all other fields in the Deployment Information section are disabled, along with the Notifications section. For more information, see Create a Test Deployment.
If the package was previously installed on a target asset, you can select the Reinstall checkbox and the package will be reinstalled. If the Reinstall checkbox is not selected, and the package was previously installed on a target asset, that asset is skipped by the deployment.
4. Optionally, you can add a brief description in the Description field.
5. You can enter a value in the Priority field. If the priority is not set, the deployment is prioritized based on the time of creation. The priority value range is 1 to 1000, where 1 is the highest priority. For more information, see Deployment Priority.
* 
The Scan Frequency (Mins) field is not applicable for a one-time deployment.
6. Configure Retry Attempt settings:
If you want unlimited retry attempts for the deployment, select the Unlimited checkbox.
If you want the deployment to be automatically retried for a specific number of times, enter that number in the Count field. By default, the Count value is set to 5. For information about configuring this option, see Configuration Parameters for Auto-Retry.
* 
When you select the Unlimited checkbox, the Count field is hidden.
7. If you want the deployment to be automatically retried after a specific time interval, configure the Interval settings. Use the Hours and Minutes fields to specify that interval in 24-hour format. By default, the interval is set to 00:00.
8. If you want the deployment to be automatically retried during a specific time window on certain days, configure the Window settings . Enter the Start Time and End Time values for the time window using the 24-hour format and select the days from the Days list. The start and end times are in the time zone set for the ThingWorx Platform.
9. For instruction-based packages, select when the deployment starts from the Deployment Start Time options:
Immediately—The deployment starts immediately.
Date—The date and time when the deployment must start. By default, this value is set to 24 hours after the current time. The value can be edited, but must be later than the current time.
10. For file-based packages, select when the package will be downloaded from the Package Download Time options:
Immediately—The package is downloaded immediately.
Date—The date and time when the package is to be downloaded. By default, this value is set to 24 hours after the current time. The value can be edited, but must be later than the current time.
11. For file-based packages, select when the package will be installed from the Package Install Time options:
Immediately (through 9.7.0) or On Download (as of 9.7.1)—The package will be installed one minute after the download has completed.
Date—The date and time when the package installation must start. By default, this value is set to 24 hours after the current time. The value can be edited, but must be later than the current time and at least one minute later than the download completion time.
12. If you have selected a file-based package for deployment, you can also set the Parameter Name and Parameter Value in the Script Parameters (Optional) section. Click plus sign icon to save the script parameters.
13. Click Save to save the deployment information.
The Clear button resets all input fields to their default state.
Perpetual Deployment 
A perpetual deployment allows new assets that meet the defined criteria to be added to the deployment, without creating a new deployment. The system regularly searches for assets that meet the criteria defined for the selected saved asset search and adds them to the deployment. The package is then deployed to the new assets.
Once started, a perpetual deployment continues scanning for and deploying the package to new assets until the package expires or a user cancels the deployment.
When you are creating a perpetual deployment, complete the following steps in the Deployment Information section:
1. In the Type field, select Perpetual.
2. Enter a name for the deployment in the Name field.
3. Optionally, you can select the Reinstall checkbox. When this checkbox is selected, if the package had been previously installed on a target asset, the package will be reinstalled. If the Reinstall checkbox is not selected, and the package was previously installed on a target asset, that asset is skipped by the deployment.
* 
Do not select the Test checkbox for a perpetual deployment. If you select the Test checkbox, the deployment is changed to a one-time, test deployment. For more information, see Create a Test Deployment.
4. Optionally, you can add a brief description in the Description field.
5. You can enter a value in the Priority field. If the priority is not set, the deployment is prioritized based on the time of creation. The priority value range is 1 to 1000, where 1 is the highest priority. For more information, see Deployment Priority.
6. Set a Scan Frequency (Mins) for the deployment. Scan frequency is the rate at which a scanning process is performed. The system searches for assets that match the defined criteria based on the time duration. New assets found during the scan are added to the deployment list. The scan frequency values range from 1 minute to 1440 minutes (24 hours). The scan frequency adds the package to the deployment list until the expiration of the package. If no scan frequency is specified on the deployment, then the updateRate for the TW.RSM.SFW.Timer.ScanDeploymentsTimer timer is used.
7. Configure the Retry Attempt settings:
If you want unlimited retry attempts for the deployment, select the Unlimited checkbox.
If you want the deployment to be automatically retried for a specific number of times, enter that number in the Count field. By default, the Count value is set to 5. For information about configuring this option, see Configuration Parameters for Auto-Retry.
* 
When you select the Unlimited check box, the Count field is hidden.
8. If you want the deployment to be automatically retried after a specific time interval, configure the Interval settings. Use the Hours and Minutes fields to specify that interval in 24-hour format. By default, the interval is set to 00:00.
9. If you want the deployment to be automatically retried during a specific time window on certain days, configure the Window settings . Enter the Start Time and End Time values for the time window using the 24-hour format and select the days from the Days list. The start and end times are in the time zone set for the ThingWorx Platform.
10. For instruction-based packages, select when the deployment starts from the Deployment Start Time options:
Immediately—The deployment starts immediately.
Date—The date and time when the deployment must start. By default, this value is set to 24 hours after the current time. The value can be edited, but must be later than the current time.
11. For file-based packages, select when the package will be downloaded from the Package Download Time options:
Immediately—The package is downloaded immediately.
Date—The date and time when the package is to be downloaded. By default, this value is set to 24 hours after the current time. The value can be edited, but must be later than the current time.
12. For file-based packages, select when the package will be installed from the Package Install Time options:
Immediately (through 9.7.0) or On Download (as of 9.7.1)—The package will be installed one minute after the download has completed.
Date—The date and time when the package installation must start. By default, this value is set to 24 hours after the current time. The value can be edited, but must be later than the current time and at least one minute later than the download completion time.
13. If you have selected a file-based package for deployment, you can also set the Parameter Name and Parameter Value in the Script Parameters (Optional) section. Click to save the script parameters.
14. Click Save to save the deployment information.
The Clear button resets all input fields to their default state.
Was this helpful?