Ensuring a Smooth User Import
Published October 26, 2022
Tips for Configuring Your Excel File
For the sake of this post, we’re going to assume you are familiar enough with the import process to know what we mean when we refer to the Import Wizard or Batch User Import. That’s because we want to focus specifically on importing users by uploading a file to your Sona site. We’ve designed the Import Wizard to be forgiving, largely self-explanatory, and requiring minimal work when it comes to prepping the file you intend to upload. But there are some steps you can take to help ensure that the import process runs smoothly each and every time. We’ve put these together into a convenient checklist you can use and re-use as needed.
Before we start on our checklist, we really should specify what we mean by “uploading a file.” Basically, you’ll want to make sure the file type you intend to use can be uploaded to your Sona site, and this means making sure your file is saved as an .xlsx file. If you attempt to upload a different file type (e.g., a CSV or .xls file) you’ll get an error message when you hit the “Continue” button:
“System Message: Please upload a valid Excel file (XLSX format).”
Please note that this does not mean that you cannot use CSV files or similarly formatted files (e.g., an .xls spreadsheet) to import users. It’s just that the upload feature doesn’t support these file types. You can still copy and paste from such files instead of uploading if that is easier. After all, that’s why the very same page that allows you to select a file from your computer also has a giant textbox for you to use as an alternative. Although we’re focusing on the upload method here, we don’t want to downplay the utility of the copy and paste import method. You can use this method to import from non-XLSX file types by copying from e.g., an .xls or CSV file and pasting directly into the “Paste delimited text” textbox. If you want to click the “Choose file” button, however, to upload a file from your computer, then it needs to be an .xlsx file.
That’s more of a pre-Checklist to our actual checklist of tips. And now that we’ve gotten the correct file type matter out of the way, we can move on to our pre-Upload Checklist of items. If you start getting into the habit of considering each of the following items before you upload your .xlsx file, it can prevent you from using this list to troubleshoot unsuccessful imports:
- Carefully check the “Import Wizard — Step 3” page to make sure both the order and number of the fields matches the order and number of fields (columns) in your file. After you select which optional field types your file contains (e.g., alternate email address, password, etc.), and you’ve checked that your file also contains the three required fields (First Name, Last Name, and User ID without the @yourschool.edu part), clicking the continue button brings you to the field numbering page. Make sure the order of the fields matches the numbers, and that no values are repeated. So, for example, if your first column in your .xlsx file is “last name” and the second is “first name”, then make sure to put a “2” for the First Name field and an “1” for the Last Name field:
- Avoid any additional columns or cells. Getting the order of your spreadsheet columns to match the order you select is great, but you should also limit your spreadsheet to these columns. That is, you don’t want to have extra columns or cells that you don’t intend to be part of your import process:
- Make sure the “header” checkbox matches your files first row. There’s a checkbox right under the import file button that is checked by default:This is to let the system know that the first row of your spreadsheet contains headers. Though headers aren’t strictly necessary (because you are selecting which fields your file has and in which order), they’re common enough to warrant the default checked status. But if your spreadsheet doesn’t have headers, please remember to uncheck this box. You don’t want the first row excluded from your import unless it consists of headers.
- Use single worksheets for single course, instructor, and researcher import. You should really only upload a file with multiple tabs or worksheets if you select the multiple course import option:For any other option, using multiple worksheets or tabs in the same file is unnecessary and may cause problems. Be sure to check that your spreadsheet has no additional worksheets (or tabs). For example, if you store instructors as a tab in the same workbook you are using to import students to courses, you’ll want to create new files for each tab or worksheet.
- Do not use special characters, formatting, encryption, or password protection for worksheets or workbooks. Most characters that Excel will allow you to use to name or rename your worksheets are likely to be just fine, particularly as Excel will remove things like subscripts and will typically not allow highly irregular fonts (e.g., wingdings). But try not to go out of your way to be creative here, as certain formatting choices may cause errors when the system attempts to process your file. Security measures, though, are riskier here.If you try to upload a file encrypted with a password, or that contains specially protected worksheets, the chances are your security settings will prevent the system from reading your file. So you will want to avoid using password protection, encryption, or similar settings in the file you wish to upload. If you are using e.g., password protected files that you wish to retain after the import process, then you will probably want to copy and paste the contents of your worksheet or worksheets using the “Paste Special” method described at the end of this post. After you finish the import, you can delete the copies so that all that remains are your secured files.
- Make sure your worksheets have unique names. Again, unless you are uploading multiple worksheets using the multiple course option, you should really only have a single worksheet per file. If you are using the multiple course option, however, then it becomes much more critical to make sure they have unique names. Luckily, most of the time the entire point of using names is to be able to easily distinguish between worksheets (and Excel will likely stop you from using a worksheet name already in use in your workbook). So, while you certainly can use the generic “Sheet1, Sheet 2,…”, you are unlikely to encounter any problems using e.g., using course titles as worksheet names. Just make sure that each worksheet has its own, unique name.
- Use “plain text” in your files. Remove any special formatting, such as bolded text or italics, before uploading. You want your “data” to be as close to plain text as possible. This may include dragging the “fill” handle in Excel to auto-fill a column or row with the same function or formula used in a “template” cell (e.g., something that creates what looks like text in a cell, but if you look at the values in that cell you its value is something such as
= SUBSTITUTE ( CONCAT ( LEFT (A2,1), ".", B2), CHAR (32), "")). If you have a column in your worksheet that might have special characters, was generated using Excel functions or auto-fill, or in any other way may be read as non-text formatting, there’s a quick and easy fix. Simply copy the cells in the relevant column, paste them as text into a basic text editor like Notepad or TextEdit (make sure to select the “Plain Text” format for applications like TextEdit which can allow for “Rich Text”). Once you see the cell entries in your text editor, delete them from excel. Now you can copy the “Plain Text” from the text editor back into the column:
- Avoid using the back button. If you have to change something, it’s better to just restart the process. There are, after all, only a few steps, so it won’t take that much longer than if you hit the back button. And while hitting the back button may not create problems, why risk it?
- Uploading more than 300 users at once increases the likelihood of encountering problems. It’s tempting to import as many participants as you can in one go, and indeed that’s why we included the option to upload XLSX files in the first place. Importing very large numbers of users at a time, however, can put too large of a load on the system, increasing the chances that the system will stall, time out, or run into other issues. There is no hard and fast rule here, as there are several factors involved rather than something like a cut-off limit at 300. Often, uploading a file with more than 300 users will not cause any issues. The system doesn’t count up to a particular number of users and then stop.That said, you are more likely to encounter errors if you are trying to import more than 300 users at a time. And the more often you do attempt to, the more likely it is that one of those times will not work smoothly. Since this post and this checklist are concerned with optimizing the import process, you can think of the number 300 here as the point at which you are no longer necessarily “ensuring a smooth import process”. It may work, and it may work every time, but the more you exceed 300 and the more frequently you do, the greater the changes of error.
That’s all for our checklist! Essentially, we just want you to know some of the common errors that happen and how to avoid them. And you may have noticed that many items share something in common- simplicity. Whether it’s removing special fonts or using generic names for worksheets, as a general rule the simpler the better (and, contrariwise, the fancier you try to make your file the more likely you are to run into some issues that complicate the import process).
We’ll wrap things up with one final tip, but one that can be implemented (if necessary) mid-import.
What happens if, after you’ve uploaded your file, you discover mid-import that there appears to be an error processing your file? You did all kinds of work to get to this point, the time limit is approaching (well, it probably isn’t, but 2 minutes can feel like the 20 allotted when you get an error message and feel your heartbeat quicken), so now what?
First, please stay calm. Help is just a few clicks away:
(this button may be found by selecting “Help and Documentation” from the “Administrator” dropdown menu). Even the most dire errors can be repaired if you contact us, as apart from any technical solutions we may have for you, there is always our ability restore your system using a recent back up (one of the many perks of using our cloud-based services, even if we do say so ourselves!). Second, there’s a very good chance that you can fix whatever the issue is quite easily. Here’s how:
Simply copy the worksheet contents from the file you are trying to upload and then use the “paste values” option to paste only the values from the original spreadsheet into a new one. Don’t just copy and paste from the old spreadsheet (doing this will likely cause Excel to faithfully copy the old problem into the new spreadsheet). Instead, open the dropdown menu under the “Paste” select the “Paste Values (V)” item from the “Paste Values” section of the menu. Alternatively, after you copy from your original spreadsheet, you can right-click on the first cell in a new, blank spreadsheet, select “Paste Special” from the displayed options, and then click on the “Paste Values (V)” icon. Both methods are depicted below.
And that’s it! Nine out of ten times, this will work and your import will proceed smoothly from this point onwards.
May 17, 2023
Aesthetics, elegance, and other aspects of design are certainly important. […]
May 3, 2023
Several of our blog posts, including the most recent ones, […]
April 17, 2023
Generally speaking, automatic credit granting makes recruiting and compensating participants […]