Create a Deployment
Complete the following steps to deploy a published package:
1. Ensure that the package that you want to create a deployment for is displayed in the Package Information layout.
This field displays the last package that was created or the last package that was selected. If you want to deploy a different package, click 
, and select the correct package from the Find Packages For Deployment page.
, and select the correct package from the Find Packages For Deployment page.2. Navigate to Deployment Information and name the deployment using the Deployment Name field.
Select the Deployment type using the drop down. You can have either a One Time or a Perpetual deployment.
3. Once you have filled all the mandatory criteria in Deployment Information and Asset Information fields, click the Start button.
 | The Start button will not activate unless the mandatory criteria has been fulfilled. |
One Time Deployment
One-time deployment typically refers to the act of deploying a package for a single instance or event. It also means that the deployment is not intended to be regularly updated or modified after the initial installation.
Perform the following steps for One Time deployment:
1. In the Deployment Information field select One Time deployment in the Type field.
2. Enter a Name of the deployment.
3. If you select the Test checkbox, the package deployment will be marked as a test. This is used to validate the package.
4. If you select the Reinstall checkbox, the package which has already been deployed will be reinstalled.
| | Selecting either of the Test or Reinstall checkbox is entirely optional. If you have not checked any of them, the package will proceed further for actual deployment. |
5. Add a brief description in the Deployment Description field. This is an optional step.
6. Set a Priority for the deployment. This is an optional setting. In case if the Priority is not set, the deployment is based on the time when it is created.
| | Priority can be set in the range of 1 to 1000, where 1 is the highest priority. The Scan Frequency field is not applicable for One Time deployment. |
7. If you want unlimited retry attempts for a deployment, select the Unlimited check box. If you want the deployment to be auto retried for a finite number of times, enter the count in the Count field. By default, it is set to 5. For information about configuring this option, see Configuration Parameters for Auto-Retry.
| | When you enable the Unlimited check box, the Count field will hide. |
8. Interval: If you want deployment to be auto retried after a specific time interval, you can enter the hours and minutes in the Hours and Minutes field of the interval. The interval is in 24-hour format.
9. Window: If you want a deployment to be auto retried during a time window and only on specific days, then you can use this window option. You can specify the window using the start time, end time and Days fields.
| | The start and end times are in 24-hour format and these times are as per the Thingworx Platform time zone |
10. Deployment Start Time for instruction-based packages. This is the time when the deployment starts. Select one of the following options:
◦ Immediately — Select to start the deployment immediately.
◦ Date — Select to specify the date and time at which the deployment must start.
11. The Package Download Time and Package Install Time fields get activated for file-based packages. Select one of the following options:
◦ Immediately — Select to start the deployment immediately.
◦ Date — Select to specify the date and time at which the deployment must start.
Perpetual Deployment
Perpetual deployment allows the addition of a new asset belonging to a defined criteria without the requirement of creating a new deployment. The deployment will be carried out in asynchronous mode.
Perform the following steps for Perpetual deployment:
1. In the Deployment Information field select Perpetual deployment in the Type field.
2. Enter a Name of the deployment.
3. If you select the Reinstall checkbox, the package which has already been deployed will be reinstalled.
| | Test is not applicable for Perpetual Deployment. Selecting the Reinstall checkbox is entirely optional. If you have not selected the checkbox, the package will proceed further for actual deployment. |
4. Add a brief description in the Deployment Description field. This is an optional step.
5. Set a Priority and Scan Frequency for the deployment.
| | Priority can be set in the range of 1 to 1000, where 1 is the highest priority. Scan frequency typically refers to the rate at which a scanning process is performed. The system will scan for assets matching the defined criteria based on the defined time duration. Any new assets found during the scanning will be added to the deployment list. The Scan Frequency values range from 1 min to 1440 min (24 hour). The scan frequency will add the package to the deployment list until the scheduled expiration of the package. |
6. If you want unlimited retry attempts for a deployment, select the Unlimited check box. If you want the deployment to be auto retried for a finite number of times, enter the count in the Count field. By default, it is set to 5. For information about configuring this option, see Configuration Parameters for Auto-Retry.
| | When you enable the Unlimited check box, the Count field will hide. |
7. Interval: If you want deployment to be auto retried after a specific time interval, you can enter the hours and minutes in the Hours and Minutes field of the interval. The interval is in 24-hour format.
8. Window: If you want a deployment to be auto retried during a time window and only on specific days, then you can use this window option. You can specify the window using the start time, end time and Days fields.
| | The start and end times are in 24-hour format and these times are as per the Thingworx Platform time zone |
9. Deployment Start Time for instruction-based packages. This is the time when the deployment starts. Select one of the following options:
◦ Immediately — Select to start the deployment immediately.
◦ Date — Select to specify the date and time at which the deployment must start.
10. The Package Download Time and Package Install Time fields get activated for file-based packages. Select one of the following options:
◦ Immediately — Select to start the deployment immediately.
◦ Date — Select to specify the date and time at which the deployment must start.
| | The Perpetual Deployment will be completed when the package expires or when the user cancels the deployment. |
Click Save to save the Deployment Information.
Asset Information
1. The Asset Information field appears after the Deployment Information field.
2. Click on the entity picker 
to search for Asset Type A new window will pop up and showcase a list of Thing Template assets. By default, All Assets search is available.
to search for Asset Type A new window will pop up and showcase a list of Thing Template assets. By default, All Assets search is available.| | The Keyword field that appears in the search window is used to search any Asset or Thing related properties. For example Asset name or ThingTemplate etc. After entering the keyword, the user has to click once outside the keyword text box to view the result. |
3. The Advance Search Criteria field that appears is a secondary filter which gives the option of filtering the Asset properties. For example Asset name or ThingTemplate etc.
◦ After selecting the filter option, you can select a condition from those listed in the drop down.
◦ You can set a value to the filter after selecting the condition.
4. Set a Query Name and with it with set a criteria for the assets.
5. Under the Saved Asset Searches select a saved asset search available. By default, All My Assets search is available.
6. After selecting the assets collapse the Asset Information field by clicking the downward arrow button.
| | If in case there is any change in the Asset properties, the user has to repeat all the steps of the Asset Information field. |
Notifications
1. The Notifications page will appear after Asset Information.
| | To send notifications about deployment status, you need to have the Mail Extension installed and configured. |
2. Sending notifications to users, user groups, or email address is an optional step. Complete the following steps to send notifications:
a. Under the Notification Recipients section, depending on your requirement, do the following:
▪ Click the Enable error notification check box to send an error notification to the selected users, user groups, or email addresses.
▪ Click the Notify people below when deployment to all assets has finished to send a notification to the selected users, user groups, or email addresses when deployment completes.
b. Under the Notify User, Notify User Groups, or Notify These Email Addresses sections, complete the following steps to select the user, user group, or email address that you want to receive notifications about package deployment:
i. Click to search for and select users, user groups, and email addresses.
to search for and select users, user groups, and email addresses.ii. Click 
to add the user, user group, or email address to the appropriate list.
to add the user, user group, or email address to the appropriate list.Alternatively, if you do not want the selected user, user group, or email address to receive a notification, select it from the appropriate list, and click 
3. Once you have confirmed that the deployment is configured correctly, click Start. The Track Deployment By Package page appears. For more information about tracking deployments, see Track Package Deployment.
| | On each SCM-capable thing, the maxConcurrentUpdatesproperty controls how many concurrent updates a thing can process. By default, this property is set to 1. If a deployment is attempted for an asset and it exceeds the value of the maxConcurrentUpdates property, that deployment will be in the Pending state until it can proceed. To set the number of concurrent deployments that an agent can handle, login to the ThingWorx Composer and update the value of the maxConcurrentUpdates property. Regardless of the value of this property, deployments take place within the threshold of the capability of the agent. |