'; Campaigns | Incognito Help
Array
(
    [0] => Array
        (
            [version] => 4.3
            [language] => en
        )

    [1] => Array
        (
            [version] => 4.2
            [language] => en
        )

    [2] => Array
        (
            [version] => 4.1
            [language] => en
        )

    [3] => Array
        (
            [version] => 4.0
            [language] => en
        )

    [4] => Array
        (
            [version] => 3.5
            [language] => en
        )

    [5] => Array
        (
            [version] => 3.4
            [language] => en
        )

    [6] => Array
        (
            [version] => 3.3
            [language] => en
        )

    [7] => Array
        (
            [version] => 3.2
            [language] => en
        )

    [8] => Array
        (
            [version] => 3.1
            [language] => en
        )

    [9] => Array
        (
            [version] => 4.2
            [language] => fr
        )

    [10] => Array
        (
            [version] => 4.2
            [language] => es
        )

)
Rel: acs/topics/acs/dita/campaigns
URI: acs/topics/campaigns
=== Tags ===
Array
(
    [809] => operations
)

=== Related ===
Array
(
)

Campaigns

Campaigns enable you to execute a device operation, or series of device operations, across a group of devices. Use these settings to view and manage campaigns.

Campaigns can be system-created or user-created. The service automatically generates a campaigns when operations are performed against multiple devices. For example, after a service class update or for a device group association to service classes.

Campaign status is indicated by a colored circle to the right of the campaign row:
  • In progress (purple)
  • Scheduled (gray)
  • Completed successfully (green)
  • Completed with errors (red)
  • Terminated (black)
To do this: Follow these steps:
View details for a campaign Double-click a record.
Search for a campaign Click the search symbol (), type search terms, and press Enter.
Change filter type From the dropdown menu, choose one of:
  • All
  • In progress
  • Scheduled
  • Completed Successfully
  • Completed with Errors
  • Terminated
  • Archived
Create a campaign Click Create.
Select a campaign Double-click a record. To select multiple records, press and hold CTRL and click the records you want to select.
Select all campaigns In the action bar, click Select All. Exit select mode by clicking on any whitespace on the page.
Archive a completed campaign Select a campaign, and in the action bar, click Archive.
Pause a campaign Select a campaign, and in the action bar, click Pause.
Resume a campaign Select a campaign, and in the action bar, click Resume.
Cancel a campaign Select a campaign, and in the action bar, click Terminate.
Switch to table view/grid view Click the table symbol ()/grid symbol ().
Go back one screen Click the back symbol ().
Return to the main screen of the service Click the hub symbol ().
Note: The service searches for an exact match. If you need to search for a partial match, type a wildcard (*) for the character(s) you do not know.

Creating Campaigns

Use these settings to create and schedule custom, user-created, campaigns.

To do this: Follow these steps:
Search for a device type or device group Click Devices. Click the search symbol (), type search terms, and press Enter.
Assign tasks to the campaign Click Select Tasks. In the action bar, click Add and select a single task. In the action bar, click Confirm.
Note: You can add multiple tasks to a campaign.
Add a device type or device group to the campaign Click Select Devices. To filter results, select ‘By Devices’ or ‘By Device Groups’ from the dropdown list.
Create an adhoc device group from the selected devices Click Select Devices. Select one or more devices, and in the action bar, click Confirm. When prompted, enable ‘Save device selection’.
Create a schedule for the campaign From the Campaign Type dropdown, select ‘Immediate’, ‘Next Contact’, ‘Window’, or ‘Performance Testing (CAF/A-CAM)’ (if available).
Save changes Click Save.
Note: The service searches for an exact match. If you need to search for a partial match, type a wildcard (*) for the character(s) you do not know.
Table 1. Campaign Type
Immediate The service immediately sends the operation to the device.
Next Contact The service waits to send the operation until the next contact from the device.
Window Create a time window for the campaign to run. Window scheduling is useful for scheduling events that may disrupt service.

See the table below for parameters for time window scheduling.

Performance Testing (CAF/A-CAM) Create a performance report to fulfill U.S. Federal CAF/A-CAM requirements.
Note: This campaign type only applies to the following tasks: Upload Speed Test, Download Speed Test, and Ping Test.
Table 2. Window campaign type - Schedule options
Date The date the service can run the operation.
Start Time The start of a time window in which the service can run the operation.
End Time The end of a time window in which the service can run the operation.
Note: Operations are only sent to the device within the active time window(s). Operations that are not completed at the end of this period move into a failed state.
Notify Device When the time window becomes active, the service notifies the device. Otherwise, the service waits to send the operation until the next contact from the device.
Repeat Enable to define a daily or weekly recurring schedule.
Repeats Daily or weekly.
Run Length of time to run the repeat schedule. Select one of:
  • Until completion
  • After ___ occurrence(s)
  • Until date ___
