Note: You are currently viewing documentation for Moodle 3.8. Up-to-date documentation for the latest stable version of Moodle may be available here: Upload users in Moodle Workplace.

Upload users in Moodle Workplace: Difference between revisions

From MoodleDocs
(Upload course completion to Data store.)
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
{{Workplace}}
{{Workplace}}


[[Upload users]] tool is enhanced in Moodle Workplace to allow additional functionality
The [[Upload users]] tool is enhanced in Moodle Workplace to allow additional functionality.


==Tenant allocation==
==Tenant allocation==


If the current user has capability 'tool/tenant:allocate', they will be able to specify a tenant when uploading users (both when creating new users and updating existing). If the current user does not have this capability, they can only work with users from their own tenant.
If the current user has the capability tool/tenant:allocate, they will be able to specify a tenant when uploading users (both when creating new users and updating existing). If the current user does not have this capability, they can only create/update users in their own tenant.


Example of the csv file:
Example of the CSV file:


<code>
<code>
Line 21: Line 21:
==Job assignments==
==Job assignments==


If the current user has capability to assign jobs (on top of capability to use upload user tool), they can create jobs for users or modify existing ones. Fields jobstartdate1 and jobenddate1 are optional. When a user already has a job in this department and position, the dates will be modified but the new job will not be created. Departments and positions are matched by their "ID number" just like tenants.
If the current user has the capability to assign jobs (in addition to the capability to use the upload user tool), they can create jobs for users or modify existing ones. Fields jobstartdate1 and jobenddate1 are optional. When a user already has a job in this department and position, the dates will be modified but the new job will not be created. Departments and positions are matched by their "ID number" just like tenants.


<code>
<code>
Line 32: Line 32:
==Programs and certifications allocations==
==Programs and certifications allocations==


If the current user has capability to allocate to programs and/or certifications (on top of capability to use upload user tool), they can do so in upload users tool. Only users, programs and certifications from the same tenant can be used. If user already has a direct allocation to this program/certification, the dates will be updated. Programs and certifications are referenced by their "ID number".  
If the current user has the capability to allocate to programs and/or certifications (in addition to the capability to use the upload user tool), they can do so in the upload users tool. Only users, programs and certifications from the same tenant can be used. If the user already has a direct allocation to a program/certification, the dates will be updated. Programs and certifications are matched by their "ID number".  


Programs:
Programs:
Line 53: Line 53:
user13,cert1,2019-05-12,2032-01-09,2032-01-09,2032-01-09
user13,cert1,2019-05-12,2032-01-09,2032-01-09,2032-01-09
</code>
</code>
==Course completion==
If the current user has the 'tool/datastore:uploadcoursecompletion' capability, they can upload course completion data to be stored in the Data store for users who belong to the same tenant as themselves. This data can be reported on by using Report builder to [[Report_builder#Creating_a_custom_report|create a new report]] using the "Course completion from datastore" report source. The following is an example CSV file:
<code>
username,coursecompleted1,coursecompleteddate1
student,English 101,2019-01-01
</code>
Courses are matched on the 'coursecompleted' field of the CSV, which should refer to the shortname of the course in Moodle. It's possible to set the completion date by using the 'coursecompleteddate' field (if this field is omitted, then the current date will be used).

Latest revision as of 11:01, 26 November 2019

workplacelogo.png This feature is part of Moodle Workplace, which is available through Moodle Partners.


The Upload users tool is enhanced in Moodle Workplace to allow additional functionality.

Tenant allocation

If the current user has the capability tool/tenant:allocate, they will be able to specify a tenant when uploading users (both when creating new users and updating existing). If the current user does not have this capability, they can only create/update users in their own tenant.

Example of the CSV file:

username,firstname,lastname,email,tenant jonest,Tom,Jones,jonest@example.com,big reznor,Trent,Reznor,reznor@example.com,small

Tenants are matched by their "ID number".

Locating tenant ID number

Job assignments

If the current user has the capability to assign jobs (in addition to the capability to use the upload user tool), they can create jobs for users or modify existing ones. Fields jobstartdate1 and jobenddate1 are optional. When a user already has a job in this department and position, the dates will be modified but the new job will not be created. Departments and positions are matched by their "ID number" just like tenants.

username,firstname,lastname,email,jobdepartment1,jobposition1,jobstartdate1,jobenddate1 jonest,Tom,Jones,jonest@example.com,exampledep,examplepos,, reznor,Trent,Reznor,reznor@example.com,exampledep2,examplepos2,2019-05-07, jon,Jon,Whatever,jon@example.com,exampledep2,examplepos2,2019-05-07,2032-01-09

Programs and certifications allocations

If the current user has the capability to allocate to programs and/or certifications (in addition to the capability to use the upload user tool), they can do so in the upload users tool. Only users, programs and certifications from the same tenant can be used. If the user already has a direct allocation to a program/certification, the dates will be updated. Programs and certifications are matched by their "ID number".

Programs:

username,program1,programstartdate1,programenddate1,programduedate1 user14,prog1,2019-05-12,, user15,prog1,2019-05-12,2032-01-09,2032-01-09 user12,prog1,2019-05-12,2032-01-09, user13,prog1,2019-05-12,,2032-01-09

Certifications:

username,certification1,certificationstartdate1,certificationenddate1,certificationduedate1,certificationexpirydate1 user14,cert1,2019-05-12,,, user15,cert1,2019-05-12,2032-01-09,2032-01-09, user12,cert1,2019-05-12,2032-01-09,, user13,cert1,2019-05-12,2032-01-09,2032-01-09,2032-01-09

Course completion

If the current user has the 'tool/datastore:uploadcoursecompletion' capability, they can upload course completion data to be stored in the Data store for users who belong to the same tenant as themselves. This data can be reported on by using Report builder to create a new report using the "Course completion from datastore" report source. The following is an example CSV file:

username,coursecompleted1,coursecompleteddate1 student,English 101,2019-01-01

Courses are matched on the 'coursecompleted' field of the CSV, which should refer to the shortname of the course in Moodle. It's possible to set the completion date by using the 'coursecompleteddate' field (if this field is omitted, then the current date will be used).