In order to access and utilize the Data Import CSV API within the Control Panel, one must have security access. The security needed is Allow .csv Data Import set to Yes.
If user(s) have security permission to allow .csv data import, then the user(s) can access the Data Import CSV API tab.
Data Import CSV API in datavis
The Data Import page has been redesigned into a datavis with function buttons, to enhance user experience and usability. However, the Legacy Data Import screen is still accessible on the page for use.
Within the redesigned Data Import page, a specific data import api tool is able to be selected (checkmark) and then displays individual buttons for the user to access/see/obtain information for an Overview, Specifications information, Sample file information, Help Guide, and the Upload Data screen for the specific Data Import API selected.
In a new system or upon upgrade, the updated Data Import datavis page may not work unless you set ‘ csv_api_data_import’ JSON model_security on applicable security roles needing access.
Any data needing to be imported, must be formatted in an appropriate CSV file, according to the specific import type’s specifications.
Data Import Options
Once a specific Data Import CSV API option has been selected (checkmark which you wish to use the data import for), the Data Import Option buttons will display for use at the bottom of the datavis.
Show Overview
The Show Overview button essentially is a pop-up window with the Data Import’s specific overview of what it will import, along with all the other option abilities (view specification files, view sample files, view any help guide documentation for the specific import selected, and ability to upload/import the data) all within the same pop-up window.
- Description: Gives a brief description of this specific data import that was selected.
- Specification File(s): Will take the user to a new separate window tab (typically a google drive document) to view the specific criteria/specifications to format the CSV file columns and rows of data with.
- Sample File(s): Will take the user to a separate window tab (typically a google drive document) to view the specific criteria/specifications to format the CSV file of data with, but in a sample CSV file. Essentially, showing a full sample formatted file for the specific import selected.
- Help Guide Documentation: Will take the user to a separate window tab of the Enterprise Health published help guide specific to the import selected.
- Upload Data Import File: Will pop-up the Upload Data screen to begin the import upload process.
Upload Data
The Upload Data pop-up window shows the field requirements (Interface, Verbose checkbox, Delimiter) and the CSV file field to browse and upload the CSV file needing to be imported that is for the specific Data Import selected.
- Interface: You can change the default name to be any text you wish. When changing the Interface field name, it’s best to be a unique name to identify the import.
- Verbose: It is recommended that you checkmark this to view more detailed information about the data processing during the import step. A data import verbose log is an extremely detailed record of the entire row/line process of bringing data into the system.
- Delimiter: Use the drop-down to select the delimiter. Typically it is as Comma
- CSV File: Browse out and select the CSV file you wish to import, that follows all specifications the specific import requires. The Data Import only accepts CSV file format.
After browsing to select the file to import, make sure to click the Validate File button before beginning the data import upload. The Validate File button will analyze the data in the file to alert you of any issues (or of a successful file with no warnings or errors) before you click to Upload File to begin the import process.
Here’s an example of possible messages visible after Validate File is clicked:
- Upload File: Once ready to import the data from the CSV file, click the Upload File button. The system will begin the import process.
Verbose Log
Once the CSV is uploaded, and if you had checkmarked Verbose in the upload requirements section (which is always recommended), you will then see a Verbose Log after the import has been processed.
- Show Log: Click this to see the detailed records of rows and lines of the entire process of bringing that CSV file data into the system. This will show successful processed rows of data and will also display any rows of data that have errored.
- Download Log: The download log button will download the log into a notes text file that you can save to your device/computer, etc.
Note: Any data that had errored, would not have been imported into the system. Thus, those would need to be fixed and placed on their own unique CSV file to import later once you’ve worked any issues the Verbose Log displayed as having an error. This is why using the Validate File button is also important to do before the upload file process.
Log:
Once the CSV is uploaded, and if you had not checkmarked Verbose in the upload requirements section (which is always recommended), you will then only see a** Log** after the import has been processed.
- Show Log: Click this to see an overview success or errored per row of the CSV file that was imported. It does not granular Verbose detail in the log, since Verbose was not marked to be utilized.
- Download Log: The download log button will download the log into a notes text file that you can save to your device/computer, etc.
Specifications
Will take the user to a new separate window tab (typically a google drive document) to view the specific criteria/specifications to format the CSV file columns and rows of data with.
Sample
Will take the user to a separate window tab (typically a google drive document) to view the specific criteria/specifications to format the CSV file of data with, but in a sample CSV file. Essentially, showing a full sample formatted file for the specific import selected.
Help Guide
Will take the user to a separate window tab of the Enterprise Health published help guide specific to the import selected.
Legacy Data Import
Within the updated datavis Data Import CSV API screen, there is the ability to get to our Legacy Data Import look and screen. Simply click the Legacy Data Import hyperlink to get to our legacy screen and the directions below apply.
Once in the Legacy Data Import tab, use the drop down to select the Enterprise Health data import type and click the GO button to continue on.
Learning Management System
To learn more about the Data Import Tab, follow the link below to the Learning Management System course:
Additional Information
Additional help guide available: Data Import Master List