Bulk actions

About bulk actions

The Connectivity Management platform enables you to complete certain actions in bulk. A bulk action enables you to apply an action to multiple subscribers simultaneously.

About the bulk actions page

On the Bulk actions page, you can view a list of already completed bulk actions or create a new bulk action.

Note: If you select a bulk action from the list, you can view details about it, for example, what actions have been performed or if there were any errors while performing the bulk action.

Available types of bulk actions

Bulk action Description Input format

Add monitoring alert
  • Use this action to add subscriber-level monitoring alerts to a group of subscribers.
  • You must provide the ICCIDs of the subscribers you are including in the action, and the lower and upper usage thresholds at which the alert is triggered.
  • Express the usage thresholds as integers, measured in megabytes.

Format:

"ICCID","lower limit in megabytes","upper limit in megabytes"

Example:

"8944122000000000000","10","100"

"8944122000000000001","10","100"

"8944122000000000002","20","50"

Add tags
  • Use this action to add tags to a group of subscribers.
  • You must provide the ICCIDs of the subscribers you are including in the action, and the tag or tags you are applying to each subscriber.

Format:

"ICCID","tag1","tag2"

Example:

"8944122000000000000","Arizona","Ohio"

"8944122000000000001","Arizona","Ohio"

"8944122000000000002","Colorado"

Remove tags
  • Use this action to remove tags from a group of subscribers.
  • You must provide the ICCIDs of the subscribers you are including in the action, and the tag or tags you are removing.

Format:

"ICCID","tag1","tag2"

Example:

"8944122000000000000","Arizona","Ohio"

"8944122000000000001","Arizona","Ohio"

"8944122000000000002","Colorado"

Add text metadata
  • Use this action to add text-based metadata key and value pairs to a group of subscribers.
  • You must provide the ICCIDs of the subscribers you are including in the action, the metadata key, and the metadata value.

  • Metadata keys have a maximum length of 148 characters.

  • You can create any metadata key you like (postcode, description, date, etc.), there are no pre-defined categories.
  • You can update text metadata in bulk, provided the metadata key you provide matches the existing key.

Format:

"ICCID","metadata key","value"

Example:

"8944122000000000000","firmware version","7.013"

"8944122000000000001","firmware version","7.013"

"8944122000000000002","postcode","EH99 1SP"

Add nickname
  • Use this action to add nicknames to a group of subscribers.
  • You must provide the ICCIDs of the subscribers you are including in the action, and the nickname you are adding.

  • Nicknames have a maximum length of 191 characters.

  • Each subscriber can only have one nickname.

Format:

"ICCID","nickname"

Example:

"8944122000000000000","Sensor 1"

"8944122000000000001","Sensor 2"

"8944122000000000002","Sensor 3"

Bar
  • Use this action to bar a group of subscribers from the network.
  • You must provide the ICCIDs of the subscribers you are including in the action.

Format:

"ICCID"

Example:

"8944122000000000000"

"8944122000000000001"

"8944122000000000002"

Unbar
  • Use this action to unbar a group of subscribers from the network.
  • You must provide the ICCIDs of the subscribers you are including in the action.

Format:

"ICCID"

Example:

"8944122000000000000"

"8944122000000000001"

"8944122000000000002"

Refresh
  • Use this action to make a group of subscribers request a new session and re-authenticate with the network.
  • You must provide the ICCIDs of the subscribers you are including in the action.
  • The effect of a refresh is similar to rebooting the device.
  • A subscriber's ability to perform this action depends on whether it is supported by the network operator.

Format:

"ICCID"

Example:

"8944122000000000000"

"8944122000000000001"

"8944122000000000002"

Add to group
  • Use this action to add subscribers to or remove subscribers from a group.
  • You must provide the group’s Group ID and the ICCIDs of the subscribers you are including in the action.
  • To find out a group’s Group ID, refer to the table on the Subscribers > Groups page.
  • You remove a subscriber from a group by giving it a Group ID of 0.

Format:

"ICCID","group id"

Example:

"8944122000000000000","11"

"8944122000000000001","11"

"8944122000000000002","12"

"8944122000000000003","13"

"8944122000000000004","0"

Perform a bulk action

1. Select Services > Bulk actions from the main navigation.

Result: You see the bulk actions page.

