Summary
This article provides guidelines for using the Bulk Data application to import files to create Journal item records.
Link:
File Format
General Format
The following general characteristics apply to Journal 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 Journal import, the identifier is:
FORMAT:IDI/CostGuardBulkData/Journal
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.
Custom Properties
An import file may include any number of journal custom properties. In the file header record, the custom property fields must be pre-fixed as follows:
ATTR_<attribute property name>
When using custom properties, please contact customer support for the specific property name to use in the Bulk Data file header. Only property display names are visible within the IDI platform and may not match the corresponding property name.
Record Layout
The third row and beyond contain the Journal records to process.
Field | DataType | Required Create | Description |
Description | Text | No | Name of the journal being imported. |
isInternal | Integer | No | 1 indicates this journal item is configured to prevent viewing by service subscribers. |
isRetained | Integer | No | 1 indicates this journal item will be displayed on the summary tab of the customer account. |
JournalStatusID | Integer | Yes | ID of a journal item status configured to be used with journal items of the specific class of this journal item. |
JournalTypeID | Integer | Yes | ID of a journal item type configured to be used with journal items of the specific class of this journal item. |
ObjectID | Integer | Yes | ID of the object the journal item is associated with. Note: A journal cannot be associated with another journal. |
ObjectType | String | Yes | Indicates the type of object to be accessed or acted upon. Options: Customer, BillingOrder, Equipment, JournalItem |
ATTR_* | String | No | Contains the value of a custom property for the journal being added. There may be zero or more custom properties included in an import file. See the Custom Properties section above. |