The bulk loader tool featured in BillingPlatform allows you to upload data sets without having to manually enter each item on the user interface. This can be a very useful feature for uploading a large amount of items such as accounts, pricing plans, products, or anything that belongs to an entity.
The bulk load tool is an advanced feature and should not be used before fully understanding how it works. The included articles will assist you in learning the operation of the bulk load tool.
The Data Model
BillingPlatform runs on an entity model that allows you to perform bulk load operations within your system -- ranging from system components to your custom created entities. It is important to understand the entity model before proceeding with the bulk load tool. This will enable you to envision where the data will end up and how it will be tied to the rest of the data within your application. More information about the data model can be found here.
Preparing the Data
Data must be prepared in a delimited file. The most common being comma delimited, which will be saved as a CSV and can be created from a spreadsheet. Other delimiters are acceptable, but must be defined at the bulk load setup. Data must conform to all rules set forth during normal setup i.e. unique fields must still be unique, required fields are required, etc. Please account for this when collecting the data to be imported.
Entities must be loaded one at a time, for example accounts and billing profiles are setup simultaneously when entering through the user interface, but as these two are separate entities they must be loaded one at a time, and in the proper order, parent entity first, then child entity.
In the example above you would first upload accounts, the data at this step will only include the fields under the account entity. After the upload is completed you will be able to download the post upload file. This post upload file will contain all the data that you just uploaded, as well as the ID the system will assign to each record. This ID will need to be integrated into the billing profile upload as a way to tie the corresponding records together i.e. ACCOUNT1 is uploaded, then in the downloaded file the system assigns the ID 123, when uploading the billing profile, the ID 123 must be in the row with the billing profile information for ACCOUNT1. These steps are explained in more detail in the tutorial section for setting up the bulk loader.