Kavi® Members Help
Table of Contents
Use the Upload Data tool to perform batch uploads of company or user data when setting up a new site, migrating records from legacy databases or adding, editing or deleting records as a batch. This is a powerful tool designed for use by experienced Super Admins who have an advanced understanding of Kavi Members configuration, required data fields and organization policy regarding privacy options. If you have just a few records to upload or have not yet acquired this degree of expertise, please use the standard Kavi Members Admin tools. Upload Data is not designed to be used as a general substitute for Admin tools such as Add a Company or Add a User, which provide a more extensive enforcement of site-specific rules and configuration.
All users are strongly advised to read and follow the instructions carefully. This includes the instructions you are reading now and supplementary Instructions listed below.
Upload Data comes with a built-in Test Run feature that checks your data file and identifies errors that need to be corrected before you commit your changes to the database. When you upload a file with the Test Run feature enabled, the tool performs a validation check on your data and no changes are committed to the database. It's a good idea to perform a test run on every file before performing an actual upload.
When you perform a test run on a data file, validation results will display any validation errors encountered during the test run. Make whatever corrections are necessary and repeat the test run and correction process until the data file passes the test run without any validation errors.
Once the file passes this validation check, you will be sent an Upload Results Email detailing the changes that will be made if the file is uploaded. Always open and review the Upload Results for the test run before performing the actual upload to make sure you approve the changes before you commit them to the database.
Since the Super Admin is ultimately responsible for the results of any upload performed through this tool, you are strongly advised to read and follow the instructions carefully. Since changes committed to the database are permanent and cannot be rolled back, time and effort spent preparing data for the upload process pays off in smooth and efficient data management and reduced administrative burden. In a worse case scenario, a carelessly performed upload has the potential to corrupt the database. This is rare, but if it happens, the database usually has to be restored from backup versions, resulting in a loss of any changes made between the time the backup was created and the time the database was corrupted.
The instructions for the Upload Data tool are divided into several documents (including this one). This document provides general instructions on using the tool once your data file is prepared. The Upload Data tool is easy to use —preparing the data file so that company and user records in the database follow configuration rules and organization policy is the hard part. You are referred to the following documents for instructions on preparing data files.
Click the link for the instructions you want to see:
For tips on working with CSV data files, see Preparing CSV Files for Upload Data.
For examples of company data prepared for specific kinds of upload actions, see Sample Company Data Files for the Upload Data Tool
For examples of user data prepared for specific kinds of upload actions, see Sample User Data Files for the Upload Data Tool
Detailed information for preparing data files for specific kinds of actions is provided in Upload Data Instructions for Add, Edit and Delete Actions. This includes instructions for populating a database for the site setup process, adding new companies and users, adding memberships, and editing or deleting records. Begin with the general instructions, then follow the instructions for the specific type of action(s) you wish to perform.
For detailed information on data fields, use the Guide to Predefined Data Fields to lookup the circumstances under which a field is required or optional, and which value is inserted by default if no value is provided. Since this guide is the definitive source for information on data fields, other documents in this set are heavily cross-linked to it.
Populate the Members database as part of the Web site set up process.
Add multiple new companies or users to the database, and if they are members, add new memberships.
Edit the records of multiple companies or users simultaneously.
Add new memberships for companies or users who already exist in the database.
Permanently delete a batch of company or user records from the database.
Perform a mix of actions on company or user records: adding, editing and/or deleting in a single upload process.
Because the data preparation requirements for this tool can be somewhat complex and are different for each type of action, detailed instructions have been provided in the Appendix, as described above.
Important
The suppress email feature is set to 'Suppress email' by default, and there are few circumstances under which you would want to change this. After the upload operation is complete, you will have the option of sending email to companies or users whose data has changed. This option doesn't suppress the Upload Results Email.
You have the option of performing a test run to check your file for errors or performing an actual upload. When uploading data, run your data file through the Upload Data steps to make sure the file uploads properly before performing the actual upload to minimize the possibility of introducing errors into the database.
To perform a test run, set the 'Test Run' option to 'Do a test run.', add the email address you will be monitoring for test results in the 'Email Results To' text box, then validate your file. If the Validation Results display any errors, press Back to return to the Options step, correct and resave the data file, then press Validate. All your option settings are retained so you don't have to reset them when repeating test runs. You don't even have to browse for the data file again unless you save it under a new name. Repeat this process until no errors appear in the Validation Results and all the rows that contain records are listed as 'good rows' in the results.
Remember that the first row of the data file contains the column headings and 'good rows' refers only to the rows that contain data records, so the number of 'good rows' should equal the total number of rows minus one.
Once the data file passes the validation check, press Upload Data. The results of the test upload will be sent to you in an Upload Results Email. Be sure to review the test run upload results to make sure the upload worked properly and look over the changes that will be made to be sure they are appropriate.
If you are satisfied with the changes listed in the Upload Results Email, your file is ready for upload. Press Upload Another File to return to the Option step, set the 'Test Run' option to 'Do NOT do a test run. Do the real upload.' and follow the steps to commit your changes to the database. When you are done, take the time to review the Upload Results Email and double check your results.
Options
- CSV Templates and Data
-
Download the appropriate company or user template or data file and prepare it for upload.
Templates and data files:
- CSV template for adding new users
Use this link to download the person.csv template when you want to add new users to the database. The template contains column headings but no data. This template can be used to add users whether there are already user records in the database or not. It cannot be used to edit or delete existing users.
- CSV data file for editing or deleting existing users
Use this link to download the person.csv data file when you want to edit or delete users who already exist in the database. The data file will contain records for every person in the database. This data file should not be used to add new users.
- CSV template for adding new companies
Use this link to download the company.csv template when you want to add new companies to the database. The template contains column headings but no data. This template can be used to add users whether there are already user records in the database or not. It cannot be used to edit or delete existing users.
- CSV data file for editing or deleting existing companies
Use this link to download the company.csv data file when you want to edit or delete companies that already exist in the database. The data file will contain records for every company in the database. This data file should not be used to add new companies.
- CSV File
When your CSV data file is ready, browse for it on your hard drive and select it for upload.
- Data Type
Set this option to tell the Upload Data tool whether you want it to upload company or user data.
- Suppress all scheduled user and company emails for this upload.
Settings:
- Suppress email.
Select this option except on those rare occasions where you do want scheduled email to be sent. This option won't suppress the Upload Results Email. You will have an opportunity to notify companies or users who have been affected by data changes after the upload operation has been performed.
- Do NOT suppress email. Send out all scheduled email.
This is rarely used except by those who have enough experience with this tool and familiarity with the organization's scheduled email to accurately predict the outcome of the upload and are confident that only appropriate email notifications will be automatically generated.
- Test Run
-
Keep this set to 'Do a test run' until your data file has passed the validation check. Review the Upload Results Email after each test run, fix any errors in the data file and make sure you are getting the desired results. It may take several test runs before your test run to validate your data and preview the results of uploading your file, set this option to 'Do a test run'.
When your data file has passed the validation check without requiring any edits, you are ready to upload your data. Set this option to 'Do NOT do a test run. Do the real upload.'
- Upload Results Email
During the data file validation testing, enter the email address you are currently monitoring so you can check the results immediately. When you perform the actual upload, add the addresses of any other users who should receive the upload results.
Validation Results are displayed for you to review. This may include a list of errors encountered during the upload process, followed by a list of all successfully uploaded rows. The results describes the type of error and the row in which it was found. If your data file contains validation errors, press Back to return to the Options step, correct the errors, save and revalidate the file as described previously.
If the file passes the validation check, press Upload Data. If you are using the Upload Data tool in test run mode, no changes will be committed to the database at this time. If you are performing an actual upload, your changes will be committed to the database.
Your data has been uploaded and the Upload Results Email has been sent to the specified address. Always review the upload results to be sure the upload completed successfully.
If you performed a test run, examine the test run upload results to be sure no errors occurred. Sometimes errors occur that can't be detected during the validation check. You should also look over the results to make sure you are committing an appropriate set of changes to the database. If the results look good to you, your file is ready for upload. Press Upload Another File, reset the 'Test Run' option to 'Do NOT do a test run. Do the real upload.' and run through the steps to perform an actual upload. If you have any concerns, please contact Kavi support before proceeding with the actual upload.
If you performed an actual upload, examine the upload results to be sure no errors occurred and the desired set of changes were committed to the database. If you followed the data file preparations as described in the Instructions for Upload Data Add, Edit and Delete Actions, performed the test run and reviewed the test run upload results as instructed, everything should be fine. If you have any concerns, please contact Kavi support for assistance.