Wiki source code of Batch Upload Formats

Last modified by Matthew Deceunynck on 2015/06/05 16:12

version	line-number	content
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
18.1	27	(((
4.1	28
18.1	29	)))
	30
	31	[[image:BatchUploadTablesAndKeys-1330540947.png]]
	32
4.1	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
48.2	58	[[(% class="wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink" %)Sample file>>attach:role.csv]]
4.1	59
5.1	60	{{code}}
	61	operation,name,code,description
33.1	62	UPDATE,BatchUploadSampleRole1,BUSR1,Example role 1
	63	UPDATE,BatchUploadSampleRole2,BUSR2,Example role 2
	64	UPDATE,BatchUploadSampleSupervisor,BUSPV,Example role 3
5.1	65	{{/code}}
4.1	66
	67
18.1	68	==== (% style="font-size: 19px; line-height: 1.2em; color: rgb(33, 115, 175); font-size: 14px" %)Role Permission(%%) ====
4.1	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
48.2	79	* (% style="font-size: 14px;" %)role.code
4.1	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
48.2	82	[[(% class="wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink" %)Sample File>>attach:role_permission.csv]]
4.1	83
5.1	84	{{code}}
	85	operation,role.code,permission.name
4.1	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
5.1	109	UPDATE,BUSR2,REPORTS_VIEW
	110	{{/code}}
4.1	111
	112
18.1	113	==== Client ====
4.1	114
18.1	115	Description: define basic client information.
4.1	116
18.1	117	Same as: Clients... admin screen ~-~-> Basic Information tab.
4.1	118
18.1	119	Notes: The "active" field is a Boolean.
4.1	120
18.1	121	Prerequisite: None
4.1	122
18.1	123	Batch File Fields:
4.1	124
	125
18.1	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
4.1	136
48.2	137	[[(% class="wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink" %)Sample file>>attach:client.csv]]
4.1	138
5.1	139	{{code}}
	140	operation, firstName, lastName, identifier, active, gender, dob, payerID, providerID, memberID
4.1	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
5.1	152	UPDATE,Test,Client12,TC12,TRUE,FEMALE,1998/03/27,3PPID03, ProvID1, Mem877
	153	{{/code}}
4.1	154
	155
18.1	156	==== Client Placement ====
4.1	157
18.1	158	Description: define client placements at org units.
4.1	159
18.1	160	Same as: Clients... admin screen ~-~-> Organizational Placements tab.
4.1	161
18.1	162	Prerequisite: CLIENT, Organizational Units
4.1	163
18.1	164	Batch File Fields:
4.1	165
	166
18.1	167	* (% style="font-size: 14px;" %)operation
48.2	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
4.1	173
48.2	174	[[(% class="wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink" %)Sample file>>attach:client_placement.csv]]
4.1	175
5.1	176	{{code}}
50.1	177	operation, client.identifier, orgUnit.code, startDate, endDate, externalId
49.1	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
5.1	191	{{/code}}
4.1	192
	193
	194
18.1	195	==== Client Tag ====
4.1	196
18.1	197	Description: assign taxonomy tags to client
4.1	198
18.1	199	Same as: Clients... admin screen ~-~-> Tags tab.
4.1	200
18.1	201	Prerequisites: CLIENT, TAG
4.1	202
18.1	203	Batch File Fields:
4.1	204
	205
18.1	206	* (% style="font-size: 14px;" %)operation
	207	* (% style="font-size: 14px;" %)CLIENT.identifier
	208	* (% style="font-size: 14px;" %)TAG.code
4.1	209
48.2	210	[[(% class="wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink" %)Sample file>>attach:client_tag.csv]]
4.1	211
5.1	212	{{code}}
	213	operation,client.identifier,tag.code
4.1	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
5.1	234	UPDATE,TC12,TT3
	235	{{/code}}
4.1	236
	237
18.1	238	==== Caregiver ====
4.1	239
18.1	240	Description: define/assign caregivers for clients.
4.1	241
18.1	242	Same as: CANS Assessment ~-~-> Client details ~-~-> caregivers tab.
4.1	243
18.1	244	Prerequisites: CLIENT
4.1	245
18.1	246	Batch File Fields:
4.1	247
	248
18.1	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
4.1	254
48.2	255	[[(% class="wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink" %)Sample file>>attach:caregiver.csv]]
4.1	256
5.1	257	{{code}}
	258	operation,client.identifier,relationshipToClient,firstName,lastName
4.1	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
5.1	264	UPDATE,TC2,Biological Mother,Bio,Mother
	265	{{/code}}
4.1	266
	267
18.1	268	==== Staff ====
4.1	269
18.1	270	Description: define staff members/users of the system.
4.1	271
18.1	272	Same as: Staff... admin screen.
4.1	273
18.1	274	Prerequisites: valid email address
4.1	275
18.1	276	Notes: The password is set to the lastName.
4.1	277
18.1	278	The "active" field is a Boolean - TRUE or FALSE
4.1	279
18.1	280	Batch File Fields:
4.1	281
	282
