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 – Disassociate Device from Services Specification

Prev Next

Summary

This article will provide the necessary information when importing files for disassociating devices from services using the Bulk Data application.

Sample File

File Format

General Format

The following general characteristics apply to the Disassociate Device From Services 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

  • Place quotes (“) around any text fields containing a comma.

  • Empty (non-required) fields are acceptable.

  • The columns are not required to appear in a specific order.

  • 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 customer file the identifier is:

FORMAT:IDI/CostGuardBulkData/DisassociateDevice

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 if you use the Bulk Import module. It is the second row if you use the file automation method. The column names can be found 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 the columns, only the columns that contain data to be imported are necessary.

Clear Values

This import file does not support the ability to clear previously set data.

Record Layout

Column Name

Required

Data Type

Description

EquipmentNumber

Yes

Text

The Equipment ID (aka serial number) or alternate Equipment ID of the device to disassociate from services

DeviceStatusID

Yes

Integer

The New status for the device once it is disassociated from all services

ReserveForRetail

No

Yes/No

If set to true, it will mark the device as reserved for retail once it is disassociated from all services.

SourceCodeID

No

Integer

New source code for the device once it is disassociated from all services

Document Version History

Version

Change Description

Change Date

1.0

Version 19.8

08/29/2019