Bulk Actions on SIMs

AerPort provides numerous ways to make changes to a group of SIMs using Bulk Actions. Each action comes with a template in CSV format. The template provides guidance on how to populate it to operate on your SIMs.

In this article:

For specifics on Bulk Activation, see Activating a Batch of SIMs Using a Bulk Action (CSV).

Basics

During its lifecycle, a SIM goes through numerous changes, from before it is activated to its end-of-life cancelation. You can make changes to the SIM interactively using the Activate SIMs and Manage SIMs screens, but often, you want to make changes to a large bulk of SIMs. The Bulk Actions operations make this possible.

You can perform different bulk actions on SIMs from different products in the same CSV file.

Bulk operations may take some time depending on the number of the devices included in the transaction, therefore AerPort will send you an email once the operation is complete. This email will contain a transaction ID that allows you to later identify and track the operation's status under the Transaction History.

The Bulk Action Process

The Bulk Actions screen is available from the SIMs menu. Selecting Bulk Actions displays a screen that shows the process for making changes.



  1. Start: Select the bulk action you want to perform. Click Download File to obtain a .ZIP file containing the template in .CSV format. Use this template as a guide to populate the file with your specific list of SIMs for processing. See Preparing Your CSV Upload File below for further information. Note: if your CSV file contains blank lines, they are included in the count of SIMs to be processed. Therefore, it is best to remove blank lines from the upload file.
  2. Select File: Locate and select the .CSV file that you have prepared.
  3. Upload: Click Upload to begin the bulk action.
  4. Process File: Observe the messages that appear as AerPort processes your file. During processing, you can select another file to queue it for processing. When processing is complete, AerPort displays the results. You can view the details in the Transaction History.

List of Bulk Actions

The following bulk actions are available.

Activation Actions

  • Activate
  • Provision
  • Reprovision

Status Actions

  • Bill
  • Cancel
  • Suspend
  • Unsuspend

Attribute Actions

  • Change Rate Plan
  • Change Service Name (same as Service Profile)
  • Update Attributes

Traffic Actions

  • Block Traffic Policy
  • Unblock Traffic Policy

Limits on Bulk Operations

When performing bulk operations, there are limits to the number of SIMs you can modify in a single operation.

  • Bulk actions via CSV upload file: maximum 10,000 SIMs.
  • Bulk actions on SIMs selected from the Manage SIMs list: maximum 1000 SIMs. Below the Manage SIMs table, you see a check box labeled: Select first 1,000 of n active SIMs. Thus, you can select 1000 at a time.
  • Bulk actions via the AerAdmin API: maximum 1000 SIMs.

Preparing Your CSV Upload File

After you download a template, make a copy of it and then populate it with your specific list of SIMs for processing.

CSV Upload File Fields

The following table lists fields in alphabetical order that are used in the various CSV file templates. Please note that PROVISION and REPROVISION fields are described in detail here: Activation, Provision, and Reprovision CSV Upload File Fields.

Fields Name

Operations Using this Field

Description

accessProfile1ID

BILL, BLOCKTRAFFICPOLICY, CHANGERATEPLAN, CHANGESERVICENAME, SUSPEND, TRAFFICPOLICY, UNBLOCKTRAFFICPOLICY, UNSUSPEND, UPDATEATTRIBUTES Specify the actual identifier of the SIM being modified. The identifier should be 20 digits for ICCID or 32 digits for EID.

Note that ICCID and EID values are very long numbers. If you are using a spreadsheet to create the CSV file, if you paste in a large number, it may be changed into scientific notation, which eliminates the specificity of the value. Instead, you can format the cell as a label and then paste the number. For example, in Microsoft Excel, begin the cell contents with an apostrophe:

'89044045817727484800000012274487

After you save the CSV file, you can reopen it in a text editor to ensure that the value is a plain number between the commas with no quotes or apostrophes. For example:

… ,,,,EID,89044045817727484800000012274487,,,,

accessProfile1IDType

