Summary
This article provides guidelines for using the Bulk Data application to import files to create (pre-load) SIM records in SIM Management. A preloaded SIM record can either be a SIM Card or an eSIM (and possibly using a SM-DP+ system to pre-provision them). Rather than using the existing IDI Desktop Client SIM File Upload utility, the Bulk Data Import method reduces the likelihood of syntax errors and makes it easier to create and manage import files.
You can search and view successfully imported SIM records via CostGuard Client SIM Management (Applications > BackOffice Management).
Links:
File Format
General Format
The following general characteristics apply to SIM import files:
- File naming convention must be *.csv
- A header is required
- The header must be followed by one or more comma-delimited detail records
- Non-required fields can be empty
- The columns are not required to appear in a specific order. The order for a specific file is defined by the header record
- You do not have to include all columns in an import file
Import Identifier
The first row of the file must have the file format identifier, starting in the first position of the first row. For the SIM import, the identifier is:
FORMAT:IDI/CostGuardBulkData/SIMFILEIMPORT
Note: “FORMAT:” is part of the identifier and must be included.
Header Record
The second row of the import file must contain the appropriate column names. The column names are listed in the Record Layout section of this document. The columns do not need to appear in a specific order. Import files do not need to include all columns, only those that contain data to be imported. The field names must match exactly as listed in the layout.
Record Layout
The third row and beyond contain the SIM records to process.
| Import Field Name | CostGuard Field Name | Required? | Notes |
| SIM Type | Yes | Values are: GSM or LTE | |
| ProfileName | SIMCard.ProfileName | No | There should only be one Profile record in a SIM Card Import file. All SIM Card records in the file will share the same ProfileName value. If multiple Profile records are present in a file then the last one read in will be the one that is used. |
| IMSI | SIMCard.IMSI | Yes | |
| SIMNumber | SIMCard.SIMCardNumber | Yes | |
| PIN1 | SIMCard.PIN1 | No | |
| PIN2 | SIMCard.PIN2 | No | |
| PUK1 | SIMCard.PUK1 | No | |
| PUK2 | SIMCard.PUK2 | No | |
| ActivationUrl | SIMCard.ActivationURL | No | |
| Authentication Key | SIMCard.AuthenticationKey | No | Allowed when type = GSM only |
| ADMPIN | SIMCard.ADMPIN | No | Allowed when type = GSM only |
| Kappli | SIMCard.Kappli | No | Allowed when type = GSM only |
| ADMPIN | SIMCard.ADMPIN | No | Allowed when type = LTE only |
| HexEUIMID | SIMCard.EUIMID | No | Allowed when type = LTE only |
| HexPseudoUIMID | SIMCard.PsuedoUIMID | No | Allowed when type = LTE only |
| SIPSecret | SIMCard.SIPSecrect | No | Allowed when type = LTE only |
| HRPDSecret | SIMCard.HRPDSecret | No | Allowed when type = LTE only |
| MIPAAASecret | SIMCard.MIPAAASecrect | No | Allowed when type = LTE only |
| MIPHASecret | SIMCard.MIPHASecret | No | Allowed when type = LTE only |
| CaveAuthKey | SIMCard.CAVEAuthKey | No | Allowed when type = LTE only |
| KKEY | SIMCard.KKey | No | Allowed when type = LTE only |
| SIMClassID | SIMCard.SIMClassID | Yes | Valid values are: 1 = eSIM and 3 = SIM Card (default) |