2. Select the Create new action button.

Result: You see the Create new action modular.

3. Enter a name for the new bulk action.

4. Select the bulk action type from the drop-down menu.

Result: The Create a new action modular expands to let you select the subscribers you want to include in the bulk action.

Format of the CSV file:

  • Include a line break between each set of values (see table below for the required values)
  • Use quotation marks around every value

Note: When naming your CSV file, make sure that the file ending is ".csv". The file ending is case sensitive, do not use capital letters.

Bulk action Description Input format

Add monitoring alert
  • Use this action to add subscriber-level monitoring alerts to a group of subscribers.
  • You must provide the ICCIDs of the subscribers you are including in the action, and the lower and upper usage thresholds at which the alert is triggered.
  • Express the usage thresholds as integers, measured in megabytes.

Format:

"ICCID","lower limit in megabytes","upper limit in megabytes"

Example:

"8944122000000000000","10","100"

"8944122000000000001","10","100"

"8944122000000000002","20","50"

Add tags
  • Use this action to add tags to a group of subscribers.
  • You must provide the ICCIDs of the subscribers you are including in the action, and the tag or tags you are applying to each subscriber.

Format:

"ICCID","tag1","tag2"

Example:

"8944122000000000000","Arizona","Ohio"

"8944122000000000001","Arizona","Ohio"

"8944122000000000002","Colorado"

Remove tags
  • Use this action to remove tags from a group of subscribers.
  • You must provide the ICCIDs of the subscribers you are including in the action, and the tag or tags you are removing.

Format:

"ICCID","tag1","tag2"

Example:

"8944122000000000000","Arizona","Ohio"

"8944122000000000001","Arizona","Ohio"

"8944122000000000002","Colorado"

Add text metadata
  • Use this action to add text-based metadata key and value pairs to a group of subscribers.
  • You must provide the ICCIDs of the subscribers you are including in the action, the metadata key, and the metadata value.

  • Metadata keys have a maximum length of 148 characters.

  • You can create any metadata key you like (postcode, description, date, etc.), there are no pre-defined categories.
  • You can update text metadata in bulk, provided the metadata key you provide matches the existing key.

Format:

"ICCID","metadata key","value"

Example:

"8944122000000000000","firmware version","7.013"

"8944122000000000001","firmware version","7.013"

"8944122000000000002","postcode","EH99 1SP"

Add nickname
  • Use this action to add nicknames to a group of subscribers.
  • You must provide the ICCIDs of the subscribers you are including in the action, and the nickname you are adding.

  • Nicknames have a maximum length of 191 characters.

  • Each subscriber can only have one nickname.

Format:

"ICCID","nickname"

Example:

"8944122000000000000","Sensor 1"

"8944122000000000001","Sensor 2"

"8944122000000000002","Sensor 3"

Bar
  • Use this action to bar a group of subscribers from the network.
  • You must provide the ICCIDs of the subscribers you are including in the action.

Format:

"ICCID"

Example:

"8944122000000000000"

"8944122000000000001"

"8944122000000000002"

Unbar
  • Use this action to unbar a group of subscribers from the network.
  • You must provide the ICCIDs of the subscribers you are including in the action.

Format:

"ICCID"

Example:

"8944122000000000000"

"8944122000000000001"

"8944122000000000002"

Refresh
  • Use this action to make a group of subscribers request a new session and re-authenticate with the network.
  • You must provide the ICCIDs of the subscribers you are including in the action.
  • The effect of a refresh is similar to rebooting the device.
  • A subscriber's ability to perform this action depends on whether it is supported by the network operator.

Format:

"ICCID"

Example:

"8944122000000000000"

"8944122000000000001"

"8944122000000000002"

Add to group
  • Use this action to add subscribers to or remove subscribers from a group.
  • You must provide the group’s Group ID and the ICCIDs of the subscribers you are including in the action.
  • To find out a group’s Group ID, refer to the table on the Subscribers > Groups page.
  • You remove a subscriber from a group by giving it a Group ID of 0.

Format:

"ICCID","group id"

Example:

"8944122000000000000","11"

"8944122000000000001","11"

"8944122000000000002","12"

"8944122000000000003","13"

"8944122000000000004","0"

Type or copy and paste the bulk action in the following format:

  • Include a line break between each set of values (see table below for the required values)
  • Use quotation marks around every value