BILL, BLOCKTRAFFICPOLICY, CHANGERATEPLAN, CHANGESERVICENAME, SUSPEND, TRAFFICPOLICY, UNBLOCKTRAFFICPOLICY, UNSUSPEND, UPDATEATTRIBUTES Specifies the corresponding identifier type (either ICCID or EID) of the SIM based on the technology. 
  • If this is a GSM or LTE device, then specify ICCID.
  • If this is an eSIM device, then specify EID.
Do not use quotes or apostrophes around the identifier type.

accessProfile1Technology

BILL, BLOCKTRAFFICPOLICY, CHANGERATEPLAN, CHANGESERVICENAME, SUSPEND, TRAFFICPOLICY, UNBLOCKTRAFFICPOLICY, UNSUSPEND, UPDATEATTRIBUTES Specify the technology of the SIM you are modifying, which can be one of the following:
  • GSM
  • LTE

If you are provisioning or reprovisioning an eSIM, leave this field blank.

Do not use quotes or apostrophes around the technology type.

accessProfile2ID

BILL, BLOCKTRAFFICPOLICY, CHANGERATEPLAN, CHANGESERVICENAME, SUSPEND, TRAFFICPOLICY, UNBLOCKTRAFFICPOLICY, UNSUSPEND, UPDATEATTRIBUTES Optionally specify the actual identifier of the secondary SIM being modified.

If this is a Single-Mode SIM, leave this field blank.

accessProfile2IDType

BILL, BLOCKTRAFFICPOLICY, CHANGERATEPLAN, CHANGESERVICENAME, SUSPEND, TRAFFICPOLICY, UNBLOCKTRAFFICPOLICY, UNSUSPEND, UPDATEATTRIBUTES Optionally specify the corresponding identifier type (either ICCID or EID) of the secondary SIM based on the technology.

If this is a Single-Mode SIM, leave this field blank.

Do not use quotes or apostrophes around the identifier type.

accessProfile2Technology

BILL, BLOCKTRAFFICPOLICY, CHANGERATEPLAN, CHANGESERVICENAME, SUSPEND, TRAFFICPOLICY, UNBLOCKTRAFFICPOLICY, UNSUSPEND, UPDATEATTRIBUTES Optionally specify the technology of the secondary SIM only if you are modifying a Dual-Mode device.

If this is a Single-Mode SIM, leave this field blank.

Do not use quotes or apostrophes around the technology type.

accessProfile3ID

BILL, BLOCKTRAFFICPOLICY, CHANGERATEPLAN, CHANGESERVICENAME, SUSPEND, TRAFFICPOLICY, UNBLOCKTRAFFICPOLICY, UNSUSPEND, UPDATEATTRIBUTES Optionally specify the actual identifier of the third SIM being modified.

If this is a Single-Mode SIM, leave this field blank.

accessProfile3IDType BILL, BLOCKTRAFFICPOLICY, CHANGERATEPLAN, CHANGESERVICENAME, SUSPEND, TRAFFICPOLICY, UNBLOCKTRAFFICPOLICY, UNSUSPEND, UPDATEATTRIBUTES Optionally specify the corresponding identifier type (either ICCID or EID) of the third SIM based on the technology.

If this is a Single-Mode SIM, leave this field blank.

Do not use quotes or apostrophes around the identifier type.

accessProfile3Technology BILL, BLOCKTRAFFICPOLICY, CHANGERATEPLAN, CHANGESERVICENAME, SUSPEND, TRAFFICPOLICY, UNBLOCKTRAFFICPOLICY, UNSUSPEND, UPDATEATTRIBUTES Optionally specify the technology of the third SIM only if you are modifying a Dual-Mode device.

If this is a Single-Mode SIM, leave this field blank.

Do not use quotes or apostrophes around the technology type.

agentId

UPDATEATTRIBUTES

Optionally specify the sales agent ID for capturing and tracking devices belonging to certain sales representatives, Sales Agents, or sales channels.
all BLOCKTRAFFICPOLICY, TRAFFICPOLICY, UNBLOCKTRAFFICPOLICY Specify BLOCK or UNBLOCK. This field affects packet data, SMS, and voice traffic.

