Wiki source code of Batch Uploads

Version 14.2 by karimpirani on 2014/07/14 17:44

Hide last authors
karimpirani 1.1 1 **Batch Data Upload Process**
2
karimpirani 14.2 3 The batch data upload process allows you to quickly populate the system database with existing data that is already recorded in electronic format on one of your other data systems. The following is a step-by-step guide to making your way through this process.
karimpirani 1.1 4
5
karimpirani 14.2 6 csv process - batch uploads - common looking/format data (export/import)
7 usually, CSV: text file, 1 line in file per assessment ;;; client id, date, score, assessor ~-~-- way to transfer assessment data
karimpirani 1.1 8
karimpirani 14.2 9 Prepare your file for uploading:
karimpirani 1.1 10
karimpirani 14.2 11 ~1. CSV file type: please note that you will be required to upload all data to the system as a CSV file. Short for comma-separated values file, these files enable both parties (i.e. those responsible for importing and exporting the data) to have common expectations as to the data that must be uploaded and what the data signifies. They also prove to be the simplest and most effective way to transfer assessment data for clients. In the batch upload process, therefore, your CSV file will contain all the necessary and pertinent information for clients. Each CSV file, usually a text file, can contain information about many different clients. An outline for what to include and what format to use is shown below.
karimpirani 1.1 12
karimpirani 14.2 13
karimpirani 14.1 14 * Use of CSV file.
15 * Export of client's data to CSV file format
16 * Show a few columns on a fake and limited spreadsheet.
karimpirani 1.1 17
karimpirani 14.1 18 Batch Upload Data Formats
karimpirani 1.1 19
karimpirani 14.2 20 * Most common upload formats include: Role, Client, Staff Member, etc.
21 * Some customized formats may be available or could be developed. Please contact OA for more information.
karimpirani 1.1 22
karimpirani 14.1 23 **General Uploading Process**
Matthew Deceunynck 13.1 24
sghareeb 4.2 25 ~1. Log into the application
karimpirani 1.1 26
27 2. Select the Batch Uploads option under the Administration sidebar
28
karimpirani 7.1 29 [[image:batch uploads - admin bar.PNG]]
30
31
32 The following screen should appear.
33
karimpirani 4.1 34 [[image:bu 1.PNG||width="100%"]]
karimpirani 1.1 35
karimpirani 3.2 36
karimpirani 1.1 37 3. Select New...
38
39 4. Select the file you wish to upload and identify the type of data that it contains, and click on Submit
40
karimpirani 4.1 41 [[image:bu 2.PNG||width="100%"]]
karimpirani 1.1 42
43
44
45 5. Confirm successful upload
46
karimpirani 11.1 47 [[image:batch uploads - 7.PNG]]
karimpirani 1.1 48
49
50
karimpirani 7.1 51 6. Select the uploaded data and click on 'Process Selected'
karimpirani 1.1 52
53 7. If there are errors, view the error details by clicking on the Show Error Details option
54
karimpirani 11.1 55 [[image:batch uploads - 5.PNG]]
karimpirani 1.1 56
57 You will need to correct the data in the CSV file, or obtain a new, corrected copy of the data.
58
59
60
karimpirani 7.1 61 8. If there are no errors (Success Count = Total Count), then you are done!
karimpirani 1.1 62
63
64
65 **General File and Field Format/Content Rules**
66
67 1. All fields are comma delimited.
68 1. The first row of the file is the 'header' record that specifies which fields are in the subsequent rows.
karimpirani 7.1 69 1. The possible fields are case sensitive. E.g. 'name' does not equal 'NaMe'
karimpirani 1.1 70 1. Fields can be escaped using Microsoft escaping or standard escaping.
karimpirani 7.1 71 1. Dates are to be formatted in YYYY/MM/DD format. E.g. 2009/01/23
karimpirani 1.1 72 1. Boolean values are either TRUE or FALSE.
73 1. Operation fields are not required and default to UPDATE when not specified. Here are the possible values for operation:
74 11. UPDATE: inserts or updates the record in the system
75 11. DELETE: removes a specific record from the system
76 11. DELETE_ALL: removes all records specified by the key from the system. This really only applies to the one to many cases in the system. If not a one to many case, this will behave the same as the DELETE operation