Configuration
boomxl is flexible enough that meets your needs and can be configured dynamically.
boomxl configuration is Array of Objects and each object represents individual field and its validations and normalizations, the object represents one column in uploaded excel/csv file that it is going to be mapped with.
columns
columns is the first and most important key:value pair of boomxl configuration object, It is an array of objects and each object represents one single column in uploaded excel/csv file. Below are various object keys of individual column object.
name
name key represents the name of column it is expecting in the uploaded excel/csv file, it must be unique to other configuration options and it will be returned in processed json object and will be the key in each returned response array. This is required and must be non-empty and must not contain any space.
columns:[
{name:"some_name"}
]
}
label
label displays the column name during mapping process, it is human readable name for respective column name. This is required and must be non-empty.
columns:[
{label:"some human readable label"}
]
}
webhook_url
webhook_url is key:value pair of boomxl configuration object, It defines the URL where boomxl will send processed results, The request method will be POST and below is the sample response format.
"webhook_url":"https://post.url"
}
"data":{
"worksheet_name" : "selected_worksheet_name",
"rows" : [{array_of_objects}]
},
"file_id" : "uploaded_file_id_hash"
}
Sample Object
Below is the basic sample object for configurations, you can check other additional column options in next section under validations and normalization
columns:[
{name:"some_name", label:"some human readable label"}
]
}