Bulk Data Import

Summary

This article provides guidelines for using Bulk Data Import to create and/or modify device records. Rather than using the existing IDI Desktop Client Device or Samsung Manifest File Upload utilities, 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 Device records via IDI Desktop Client Device Management (Applications > BackOffice Management).

Link:

Example Specification

File Format

General Format

The following general rules apply to device 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 be 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 described below 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 device import files the identifier is:

FORMAT:IDI/CostGuardBulkData/Device

Note:
“Format:” is part of the identifier and must be included.

Header Record

The import file must contain the column names to be included in the file. This is typically the first row when using the Bulk Import Module. It is the second row when using the file automation method. The column names are listed in the Record Layout section of this document. The columns do not need to be in a specific order. Import files do not need to include all columns; only those that contain data to be imported. The column names must match exactly as listed in the layout section.

Clear Values

The modify action lets you clear previously set data. To clear data, set the record value to the following: @[System.Clear]

Refer to the sample import file for an example of this.

Note:
Attempts to clear data for fields that are Yes/No data type or required, will result in an errored record.

Record Layout

Field	Data Type	Required for Create	Required for Modify	Description
Action	Text	No	Yes	Operation to perform on a device. Valid Values: Create or Modify. When not specified, the action defaults to Create.
AKey	Text	No	No	Authorization key.
SerialNumber	Text	See note		Device serial number. The device must have either a serial number or alternative serial number. Based on the SerialNumberTypeID this value will be: DEC ESN DEC MEID IMEI Note: This field is required when AlternateSerialNumber is not specified.
AlternateSerialNumber	Text	See note		Alternate representation of the device serial number. Note: This field is required when SerialNumber is not specified and is ignored when SerialNumber is specified.
Bind	Boolean	No	No	Indicates whether or not the device is currently bound to a service number.
BlackBerryRegistrationID	Text	See note		ID as received from manufacturer. Note: Required for adding a Blackberry device.
DecimalPseudoESN	Text	No	No	Decimal representation of the ESN.
HexPseudoESN	Text	No	No	Hex representation for the ESN.
DeviceStatusID	Integer	No	No	Status of the device. 1=Active, 2=Inactive, 3=Stolen Other statuses may be defined via Backoffice > Device Management.
DeviceStatusException	Text	No	No	Semicolon-delimited list of device status values to not replace on a modify action. Device Status will not be modified if the current value is one of the values in this list.
EID	Text	No	No	For use with eSIMs, the EID (Embedded Identity Document) is a unique identifier built into the device.
HandsetCatalogID	Integer	Yes	No	Unique identifier of the device’s product catalog value. Note: This field is required when TechnologyTypeID is not specified.
HandsetCatalogIDException	Text	No	No	Semicolon-delimited list of handset catalog ID values to not replace on a modify action. The ID will not be modified if the current value is one of the values in this list.
TechnologyTypeID	Integer	See note	No	Unique identifier for the device’s technology type as set in the Product Catalog (Technology field). 1=CDMA/TDMA, 2=GSM, 4=Dual Mode (CDMA+SIM) Note: This field is required when Handset Catalog ID is not specified and is ignored when Handset Catalog ID is specified.
HandsetSKU	Text	See note	No	Device SKU as defined in the Product Catalog. Note: This field is required when HandsetCatalogID is not specified and is ignored when HandsetCatalogID is specified.
HandsetSKUException	Text	No	No	Semicolon-delimited list of SKUs to not replace on a modify action. The SKU will not be modified if the current value is one of the values in this list..
HardwareVersion	Text	No	No	Version of the device’s hardware.
HardwareVersionException	Text	No	No	Semicolon-delimited list of version values to not replace on a modify action. The version will not be modified if the current value is one of the values in this list.
MSL	Text	No	No	Mast Subsidy Lock value for the device.
MSLException	Text	No	No	Semicolon-delimited list of MSL values to not replace on a modify action. The MSL will not be modified if the current value is one of the values in this list.
OneTimeSL	Text	No	No	One time SL number for the device.
OneTimeSLException	Text	No	No	Semicolon-delimited list of OneTimeSL values to not replace on a modify action. The OneTimeSL will not be modified if the current value is one of the values in this list.
PIN	Text	No	No	PIN associated with the device.
ReservedForRetail	Boolean	No	No	If true, will mark the device as reserved for retail.
SID	Text	No	No	System Identification Number for the device.
SIMCardNumber	Text	No	No	ID specific to a SIM card as provided by the SIM card dealer.
SoftwareVersion	Text	No	No	Software version the device is on.
SoftwareVersionException	Text	No	No	Semicolon-delimited list of software version values to not replace on a modify action. The software version will not be modified if the current value is one of the values in this list.
SourceCode	Text	See note		The device’s source code. Note: This field is required when SourceCodeID is not specified and is ignored when SourceCodeID is specified.
SourceCodeException	Text	No	No	Semicolon-delimited list of source code values to not replace on a modify action. The source code will not be modified if the current value is one of the values in this list.
SourceCodeID	Integer	See note	No	Unique identifier for the device’s source code. 1=Coupon, 2=Inbound, 3=Online, 4=Outbound, 5=Other Note: This field is required when SourceCode is not specified.
UpdateActiveServices	Boolean	No	No	If true, update the device’s active services.

Documentation Index