Documentation Index

Fetch the complete documentation index at: https://help.idibilling.com/llms.txt

Use this file to discover all available pages before exploring further.

IDI version 26.8 is now available.  Click here for details: IDI Updates.

Bulk Data – SIM Record Import

Prev Next

Summary

This article provides guidelines for using the Bulk Data application to import files to create (pre-load) SIM records or modify existing 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).  Whether to create a new record or modify an existing one is specified by the row’s Action identifier.

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 IDI Desktop Client SIM Management (Applications > BackOffice Management).

Link:

Example Specification

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 import identifier is optional if you import files via the Bulk Import web module. The correct identifier is automatically applied by selecting the type of import.

If you import using the file automation method by uploading files and placing them on the file server, 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 import file must contain the appropriate column names.  This is typically the first row when using the Bulk Import module. It is the second row if you use the file automation method. 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.

Clear Values

When modifying a record (Action = Modify), you can specify to clear the  previous data. To clear data, the record must contain “@[System.Clear]” without the quotes. Example:

@[System.Clear]

Attempts to clear data for fields that are of ‘Yes/No’ data types or required, will result in an errored record.

Record Layout

The third row and beyond contain the SIM records to process.

Import Field Name

IDI Platform Field Name

Required?

Notes

Action

Text

No

Indicates the operation to perform on a SIM.
Valid Values: “Create” or “Modify”. When not specified, this value defaults to “Create”.

SIM Type

Yes

Values are: GSM or LTE

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)