applicationType

UPDATEATTRIBUTES

Optionally specify M, if your device is mobile. This is default value if the field is left blank.

Specify F, if your device is fixed.

The application type is is used to assist in troubleshooting problematic devices. Mobile suggests that your device can move from one physical location to another as part of normal operation. Fixed suggests that your device does not move from one location to another as part of normal operation, for example, if the device is fixed to a power source.

assignStaticIP

ASSIGNSTATICIP

Specify TRUE to assign a static IP to the SIM, and FALSE otherwise. The default value is FALSE.

You can assign a Static IP only if it is included in the SIM's service profile.

cancel-code CANCEL Optionally specify the reason you are cancelling the device. The value is an integer:
  • 1: Unknown
  • 2: Voluntary

currentLocation

UPDATEATTRIBUTES

Optionally specify your SIM's current location. This field has a limit of 30 characters.

customAttributeName1

customAttributeValue1

UPDATEATTRIBUTES

Optional. Custom attributes allow you to track additional SIM or device information in up to 5 separate custom fields in the Name-Value pair. 

customAttributeName1: specify only customField1 in this field.

customAttributeValue1: specify the actual value of the first custom attribute. The custom attribute value is limited to 64 characters and you can use any printable ASCII characters.

customAttributeName2

customAttributeValue2

UPDATEATTRIBUTES

Optional. Custom attributes allow you to track additional SIM or device information in up to 5 separate custom fields in the Name-Value pair. 

customAttributeName2: specify only customField2 in this field.

customAttributeValue2: specify the actual value of the second custom attribute. The custom attribute value is limited to 64 characters and you can use any printable ASCII characters.

customAttributeName3

customAttributeValue3

UPDATEATTRIBUTES

Optional. Custom attributes allow you to track additional SIM or device information in up to 5 separate custom fields in the Name-Value pair. 

customAttributeName3: specify only customField3 in this field.

customAttributeValue3: specify the actual value of the third custom attribute. The custom attribute value is limited to 64 characters and you can use any printable ASCII characters.

customAttributeName4

customAttributeValue4

UPDATEATTRIBUTES

Optional. Custom attributes allow you to track additional SIM or device information in up to 5 separate custom fields in the Name-Value pair. 

customAttributeName4: specify only customField4 in this field.

customAttributeValue4: specify the actual value of the fourth custom attribute. The custom attribute value is limited to 64 characters and you can use any printable ASCII characters.

customAttributeName5

customAttributeValue5

UPDATEATTRIBUTES

Optional. Custom attributes allow you to track additional SIM or device information in up to 5 separate custom fields in the Name-Value pair. 

customAttributeValue5: specify only customField5 in this field.

customAttributeValue5: specify the actual value of the fifth custom attribute. The custom attribute value is limited to 64 characters and you can use any printable ASCII characters.

deviceName

UPDATEATTRIBUTES

Optionally specify a unique name for your SIM. This field has a limit of 24 characters.
deviceProfileId BILL, BLOCKTRAFFICPOLICY, CANCEL, CHANGERATEPLAN, CHANGESERVICENAME, SUSPEND, TRAFFICPOLICY, UNBLOCKTRAFFICPOLICY, UNSUSPEND, UPDATEATTRIBUTES Specify the identifier of the SIM. This is a separate identifier from the ICCID or EID. It is assigned at the time of provisioning. For example, AER0000007743295.
id-1

id-2

id-3

CANCEL Specify the actual identifier of the SIM being cancelled. The identifier should be 20 digits for ICCID or 32 digits for EID.

Note that ICCID and EID values are very long numbers. If you are using a spreadsheet to create the CSV file, if you paste in a large number, it may be changed into scientific notation, which eliminates the specificity of the value. Instead, you can format the cell as a label and then paste the number. For example, in Microsoft Excel, begin the cell contents with an apostrophe:

'89044045817727484800000012274487

After you save the CSV file, you can reopen it in a text editor to ensure that the value is a plain number between the commas with no quotes or apostrophes. For example:

… ,,,,EID,89044045817727484800000012274487,,,,

idType-1

idType-2

idType-3

CANCEL Specifies the corresponding identifier type (either ICCID or EID) of the SIM based on the technology. 
  • If this is a GSM or LTE device, then specify ICCID.
  • If this is an eSIM device, then specify EID.

newRatePlan

CHANGERATEPLAN

Specify the Rate Plan Label for device billing purposes. The Rate Plan Label must be exactly same as was created for your account. You can find the Rate Plan Labels for your account under the Account, Accounts Details menu.

Ensure that the rate plan is valid for the product associated with this SIM.

The Rate Plan Name must not be used in this field. Always use the Rate Plan Label in this field.

newRatePlanEffectiveDate CHANGERATEPLAN Specify a date in the format MM/DD/YYYY.

newServiceName

CHANGESERVICENAME

Specify the Service Profile Name, which identifies the network services your SIM can access. The service profile name must be exactly the same as was created for your account. You can find the Service Profile Names for your account under the Account, Accounts Details menu.

Ensure that the service profile is valid for the product associated with this SIM.

operation

BILL, BLOCKTRAFFICPOLICY, CANCEL, CHANGERATEPLAN, CHANGESERVICENAME, SUSPEND, TRAFFICPOLICY, UNBLOCKTRAFFICPOLICY, UNSUSPEND, UPDATEATTRIBUTES

Specify the bulk operation name that you are selecting from the Bulk Actions list box.
  • BILL
  • BLOCKTRAFFICPOLICY
  • CANCEL
  • CHANGERATEPLAN
  • CHANGESERVICENAME
  • SUSPEND
  • TRAFFICPOLICY
  • UNBLOCKTRAFFICPOLICY
  • UNSUSPEND
  • UPDATEATTRIBUTE
packet BLOCKTRAFFICPOLICY, TRAFFICPOLICY, UNBLOCKTRAFFICPOLICY Specify BLOCK or UNBLOCK. This field affects only packet data traffic.
removeStaticIP REMOVESTATICIP Specify TRUE to remove the static IP from the SIM, and FALSE otherwise.

reportGroup

UPDATEATTRIBUTES

Optionally specify an integer. The report group is used to classify and group devices in reports. The value of the report group cannot be greater than 2147483647. A report group can contain up to 10,000 devices and there can be up to 256 unique report groups.

If a report group is not specified, your device is assigned to group 0, by default.

sms BLOCKTRAFFICPOLICY, TRAFFICPOLICY, UNBLOCKTRAFFICPOLICY Specify BLOCK or UNBLOCK. This field affects only SMS traffic.
technology-1

technology-2

technology-3

CANCEL Specify the technology of the SIM you are cancelling, which can be one of the following:
  • GSM
  • LTE

If you are cancelling an eSIM, leave this field blank.

voice BLOCKTRAFFICPOLICY, TRAFFICPOLICY, UNBLOCKTRAFFICPOLICY Specify BLOCK or UNBLOCK. This field affects only voice traffic.

Use Case for Bulk Updates to SIMs

To prepare a CSV upload file for updating your SIMs, you first need to prepare your list of SIM identifiers. There are two methods of obtaining a list of SIMs. Be sure to test both methods to ensure you have the correct and complete list of SIMs.

  • Primary method: Using the SIMs menu, select Manage SIMs, then choose the filters for the set of devices you want to modify. Then use the Actions menu to Export all as CSV.
  • Secondary method: Using the Reports menu, select Build, then select the Account Devices Detail report. Choose the filters for the set of devices you want to modify. Click Generate Report then Download. Note that this method of retrieving SIM information omits SIMs that are not assigned to a Pool.

Using the SIMs menu, here is an example of an exported list of SIMs in CSV format. Let's call this file SIMsExported.CSV.