Bulk action Description Input format

Add monitoring alert
  • Use this action to add subscriber-level monitoring alerts to a group of subscribers.
  • You must provide the ICCIDs of the subscribers you are including in the action, and the lower and upper usage thresholds at which the alert is triggered.
  • Express the usage thresholds as integers, measured in megabytes.

Format:

"ICCID","lower limit in megabytes","upper limit in megabytes"

Example:

"8944122000000000000","10","100"

"8944122000000000001","10","100"

"8944122000000000002","20","50"

Add tags
  • Use this action to add tags to a group of subscribers.
  • You must provide the ICCIDs of the subscribers you are including in the action, and the tag or tags you are applying to each subscriber.

Format:

"ICCID","tag1","tag2"

Example:

"8944122000000000000","Arizona","Ohio"

"8944122000000000001","Arizona","Ohio"

"8944122000000000002","Colorado"

Remove tags
  • Use this action to remove tags from a group of subscribers.
  • You must provide the ICCIDs of the subscribers you are including in the action, and the tag or tags you are removing.

Format:

"ICCID","tag1","tag2"

Example:

"8944122000000000000","Arizona","Ohio"

"8944122000000000001","Arizona","Ohio"

"8944122000000000002","Colorado"

Add text metadata
  • Use this action to add text-based metadata key and value pairs to a group of subscribers.
  • You must provide the ICCIDs of the subscribers you are including in the action, the metadata key, and the metadata value.

  • Metadata keys have a maximum length of 148 characters.

  • You can create any metadata key you like (postcode, description, date, etc.), there are no pre-defined categories.
  • You can update text metadata in bulk, provided the metadata key you provide matches the existing key.

Format:

"ICCID","metadata key","value"

Example:

"8944122000000000000","firmware version","7.013"

"8944122000000000001","firmware version","7.013"

"8944122000000000002","postcode","EH99 1SP"

Add nickname
  • Use this action to add nicknames to a group of subscribers.
  • You must provide the ICCIDs of the subscribers you are including in the action, and the nickname you are adding.

  • Nicknames have a maximum length of 191 characters.

  • Each subscriber can only have one nickname.

Format:

"ICCID","nickname"

Example:

"8944122000000000000","Sensor 1"

"8944122000000000001","Sensor 2"

"8944122000000000002","Sensor 3"

Bar
  • Use this action to bar a group of subscribers from the network.
  • You must provide the ICCIDs of the subscribers you are including in the action.

Format:

"ICCID"

Example:

"8944122000000000000"

"8944122000000000001"

"8944122000000000002"

Unbar
  • Use this action to unbar a group of subscribers from the network.
  • You must provide the ICCIDs of the subscribers you are including in the action.

Format:

"ICCID"

Example:

"8944122000000000000"

"8944122000000000001"

"8944122000000000002"

Refresh
  • Use this action to make a group of subscribers request a new session and re-authenticate with the network.
  • You must provide the ICCIDs of the subscribers you are including in the action.
  • The effect of a refresh is similar to rebooting the device.
  • A subscriber's ability to perform this action depends on whether it is supported by the network operator.

Format:

"ICCID"

Example:

"8944122000000000000"

"8944122000000000001"

"8944122000000000002"

Add to group
  • Use this action to add subscribers to or remove subscribers from a group.
  • You must provide the group’s Group ID and the ICCIDs of the subscribers you are including in the action.
  • To find out a group’s Group ID, refer to the table on the Subscribers > Groups page.
  • You remove a subscriber from a group by giving it a Group ID of 0.

Format:

"ICCID","group id"

Example:

"8944122000000000000","11"

"8944122000000000001","11"

"8944122000000000002","12"

"8944122000000000003","13"

"8944122000000000004","0"

5. Select the Create action button.

Result: The new bulk action is created. You see the bulk actions page with the newly created bulk action. The bulk action will now be verified by the system.

6. When the status of the bulk action changed to checked, select the bulk action from the list on the bulk actions page.

Result: You see the bulk action details page.

7. Select the Continue Processing button to perform the bulk action.

Result: The bulk action will be processed by the system. The status of the bulk action will tell you if the bulk action was completed successfully or failed.

Bulk action status Description

