CSV Reader Event
An overview of how to configure the CSV Reader event in Dittofi
The CSV reader event lets you build in functionality to import custom CSV files into your apps. You can set up the CSV reader event in five quick and easy steps.
- Step 1. create a custom model
- Step 2. create an csv reader endpoint
- Step 3. create a csv reader action
- Step 4. add the csv reader event
- Step 5. build and test your code
- Step 6. looping through the CSV data
For the purpose of this example, we will be using the CSV file below.
To use the CSV reader event, you first need to head over to the custom models tab. You can find the custom models tab under the wrench icon in the Dittofi Design Studio.
Create a custom model with the custom attributes set to the same names as the CSV headers i.e. address_line_1, address_line_2 and postcode. See below.
TWO IMPORTANT THINGS TO NOTE:
- 1.When you create the Custom Attributes we set the type to Text. If you want to configure your app to import different data types, you need to set these data types. For example, if you want to import numbers, you need to set the data type to Number.
- 2.When you set the Custom Attributes, you need to choose between strict and nullable options. The nullable option allows you to import null values into the field. The strict option will force your system only accept the row of data if the field is not null.
You can create your CSV reader endpoint from within the endpoint tab. Set up the endpoint with the name "CSV Reader", the path "/v1/csv_reader", the description "Read in my address book", the request method to "Post" and the req content type to "multipart/form-data". You can see an example of this below.
Next, you need to add a body variable to your endpoint. This will allow your endpoint to accept the file that you're expecting to upload. You can set the name to "uploadfile" and set the type to "file", as below.
Next up, head on over to the actions tab and create a CSV reader action called CSV Reader and link this action to your endpoint.
Next, add the CSV reader event to your action and pick the file that is being passed in from your endpoint. Set the Single Row As option to use the custom model from step 1. This Single Row As variable is going to hold one row of data that is being looped over by the event. Lastly, set the All Rows As to AllRows. The All Rows As variable holds all the data that is being uploaded by the file in memory. The All Rows As variable is populated one row at a time as the file that has been uploaded is being looped over.
Finally, go to the action trigger and set the response variable to "AllRows". This will send all the rows of data that are being uploaded back to your endpoint. This can be useful if you want to display this data immediately in your frontend.
To build your code, click the "Build code" button and wait for the code to build. Once the code has been built, open up your CSV reader endpoint and click the run button. Using the body variable input, select the test CSV file and click run.
You will notice that the response variable from your CSV reader action, "AllRows", is displayed in your endpoint. This is the same data that is in your CSV file upload.
Now that you know how to use the CSV Reader event, you can combine this event with different events and workflows to do all kinds of things with your data. You can, for example, display the data in the front end of your app, extend the action to map this data into a Data Model and much much more.
Notice, you can also loop through the CSV data and map this data into one of your Data Models. To do this, create a Data Model to store the data.
Next, head on over to the actions tab and open up the CSV reader action that we created in step 3.
Add a Loop Event to iterate over the CSV data stored inside the AllRows variable.
Next add a Create Event inside the loop event. This will be used to write each row of data that is iterated over to your Data Model.
Finally, map the RowOfData to the columns in your data model.
Notice, you can do anything in the loop such as send emails to everyone in the csv file if you have a list of emails in your file.