MIN MDN MEID MSID HEX MEID ESN HEX ESN ICCID MSISDN IMSI Provision Date Status Status Date Rate Plan Pool Name Report Group Service Name
              '89011702278469573160' '12569175479' '310170846957316' 8/5/2021 Bill 8/5/2021 ALH_2GB_FIC   0 ALH_IOT_D3L_FIC
              '89011702278483607077' '15864952191' '310170848360707' 2/22/2022 Bill 2/22/2022 FUSION_10MB_ATT FUSION_ALH 0 ALH_IOT_D3L_FIC
              '89011702278483607044' '15752615308' '310170848360704' 8/1/2022 Bill 2/2/2023 FUSION_10MB_ATT FUSION_ALH 0 ALH_IOT_D3L_FIC
              '89011702278201312349' '13025682478' '310170820131234' 1/25/2024 Provision 1/25/2024 FUSION_10MB_ATT FUSION_ALH 0 ALH_IOT_D3L_FIC
              '89011702278820705337' '12405198613' '310170882070533' 8/29/2023 Bill 3/1/2024 FUSION_10MB_ATT FUSION_ALH 0 ALH_IOT_D3L_FIC
              '89011701328870210091' '12179619234' '310170887021009' 4/12/2023 Bill 10/13/2023 FUSION_10MB_ATT FUSION_ALH 0 ALH_IOT_D7L_FIOT
              '89011701328870210109' '17692904600' '310170887021010' 4/12/2023 Bill 4/12/2023 ALH_2GB_FIC ALH2GBPOOL 0 ALH_IOT_D7L_FIOT
              '89011702278407991102' '12172619930' '310170840799110' 3/8/2023 Bill 9/9/2023 FUSION_10MB_ATT FUSION_ALH 0 ALH_IOT_D3L_FIC
              '89011702278407991110' '12172619931' '310170840799111' 3/8/2023 Bill 9/9/2023 FUSION_10MB_ATT FUSION_ALH 0 ALH_IOT_D3L_FIC
              '89011702278871667857' '12059629371' '310170887166785' 1/13/2023 Bill 7/14/2023 FUSION_10MB_ATT FUSION_ALH 0 ALH_IOT_D3L_FIC
              '89011702278903587370' '13863321811' '310170890358737' 11/16/2022 Bill 5/17/2023 FUSION_10MB_ATT FUSION_ALH 0 ALH_IOT_D7L_FIOT
              '89011702278483607085' '14646004035' '310170848360708' 10/6/2022 Bill 4/7/2023 FUSION_10MB_ATT FUSION_ALH 0 ALH_IOT_D7L_FIOT

Notice that the ICCID column presents each identifier inside apostrophes (single quotes). However, the CSV Upload file for Bulk Operations requires the identifier to appear as an integer (no apostrophes/single quotes). Let's call the Upload file for Bulk Operations UPDATEATTRIBUTES-template.CSV.

If you open SIMsExported.CSV into a spreadsheet, such as Microsoft Excel, you see single quotes around each identifier. For example: '89011702278871667857'

If you Search and Replace to remove all the single quotes, then Excel treats each identifier as a very large number and converts it to scientific notation, which eliminates the specificity of the number. For example: 8.90117E+19

To avoid this, you can undo the Search and Replace, then manually format each cell as a label by beginning each cell with a single quote and removing the trailing single quote. For example: '89011702278871667857

However, it is cumbersome or impossible to manually edit each cell to remove the trailing single quote.

Here are two possible methods to format the identifiers from the SIMsExported.CSV file.