Pending

 The bulk action is waiting to be processed by the system.
Validation failed

The bulk action failed because the input format is invalid.

To resolve this, you must create a new bulk action using a valid input.

Processing

The bulk action is currently being processed by system.

Failed

One or more of the subscribers in the bulk action failed to be processed by the system.

Select the bulk action to view a summary of the subscribers that were updated by the action, and those that could not be processed.

Select the Retry failed items button to retry the action for the subscribers that could not be processed.

Completed

Select the bulk action to view the bulk action details page and check if the actions for the individual subscribers in the action were completed successfully or if any errors occurred.

All subscribers in the bulk action have been processed successfully by the system, and the action is complete.

Select the bulk action from the table to view a summary of the subscribers that were updated by the action.
Info:

When the status of the bulk action changed to completed, the bulk action is fully processed.

Select the bulk action to view the bulk action details page and check if the actions for the individual subscribers in the action were completed successfully or if any errors occurred.

Section of the bulk action details page Description
Action details

View a summary of the action, including its type, the user who created the action, when the action was created, and when the action was last updated by the system.
Action progress

Check the progress of an action that is being processed by the system, view a summary of how many subscribers have been processed successfully, and how many have failed.
Action items

View details about each subscriber in the bulk action, check each subscriber's progress, and retry the action for any subscribers that have failed.

Resolve bulk action errors

If your bulk action completes with a status of Failed or Validation failed, it means that the platform could not process your action. A bulk action may fail because of a validation error, or because another error occurred, such as a time-out error.

Validation errors

If your action fails with a status of Validation failed, it means your input is invalid. To resolve this, refer to the documentation about the required input format for your action, and ensure that your input matches the required format.

Info: See the Available types of bulk actions section for information about how to format the input for a bulk action.

Failed actions

If your action fails with a status of Failed, it means that all, or some of, the subscribers in the action could not be processed by the platform. Select the action to view a summary of the subscribers that failed.

Potential reasons for an action failing include, time-out errors, the subscribers in the action not belonging to your company account, or the action not being supported by the rate plan the failed subscribers are on.

To resolve this issue, you can retry the action.

Retry failed actions

1. Select Services > Bulk actions from the main navigation.

Result: You see the bulk actions page.

2. Select the bulk action you want to retry.

3. To retry the action for an individual subscriber, select the subscriber from the list, and then select the Retry for failed items button.

Result: The bulk action will be processed by the system. The status of the bulk action will tell you if the bulk action was completed successfully or failed.

4. To retry the action for all the subscribers that failed, select the Retry for failed items button.

Result: The platform processes the bulk action. The status of the bulk action will tell you if it was completed successfully or failed.

If the action continues to fail after the retry, we recommend that you:

  • Verify that the subscribers in the action belong to your company account. You can do this by searching for their ICCID in the platform. If the subscribers belong to your company account, they are returned by the search.
  • Verify that the action you are performing is supported by the rate plan the subscriber is on.

Status of a bulk action

You can track the status of the bulk action on the bulk action page and the bulk action details page. The following table describes each bulk action status.

Bulk action status Description

Pending

 The bulk action is waiting to be processed by the system.
Validation failed

The bulk action failed because the input format is invalid.

To resolve this, you must create a new bulk action using a valid input.

Processing

The bulk action is currently being processed by system.

Failed

One or more of the subscribers in the bulk action failed to be processed by the system.

Select the bulk action to view a summary of the subscribers that were updated by the action, and those that could not be processed.

Select the Retry failed items button to retry the action for the subscribers that could not be processed.

Completed

Select the bulk action to view the bulk action details page and check if the actions for the individual subscribers in the action were completed successfully or if any errors occurred.

All subscribers in the bulk action have been processed successfully by the system, and the action is complete.

Select the bulk action from the table to view a summary of the subscribers that were updated by the action.

Details of a bulk action

Select a bulk action on the bulk actions page to get to the bulk action details page:

Section of the bulk action details page Description
Action details

View a summary of the action, including its type, the user who created the action, when the action was created, and when the action was last updated by the system.
Action progress

Check the progress of an action that is being processed by the system, view a summary of how many subscribers have been processed successfully, and how many have failed.
Action items

View details about each subscriber in the bulk action, check each subscriber's progress, and retry the action for any subscribers that have failed.