Wiki source code of Batch Upload Formats

Last modified by Matthew Deceunynck on 2015/06/05 16:12
Show last authors
1 == **Batch Data File Formats and Examples** ==
2
3 * Each batch file contains a set of related items that represent an aspect of your organization - your clients, your staff, the roles your staff will fulfill using the system.
4 * Some batch files must be loaded before others so that a particular aspect of your organization can be linked to another, for example, client data must be uploaded prior to the client placement data.
5 * Organization Units (ORGUNIT) does not have a batch upload and must be defined through the SMR application
6 * Taxonomy tags (TAG) do not have a batch upload and must be defined through the SMR application.
7 * The following table briefly describes each batch file according to the aspect of the organization it contains.
8
9
10
11 |**Organizational Aspect**|**Description **|**Prerequisite Item(s)**
12 |**1. Role**|What are the distinct groups of users in your organization? |None
13 |**2. Role Permission**|What specific permissions are allowed for each role? |Role
14 |**3. Client** |Identify the clients your organization is serving |None
15 |**4. Client Placement** |Where do your clients belong for in your organization structure?|Client, Org Unit
16 |**5. Client Tag** |Associate clients with non-OU tags/taxonomy items |Client, Tag
17 |**6. Caregiver** |Associate caregivers to specific clients |Client
18 |**7. Staff **|Identify the staff members in your organization.|staff members' email addresses
19 |**8. Staff Role**|What role does a specific staff member serve?|Staff, Role
20 |**9. Staff Placement**|Where do your staff belong in your organization structure?|Staff, Org Unit
21 |**10. Staff Responsibility**|Who supervises each staff member?|Staff, Role
22 |**11. Organizational Unit Responsibility**|Which organizational unit does each staff member belong to?|Staff, Role, Org Unit
23 |**12. Staff-Client Assignment** |Which clients are specifically assigned to a staff member?|Staff, Role, Client
24
25 * The following diagram provides a visual roadmap of the prerequisites for loading each batch file:(% style="font-family: sans-serif; font-size: 14px;" %)
26
27 (((
28
29 )))
30
31 [[image:BatchUploadTablesAndKeys-1330540947.png]]
32
33
34
35 The sections below describe specific upload information about each organizational batch upload file:
36
37 * Name of organization items and link to an example of batch upload content
38 * Description
39 * Upload fields
40 * Sample upload file - These samples were used to successfully populate a test version of the SMR system.
41 * Screenshot of the appropriate admin page after successful upload
42
43 ==== **Role** ====
44
45 **Description**: define Roles in the system.
46
47 **Same as**: Roles... admin screen.
48
49 **Prerequisite**: None
50
51 **Batch File Fields**:
52
53 * (% style="font-size: 14px;" %)operation
54 * (% style="font-size: 14px;" %)name
55 * (% style="font-size: 14px;" %)code
56 * (% style="font-size: 14px;" %)description
57
58 [[(% class="wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink" %)**Sample file**>>attach:role.csv]]
59
60 {{code}}
61 operation,name,code,description
62 UPDATE,BatchUploadSampleRole1,BUSR1,Example role 1
63 UPDATE,BatchUploadSampleRole2,BUSR2,Example role 2
64 UPDATE,BatchUploadSampleSupervisor,BUSPV,Example role 3
65 {{/code}}
66
67
68 ==== (% style="font-size: 19px; line-height: 1.2em; color: rgb(33, 115, 175); font-size: 14px" %)**Role Permission**(%%) ====
69
70 **Description**: assign permissions to Roles.
71
72 **Same as**: Roles... admin screen ~-~-> Assigned Permissions tab.
73
74 **Prerequisite**: ROLE
75
76 **Batch File Fields**:
77
78 * (% style="font-size: 14px;" %)operation
79 * (% style="font-size: 14px;" %)role.code
80 * [[permission.name>>url:file:///Assignable-Permission-List||style="font-size: 14px;"]](% style="font-size: 14px;" %) - These permissions are defined configured for your specific version of SMR
81
82 [[(% class="wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink" %)**Sample File**>>attach:role_permission.csv]]
83
84 {{code}}
85 operation,role.code,permission.name
86 UPDATE,BUSR1,CANS_CREATE
87 UPDATE,BUSR1,CANS_EDIT
88 UPDATE,BUSR1,CANS_VIEW
89 UPDATE,BUSR1,CLIENTS_VIEW
90 UPDATE,BUSR1,OU_VIEW
91 UPDATE,BUSR1,REPORTS_VIEW
92 UPDATE,BUSPV,CANS_APPROVE
93 UPDATE,BUSPV,CANS_AUTO_APPROVE
94 UPDATE,BUSPV,CANS_CREATE
95 UPDATE,BUSPV,CANS_EDIT
96 UPDATE,BUSPV,CANS_VIEW
97 UPDATE,BUSPV,CLIENTS_CREATE
98 UPDATE,BUSPV,CLIENTS_DELETE
99 UPDATE,BUSPV,CLIENTS_EDIT
100 UPDATE,BUSPV,CLIENTS_OU_VIEW
101 UPDATE,BUSPV,CLIENTS_TAG_VIEW
102 UPDATE,BUSPV,CLIENTS_VIEW
103 UPDATE,BUSPV,REPORTS_VIEW
104 UPDATE,BUSR2,ANSA_CREATE
105 UPDATE,BUSR2,ANSA_EDIT
106 UPDATE,BUSR2,ANSA_VIEW
107 UPDATE,BUSR2,CLIENTS_VIEW
108 UPDATE,BUSR2,OU_VIEW
109 UPDATE,BUSR2,REPORTS_VIEW
110 {{/code}}
111
112
113 ==== **Client** ====
114
115 **Description**: define basic client information.
116
117 **Same as**: Clients... admin screen ~-~-> Basic Information tab.
118
119 **Notes**: The "active" field is a Boolean.
120
121 **Prerequisite**: None
122
123 **Batch File Fields**:
124
125
126 * (% style="font-size: 14px;" %)operation
127 * (% style="font-size: 14px;" %)firstName
128 * (% style="font-size: 14px;" %)lastName
129 * (% style="font-size: 14px;" %)identifier
130 * (% style="font-size: 14px;" %)active
131 * (% style="font-size: 14px;" %)gender
132 * (% style="font-size: 14px;" %)dob
133 * (% style="font-size: 14px;" %)payerID
134 * (% style="font-size: 14px;" %)providerID
135 * (% style="font-size: 14px;" %)memberID
136
137 [[(% class="wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink" %)**Sample file**>>attach:client.csv]]
138
139 {{code}}
140 operation, firstName, lastName, identifier, active, gender, dob, payerID, providerID, memberID
141 UPDATE,Test,Client1,TC1,TRUE,MALE,1995/01/12,3PPID01, ProvID1, Mem117
142 UPDATE,Test,Client2,TC2,TRUE,FEMALE,1995/06/18,3PPID11, ProvID2, Mem121
143 UPDATE,Test,Client3,TC3,TRUE,MALE,1995/07/23,3PPID01, ProvID3, Mem233
144 UPDATE,Test,Client4,TC4,TRUE,FEMALE,1996/02/19,3PPID38, ProvID1, Mem257
145 UPDATE,Test,Client5,TC5,TRUE,MALE,1996/06/25,3PPID432, ProvID2, Mem301
146 UPDATE,Test,Client6,TC6,TRUE,FEMALE,1996/08/25,3PPID010, ProvID3, Mem443
147 UPDATE,Test,Client7,TC7,TRUE,MALE,1996/12/02,01010101, ProvID1, Mem43
148 UPDATE,Test,Client8,TC8,TRUE,FEMALE,1997/01/27,3PPID01, ProvID2, Mem228
149 UPDATE,Test,Client9,TC9,TRUE,MALE,1997/01/31~,~, ProvID3, Mem73
150 UPDATE,Test,Client10,TC10,TRUE,FEMALE,1997/08/01,3PPID01~,~, Mem11
151 UPDATE,Test,Client11,TC11,TRUE,MALE,1997/12/19~,~, ProvID2, Mem127
152 UPDATE,Test,Client12,TC12,TRUE,FEMALE,1998/03/27,3PPID03, ProvID1, Mem877
153 {{/code}}
154
155
156 ==== **Client Placement** ====
157
158 **Description**: define client placements at org units.
159
160 **Same as**: Clients... admin screen ~-~-> Organizational Placements tab.
161
162 **Prerequisite**: CLIENT, Organizational Units
163
164 **Batch File Fields**:
165
166
167 * (% style="font-size: 14px;" %)operation
168 * (% style="font-size: 14px;" %)client.identifier
169 * (% style="font-size: 14px;" %)orgUnit.code
170 * (% style="font-size: 14px;" %)startDate
171 * (% style="font-size: 14px;" %)endDate
172 * (% style="font-size: 14px;" %)externalId
173
174 [[(% class="wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink" %)**Sample file**>>attach:client_placement.csv]]
175
176 {{code}}
177 operation, client.identifier, orgUnit.code, startDate, endDate, externalId
178 UPDATE, 1234, OU-1, 2014/01/01,2014/07/01, abcd_20140101120000
179 UPDATE, 1235, OU-1, 2013/02/01, , abcd_20130201120000
180 UPDATE, 1251, OU-1, 2014/02/01, 2015/02/01, abcd_20140201131545
181 UPDATE, 1252, OU-1, 2014/03/01, 2015/03/01, abcd_20140301170000
182 UPDATE, 1253, OU-1, 2014/04/01, , abcd_20140101000000
183 UPDATE, 1254, OU-1, 2014/05/01, 2014/05/02, abcd_20140501120000
184 UPDATE, 1255, OU-2, 2013/01/01, 2014/01/01, efgh_00001
185 UPDATE, 1256, OU-2, 2013/02/01, 2014/02/01, efgh_00002
186 UPDATE, 1257, OU-2, 2013/03/01, 2014/03/01, efgh_00003
187 UPDATE, 1258, OU-2, 2013/04/01, , efgh_00558
188 UPDATE, 1259, OU-2, 2013/05/01, , efgh_01098
189 UPDATE, 1260, OU-2, 2013/06/01, 2015/01/01, efgh_01714
190 UPDATE, 1261, OU-2, 2013/07/01, 2014/12/31, efgh_00000_00000
191 {{/code}}
192
193
194
195 ==== **Client Tag** ====
196
197 **Description**: assign taxonomy tags to client
198
199 **Same as**: Clients... admin screen ~-~-> Tags tab.
200
201 **Prerequisites**: CLIENT, TAG
202
203 **Batch File Fields**:
204
205
206 * (% style="font-size: 14px;" %)operation
207 * (% style="font-size: 14px;" %)CLIENT.identifier
208 * (% style="font-size: 14px;" %)TAG.code
209
210 [[(% class="wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink" %)**Sample file**>>attach:client_tag.csv]]
211
212 {{code}}
213 operation,client.identifier,tag.code
214 UPDATE,TC1,TT1
215 UPDATE,TC1,TT1.1
216 UPDATE,TC1,TT1.2
217 UPDATE,TC1,TT2
218 UPDATE,TC1,TT3
219 UPDATE,TC1,TT3.1
220 UPDATE,TC1,TT3.2
221 UPDATE,TC1,TT1
222 UPDATE,TC1,TT1.1
223 UPDATE,TC1,TT1.2
224 UPDATE,TC2,TT2
225 UPDATE,TC3,TT3
226 UPDATE,TC4,TT2
227 UPDATE,TC5,TT3
228 UPDATE,TC6,TT3.1
229 UPDATE,TC7,TT3.2
230 UPDATE,TC8,TT1
231 UPDATE,TC9,TT1.1
232 UPDATE,TC10,TT1.2
233 UPDATE,TC11,TT2
234 UPDATE,TC12,TT3
235 {{/code}}
236
237
238 ==== **Caregiver** ====
239
240 **Description**: define/assign caregivers for clients.
241
242 **Same as**: CANS Assessment ~-~-> Client details ~-~-> caregivers tab.
243
244 **Prerequisites**: CLIENT
245
246 **Batch File Fields**:
247
248
249 * (% style="font-size: 14px;" %)operation
250 * (% style="font-size: 14px;" %)CLIENT.identifier
251 * [[relationshipToClient>>url:file:///Caregiver-RelationshipToClient||style="font-size: 14px;"]]
252 * (% style="font-size: 14px;" %)firstName
253 * (% style="font-size: 14px;" %)lastName
254
255 [[(% class="wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink" %)**Sample file**>>attach:caregiver.csv]]
256
257 {{code}}
258 operation,client.identifier,relationshipToClient,firstName,lastName
259 UPDATE,TC2,Adoptive Father,Adopt,Father
260 UPDATE,TC2,Adoptive Mother,Adopt,Mother
261 UPDATE,TC2,Godparent,Greg,Smith
262 UPDATE,TC2,Godparent,Gina,Smith
263 UPDATE,TC2,Biological Father,Bio,Father
264 UPDATE,TC2,Biological Mother,Bio,Mother
265 {{/code}}
266
267
268 ==== **Staff** ====
269
270 **Description**: define staff members/users of the system.
271
272 **Same as**: Staff... admin screen.
273
274 **Prerequisites**: valid email address
275
276 **Notes**: The password is set to the **lastName**.
277
278 The "active" field is a Boolean - TRUE or FALSE
279
280 **Batch File Fields**:
281
282
283 * (% style="font-size: 14px;" %)operation
284 * (% style="font-size: 14px;" %)firstName
285 * (% style="font-size: 14px;" %)lastName
286 * (% style="font-size: 14px;" %)login
287 * (% style="font-size: 14px;" %)email
288 * (% style="font-size: 14px;" %)active
289
290 [[(% class="wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink" %)**Sample file**>>attach:staff_member.csv]]
291
292 {{code}}
293 operation,firstName,lastName,middleName,login,email,active
294 UPDATE,Test,Staff1,teststaff1,test1@test.com,TRUE
295 UPDATE,Test,Staff2,teststaff2,test2@test.com,TRUE
296 UPDATE,Test,Staff3,teststaff3,test3@test.com,TRUE
297 UPDATE,Test,Staff4,teststaff4,test4@test.com,TRUE
298 UPDATE,Test,Staff5,teststaff5,test5@test.com,TRUE
299 UPDATE,Test,Staff6,teststaff6,test6@test.com,TRUE
300 {{/code}}
301
302
303 ==== **Staff Role** ====
304
305 **Description**: assign roles to staff members
306
307 **Same as**: Staff... admin screen ~-~-> Assigned Roles tab.
308
309 **Prerequisites**: STAFF, ROLE
310
311 **Notes**: The "active" field is a Boolean.
312
313 **Batch File Fields**:
314
315
316 * (% style="font-size: 14px;" %)operation
317 * (% style="font-size: 14px;" %)STAFF.login
318 * (% style="font-size: 14px;" %)ROLE.code
319 * (% style="font-size: 14px;" %)active
320
321 [[(% class="wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink" %)**Sample file**>>attach:staff_member_role.csv]]
322
323 {{code}}
324 operation,user.login,role.code,active
325 UPDATE,teststaff1,BUSR1,TRUE
326 UPDATE,teststaff2,BUSR1,TRUE
327 UPDATE,teststaff3,BUSR1,TRUE
328 UPDATE,teststaff4,BUSR1,TRUE
329 UPDATE,teststaff5,BUSR1,TRUE
330 UPDATE,teststaff6,BUSPV,TRUE
331 {{/code}}
332
333
334 ==== **Staff Placement** ====
335
336 **Description**: define staff member placements at org units.
337
338 **Same as**: Staff... admin screen ~-~-> Placement tab
339
340 **Prerequisites**: STAFF, ORGUNIT
341
342 **Batch File Fields**:
343
344
345 * (% style="font-size: 14px;" %)operation
346 * (% style="font-size: 14px;" %)STAFF.login
347 * (% style="font-size: 14px;" %)ORGUNIT.code
348
349 [[(% class="wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink" %)**Sample file**>>attach:staff_member_placement.csv]]
350
351 {{code}}
352 operation,user.login,orgUnit.code
353 UPDATE,teststaff1,SC.B1
354 UPDATE,teststaff2,SC.B2
355 UPDATE,teststaff3,SC.B1
356 UPDATE,teststaff4,SC.B2
357 UPDATE,teststaff5,R1W
358 UPDATE,teststaff6,R1E
359 {{/code}}
360
361
362 ==== **Staff Responsibility** ====
363
364 **Description**: assign staff member responsibility for other staff members.
365
366 **Same as**: Responsibilities... ~-~-> Staff tab
367
368 **Prerequisites**: STAFF, ROLE
369
370 **Batch File Fields**:
371
372
373 * (% style="font-size: 14px;" %)operation
374 * (% style="font-size: 14px;" %)parentUserRole.STAFF.login
375 * (% style="font-size: 14px;" %)parentUserRole.ROLE.code
376 * (% style="font-size: 14px;" %)childUserRole.STAFF.login
377 * (% style="font-size: 14px;" %)childUserRole.ROLE.code
378
379 [[(% class="wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink" %)**Sample file**>>attach:staff_member_responsibility.csv]]
380
381 {{code}}
382 operation,parentUserRole.user.login,parentUserRole.role.code,childUserRole.user.login,childUserRole.role.code
383 UPDATE,teststaff6,BUSPV,teststaff1,BUSR1
384 UPDATE,teststaff6,BUSPV,teststaff2,BUSR1
385 UPDATE,teststaff6,BUSPV,teststaff3,BUSR1
386 UPDATE,teststaff6,BUSPV,teststaff4,BUSR1
387 UPDATE,teststaff6,BUSPV,teststaff5,BUSR1
388 {{/code}}
389
390
391 ==== **Organizational Unit Responsibility** ====
392
393 **Description**: assign staff member direct responsibility for org units.
394
395 **Same as**: Responsibilities... ~-~-> OU tab
396
397 **Prerequisites**: STAFF, ROLE, ORGUNIT
398
399 **Batch File Fields**:
400
401
402 * (% style="font-size: 14px;" %)operation
403 * (% style="font-size: 14px;" %)userRole.STAFF.login
404 * (% style="font-size: 14px;" %)userRole.ROLE.code
405 * (% style="font-size: 14px;" %)ORGUNIT.code
406
407 [[(% class="wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink" %)**Sample file**>>attach:organizational_unit_responsibility.csv]]
408
409 {{code}}
410 operation,userRole.user.login,userRole.role.code,orgUnit.code
411 UPDATE,teststaff6,BUSPV,SC
412 UPDATE,teststaff6,BUSPV,NC
413 UPDATE,teststaff6,BUSPV,R1
414 UPDATE,teststaff6,BUSPV,R2
415 {{/code}}
416
417 ==== **Staff - Client Assignment** ====
418
419 **Description**: assign staff member direct responsibility for clients.
420
421 **Same as**: Responsibilities... ~-~-> Clients tab.
422
423 **Prerequisites**: STAFF, ROLE, CLIENT
424
425 **Batch File Fields**:
426
427
428 * (% style="font-size: 14px;" %)operation
429 * (% style="font-size: 14px;" %)userRole.STAFF.login
430 * (% style="font-size: 14px;" %)userRole.ROLE.code
431 * (% style="font-size: 14px;" %)CLIENT.identifier
432
433 [[(% class="wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink" %)**Sample file**>>attach:client_responsibility.csv]]
434
435 {{code}}
436 operation,userRole.user.login,userRole.role.code,client.identifier
437 UPDATE,teststaff1,BUSR1,TC1
438 UPDATE,teststaff1,BUSR1,TC2
439 UPDATE,teststaff1,BUSR1,TC3
440 UPDATE,teststaff1,BUSR1,TC4
441 UPDATE,teststaff1,BUSR1,TC5
442 UPDATE,teststaff1,BUSR1,TC6
443 UPDATE,teststaff1,BUSR1,TC7
444 UPDATE,teststaff1,BUSR1,TC8
445 UPDATE,teststaff1,BUSR1,TC9
446 UPDATE,teststaff1,BUSR1,TC10
447 UPDATE,teststaff1,BUSR1,TC11
448 UPDATE,teststaff1,BUSR1,TC12
449 {{/code}}