Wiki source code of Batch Upload Formats

Version 4.1 by Davide Bonicelli on 2015/03/25 09:35
Hide last authors
Davide Bonicelli 4.1 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 [[image:BatchUploadTablesAndKeys-1330540947.png]]
28
29
30
31 The sections below describe specific upload information about each organizational batch upload file:
32
33 * Name of organization items and link to an example of batch upload content
34 * Description
35 * Upload fields
36 * Sample upload file - These samples were used to successfully populate a test version of the SMR system.
37 * Screenshot of the appropriate admin page after successful upload
38
39 ==== **Role** ====
40
41 **Description**: define Roles in the system.
42
43 **Same as**: Roles... admin screen.
44
45 **Prerequisite**: None
46
47 **Batch File Fields**:
48
49
50 * (% style="font-size: 14px;" %)operation
51 * (% style="font-size: 14px;" %)name
52 * (% style="font-size: 14px;" %)code
53 * (% style="font-size: 14px;" %)description
54
55
56 [[(% class="wikiattachmentlink" %)**Sample file**>>attach:Role - Batch File Example-1348454930.html]]
57
58 {{code}}operation,name,code,description
59
60 UPDATE,BatchUploadSampleRole1,BUSR1,Example role #1
61
62 UPDATE,BatchUploadSampleRole2,BUSR2,Example role #2
63
64 UPDATE,BatchUploadSampleSupervisor,BUSPV,Example role #3{{/code}}
65
66
67 ==== (% style="font-size: 14px;" %)**Role Permission**(%%) ====
68
69 **Description**: assign permissions to Roles.
70
71 **Same as**: Roles... admin screen ~-~-> Assigned Permissions tab.
72
73 **Prerequisite**: ROLE
74
75 **Batch File Fields**:
76
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 [[Sample File>>attach:Role Permission - Batch File Example-1348454930.html]]
83
84 {{code}}operation,role.code,permission.name
85
86 UPDATE,BUSR1,CANS_CREATE
87
88 UPDATE,BUSR1,CANS_EDIT
89
90 UPDATE,BUSR1,CANS_VIEW
91
92 UPDATE,BUSR1,CLIENTS_VIEW
93
94 UPDATE,BUSR1,OU_VIEW
95
96 UPDATE,BUSR1,REPORTS_VIEW
97
98 UPDATE,BUSPV,CANS_APPROVE
99
100 UPDATE,BUSPV,CANS_AUTO_APPROVE
101
102 UPDATE,BUSPV,CANS_CREATE
103
104 UPDATE,BUSPV,CANS_EDIT
105
106 UPDATE,BUSPV,CANS_VIEW
107
108 UPDATE,BUSPV,CLIENTS_CREATE
109
110 UPDATE,BUSPV,CLIENTS_DELETE
111
112 UPDATE,BUSPV,CLIENTS_EDIT
113
114 UPDATE,BUSPV,CLIENTS_OU_VIEW
115
116 UPDATE,BUSPV,CLIENTS_TAG_VIEW
117
118 UPDATE,BUSPV,CLIENTS_VIEW
119
120 UPDATE,BUSPV,REPORTS_VIEW
121
122 UPDATE,BUSR2,ANSA_CREATE
123
124 UPDATE,BUSR2,ANSA_EDIT
125
126 UPDATE,BUSR2,ANSA_VIEW
127
128 UPDATE,BUSR2,CLIENTS_VIEW
129
130 UPDATE,BUSR2,OU_VIEW
131
132 UPDATE,BUSR2,REPORTS_VIEW{{/code}}
133
134
135
136 **Client** ([[Example>>url:file:///Client+-+Batch+File+Example]])
137
138 Description: define basic client information.
139
140 Same as Clients... admin screen ~-~-> Basic Information tab.
141
142 Notes: The "active" field is a Boolean.
143
144 Prerequisite: None
145
146 Batch File Fields:
147
148 operation
149
150 firstName
151
152 lastName
153
154 identifier
155
156 active
157
158 gender
159
160 dob
161
162 payerID
163
164 providerID
165
166 memberID
167
168 Sample file
169
170 {{code}}operation, firstName, lastName, identifier, active, gender, dob, payerID, providerID, memberID
171 UPDATE,Test,Client1,TC1,TRUE,MALE,1995/01/12,3PPID01, ProvID1, Mem117
172 UPDATE,Test,Client2,TC2,TRUE,FEMALE,1995/06/18,3PPID11, ProvID2, Mem121
173 UPDATE,Test,Client3,TC3,TRUE,MALE,1995/07/23,3PPID01, ProvID3, Mem233
174 UPDATE,Test,Client4,TC4,TRUE,FEMALE,1996/02/19,3PPID38, ProvID1, Mem257
175 UPDATE,Test,Client5,TC5,TRUE,MALE,1996/06/25,3PPID432, ProvID2, Mem301
176 UPDATE,Test,Client6,TC6,TRUE,FEMALE,1996/08/25,3PPID010, ProvID3, Mem443
177 UPDATE,Test,Client7,TC7,TRUE,MALE,1996/12/02,01010101, ProvID1, Mem43
178 UPDATE,Test,Client8,TC8,TRUE,FEMALE,1997/01/27,3PPID01, ProvID2, Mem228
179 UPDATE,Test,Client9,TC9,TRUE,MALE,1997/01/31~,~, ProvID3, Mem73
180 UPDATE,Test,Client10,TC10,TRUE,FEMALE,1997/08/01,3PPID01~,~, Mem11
181 UPDATE,Test,Client11,TC11,TRUE,MALE,1997/12/19~,~, ProvID2, Mem127
182 UPDATE,Test,Client12,TC12,TRUE,FEMALE,1998/03/27,3PPID03, ProvID1, Mem877{{/code}}
183
184
185
186 **Client Placement** ([[Example>>url:file:///Client+Placement+-+Batch+File+Example]])
187
188 Description: define client placements at org units.
189
190 Same as Clients... admin screen ~-~-> Organizational Placements tab.
191
192 Prerequisite: CLIENT, Organizational Units
193
194 [[See the OU structure used for this sample>>url:file:///Sample-OU-structure]]
195
196 Batch File Fields:
197
198 operation
199
200 CLIENT.identifier
201
202 ORGUNIT.code
203
204 Sample file
205
206 {{code}}operation, client.identifier, orgUnit.code
207
208 UPDATE, 1234, OU-1
209
210 UPDATE, 1235, OU-1
211
212 UPDATE, 1251, OU-1
213
214 UPDATE, 1252, OU-1
215
216 UPDATE, 1253, OU-1
217
218 UPDATE, 1254, OU-1
219
220 UPDATE, 1255, OU-2
221
222 UPDATE, 1256, OU-2
223
224 UPDATE, 1257, OU-2
225
226 UPDATE, 1258, OU-2
227
228 UPDATE, 1259, OU-2
229
230 UPDATE, 1260, OU-2
231
232 UPDATE, 1261, OU-2{{/code}}
233
234
235
236 **Client Tag** ([[Example>>url:file:///Client+Tag+-+Batch+File+Example]])
237
238 Description: assign taxonomy tags to client
239
240 Same as Clients... admin screen ~-~-> Tags tab.
241
242 Prerequisites: CLIENT, TAG
243
244 [[See the sample set of Tags used for this example.>>url:file:///Sample-set-of-Tags]]
245
246 Batch File Fields:
247
248 operation
249
250 CLIENT.identifier
251
252 TAG.code
253
254 Sample file
255
256 {{code}}operation,client.identifier,tag.code
257
258 UPDATE,TC1,TT1
259
260 UPDATE,TC1,TT1.1
261
262 UPDATE,TC1,TT1.2
263
264 UPDATE,TC1,TT2
265
266 UPDATE,TC1,TT3
267
268 UPDATE,TC1,TT3.1
269
270 UPDATE,TC1,TT3.2
271
272 UPDATE,TC1,TT1
273
274 UPDATE,TC1,TT1.1
275
276 UPDATE,TC1,TT1.2
277
278 UPDATE,TC2,TT2
279
280 UPDATE,TC3,TT3
281
282 UPDATE,TC4,TT2
283
284 UPDATE,TC5,TT3
285
286 UPDATE,TC6,TT3.1
287
288 UPDATE,TC7,TT3.2
289
290 UPDATE,TC8,TT1
291
292 UPDATE,TC9,TT1.1
293
294 UPDATE,TC10,TT1.2
295
296 UPDATE,TC11,TT2
297
298 UPDATE,TC12,TT3{{/code}}
299
300
301 **Caregiver** ([[Example>>url:file:///Caregiver+-+Batch+File+Example]])
302
303 Description: define/assign caregivers for clients.
304
305 Same as CANS Assessment ~-~-> Client details ~-~-> caregivers tab.
306
307 Prerequisites: CLIENT
308
309 Batch File Fields:
310
311 operation
312
313 CLIENT.identifier
314
315 [[relationshipToClient>>url:file:///Caregiver-RelationshipToClient]]
316
317 firstName
318
319 lastName
320
321 Sample file
322
323 {{code}}operation,client.identifier,relationshipToClient,firstName,lastName
324
325 UPDATE,TC2,Adoptive Father,Adopt,Father
326
327 UPDATE,TC2,Adoptive Mother,Adopt,Mother
328
329 UPDATE,TC2,Godparent,Greg,Smith
330
331 UPDATE,TC2,Godparent,Gina,Smith
332
333 UPDATE,TC2,Biological Father,Bio,Father
334
335 UPDATE,TC2,Biological Mother,Bio,Mother{{/code}}
336
337
338 **Staff** ([[Example>>url:file:///Staff+Member+-+Batch+File+Example]])
339
340 Description: define staff members/users of the system.
341
342 Same as Staff... admin screen.
343
344 Prerequisites: valid email address
345
346 Notes: The password is set to the **lastName**.
347
348 The "active" field is a Boolean - TRUE or FALSE
349
350 Batch File Fields:
351
352 operation
353
354 firstName
355
356 lastName
357
358 login
359
360 email
361
362 active
363
364 Sample file
365
366 {{code}}operation,firstName,lastName,middleName,login,email,active
367
368 UPDATE,Test,Staff1,teststaff1,test1@test.com,TRUE
369
370 UPDATE,Test,Staff2,teststaff2,test2@test.com,TRUE
371
372 UPDATE,Test,Staff3,teststaff3,test3@test.com,TRUE
373
374 UPDATE,Test,Staff4,teststaff4,test4@test.com,TRUE
375
376 UPDATE,Test,Staff5,teststaff5,test5@test.com,TRUE
377
378 UPDATE,Test,Staff6,teststaff6,test6@test.com,TRUE{{/code}}
379
380
381 **Staff Role** ([[Example>>url:file:///Staff+Member+Role+-+Batch+File+Upload]])
382
383 Description: assign roles to staff members
384
385 Same as Staff... admin screen ~-~-> Assigned Roles tab.
386
387 Prerequisites: STAFF, ROLE
388
389 Notes: The "active" field is a Boolean.
390
391 Batch File Fields:
392
393 operation
394
395 STAFF.login
396
397 ROLE.code
398
399 active
400
401 Sample file
402
403 {{code}}operation,user.login,role.code,active
404
405 UPDATE,teststaff1,BUSR1,TRUE
406
407 UPDATE,teststaff2,BUSR1,TRUE
408
409 UPDATE,teststaff3,BUSR1,TRUE
410
411 UPDATE,teststaff4,BUSR1,TRUE
412
413 UPDATE,teststaff5,BUSR1,TRUE
414
415 UPDATE,teststaff6,BUSPV,TRUE{{/code}}
416
417
418 **Staff Placement** ([[Example>>url:file:///Staff+Member+Placement+-+Batch+File+Upload]])
419
420 Description: define staff member placements at org units.
421
422 Same as Staff... admin screen ~-~-> Placement tab
423
424 Prerequisites: STAFF, ORGUNIT
425
426 [[See the OU structure used for this sample>>url:file:///Sample-OU-structure]]
427
428 Batch File Fields:
429
430 operation
431
432 STAFF.login
433
434 ORGUNIT.code
435
436 Sample file
437
438 {{code}}operation,user.login,orgUnit.code
439
440 UPDATE,teststaff1,SC.B1
441
442 UPDATE,teststaff2,SC.B2
443
444 UPDATE,teststaff3,SC.B1
445
446 UPDATE,teststaff4,SC.B2
447
448 UPDATE,teststaff5,R1W
449
450 UPDATE,teststaff6,R1E{{/code}}
451
452
453 **Staff Responsibility** ([[Example>>url:file:///Staff+Member+Responsibility+-+Batch+Upload+Example]])
454
455 Description: assign staff member responsibility for other staff members.
456
457 Same as Responsibilities... ~-~-> Staff tab
458
459 Prerequisites: STAFF, ROLE
460
461 Batch File Fields:
462
463 operation
464
465 parentUserRole.STAFF.login
466
467 parentUserRole.ROLE.code
468
469 childUserRole.STAFF.login
470
471 childUserRole.ROLE.code
472
473 Sample file
474
475 {{code}}operation,parentUserRole.user.login,parentUserRole.role.code,childUserRole.user.login,childUserRole.role.code
476
477 UPDATE,teststaff6,BUSPV,teststaff1,BUSR1
478
479 UPDATE,teststaff6,BUSPV,teststaff2,BUSR1
480
481 UPDATE,teststaff6,BUSPV,teststaff3,BUSR1
482
483 UPDATE,teststaff6,BUSPV,teststaff4,BUSR1
484
485 UPDATE,teststaff6,BUSPV,teststaff5,BUSR1{{/code}}
486
487
488 **Organizational Unit Responsibility** ([[Example>>url:file:///Organizational+Unit+Responsibility+-+Batch+File+Example]])
489
490 Description: assign staff member direct responsibility for org units.
491
492 Same as Responsibilities... ~-~-> OU tab
493
494 Prerequisites: STAFF, ROLE, ORGUNIT
495
496 Batch File Fields:
497
498 operation
499
500 userRole.STAFF.login
501
502 userRole.ROLE.code
503
504 ORGUNIT.code
505
506 Sample file
507
508 {{code}}operation,userRole.user.login,userRole.role.code,orgUnit.code
509
510 UPDATE,teststaff6,BUSPV,SC
511
512 UPDATE,teststaff6,BUSPV,NC
513
514 UPDATE,teststaff6,BUSPV,R1
515
516 UPDATE,teststaff6,BUSPV,R2{{/code}}
517
518 **Staff - Client Assignment** ([[Example>>url:file:///Client+Responsibility+-+Batch+File+Example]])
519
520 Description: assign staff member direct responsibility for clients.
521
522 Same as Responsibilities... ~-~-> Clients tab.
523
524 Prerequisites: STAFF, ROLE, CLIENT
525
526 Batch File Fields:
527
528 operation
529
530 userRole.STAFF.login
531
532 userRole.ROLE.code
533
534 CLIENT.identifier
535
536 Sample file
537
538 {{code}}operation,userRole.user.login,userRole.role.code,client.identifier
539
540 UPDATE,teststaff1,BUSR1,TC1
541
542 UPDATE,teststaff1,BUSR1,TC2
543
544 UPDATE,teststaff1,BUSR1,TC3
545
546 UPDATE,teststaff1,BUSR1,TC4
547
548 UPDATE,teststaff1,BUSR1,TC5
549
550 UPDATE,teststaff1,BUSR1,TC6
551
552 UPDATE,teststaff1,BUSR1,TC7
553
554 UPDATE,teststaff1,BUSR1,TC8
555
556 UPDATE,teststaff1,BUSR1,TC9
557
558 UPDATE,teststaff1,BUSR1,TC10
559
560 UPDATE,teststaff1,BUSR1,TC11
561
562 UPDATE,teststaff1,BUSR1,TC12{{/code}}