Method 1 - Google Sheets

  1. In Google Sheets, start with a blank sheet. Then import the SIMsExported.CSV file. File, Import, Upload, Browse, locate file, Open.
  2. In the Import file box, select Import location "Replace current sheet," Separator type "Detect automatically,", and check the box for Convert text to numbers, dates, and formulas. Then click Import data.
  3. In the column of SIM identifiers, you will see the number followed by a single quote. For example, 89011702278469573160'. However, if you put your cursor on the cell, you will see that the SIM identifier starts and ends with a single quote. '89011702278469573160'.
  4. Perform a search and replace to remove the single quotes. Edit, Find and replace, Find ', Replace <leave blank>, do not check any boxes, Done. This removes the trailing single quote. So now if you put your cursor on the cell, you will see that the SIM identifier starts but does not end with a single quote. For example, '89011702278469573160
  5. Insert another sheet into the Google spreadsheet. Insert, Sheet. Now your Google sheet has two tabs.
  6. Import the Bulk Actions template that you want to populate, such as UPDATEATTRIBUTES-template.CSV, using the same process shown in step 2.
  7. Return to the first tab with the list of SIM identifiers and copy the full range of identifiers to the Clipboard.
  8. Return to the second tab with the Bulk Actions template, locate the column to contain the SIM identifiers, such as accessProfile1ID, and paste the SIM identifiers.
  9. Make all the remaining changes you want to make to the template for the bulk operation.
  10. Save the sheet as a CSV using File, Download, Comma Separated Values (.csv). Google saves the current tab as a csv and downloads it to your computer's normal download location.

Method 2 - Microsoft Excel with a Formula

  1. In Excel, with the SIMsExported.CSV file open, delete all the columns that you do not need. For example, keep only the ICCID or EID column as column A. Save this as a separate CSV file, such as MySIMs.CSV.
  2. In Excel, in the MySIMs.CSV file, in column B, insert a formula to remove the trailing single quote. For example, if the SIM identifier '89011702278469573160' is in cell A2, then in cell B2, enter this formula:
    =RIGHT(LEFT(A2,LEN(A2)-1),LEN(A2)-2)
  3. This results in the following value in cell B2: 89011702278469573160
  4. Copy the formula down column B for all rows of SIM identifiers.
  5. Save your changes, using a different file name if you wish, such as MySIMsClean.CSV. Keep the file open in Excel.
  6. Open the Bulk Actions template that you want to populate, such as UPDATEATTRIBUTES-template.CSV.
  7. Locate the column to contain the SIM identifiers, such as accessProfile1ID.
  8. Format this column as Number format with 0 decimal places. (Select the blank column, including the column heading, right-click, select Format Cells, select Number, 0 decimal places, no thousands separator.)
  9. Return to your spreadsheet of SIM identifiers (MySIMsClean.CSV) and copy the full range of identifiers to the Clipboard.
  10. Return to the Bulk Actions template (UPDATEATTRIBUTES-template.CSV), in row 2 of the column to contain the SIM identifiers. Right-click and select Paste Options, Values (the icon with the clipboard and 123). Save your changes.
  11. Make all the remaining changes you want to make to this template before running the bulk operation. Then save the template (still as a CSV file). Remember that when you close this file, the next time you open it in Excel, the SIM identifiers will turn into scientific notation again.

Example CSV Upload File

Here is an example of a CSV file to update the attributes on two SIMs.

My_UPDATEATTRIBUTES_file.csv

operation,deviceProfileId,accessProfile1Technology,accessProfile1ID,accessProfile1IDType,accessProfile2Technology,accessProfile2ID,accessProfile2IDType,accessProfile3Technology,accessProfile3ID,accessProfile3IDType,deviceName,currentLocation,reportGroup,applicationType,agentId,customAttributeName1,customAttributeValue1,customAttributeName2,customAttributeValue2,customAttributeName3,customAttributeValue3,customAttributeName4,customAttributeValue4,customAttributeName5,customAttributeValue5
UPDATEATTRIBUTES,,LTE,89011702278469573160,ICCID,,,,,,,MyDevice1,CALIFORNIA,,,,,First_attribute,,Second_attribute,,,,,,
UPDATEATTRIBUTES,,LTE,89185000190416000167,ICCID,,,,,,,MyDevice2,CALIFORNIA,,,,,First_attribute,,Second_attribute,,,,,,

Have more questions? Submit a request

0 Comments

Article is closed for comments.