Jump to content

G Suite: Difference between revisions

From UmsWiki
← Older edit
VisualWikitext
Kia (talk | contribs)
engineering, inHouse, Administrators
2,475 edits
 
(41 intermediate revisions by 5 users not shown)
Line 13: Line 13:


==Prerequisites==
==Prerequisites==
===Supported administrative systems===


===Module requirements===
===Module requirements===
[[UMS]]
[[Google app API]]
 
===Additional functionality===
 
===Testing after setup===
 
===What to have ready===
 
===Is any physical item required===
 
===Should third party be contacted===


==Installation==
==Installation==
'''Google Apps'''
[[File:Googleappsadminsettings.png|none|frame]]
[[File:Googleappsadminsettings.png|none|thumb|577x577px]]


======Organization settings======
=== Organization settings ===
See description how to create/setup further down this page
See description how to create/setup further down this page


=== Users ===


''Users''
==== Mail Alias ====
 
 '''“Mail Alias”'''
 
Choose what to use as the users mail address (login).
Choose what to use as the users mail address (login).


'''“Disable users”'''
==== Forward mail to on premise mail server ====
This will forward the users Google mail to the primary mail address from AD (If user does not have a proxy address it will read it from the mail attribute)


====Disable users====
When marked the users will be disabled when they are no longer attending classes.
When marked the users will be disabled when they are no longer attending classes.


 '''“Delete users”'''
====Delete users====
 
Choose if users are to be deleted after grace period has ended
Choose if users are to be deleted after grace period has ended.
 
 '''“Forward mail to on premise mail server”'''
 
This will forward the users Office 365 mail to the primary mail address from AD (If user does not have a proxy address it will read it from the mail attribute)


'''“Keep inactive before deleting x days”'''
==== Keep alive x days ====
Keep users as active in Google before disabling. This triggers when user is no longer on a template that has a google setting.


Specify a grace period where users are disabled. 
====Keep disabled before deleting x days====
Specify a grace period where users are kept as disabled users in Google.


''Distribution lists''
=== Metadata configuration ===
Specify extra information to set on users in Google.


