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.
- 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.
- Select File: Locate and select the .CSV file that you have prepared.
- Upload: Click Upload to begin the bulk action.
- 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
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. 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.
|
|
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:
If you are provisioning or reprovisioning an eSIM, leave this field blank. |
|
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. |
|
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. |
|
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. |
| 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. |
|
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:
|
|
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. 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.
|
|
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.
|
| 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:
If you are cancelling an eSIM, leave this field blank. |
| voice | BLOCKTRAFFICPOLICY, TRAFFICPOLICY, UNBLOCKTRAFFICPOLICY | Specify BLOCK or UNBLOCK. This field affects only voice traffic. |
0 Comments