Overview
The Manual Upload Process allows users to upload sample result data files into the Klir platform. This document provides step-by-step instructions for importing sample results using an Excel file.
Prerequisites
- Admin access to the Klir platform.
- A file in the supported format (Excel) containing the sample result data.
- A properly formatted file matching the required data structure (template available).
Steps to Upload Sample Results
1. Access Data Management
- Navigate to the Admin section of the Navigation Menu.
- Click on Data Management.
2. Initiate the File Import Process
- In the Data Management screen, select File Imports from the options.
- Click the Create New Data Transfer button to initiate the upload.
3. Select Sampling Data Type
- From the available options, select Sampling to import Sample Results.
4. Download Sample Result Upload Template (Optional)
- If needed, you can download the Sample Result Upload Template by clicking the New Template button. This template contains the correct column headers for formatting your data file.
Fill in all Required Fields: The template includes mandatory fields that must be populated for successful sample results uploads.
These fields include:
- Sample ID: ID field for individual Samples and results that should be a unique value.
- Facility ID (may be called PWS): This code identifies the system where the sample will be associated. It must be selected from a predefined list of available system codes in Klir.
- Monitoring Location ID: This ID specifies the location where the sample will be collected or monitored.
- Collected Date: Date when the Sample data was collected.
- Parameter: Value used to identify the compounds sampled.
- Received Date: Date when the Sample data was received.
- Result: Sample result data
- Unit of Measurement: Unit of measurement unit for the sample data (e.g., mg/L, µg/L, etc.).
You may upload sample results with only the mandatory columns filled out, though having values for the other columns is beneficial.
If you have any data points that is not part of the upload template column layout, we recommend reaching out to your Customer Success Manager (CSM) for guidance. In such cases, we may be able to map the data to an unused column to add the additional data there, and your CSM will assist in determining the best approach for incorporating it into the system.
5. Upload the Data File
- Once your data file is ready, click the + Import from Excel button.
- Browse and select the file you wish to upload.
6. Map File Columns to Klir Entities
- After selecting the file, the Column Mapping screen will appear. In this screen, you will match the columns in your upload file with the corresponding Klir entities.
Column Mapping Overview:
- Klir Entity: The field that the Klir platform expects in the upload file.
- File Column Mapping: The column names from your upload file.
Important:
- Any Klir Entity marked with a red “*” is mandatory and must be mapped for the upload to be successful.
- Columns without the red “*” are optional but highly recommended to ensure complete data.
Example:
- If the upload file has a column named “Locations” but Klir expects “Monitoring Location ID”, you will need to map “Locations” to “Monitoring Location ID” in the column mapping screen.
Select the appropriate Klir Entity for each file column by clicking on the picklist next to the file column name. Choose the correct Klir Entity value to ensure proper mapping.
7. Save and Import the File
- Once all columns are mapped, click Save and Import.
- The File Imports screen will reload, showing the filename of the newly uploaded file.
8. Monitor Upload Status
- The system will process the uploaded file, and you can monitor the upload status:
- Success: The file was processed without errors, and the data was successfully imported.
- Completed with Errors: Errors were found during processing. Errors will need to resolve for these issues on the lines of data that had errors.
- Error Resolution Methods: There are a few approaches you can take to resolve errors:
- Isolate and Resolve Errors:
- Copy and paste the rows containing errors into a new spreadsheet. Once the errors are fixed, you can upload the updated file.
- Re-upload the Entire File:
- Alternatively, you can re-upload the entire file after correcting any errors. Re-uploading the file will overwrite any existing values on the platform with the new data present on the re-uploaded file.
- To view error details, click the 3-dot menu next to the uploaded file, and select View Errors.
Error Handling and Resolution
If the upload status shows Completed with Errors, follow these steps to resolve the issues:
1. View the Error Report
- The Error Report provides the following details:
- Line Number: The row in the uploaded file where the error occurred.
- Column: The specific column that contains the error.
- Description: A brief explanation of the error.
- Value: The incorrect value that caused the error.
2. Investigate and Resolve Errors
- Review the error report, identify the issue, and correct the data in the file. Common issues include:
- Mismatched column names or missing required fields.
- Invalid data formats or values.
3. Re-upload the Corrected File
- After addressing the errors, re-upload the corrected file by following the same steps outlined above.
Additional Resources
A video walkthrough of the manual upload process is available for reference - 18 Mins.
Troubleshooting Tips
- Ensure that all mandatory fields marked with a red asterisk (*) are populated.
- Double-check the column mapping to ensure that all file columns are correctly mapped to the corresponding Klir Entities.
- If encountering persistent errors, contact Klir support for assistance.
Conclusion
This guide provides a comprehensive walkthrough of the manual upload process for sample results in the Klir platform. By following the outlined steps and resolving any upload errors, you can successfully import sample data into Klir.