'''UMS integrates to G Suite with the module G Suite Sync which:'''
UMS integrates to G Suite with the module G Suite Sync which:
*'''Creates users and their e-mail accounts'''
*Creates users and their e-mail accounts
*'''Maintains users in G Suite, i.e. data changes are synchronised to UMS'''
*Maintains users in G Suite, i.e. data changes are synchronised to UMS
*'''Synchronises passwords'''
*Synchronises passwords
*'''Deletes users who no longer attend the school'''
*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'''
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'''
*Avoid having to program scripts to synchronise the data
*'''Users are automatically created with data from your student administration system'''
*Users are automatically created with data from your student administration system
*'''It reduces the workload for the IT-department'''
*It reduces the workload for the IT-department
=='''Prerequisites'''==
==Prerequisites==
==='''Module requirements'''===
===Module requirements===
[[Google app API|'''Google app API''']]
[[Google app API]]
=='''Installation'''==
==Installation==
[[File:Googleappsadminsettings.png|none|frame]]
[[File:Googleappsadminsettings.png|none|frame]]
=== '''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 ====
'''When marked the users will be disabled when they are no longer attending classes.'''
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)
===='''Delete users'''====
====Disable users====
'''Choose if users are to be deleted after grace period has ended.'''
When marked the users will be disabled when they are no longer attending classes.
===='''Forward mail to on premise mail server'''====
====Delete users====
'''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)'''
Choose if users are to be deleted after grace period has ended
===='''Keep inactive before deleting x days'''====
==== Keep alive x days ====
'''Specify a grace period where users are disabled. '''
Keep users as active in Google before disabling. This triggers when user is no longer on a template that has a google setting.
==== '''''Distribution lists''''' ====
====Keep disabled before deleting x days====
Specify a grace period where users are kept as disabled users in Google.
====='''Maintain lists'''=====
=== Metadata configuration ===
'''Mark this to create distribution groups in Office 365. The groups will be created, updated and deleted if this is specified.'''
Specify extra information to set on users in Google.
====='''Delete 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 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'''=====
=== Distribution lists ===
'''Specify in days how long the distribution groups are to be kept alive in Office 365 before deletion.'''
==== '''Template security groups''' ====
=====Maintain lists=====
Mark this to create distribution groups in Google. The groups will be created, updated and deleted if this is specified.
====='''Maintain'''=====
=====Delete lists=====
'''This will create the security group entered in the field “template security group” in the destination node in the template settings.'''
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
==== '''Timetable''' ====
=====Delete unused lists after x days=====
Specify in days how long the distribution groups are to be kept alive in Google before deletion.
====='''Maintain'''=====
=== Template security groups ===
'''Mark this to create timetable blocks in Google Apps. They will be created, updated and deleted.'''
====='''Delete old'''=====
=====Maintain=====
'''Mark this to delete old timetable blocks from calendars.'''
This will create the security group entered in the field “template security group” in the destination node in the template settings.
==='''Site'''===
=== Timetable ===
[[File:Googleappssite.png|none|thumb|720x720px]]
===='''Automation type'''====
=====Maintain=====
'''Full: Means that site maintenance will be fully automated.'''
Mark this to create timetable blocks in Google Apps. They will be created, updated and deleted.
===='''Remove learner method'''====
=====Delete old=====
'''Deleted in AD'''
Mark this to delete old timetable blocks from calendars.
'''Users will be removed from site when they are not active in UMS anymore'''
===Site===
[[File:Googleappssite.png|none|thumb|720x720px]]
'''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'''
'''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.'''
'''This filter ensures that it is only applied to activities that matches this SQL sentence.'''
'''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.
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.
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.
You get a list of these groups by running this SQL command:
Select Distinct Aktivitet As Activity From Students Order By Activity
'''Activity Classrooms'''
'''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.
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.
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.
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.
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
Not Authorized to access this resource/api [403] Errors [ Message[Not Authorized to access this resource/api] Location[ - ] Reason[forbidden] Domain[global]
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.