'''“Maintain lists”'''
See this [https://developers.google.com/workspace/admin/directory/reference/rest/v1/schemas https://developers.google.com/workspace/admin/directory/reference/rest/v1/schemas]


Mark this to create distribution groups in Office 365. The groups will be created, updated and deleted if this is specified.
=== Distribution lists ===


'''“Delete lists”'''
=====Maintain lists=====
Mark this to create distribution groups in Google. The groups will be created, updated and deleted if this is specified.


=====Delete lists=====
Mark this to delete distributions groups when they are no longer active in the administrative system. Check the data export manuals too when this happens
Mark this to delete distributions groups when they are no longer active in the administrative system. Check the data export manuals too when this happens


'''“Delete unused lists after x days”'''
=====Delete unused lists after x days=====
Specify in days how long the distribution groups are to be kept alive in Google before deletion.


Specify in days how long the distribution groups are to be kept alive in Office 365 before deletion.
=== Template security groups ===
 
'''“Only senders inside my organization”'''
 
With this marked only users in the domain will be able to send to distribution groups created by UMS.
 
''Template security groups''
 
'''“Maintain”'''


=====Maintain=====
This will create the security group entered in the field “template security group” in the destination node in the template settings.
This will create the security group entered in the field “template security group” in the destination node in the template settings.


''Timetable''
=== Timetable ===
 
'''“Maintain”'''


=====Maintain=====
Mark this to create timetable blocks in Google Apps. They will be created, updated and deleted.
Mark this to create timetable blocks in Google Apps. They will be created, updated and deleted.


'''“Delete old”'''
=====Delete old=====
 
Mark this to delete old timetable blocks from calendars.
Mark this to delete old timetable blocks from calendars.


===''Site''===
===Site===
[[File:Googleappssite.png|none|thumb|720x720px]]
[[File:Googleappssite.png|none|thumb|720x720px]]


'''“Automation type”'''
==== See [[LMS Settings]] for options not described below ====
 
Full: Means that site maintenance will be fully automated.
 
'''“Remove learner method”'''
 
“Deleted in AD”
 
Users will be removed from site when they are not active in UMS anymore
 
“Finished on activity/course”
 
Users will be removed when they have finished with the course.
 
'''“Delete sites”'''
 
“Auto delete”
 
Sites will be delete when the last student has left the site
 
“Manual Delete”
 
Sites will not be deleted by UMS. This has to be done by an administrator
 
'''“Send mail to teacher(s)”'''
 
Send mail notification to teachers when they are attached to a site.
 
'''“Create x days before”'''
 
Choose how many days before start that the sites are to be created.
 
'''“Delete x days after end”'''
 
Choose how many days after end that the sites are to be deleted.
 
 '''“Teacher rights on sites”'''
 
Rights the teacher will have on the site when attached.
 
'''“Learner rights on sites”'''
 
Rights the student/learner will have on the site when attached.  
 
==='''SQL Groups'''===
Members of these groups will be attached to all sites created with this setting as teachers
[[File:Googleappssqlgroups.png|none|thumb|458x458px]]
 
'''“Group name”'''
 
This can only be a group that is found in UMS
 
You get a list of these groups by running this SQL command:
 
Select Distinct Aktivitet As Activity From Students Order By Activity
 
'''“Activity Sites”'''
 
'''“Do not create”'''
 
It will not create any sites based on activities.
 
'''“LMS has to be checked”'''
 
The field Aktivitet_LMS in the students table has to be “True”. (Look in the documentation for the specific administrative system to see how this is set)
 
'''“Based on template filter”'''
 
Create sites based on a filter that is specified per template.
[[File:Googleappsactivitysites.png|none|thumb|493x493px]]
 
'''“All”'''
 
Create all sites.
 
'''Title'''
 
Title of the site. Changing this after a site has been created will cause it to be updated.
 
'''Description'''
 
Description of the site. Changing this after a site has been created will cause it to be updated.  
 
==='''Search filter and criteria'''===
This will enable you to concatenate sites that would have been created as to or more sites to be created as one site.
[[File:Googleappssearchfilters.png|none|thumb|401x401px]]
 
'''“Remarks”'''
 
This is just for description purposes.
 
'''“Filter”'''
 
The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll
 
'''“Semester roll”'''
 
'''“Use replace string with empty”'''
 
This will replace a section of the site with an empty string.
 
                                            '''“Start index”'''
 
Determine where to start in string to remove.
 
                                            '''“Length”'''
 
How many characters will be removed from the string.
 
“'''Add activity short description to node ID'''“
 
This will add the field Kort_Betegnelse (Short Description) from the students table to the node id.
 
Node id is the URL.
 
===='''Examples'''====
If you have three activities named English1, English2, English3 and you only want one SharePoint site.
 
Set the settings as shown below
[[File:Googleappsseachfilters2.png|none|thumb|413x413px]]


This filter ensures that it is only applied to activities that matches this SQL sentence.
==== Drive ====
 
'''“Course Sites”'''
 
Course URL’s will always be created as “activity_course”.
 
'''“Do not create”'''
 
It will not create any sites based on courses.
 
'''“LMS has to be checked”'''
 
The field Skolefag_LMS in the students table has to be “True”. (Look in the documentation for the specific administrative system to see how this is set)
 
'''“Based on template filter”'''
 
Create sites based on a filter that is specified per template.
[[File:Googleappsactivitysites.png|none|thumb|493x493px]]
 
'''“All”'''
 
Create all sites.
 
'''Title'''
 
Title of the site. Changing this after a site has been created will cause it to be updated.
 
'''Description'''
 
Description of the site. Changing this after a site has been created will cause it to be updated.  
 
'''Search filter and criteria'''
 
This will enable you to concatenate sites that would have been created as two or more sites to be created as one site.
[[File:Googleappsseachfilters3.png|none|thumb|427x427px]]
 
'''“Remarks”'''
 
This is just for description purposes.
 
'''“Course Filter”'''
 
The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll.
 
'''“Semester roll”'''
 
'''“Use replace string with empty”'''
 
This will replace a section of the site with an empty string.
 
                                            '''“Start index”'''
 
Determine where to start in string to remove.
 
'''“Length”'''
 
How many characters will be removed from the string.
 
'''“Activity Filter”'''
 
The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll
 
'''“Semester roll”'''
 
'''“Use replace string with empty”'''
 
This will replace a section of the site with an empty string.
 
                                            '''“Start index”'''
 
Determine where to start in string to remove.
 
'''“Length”'''
 
How many characters will be removed from the string.  
 
==='''<big>Drive</big>'''===
[[File:Googleappsdrive.png|none|thumb|720x720px]]
[[File:Googleappsdrive.png|none|thumb|720x720px]]


'''“Automation type”'''
===== See [[LMS Settings]] for options not described below =====
 
<u>'''<big>Full</big>''':</u> Means that drive maintenance will be fully automated.
 
 
'''<u><big>“Remove learner method”</big></u>'''
 
'''“Deleted in AD”'''
 
Users will be removed from drive when they are not active in UMS anymore
 
'''“Finished on activity/course”'''
 
Users will be removed when they have finished with the course. 
 
'''<u><big>“Delete drives”</big></u>'''
 
'''“Auto delete”'''
 
Drives will be delete when the last student has left the drive
 
'''“Manual Delete”'''
 
Drives will not be deleted by UMS. This has to be done by an administrator


 
==== Classroom ====
'''“Send mail to teacher(s)”'''
 
Send mail notification to teachers when they are attached to a drive.
 
 
'''“Create x days before”'''
 
Choose how many days before start that the drives are to be created.
 
 
'''“Delete x days after end”'''
 
Choose how many days after end that the drives are to be deleted.
 
 
 '''“Teacher rights on drives”'''
 
Rights the teacher will have on the drive when attached.
 
 
'''“Learner rights on drives”'''
 
Rights the student/learner will have on the drive when attached.  
 
 
'''“SQL Groups”'''
 
Members of these groups will be attached to all drives created with this setting as teachers
[[File:Googleappssqlgroups.png|none|thumb|458x458px]]
 
 
'''“Group name”'''
 
This can only be a group that is found in UMS
 
You get a list of these groups by running this SQL command:
 
Select Distinct Aktivitet As Activity From Students Order By Activity
 
 
'''“Activity Drives”'''
 
'''“Do not create”'''
 
It will not create any sites based on activities.
 
 
'''“LMS has to be checked”'''
 
The field Aktivitet_LMS in the students table has to be “True”. (Look in the documentation for the specific administrative system to see how this is set)
 
 
'''“Based on template filter”'''
 
Create sites based on a filter that is specified per template.
[[File:Googleappsactivitysites.png|none|thumb|493x493px]]
 
'''“All”'''
 
Create all drives.
 
 
'''Description'''
 
Description of the drive. Changing this after a drive has been created will cause it to be updated.  
 
 
'''Search filter and criteria'''
 
This will enable you to concatenate drives that would have been created as to or more drives to be created as one drive.
[[File:Googleappssearchfilters.png|none|thumb|401x401px]]
 
 
'''“Remarks”'''
 
This is just for description purposes. 
 
'''“Filter”'''
 
The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll
 
 
'''“Semester roll”'''
 
'''“Use replace string with empty”'''
 
This will replace a section of the drive with an empty string.
 
                                            '''“Start index”'''
 
Determine where to start in string to remove.
 
                                            '''“Length”'''
 
How many characters will be removed from the string.
 
 
“'''Add activity short description to node ID'''“
 
This will add the field Kort_Betegnelse (Short Description) from the students table to the node id.
 
Node id is the URL.
 
 
'''Examples'''
 
If you have three activities named English1, English2, English3 and you only want one SharePoint drive.
 
Set the settings as shown below
[[File:Googleappsseachfilters2.png|none|thumb|413x413px]]
 
This filter ensures that it is only applied to activities that matches this SQL sentence. 
 
 
'''“Course Drives”'''
 
Course URL’s will always be created as “activity_course”.
 
 
'''“Do not create”'''
 
It will not create any drives based on courses.
 
 
'''“LMS has to be checked”'''
 
The field Skolefag_LMS in the students table has to be “True”. (Look in the documentation for the specific administrative system to see how this is set)
 
 
'''“Based on template filter”'''
 
Create drives based on a filter that is specified per template.
[[File:Googleappsactivitysites.png|none|thumb|493x493px]]
 
'''“All”'''
 
Create all drives.
 
'''Description'''
 
Description of the drive. Changing this after a drive has been created will cause it to be updated.  
 
'''Search filter and criteria'''
 
This will enable you to concatenate drives that would have been created as two or more drives to be created as one drive.
 
[[File:Googleappsseachfilters3.png|none|thumb|427x427px]]
'''“Remarks”'''
 
This is just for description purposes.
 
'''“Course Filter”'''
 
The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll.
 
'''“Semester roll”'''
 
'''“Use replace string with empty”'''
 
This will replace a section of the drive with an empty string.
 
                                            '''“Start index”'''
 
Determine where to start in string to remove.
 
'''“Length”'''
 
How many characters will be removed from the string.
 
'''“Activity Filter”'''
 
The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll
 
'''“Semester roll”'''
 
'''“Use replace string with empty”'''
 
This will replace a section of the drive with an empty string.
 
                                            '''“Start index”'''
 
Determine where to start in string to remove.
 
'''“Length”'''
 
How many characters will be removed from the string.  
 
 === ''Classroom'' ===
There can only be a maximum of 990 classrooms in total in one organization.  
There can only be a maximum of 990 classrooms in total in one organization.  


Line 517: Line 90:


If a user has too many classrooms it will be very slow for this user.
If a user has too many classrooms it will be very slow for this user.
[[File:Googleappsclassroomsettings.png|none|thumb|720x720px]]
[[File:Googleappsclassroomsettings.png|none|thumb|720x720px]]See [[LMS Settings]] for options not described below
 
'''“Automation type”'''
 
Full: Means that classroom maintenance will be fully automated.
 
'''“Remove learner method”'''
 
“Deleted in AD”
 
Users will be removed from classroom when they are not active in UMS anymore
 
“Finished on activity/course”
 
Users will be removed when they have finished with the course.   
 
'''“Delete classrooms”'''
 
“Auto delete”
 
Classrooms will be delete when the last student has left the classroom
 
“Manual Delete”
 
Classrooms will not be deleted by UMS. This has to be done by an administrator
 
'''“Send mail to teacher(s)”'''
 
Send mail notification to teachers when they are attached to a classroom.
 
'''“Create x days before”'''
 
Choose how many days before start that the classroom s are to be created.
 
'''“Delete x days after end”'''
 
Choose how many days after end that the classroom s are to be deleted.  
 
'''“SQL Groups”'''
 
Members of these groups will be attached to all classrooms created with this setting as teachers
[[File:Googleappssqlgroups.png|link=http://wiki.inlogic.dk/index.php/File:Googleappssqlgroups.png|none|thumb|458x458px]]
 
'''“Group name”'''
 
This can only be a group that is found in UMS
 
You get a list of these groups by running this SQL command:
 
Select Distinct Aktivitet As Activity From Students Order By Activity
 
'''“Activity Classroomss”'''
 
'''“Do not create”'''
 
It will not create any sites based on activities.
 
'''“LMS has to be checked”'''
 
The field Aktivitet_LMS in the students table has to be “True”. (Look in the documentation for the specific administrative system to see how this is set)
 
'''“Based on template filter”'''
 
Create sites based on a filter that is specified per template.
[[File:Googleappsactivitysites.png|link=http://wiki.inlogic.dk/index.php/File:Googleappsactivitysites.png|none|thumb|493x493px]]
 
'''“All”'''
 
Create all classrooms.
 
'''Description'''
 
Description of the classroom. Changing this after a classroom has been created will cause it to be updated.  
 
'''Search filter and criteria'''
 
This will enable you to concatenate classrooms that would have been created as to or more classrooms to be created as one classroom.
[[File:Googleappssearchfilters.png|link=http://wiki.inlogic.dk/index.php/File:Googleappssearchfilters.png|none|thumb|401x401px]]
 
'''“Remarks”'''
 
This is just for description purposes.
 
'''“Filter”'''
 
The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll
 
'''“Semester roll”'''
 
'''“Use replace string with empty”'''
 
This will replace a section of the classroom with an empty string.
 
                                            '''“Start index”'''
 
Determine where to start in string to remove.
 
                                            '''“Length”'''
 
How many characters will be removed from the string.
 
“'''Add activity short description to node ID'''“
 
This will add the field Kort_Betegnelse (Short Description) from the students table to the node id.
 
Node id is the URL.
 
'''Examples'''
 
If you have three activities named English1, English2, English3 and you only want one SharePoint classroom.
 
Set the settings as shown below
[[File:Googleappsseachfilters2.png|link=http://wiki.inlogic.dk/index.php/File:Googleappsseachfilters2.png|none|thumb|413x413px]]
 
This filter ensures that it is only applied to activities that matches this SQL sentence. 
 
'''“Course Classrooms”'''
 
Course URL’s will always be created as “activity course”.
 
'''“Do not create”'''
 
It will not create any classrooms based on courses.
 
'''“LMS has to be checked”'''
 
The field Skolefag_LMS in the students table has to be “True”. (Look in the documentation for the specific administrative system to see how this is set)
 
'''“Based on template filter”'''
 
Create classrooms based on a filter that is specified per template.
[[File:Googleappsactivitysites.png|link=http://wiki.inlogic.dk/index.php/File:Googleappsactivitysites.png|none|thumb|493x493px]]
 
'''“All”'''
 
Create all classrooms.
 
'''Description'''
 
Description of the classroom. Changing this after a classroom has been created will cause it to be updated.  
 
'''Search filter and criteria'''
 
This will enable you to concatenate classrooms that would have been created as two or more classrooms to be created as one classroom.
[[File:Googleappsseachfilters3.png|link=http://wiki.inlogic.dk/index.php/File:Googleappsseachfilters3.png|none|thumb|427x427px]]
 
'''“Remarks”'''
 
This is just for description purposes.
 
'''“Course Filter”'''
 
The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll.
 
'''“Semester roll”'''
 
'''“Use replace string with empty”'''
 
This will replace a section of the classroom with an empty string.
 
                                            '''“Start index”'''
 
Determine where to start in string to remove.
 
'''“Length”'''
 
How many characters will be removed from the string.
 
'''“Activity Filter”'''
 
The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll
 
'''“Semester roll”'''
 
'''“Use replace string with empty”'''
 
This will replace a section of the classroom with an empty string.
 
                                            '''“Start index”'''
 
Determine where to start in string to remove.
 
'''“Length”'''


How many characters will be removed from the string.  
=== Organization Settings ===
 
 === '''Organization Settings''' ===
When creating Google API refer to this lInk  
When creating Google API refer to this lInk  


[[Google app API|http://wiki.inlogic.dk/index.php/Google_app_API]] [[File:Googleappsorganizationsettings.png|none|thumb|378x378px]]
[[Google app API|http://wiki.inlogic.dk/index.php/Google_app_API]] [[File:Googleappsorganizationsettings.png|none|thumb|378x378px]]


'''“Description”'''
'''Description'''


Add a description to be able to identify the account.
Add a description to be able to identify the account.


'''“Admin login”'''
'''Admin login'''


Mail address of an administrative user
Mail address of an administrative user


 '''“Password”'''
 '''Password'''


Password for the admin login specified
Password for the admin login specified


'''“Domain”'''
'''Domain'''


The google domain that is used.
The google domain that is used.


'''“Client ID”, “Client Secret”'''
'''Client ID, Client Secret'''


This is obtained when following the instructions in the PDF document
This is obtained when following the instructions in the PDF document


'''“Refresh token”'''
'''Refresh token'''


This will be generated the first time google synchronization is started. If this is reset UMS will asked for it again when the next synchronization is run.
This will be generated the first time google synchronization is started. If this is reset UMS will asked for it again when the next synchronization is run.


'''“Timetable Users”'''
'''Timetable Users'''


This can be used when creating timetable blocks. Look in timetable documentation for this feature.
This can be used when creating timetable blocks. Look in timetable documentation for this feature.
Line 741: Line 130:
[[File:Googleappstemplateeditor.png|none|thumb|687x687px]]
[[File:Googleappstemplateeditor.png|none|thumb|687x687px]]


'''“Setting”'''
'''Setting'''


This is the setting described above  
This is the setting described above  


'''“Organization setting”'''
'''Organization setting'''


Specify where the users are created
Specify where the users are created
Line 771: Line 160:
A list of categories added to the site when creating it separated with a ;
A list of categories added to the site when creating it separated with a ;


A category called UMS will be added aswell. (This cannot be change)  
A category called UMS will be added as well. (This cannot be change)  


'''“SQL Groups”'''
'''SQL Groups'''


Members of these groups will be attached to all sites created with this setting as teachers
Members of these groups will be attached to all sites created with this setting as teachers
[[File:Googleappssqlgroups.png|link=http://wiki.inlogic.dk/index.php/File:Googleappssqlgroups.png|none|thumb|458x458px]]
[[File:Googleappssqlgroups.png|none|thumb|458x458px]]


'''“Group name”'''
'''Group name'''


This can only be a group that is found in UMS  
This can only be a group that is found in UMS  


You get a list of these groups by running this SQL command:
You get a list of these groups by running this SQL command:
 
Select Distinct Aktivitet As Activity From Students Order By Activity
Select Distinct Aktivitet As Activity From Students Order By Activity
 
'''Drive settings'''
'''Drive settings'''


Settings used when creating drives from this template  
Settings used when creating drives from this template  
[[File:Googleappsdrivesettings.png|none|thumb|429x429px]]


'''“Path”'''
'''Careful, do not name any of these type of subfolders with the same name.'''
[[File:GoogleApps Drive Settings.jpg|none|frame]]
'''Path'''


The path where the drives are created
The path where the drives are created


'''Create user specific subfolder'''
'''Create user specific subfolder'''
Can only be used with learner rights set to viewer.


Create a folder for each student that is attached to each drive
Create a folder for each student that is attached to each drive
Line 804: Line 194:


'''Create subfolder (Teacher Read/Write - Student Read)'''
'''Create subfolder (Teacher Read/Write - Student Read)'''
Can only be used with learner rights set to viewer.


A folder where teachers can upload data that students can only read
A folder where teachers can upload data that students can only read
Line 812: Line 204:


'''Create subfolder (Teacher Read/Write - Student Read/Write)'''
'''Create subfolder (Teacher Read/Write - Student Read/Write)'''
Can only be used with learner rights set to viewer.


A folder where teachers and students can share data both with read/write
A folder where teachers and students can share data both with read/write
Line 822: Line 216:
[[File:Googleappsstudents.png|none|thumb|279x279px]]
[[File:Googleappsstudents.png|none|thumb|279x279px]]


'''“SQL Groups”'''
'''SQL Groups'''


Members of these groups will be attached to all sites created with this setting as teachers
Members of these groups will be attached to all sites created with this setting as teachers
[[File:Googleappssqlgroups.png|link=http://wiki.inlogic.dk/index.php/File:Googleappssqlgroups.png|none|thumb|458x458px]]
[[File:Googleappssqlgroups.png|none|thumb|458x458px]]


'''“Group name”'''
'''Group name'''


This can only be a group that is found in UMS  
This can only be a group that is found in UMS  


You get a list of these groups by running this SQL command:
You get a list of these groups by running this SQL command:
 
Select Distinct Aktivitet As Activity From Students Order By Activity
Select Distinct Aktivitet As Activity From Students Order By Activity
 
'''Classroom settings'''
'''Classroom settings'''


Settings used when creating classrooms from this template  
Settings used when creating classrooms from this template  
[[File:Googleappsclassroomsettings2.png|none|thumb]]  
[[File:Googleappsclassroomsettings2.png|none|thumb]]  S'''QL Groups'''
 
'''“SQL Groups”'''


Members of these groups will be attached to all sites created with this setting as teachers
Members of these groups will be attached to all sites created with this setting as teachers
[[File:Googleappssqlgroups.png|link=http://wiki.inlogic.dk/index.php/File:Googleappssqlgroups.png|none|thumb|458x458px]]
[[File:Googleappssqlgroups.png|none|thumb|458x458px]]


'''“Group name”'''
'''Group name'''


This can only be a group that is found in UMS  
This can only be a group that is found in UMS  


You get a list of these groups by running this SQL command:
You get a list of these groups by running this SQL command:
 
Select Distinct Aktivitet As Activity From Students Order By Activity
Select Distinct Aktivitet As Activity From Students Order By Activity


==Installation G Suite Sync==
==Installation G Suite Sync==
Steps to make UMS sync work with G Suite.
Steps to make UMS sync work with G Suite.


Log on <nowiki>https://console.developers.google.com</nowiki> with your Google Admin account.
Log on https://console.developers.google.com with your Google Admin account.
 
Create a project
[[File:Googlesyncproject2.png|none|thumb|594x594px]]
 
When created choose project and click the newly created project.
 
Choose “Enable and manage APIs”. Enable these APIs
[[File:Googlesyncenableapi.png|none|thumb|463x463px]]
 
Click credentials
 
And choose “OAuth client ID”


Choose settings as show on below image. Name can be changed.
[[Google app API]]
[[File:Googlesyncoauth.png|none|thumb|499x499px]]
 
Then choose “Create”
 
Which creates an OAuth 2.0 client ID
 
Enter Client ID and Client Secret into UMS
[[File:Googlesyncoauth2.png|none|thumb|513x513px]]
 
Go back to “Overview” and choose “Enabled APIs”
 
Click on each API you added and choose Quota
[[File:Googlesyncenableapi2.png|none|thumb|517x517px]]
 
Set the number as high as you can without “apply for higher quota”
[[File:Googlesyncapplyhighquota.png|none|thumb|439x439px]]
 
And you are done with this site.
 
Now Log on https://admin.google.com with your Google Admin account
 
Find “Other Google Services” - can be located under “More Controls” or under APPS aplaced at page bottom.
 
Click “add services” upper right corner
 
Then click “Add it now” on “Groups for Business”
[[File:Googlesyncservices.png|none|thumb|495x495px]]
 
Back to start and choose “Security”
 
Choose “API reference” and check “Enable API access”
[[File:Googlesyncsecurity.png|none|thumb|439x439px]]


Go to the UMS “usermanagement folder” and run “GoogleApps_Sync.exe” manually.  
Go to the UMS “usermanagement folder” and run “GoogleApps_Sync.exe” manually.  
Line 929: Line 274:
|Runs all the parameters in this table
|Runs all the parameters in this table
|-
|-
|UpdateUsers
|CreateLearners
|Update users
|
|-
|-
|DisableUsers
|CreateStaff
|Disable users
|
|-
|-
|EnableUsers
|UpdateLearners
|Enable users
|
|-
|-
|DeleteUsers
|UpdateStaff
|Delete users
|
|-
|-
|CreateUsers
|RenameLearners
|Create users
|Rename the learners with a new mail/Login
|-
|-
|UpdateImmutableID
|RenameTeachers
|Update Immutable ID on users
|Rename the teachers with a new mail/Login
|-
|-
|UpdateOffice365SettingsIDForUsers
|DeleteLearners
|Update Office 365 settings for users if they have changed template
|
|-
|-
|UpdateUsersObjectID
|DeleteStaff
|Get the object ID from office 365 and save it in UMS DB
|
|}
{| class="wikitable"
|+Groups
!Parameter
!Description
|-
|GroupsOnly
|Runs all the parameters in this table
|-
|-
|UpdateUsers
|DisableLearners
|Update users
|
|-
|-
|DisableUsers
|EnableLearners
|Disable users
|
|-
|-
|EnableUsers
|DisableStaff
|Enable users
|
|-
|-
|DeleteUsers
|EnableStaff
|Delete users
|
|-
|-
|CreateUsers
|UpdateLearnerOU
|Create users
|Move the learners to the correct OU
|-
|-
|UpdateImmutableID
|UpdateTeacherOU
|Update Immutable ID on users
|Move the teachers to the correct OU
|-
|-
|UpdateOffice365SettingsIDForUsers
|UpdateTeacherMailForward
|Update Office 365 settings for users if they have changed template
|
|-
|-
|UpdateUsersObjectID
|UpdateLearnerMailForward
|Get the object ID from office 365 and save it in UMS DB
|
|}
|}
{| class="wikitable"
{| class="wikitable"
Line 992: Line 329:
|GroupsOnly
|GroupsOnly
|Runs all the parameters in this table
|Runs all the parameters in this table
|-
|CreateGroups
|
|-
|CleanUpGroups
|
|-
|AddTeachersToGroups
|
|-
|RemoveTeachersFromGroups
|
|-
|AddLearnersToGroups
|
|-
|RemoveLearnersFromGroups
|
|}
|}
{| class="wikitable"
{| class="wikitable"
Line 1,000: Line 355:
|TemplateGroupsOnly
|TemplateGroupsOnly
|Runs all the parameters in this table
|Runs all the parameters in this table
|-
|RemoveUsersFromTemplateGroups
|Remove users from template security groups
|-
|AddUsers2TemplateGroups
|Add users to template security groups
|-
|DeleteTemplateGroups
|Delete groups that are no longer template security groups
|}
|}
{| class="wikitable"
{| class="wikitable"
Line 1,008: Line 372:
|WebSitesOnly
|WebSitesOnly
|Runs all the parameters in this table
|Runs all the parameters in this table
|}
{| class="wikitable"
|+Drives
!Parameter
!Description
|-
|-
|DrivesOnly
|AddSites2DB
|Runs all the parameters in this table
|Add new sites to UMS DB
|-
|CreateSites
|
|-
|UpdateSites
|
|-
|DeleteSites
|
|-
|AddTeachers2Site
|
|-
|AddLearners2Site
|
|-
|DeleteTeachersWebSites
|
|-
|DeleteLearnersWebSites
|
|}
|}
{| class="wikitable"
{| class="wikitable"
Line 1,024: Line 404:
|ClassroomOnly
|ClassroomOnly
|Runs all the parameters in this table
|Runs all the parameters in this table
|-
|AddClassrooms2DB
|Add new classrooms to UMS DB
|-
|CreateClassrooms
|
|-
|UpdateClassrooms
|
|-
|DeleteClassrooms
|
|-
|AddTeachers2Classroom
|
|-
|AddLearners2Classroom
|
|-
|DeleteTeachersClassroom
|
|-
|DeleteLearnersClassroom
|
|}
|}
==Technical settings==
==Technical settings==
Line 1,058: Line 462:


'''The reason why that error occurs is that the mail adr. is used by another group or user. Test by manually creating a group in google admin portal. The image below shows the error.'''
'''The reason why that error occurs is that the mail adr. is used by another group or user. Test by manually creating a group in google admin portal. The image below shows the error.'''
'''To correct this error''': create a '''USER''' with the same email address and then delete it again. After this, it will be possible to create the Group.
[[File:Fgd.png|left|thumb|935x935px]]
[[File:Fgd.png|left|thumb|935x935px]]

Latest revision as of 14:03, 1 December 2025

UMS integrates to G Suite with the module G Suite Sync which:

  • Creates users and their e-mail accounts
  • Maintains users in G Suite, i.e. data changes are synchronised to UMS
  • Synchronises passwords
  • Deletes users who no longer attend the school

Integration to G Suite quickly becomes profitable. With UMS, the school saves resources by automating many manual tasks

  • Avoid having to program scripts to synchronise the data
  • Users are automatically created with data from your student administration system
  • It reduces the workload for the IT-department

Prerequisites

Module requirements

Google app API

Installation

Organization settings

See description how to create/setup further down this page

Users

Mail Alias

Choose what to use as the users mail address (login).

Forward mail to on premise mail server

This will forward the users Google mail to the primary mail address from AD (If user does not have a proxy address it will read it from the mail attribute)

Disable users

When marked the users will be disabled when they are no longer attending classes.

Delete users

Choose if users are to be deleted after grace period has ended

Keep alive x days

Keep users as active in Google before disabling. This triggers when user is no longer on a template that has a google setting.

Keep disabled before deleting x days

Specify a grace period where users are kept as disabled users in Google.

Metadata configuration

Specify extra information to set on users in Google.

See this https://developers.google.com/workspace/admin/directory/reference/rest/v1/schemas

Distribution lists

Maintain lists

Mark this to create distribution groups in Google. The groups will be created, updated and deleted if this is specified.

Delete lists

Mark this to delete distributions groups when they are no longer active in the administrative system. Check the data export manuals too when this happens

Delete unused lists after x days

Specify in days how long the distribution groups are to be kept alive in Google before deletion.

Template security groups

Maintain

This will create the security group entered in the field “template security group” in the destination node in the template settings.

Timetable

Maintain

Mark this to create timetable blocks in Google Apps. They will be created, updated and deleted.

Delete old

Mark this to delete old timetable blocks from calendars.

Site

See LMS Settings for options not described below

Drive

See LMS Settings for options not described below

Classroom

There can only be a maximum of 990 classrooms in total in one organization.

Google designed features (Not UMS)

If a teacher leaves the school, the material that he has put into classrooms will be deleted as well.

If a user has too many classrooms it will be very slow for this user.

See LMS Settings for options not described below

Organization Settings

When creating Google API refer to this lInk

http://wiki.inlogic.dk/index.php/Google_app_API

Description

Add a description to be able to identify the account.

Admin login

Mail address of an administrative user

 Password

Password for the admin login specified

Domain

The google domain that is used.

Client ID, Client Secret

This is obtained when following the instructions in the PDF document

Refresh token

This will be generated the first time google synchronization is started. If this is reset UMS will asked for it again when the next synchronization is run.

Timetable Users

This can be used when creating timetable blocks. Look in timetable documentation for this feature.

Template Settings

This is where you specify which templates are synchronized with Google and how.

Setting

This is the setting described above  

Organization setting

Specify where the users are created

Path

This is where all users is placed

Use this path when below 13 years of age

This is where users that are under 13 years is placed. If this is not specified everyone will be placed under the path setting. (This is helpful when it comes to Google+)

OU Description

The description that is set on the OU when it is created.

Site settings

Settings used when creating sites from this template

Site category

A list of categories added to the site when creating it separated with a ;

A category called UMS will be added as well. (This cannot be change)  

SQL Groups

Members of these groups will be attached to all sites created with this setting as teachers

Group name

This can only be a group that is found in UMS

You get a list of these groups by running this SQL command: 

Select Distinct Aktivitet As Activity From Students Order By Activity

Drive settings

Settings used when creating drives from this template

Careful, do not name any of these type of subfolders with the same name.

Path

The path where the drives are created

Create user specific subfolder

Can only be used with learner rights set to viewer.

Create a folder for each student that is attached to each drive

Suffix

A text string that is appended to the folder name

Create subfolder (Teacher Read/Write - Student Read)

Can only be used with learner rights set to viewer.

A folder where teachers can upload data that students can only read

Suffix

A text string that is appended to the folder name

Create subfolder (Teacher Read/Write - Student Read/Write)

Can only be used with learner rights set to viewer.

A folder where teachers and students can share data both with read/write

Suffix

A text string that is appended to the folder name

Example

SQL Groups

Members of these groups will be attached to all sites created with this setting as teachers

Group name

This can only be a group that is found in UMS

You get a list of these groups by running this SQL command: 

Select Distinct Aktivitet As Activity From Students Order By Activity

Classroom settings

Settings used when creating classrooms from this template  

 SQL Groups

Members of these groups will be attached to all sites created with this setting as teachers

Group name

This can only be a group that is found in UMS

You get a list of these groups by running this SQL command: 

Select Distinct Aktivitet As Activity From Students Order By Activity

Installation G Suite Sync

Steps to make UMS sync work with G Suite.

Log on https://console.developers.google.com with your Google Admin account.

Google app API

Go to the UMS “usermanagement folder” and run “GoogleApps_Sync.exe” manually.

Login to Google using credentials from Google Organization settings.

When logged in succesfully, “Accept” the following

If you get a “This page can’t be displayed”

Do not be alarmed. The job has been activated and you can check your GoogleApps_Sync.log to confirm that the job has completed running.

Parameters

> GoogleApps_Sync.exe [<optional> Action]

Eg. 

> GoogleApps_Sync.exe

> GoogleApps_Sync.exe UsersOnly
Users
Parameter Description
UsersOnly Runs all the parameters in this table
CreateLearners
CreateStaff
UpdateLearners
UpdateStaff
RenameLearners Rename the learners with a new mail/Login
RenameTeachers Rename the teachers with a new mail/Login
DeleteLearners
DeleteStaff
DisableLearners
EnableLearners
DisableStaff
EnableStaff
UpdateLearnerOU Move the learners to the correct OU
UpdateTeacherOU Move the teachers to the correct OU
UpdateTeacherMailForward
UpdateLearnerMailForward
Groups
Parameter Description
GroupsOnly Runs all the parameters in this table
CreateGroups
CleanUpGroups
AddTeachersToGroups
RemoveTeachersFromGroups
AddLearnersToGroups
RemoveLearnersFromGroups
Template groups
Parameter Description
TemplateGroupsOnly Runs all the parameters in this table
RemoveUsersFromTemplateGroups Remove users from template security groups
AddUsers2TemplateGroups Add users to template security groups
DeleteTemplateGroups Delete groups that are no longer template security groups
Web sites
Parameter Description
WebSitesOnly Runs all the parameters in this table
AddSites2DB Add new sites to UMS DB
CreateSites
UpdateSites
DeleteSites
AddTeachers2Site
AddLearners2Site
DeleteTeachersWebSites
DeleteLearnersWebSites
Classroom
Parameter Description
ClassroomOnly Runs all the parameters in this table
AddClassrooms2DB Add new classrooms to UMS DB
CreateClassrooms
UpdateClassrooms
DeleteClassrooms
AddTeachers2Classroom
AddLearners2Classroom
DeleteTeachersClassroom
DeleteLearnersClassroom

Technical settings

FAQ

Why do I not get the drive/site created?

1.      Activity

a.     Is there a user on the activity with a primary template that has an office 365 setting attached

b.     Is the flag Aktivitet_LMS = True

2.     Course

a.     Is there a user on the course with a primary template that has an office 365 setting attached

b.     Is the flag Skolefag_LMS = True

CreateGroups Error

Get root folders [Inlogic_Alle 1e-elever]

(CreateGroups) Error Google.Apis.Requests.RequestError

Not Authorized to access this resource/api [403] Errors [ Message[Not Authorized to access this resource/api] Location[ - ] Reason[forbidden] Domain[global]

Get root folders

(CreateGroups) Error Google.Apis.Requests.RequestError

Not Authorized to access this resource/api [403]

Errors [ Message[Not Authorized to access this resource/api] Location[ - ] Reason[forbidden] Domain[global]

The reason why that error occurs is that the mail adr. is used by another group or user. Test by manually creating a group in google admin portal. The image below shows the error.

To correct this error: create a USER with the same email address and then delete it again. After this, it will be possible to create the Group.

Retrieved from "https://wiki.inlogic.dk/index.php?title=G_Suite&oldid=5431"