Wiki source code of Batch Upload Formats

Version 35.1 by Davide Bonicelli on 2015/03/25 10: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" %)**Sample file**>>attach:Role - Batch File Example-1348454930.html]]
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" %)**Sample File**>>attach:Role Permission - Batch File Example-1348454930.html]]
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" %)**Sample file**>>attach:Client - Batch File Example.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
171 [[(% class="wikiattachmentlink" %)**Sample file**>>attach:Client Placement - Batch File Example.csv]]
172
173 {{code}}
174 operation, client.identifier, orgUnit.code
175 UPDATE, 1234, OU-1
176 UPDATE, 1235, OU-1
177 UPDATE, 1251, OU-1
178 UPDATE, 1252, OU-1
179 UPDATE, 1253, OU-1
180 UPDATE, 1254, OU-1
181 UPDATE, 1255, OU-2
182 UPDATE, 1256, OU-2
183 UPDATE, 1257, OU-2
184 UPDATE, 1258, OU-2
185 UPDATE, 1259, OU-2
186 UPDATE, 1260, OU-2
187 UPDATE, 1261, OU-2
188 {{/code}}
189
190
191
192 ==== **Client Tag** ====
193
194 **Description**: assign taxonomy tags to client
195
196 **Same as**: Clients... admin screen ~-~-> Tags tab.
197
198 **Prerequisites**: CLIENT, TAG
199
200 **Batch File Fields**:
201
202
203 * (% style="font-size: 14px;" %)operation
204 * (% style="font-size: 14px;" %)CLIENT.identifier
205 * (% style="font-size: 14px;" %)TAG.code
206
207 [[(% class="wikiattachmentlink" %)**Sample file**>>attach:Client Tag - Batch File Example.csv]]
208
209 {{code}}
210 operation,client.identifier,tag.code
211 UPDATE,TC1,TT1
212 UPDATE,TC1,TT1.1
213 UPDATE,TC1,TT1.2
214 UPDATE,TC1,TT2
215 UPDATE,TC1,TT3
216 UPDATE,TC1,TT3.1
217 UPDATE,TC1,TT3.2
218 UPDATE,TC1,TT1
219 UPDATE,TC1,TT1.1
220 UPDATE,TC1,TT1.2
221 UPDATE,TC2,TT2
222 UPDATE,TC3,TT3
223 UPDATE,TC4,TT2
224 UPDATE,TC5,TT3
225 UPDATE,TC6,TT3.1
226 UPDATE,TC7,TT3.2
227 UPDATE,TC8,TT1
228 UPDATE,TC9,TT1.1
229 UPDATE,TC10,TT1.2
230 UPDATE,TC11,TT2
231 UPDATE,TC12,TT3
232 {{/code}}
233
234
235 ==== **Caregiver** ====
236
237 **Description**: define/assign caregivers for clients.
238
239 **Same as**: CANS Assessment ~-~-> Client details ~-~-> caregivers tab.
240
241 **Prerequisites**: CLIENT
242
243 **Batch File Fields**:
244
245
246 * (% style="font-size: 14px;" %)operation
247 * (% style="font-size: 14px;" %)CLIENT.identifier
248 * [[relationshipToClient>>url:file:///Caregiver-RelationshipToClient||style="font-size: 14px;"]]
249 * (% style="font-size: 14px;" %)firstName
250 * (% style="font-size: 14px;" %)lastName
251
252 [[(% class="wikiattachmentlink" %)**Sample file**>>attach:Caregiver - Batch File Example.csv]]
253
254 {{code}}
255 operation,client.identifier,relationshipToClient,firstName,lastName
256 UPDATE,TC2,Adoptive Father,Adopt,Father
257 UPDATE,TC2,Adoptive Mother,Adopt,Mother
258 UPDATE,TC2,Godparent,Greg,Smith
259 UPDATE,TC2,Godparent,Gina,Smith
260 UPDATE,TC2,Biological Father,Bio,Father
261 UPDATE,TC2,Biological Mother,Bio,Mother
262 {{/code}}
263
264
265 ==== **Staff** ====
266
267 **Description**: define staff members/users of the system.
268
269 **Same as**: Staff... admin screen.
270
271 **Prerequisites**: valid email address
272
273 **Notes**: The password is set to the **lastName**.
274
275 The "active" field is a Boolean - TRUE or FALSE
276
277 **Batch File Fields**:
278
279
280 * (% style="font-size: 14px;" %)operation
281 * (% style="font-size: 14px;" %)firstName
282 * (% style="font-size: 14px;" %)lastName
283 * (% style="font-size: 14px;" %)login
284 * (% style="font-size: 14px;" %)email
285 * (% style="font-size: 14px;" %)active
286
287 [[(% class="wikiattachmentlink" %)**Sample file**>>attach:Staff Member - Batch File Example.csv]]
288
289 {{code}}
290 operation,firstName,lastName,middleName,login,email,active
291 UPDATE,Test,Staff1,teststaff1,test1@test.com,TRUE
292 UPDATE,Test,Staff2,teststaff2,test2@test.com,TRUE
293 UPDATE,Test,Staff3,teststaff3,test3@test.com,TRUE
294 UPDATE,Test,Staff4,teststaff4,test4@test.com,TRUE
295 UPDATE,Test,Staff5,teststaff5,test5@test.com,TRUE
296 UPDATE,Test,Staff6,teststaff6,test6@test.com,TRUE
297 {{/code}}
298
299
300 ==== **Staff Role** ====
301
302 **Description**: assign roles to staff members
303
304 **Same as**: Staff... admin screen ~-~-> Assigned Roles tab.
305
306 **Prerequisites**: STAFF, ROLE
307
308 **Notes**: The "active" field is a Boolean.
309
310 **Batch File Fields**:
311
312
313 * (% style="font-size: 14px;" %)operation
314 * (% style="font-size: 14px;" %)STAFF.login
315 * (% style="font-size: 14px;" %)ROLE.code
316 * (% style="font-size: 14px;" %)active
317
318 [[(% class="wikiattachmentlink" %)**Sample file**>>attach:Staff Member Role - Batch File Upload.csv]]
319
320 {{code}}
321 operation,user.login,role.code,active
322 UPDATE,teststaff1,BUSR1,TRUE
323 UPDATE,teststaff2,BUSR1,TRUE
324 UPDATE,teststaff3,BUSR1,TRUE
325 UPDATE,teststaff4,BUSR1,TRUE
326 UPDATE,teststaff5,BUSR1,TRUE
327 UPDATE,teststaff6,BUSPV,TRUE
328 {{/code}}
329
330
331 ==== **Staff Placement** ====
332
333 **Description**: define staff member placements at org units.
334
335 **Same as**: Staff... admin screen ~-~-> Placement tab
336
337 **Prerequisites**: STAFF, ORGUNIT
338
339 **Batch File Fields**:
340
341
342 * (% style="font-size: 14px;" %)operation
343 * (% style="font-size: 14px;" %)STAFF.login
344 * (% style="font-size: 14px;" %)ORGUNIT.code
345
346 [[(% class="wikiattachmentlink" %)**Sample file**>>attach:Staff Member Placement - Batch File Upload.csv]]
347
348 {{code}}
349 operation,user.login,orgUnit.code
350 UPDATE,teststaff1,SC.B1
351 UPDATE,teststaff2,SC.B2
352 UPDATE,teststaff3,SC.B1
353 UPDATE,teststaff4,SC.B2
354 UPDATE,teststaff5,R1W
355 UPDATE,teststaff6,R1E
356 {{/code}}
357
358
359 ==== **Staff Responsibility** ====
360
361 **Description**: assign staff member responsibility for other staff members.
362
363 **Same as**: Responsibilities... ~-~-> Staff tab
364
365 **Prerequisites**: STAFF, ROLE
366
367 **Batch File Fields**:
368
369
370 * (% style="font-size: 14px;" %)operation
371 * (% style="font-size: 14px;" %)parentUserRole.STAFF.login
372 * (% style="font-size: 14px;" %)parentUserRole.ROLE.code
373 * (% style="font-size: 14px;" %)childUserRole.STAFF.login
374 * (% style="font-size: 14px;" %)childUserRole.ROLE.code
375
376 [[(% class="wikiattachmentlink" %)**Sample file**>>attach:Staff Member Responsibility - Batch Upload Example.csv]]
377
378 {{code}}
379 operation,parentUserRole.user.login,parentUserRole.role.code,childUserRole.user.login,childUserRole.role.code
380 UPDATE,teststaff6,BUSPV,teststaff1,BUSR1
381 UPDATE,teststaff6,BUSPV,teststaff2,BUSR1
382 UPDATE,teststaff6,BUSPV,teststaff3,BUSR1
383 UPDATE,teststaff6,BUSPV,teststaff4,BUSR1
384 UPDATE,teststaff6,BUSPV,teststaff5,BUSR1
385 {{/code}}
386
387
388 ==== **Organizational Unit Responsibility** ====
389
390 **Description**: assign staff member direct responsibility for org units.
391
392 **Same as**: Responsibilities... ~-~-> OU tab
393
394 **Prerequisites**: STAFF, ROLE, ORGUNIT
395
396 **Batch File Fields**:
397
398
399 * (% style="font-size: 14px;" %)operation
400 * (% style="font-size: 14px;" %)userRole.STAFF.login
401 * (% style="font-size: 14px;" %)userRole.ROLE.code
402 * (% style="font-size: 14px;" %)ORGUNIT.code
403
404 [[(% class="wikiattachmentlink" %)**Sample file**>>attach:Organizational Unit Responsibility - Batch File Example.csv]]
405
406 {{code}}
407 operation,userRole.user.login,userRole.role.code,orgUnit.code
408 UPDATE,teststaff6,BUSPV,SC
409 UPDATE,teststaff6,BUSPV,NC
410 UPDATE,teststaff6,BUSPV,R1
411 UPDATE,teststaff6,BUSPV,R2
412 {{/code}}
413
414 ==== **Staff - Client Assignment** ====
415
416 **Description**: assign staff member direct responsibility for clients.
417
418 **Same as**: Responsibilities... ~-~-> Clients tab.
419
420 **Prerequisites**: STAFF, ROLE, CLIENT
421
422 **Batch File Fields**:
423
424
425 * (% style="font-size: 14px;" %)operation
426 * (% style="font-size: 14px;" %)userRole.STAFF.login
427 * (% style="font-size: 14px;" %)userRole.ROLE.code
428 * (% style="font-size: 14px;" %)CLIENT.identifier
429
430 [[(% class="wikiattachmentlink" %)**Sample file**>>attach:Client Responsibility - Batch File Example.csv]]
431
432 {{code}}
433 operation,userRole.user.login,userRole.role.code,client.identifier
434 UPDATE,teststaff1,BUSR1,TC1
435 UPDATE,teststaff1,BUSR1,TC2
436 UPDATE,teststaff1,BUSR1,TC3
437 UPDATE,teststaff1,BUSR1,TC4
438 UPDATE,teststaff1,BUSR1,TC5
439 UPDATE,teststaff1,BUSR1,TC6
440 UPDATE,teststaff1,BUSR1,TC7
441 UPDATE,teststaff1,BUSR1,TC8
442 UPDATE,teststaff1,BUSR1,TC9
443 UPDATE,teststaff1,BUSR1,TC10
444 UPDATE,teststaff1,BUSR1,TC11
445 UPDATE,teststaff1,BUSR1,TC12
446 {{/code}}