Table 3. Performance Testing (CAF/A-CAM) campaign type - Schedule / Additional Campaign Settings options
Campaign Start Date The date the service can run the operation.
Campaign Duration Length of time the operation is to run.

From the dropdowns, choose the number of days, weeks, months, quarters, or years.

Notify Device When the time window becomes active, the service notifies the device. Otherwise, the service waits to send the operation until the next contact from the device.
Run Campaign On To run the operation on all devices selected for the campaign, check All selected devices.

To run the operation on a random subset of devices, check Limit to, and from the dropdown, choose the number of devices.

Upload/Download Speed Test Run Occurrence How frequently the service runs an upload speed test or download speed test during the campaign window.

From the dropdowns, choose the number of days per week, month, quarter, or year when the test runs, and the test frequency during the day (every minute or hour in the specified time window).

Ping Test Run Occurrence How frequently the service runs a ping test during the campaign window.

From the dropdowns, choose the number of days per week, month, quarter, or year when the test runs, and the test frequency during the day (every minute or hour in the specified time window).

Upload/Download Speed Test Retry Limit Specify the test speed limit after which the service retries a test.

To set a download speed limit, check Limit if download exceeds, and from the dropdown, choose the kilobytes per second.

To set a download speed limit, check Limit if upload exceeds, and from the dropdown, choose the kilobytes per second.

For example, if the download limit is set to 20 kbps, the service retries the test one (1) minute after the download speed exceeds this limit.

Campaign End The date the service ends the operation.

Available Operations

Campaigns support the following task types.

To do this: Follow these steps:
Add a single task Select a single task. In the action bar, click Confirm.
Note: You can add multiple tasks to a campaign.
Table 4. Campaign Task Types
Set parameter values Set one (or more) device parameter value(s).
Set parameter attributes Set one (or more) device parameter attribute(s).
Reboot Reboot one (or more) device(s).
Reset Factory reset one (or more) device(s).
Download Download files (for example, firmware) from a device to a local system.
Upload Upload file(s) to a device.
ChangeDUState Change the deployment unit.
Add object Add a new TR-069 parameter object instance.
Remove object Remove an existing TR-069 parameter object instance.
Reload parameters Reload parameter values/attributes from a device.
Device synchronization Re-synchronize one (or more) device(s).
Script Execute a script on an external script engine.
Backup Backup current parameters and values from a device to a file.
Upload speed test Upload specified amount of data from a device to a remote HTTP or FTP site and measure time taken.
Note: This feature is licensed under SQM. If SQM is not available, this tile is grayed out.
Download speed test Download specified amount of data from a remote HTTP or FTP site to a device and measure time taken.
Note: This feature is licensed under SQM. If SQM is not available, this tile is grayed out.
Ping test From a device, ping a specified IP address and report standard information returned by the ping utility, such as successes, failures, etc.
Note: This feature is licensed under SQM. If SQM is not available, this tile is grayed out.

Campaign Details

Use these settings to view and manage system-created and user-created campaigns.

To do this: Follow these steps:
Group and view devices, by error code, that have completed an operation with an error In the action bar, click Aggregate, and enter an error code.
Cancel a pending operation In the action bar, click Terminate.
Pause a pending operation In the action bar, click Pause.
Save changes Click Save.
Archive Archiving failed operations will automatically cancel all failed device operations within.
Edit name In the Name field, type a text string.
Edit description In the Description field, type a text string.
Edit the operation schedule Click Schedule.
View tasks in the operation Click Tasks.
View device operations by category Under Summary, click Device operations <category>.
Type The type indicates whether the operation was system-created or user-created. System-created operations are identified by the source of the operation. For example, ‘Firmware Update’, ‘Service Class Update’, and ‘Device Group Association’.
Status The current state of the campaign. Possible states are:
  • In progress
  • In progress, device operations being created
  • In progress (Paused)
  • Scheduled
  • Scheduled, device operations being created
  • Scheduled (Paused)
  • Completed successfully
  • Completed with errors
  • Terminating
  • Terminated

If the campaign status is ‘Completed with errors’, you can manually retry the operation or cancel it.

If the campaign status is ‘In progress, device operations being created’, the creation of device operations has not completed and the counts of device operations under Summary are still not finalized. Wait until the status changes to ‘In progress’, at which point the counts will be correct.

Created Date/time when the campaign was created.
Last Modified Date/time when the campaign was last modified.
Tasks List of tasks assigned to the operation.
Devices List of devices assigned to the operation.
Device Groups List of device groups assigned to the operation.
Summary Lists active or completed operations attached to the campaign
Schedule List of tasks assigned to the operation.

Associated Tasks

List of tasks assigned to the operation.

To do this: Follow these steps:
View details for a task Double-click a task.
Select one or more tasks Click one or more task records. Each selected record is highlighted in black. To deselect a highlighted record, click the record.
Terminate one or more tasks Select one or more tasks and click Terminate.
Top