Campaigns provide the ability to perform a set of operations on multiple Things or Connections. Some examples for using campaigns are:
- Deploying Software Update Packages (SUP)
- Firmware updates (Through a SUP)
- Adding and deleting tags on various things or connections
- TR-50 Method execution
- Pinging a group of gateways
Once a campaign is created and Things or Connections are added to the campaign, the campaign must be started or scheduled for execution. The actions of the campaign will run against the Things or Connections that are added. Once a campaign is started, the campaign actions are executed against each campaign member.
The campaigns and campaign members are in one of the following states.
| Campaign States | Description |
|---|---|
| New | The campaign is ready to be executed. |
| Running | The campaign is in progress. |
| Cancelled | The campaign was executing, and has been terminated prematurely. |
| Completed | The campaign was executed to completion. |
| Campaign Member States | Description |
|---|---|
| Ready | The member is ready to be processed. |
| Scheduled | The campaign is preparing to process the member. |
| In Progress | The campaign is processing the member. |
| Waiting | The campaign has paused processing the member (thing/connection may not be online). |
| Pending | The campaign is preparing to resume processing the member. |
| Completed | The campaign has completed processing the member. |
Once the campaign is started, the campaign will not be finished until each campaign member in its list is completed (success or failure). For a list of the campaign member status see the following: campaign.find or click the View icon to the left of your finished campaign. Any campaign tasks that require parameters are provided as an array of parameters (dependent upon the task being executed).