18.1	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
4.1	289
48.2	290	[[(% class="wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink" %)Sample file>>attach:staff_member.csv]]
4.1	291
5.1	292	{{code}}
	293	operation,firstName,lastName,middleName,login,email,active
4.1	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
5.1	299	UPDATE,Test,Staff6,teststaff6,test6@test.com,TRUE
	300	{{/code}}
4.1	301
	302
18.1	303	==== Staff Role ====
4.1	304
18.1	305	Description: assign roles to staff members
4.1	306
18.1	307	Same as: Staff... admin screen ~-~-> Assigned Roles tab.
4.1	308
18.1	309	Prerequisites: STAFF, ROLE
4.1	310
18.1	311	Notes: The "active" field is a Boolean.
4.1	312
18.1	313	Batch File Fields:
4.1	314
	315
18.1	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
4.1	320
48.2	321	[[(% class="wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink" %)Sample file>>attach:staff_member_role.csv]]
4.1	322
5.1	323	{{code}}
	324	operation,user.login,role.code,active
4.1	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
5.1	330	UPDATE,teststaff6,BUSPV,TRUE
	331	{{/code}}
4.1	332
	333
18.1	334	==== Staff Placement ====
4.1	335
18.1	336	Description: define staff member placements at org units.
4.1	337
18.1	338	Same as: Staff... admin screen ~-~-> Placement tab
4.1	339
18.1	340	Prerequisites: STAFF, ORGUNIT
4.1	341
18.1	342	Batch File Fields:
4.1	343
	344
18.1	345	* (% style="font-size: 14px;" %)operation
	346	* (% style="font-size: 14px;" %)STAFF.login
	347	* (% style="font-size: 14px;" %)ORGUNIT.code
4.1	348
48.2	349	[[(% class="wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink" %)Sample file>>attach:staff_member_placement.csv]]
4.1	350
5.1	351	{{code}}
	352	operation,user.login,orgUnit.code
4.1	353	UPDATE,teststaff1,SC.B1
	354	UPDATE,teststaff2,SC.B2
	355	UPDATE,teststaff3,SC.B1
	356	UPDATE,teststaff4,SC.B2
	357	UPDATE,teststaff5,R1W
5.1	358	UPDATE,teststaff6,R1E
	359	{{/code}}
4.1	360
	361
18.1	362	==== Staff Responsibility ====
4.1	363
18.1	364	Description: assign staff member responsibility for other staff members.
4.1	365
18.1	366	Same as: Responsibilities... ~-~-> Staff tab
4.1	367
18.1	368	Prerequisites: STAFF, ROLE
4.1	369
18.1	370	Batch File Fields:
4.1	371
	372
18.1	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
4.1	378
48.2	379	[[(% class="wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink" %)Sample file>>attach:staff_member_responsibility.csv]]
4.1	380
5.1	381	{{code}}
	382	operation,parentUserRole.user.login,parentUserRole.role.code,childUserRole.user.login,childUserRole.role.code
4.1	383	UPDATE,teststaff6,BUSPV,teststaff1,BUSR1
	384	UPDATE,teststaff6,BUSPV,teststaff2,BUSR1
	385	UPDATE,teststaff6,BUSPV,teststaff3,BUSR1
	386	UPDATE,teststaff6,BUSPV,teststaff4,BUSR1
5.1	387	UPDATE,teststaff6,BUSPV,teststaff5,BUSR1
	388	{{/code}}
4.1	389
	390
18.1	391	==== Organizational Unit Responsibility ====
4.1	392
18.1	393	Description: assign staff member direct responsibility for org units.
4.1	394
18.1	395	Same as: Responsibilities... ~-~-> OU tab
4.1	396
18.1	397	Prerequisites: STAFF, ROLE, ORGUNIT
4.1	398
18.1	399	Batch File Fields:
4.1	400
	401
18.1	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
4.1	406
48.2	407	[[(% class="wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink" %)Sample file>>attach:organizational_unit_responsibility.csv]]
4.1	408
5.1	409	{{code}}
	410	operation,userRole.user.login,userRole.role.code,orgUnit.code
4.1	411	UPDATE,teststaff6,BUSPV,SC
	412	UPDATE,teststaff6,BUSPV,NC
	413	UPDATE,teststaff6,BUSPV,R1
5.1	414	UPDATE,teststaff6,BUSPV,R2
	415	{{/code}}
4.1	416
18.1	417	==== Staff - Client Assignment ====
4.1	418
18.1	419	Description: assign staff member direct responsibility for clients.
4.1	420
18.1	421	Same as: Responsibilities... ~-~-> Clients tab.
4.1	422
18.1	423	Prerequisites: STAFF, ROLE, CLIENT
4.1	424
18.1	425	Batch File Fields:
4.1	426
	427
18.1	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
4.1	432
48.2	433	[[(% class="wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink" %)Sample file>>attach:client_responsibility.csv]]
4.1	434
5.1	435	{{code}}
	436	operation,userRole.user.login,userRole.role.code,client.identifier
4.1	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
5.1	448	UPDATE,teststaff1,BUSR1,TC12
	449	{{/code}}