Search the Community
Showing results for tags 'csv onboarding'.
Found 1 result
2600HZ STEP GUIDE -- CSV ONBOARDING CSV Onboarding is a tool that allows you to enter an exported list (.csv file) of users and (optionally) phone data into the KAZOO environment. This replaces the process of entering the most common data manually when you are first setting up your users. Before you Start Create a .CSV (Comma-Separated Values) export file from your existing phone list. The following fields are used by KAZOO; you can create the same fields or if there are existing field names, map what is imported to the KAZOO names. first_name, last_name, password, email, extension, notification_email, mac_address, brand, family, model NOTES If you want to upload User names only, the fields after extension are not required. Notification_email field is optional for either onboarding option. Double-check the field name and spelling of your phone model. It must match the syntax and capitalization exactly for the import to be successful. Quick Steps Open the CSV Onboarding app. Choose if you want to Add Users only, or Add Users & Devices Drag the .csv file you created into the box and pick Proceed. You will see your imported file. The top row above the drop down fields displays the fields in your .csv file. Using the drop-down fields, select the KAZOO field you want the .csv field to map to. If you have advanced programming knowledge, enter your json payload information for Pick Proceed. The screen will follow your progress. If you want to cancel, close the window. Detailed Steps Activate and open the CSV Onboarding app. Choose whether to onboard Users Only or Users and Devices Adding Users Only You will see the screen below. Check your .csv file to make sure it includes a header row with the fields mentioned. NOTE: If the header is different, you will be able to match/change that in the next step, but the values for the columns must match. Once you upload the file, you will see this screen. Click on the Proceed button. You will see a screen like this: And when the process is complete you will see a confirmation screen Click Proceed. You will Then see a screen showing a preview of how your .csv file and data maps to the Smart PBX system data. It will look something like this. What to look for as you review this page: The fields displayed above the drop down field options are the fields that were imported from your .csv file. The field names in the drop down are the proposed match to your import file. You will need to verify this is correct. If the field is empty and should map to a required field in the drop down options, you must assign it a value. All required fields must be mapped to one of the columns you have imported so the system will be able to place them in the correct instance. If some fields are empty they will transfer as empty. Make sure to scroll to the right to see all the fields. The JSON Checkbox If you want to add some advanced custom settings for voicemail boxes, call parking and other feature codes using JSON, check the box at the bottom of the screen. You will be prompted to add your code into one of 3 different fields: User Settings, Device Settings, or Voicemail Box Settings. Some reference information about these settings is included at the end of this document. Sample .csv file Sample CSV File with Device list added Spreadsheet First Then saved as a .csv file, will look like something like this, commas separating the fields. MAKE SURE THERE ARE NO SPACES! This will block the import. first_name,last_name,login,email,extension,notification_email,mac_address,Phone,Family,Type AUser,One,userone,firstname.lastname@example.org,101,email@example.com,00-15-E9-2B-99-3C,111-22-1231,aaa,111 BUser,Two,usertwo,firstname.lastname@example.org,102,,00-15-E9-2B-99-3D,111-22-1232,bbb,222 CUser,Three,userthree,email@example.com,103,,00-15-E9-2B-99-3E,111-22-1233,aaa,111 DUser,Four,userfour,firstname.lastname@example.org,104,,00-15-E9-2B-99-3F,111-22-1234,bbb,222 EUser,Five,userfive,email@example.com,105,firstname.lastname@example.org,00-15-E9-2B-99-3G,111-22-1235,aaa,111 FUser,Six,usersix,email@example.com,106,,00-15-E9-2B-99-3H,111-22-1236,bbb,222 GUser,Seven,userseven,firstname.lastname@example.org,107,email@example.com,00-15-E9-2B-99-3I,111-22-1237,aaa,111 JSON Reference links To add your custom JSON payloads, check the box that says "add JSON", and you will see this screen. It shows an added script to assign a voicemail box. For additional reference to the syntax for JSON scripts, check the links below. Devices: https://docs.2600hz.com/supported/applications/crossbar/doc/devices/ Users: https://docs.2600hz.com/supported/applications/crossbar/doc/users/ VoiceMail: https://docs.2600hz.com/supported/applications/crossbar/doc/voicemail/ docs.2600hz.com Devices - Kazoo API Reference REST API Reference for Kazoo Crossbar API docs.2600hz.com Users - Kazoo API Reference REST API Reference for Kazoo Crossbar API docs.2600hz.com Voicemail Boxes - Kazoo API Reference REST API Reference for Kazoo Crossbar API ##### Previous Page Next Page