Wiki source code of Batch Upload Formats

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