Fronter Integration: Difference between revisions

From UmsWiki
Jump to navigation Jump to search
 
(One intermediate revision by the same user not shown)
Line 15: Line 15:


== Installation ==
== Installation ==
To configure Fronter:
In Configurator Click “Fronter” and then click “Organization settings”[[File:Fronter organizationsettings.png|none|thumb]]
 
In Configurator Click “Fronter” and then click “Organization settings”
[[File:Fronter organizationsettings.png|none|thumb]]


Click “Add”
Click “Add”
[[File:Fronter organizationsettingsadd.png|none|thumb]]
[[File:Fronter organizationsettingsadd.png|none|thumb]]
[[File:Fronter organizationsettings2.png|none|thumb]]
[[File:Fronter organizationsettings2.png|none|thumb]]
 
* '''Description:'''  Name of setting.
·        '''Description:'''  Name of setting.
* '''AuthKey''': Authentication key obtained from Fronter. (See next page)
 
* '''Source''': Obtained from Fronter.
·        '''AuthKey''': Authentication key obtained from Fronter. (See next page)
* '''Root ID''': Obtained from Fronter.
 
* '''Group name prefix''': Prefix for all groups.
·        '''Source''': Obtained from Fronter.
* '''Group name postfix''': postfix for all groups.
 
* '''Teacher groups postfix''': Postfix specifically for Teacher groups.
·        '''Root ID''': Obtained from Fronter.
* '''Template groups node name''': 
 
* '''Policy node name''': The nod you in which you want to place the policy(security) groups.
·        '''Group name prefix''': Prefix for all groups.
* '''All students group name''': Students policy(Security) group name.
 
* '''All students – no teachers group name''':  Students only policy(Security) group name.
·        '''Group name postfix''': postfix for all groups.
* '''All teachers group name''': Teacher policy(Security) group name.
 
* '''Keep students alive for''': Number of days to keep students alive in Fronter after they are gone from UMS.
·        '''Teacher groups postfix''': Postfix specifically for Teacher groups.
* '''Keep employees alive for''': Number of days to keep employees alive in Fronter after they are gone from UMS.
 
·        '''Template groups node name''': 
 
·        '''Policy node name''': The nod you in which you want to place the policy(security) groups.
 
·        '''All students group name''': Students policy(Security) group name.
 
·        '''All students – no teachers group name''':  Students only policy(Security) group name.
 
·        '''All teachers group name''': Teacher policy(Security) group name.
 
·        '''Keep students alive for''': Number of days to keep students alive in Fronter after they are gone from UMS.
 
·        '''Keep employees alive for''': Number of days to keep employees alive in Fronter after they are gone from UMS.
 
Log in to your instance on <nowiki>Https://fronter.com</nowiki>
Log in to your instance on <nowiki>Https://fronter.com</nowiki>


Go to “Admin” and click your root node ex. “Skole3”, when root node is chosen, click “Værktøj”. In the “Værktøj” menu click “Fronter integrations indstillinger”. Here you will see your AuthKey.
Go to “Admin” and click your root node ex. “Skole3”, when root node is chosen, click “Værktøj”. In the “Værktøj” menu click “Fronter integrations indstillinger”. Here you will see your AuthKey.
[[File:Fronteradmins.png|none|thumb]]  
[[File:Fronteradmins.png|none|thumb]]
 
'''Configure Fronter “Site Settings”:'''
[[File:Fronter sitesettings.png|none|thumb]]
 
In Configurator Click “Fronter” and then click “Site settings”. Then click “Add”
 
·        '''Automation type:''' 
 
o  Full:  Means that site maintenance will be fully automated.
 
·        '''Remove learner method:''' 
 
o  '''Deleted in AD''': Users will be removed from site when they are not active in UMS anymore
 
o  '''Finished on activity/course''': Users will be removed when they have finished the course.
 
·        '''Delete sites:'''
 
o  '''Auto delete''': Sites will be deleted when the last student has left the site.
 
o  '''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, the sites will be created.
 
·        '''Delete x days after end:'''  Choose how many days after end the sites be deleted.
 
·        '''Teacher rights on sites:'''  Rights the teacher will have on the site when attached.


·        '''Login:'''  Choose which field from Students table should be used as login name.
==== '''Configure Fronter “Site Settings”:''' ====
In Configurator Click “Fronter” and then click “Site settings”. Then click “Add”[[File:Fronter sitesettings.png|none|thumb]]


·        '''Rooms node''':  
* '''Automation type:'''
** 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 the course.
* '''Delete sites:'''
** '''Auto delete''': Sites will be deleted 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.


o  '''Place under organization root''': If checked the rooms will be created directly under the root node. If unchecked there will be an extra field called “Node name” under the fronter part of the template where the setting is used. The name in this field will be the name of the sub node in fronter.
* '''Create x days before:'''  Choose how many days before start, the sites will be created.
* '''Delete x days after end:'''  Choose how many days after end the sites be deleted.
* '''Teacher rights on sites:'''  Rights the teacher will have on the site when attached.
* '''Login:'''  Choose which field from Students table should be used as login name.
* '''Rooms node''':
** '''Place under organization root''': If checked the rooms will be created directly under the root node. If unchecked there will be an extra field called “Node name” under the fronter part of the template where the setting is used. The name in this field will be the name of the sub node in fronter.  
[[File:Fronter templateeditor.png|none|thumb]]
[[File:Fronter templateeditor.png|none|thumb]]
 
** Place under organization root:  Checked
§  Place under organization root:  Checked
[[File:Fronter admins2.png|none|thumb]]
[[File:Fronter admins2.png|none|thumb]]
 
** Place under organization root:  Unchecked  
§  Place under organization root:  Unchecked  
 
[[File:Fronter admins3.png|none|thumb]]
[[File:Fronter admins3.png|none|thumb]]
** '''Top rooms node name''': Name of the node where the rooms node and the deleted rooms node will reside for the given template.
** '''Rooms node name''': Name of the node containing all rooms for the given template.
** '''Deleted node name''': Name of the node containing deleted rooms. (typically “Deleted Rooms”)


o  '''Top rooms node name''': Name of the node where the rooms node and the deleted rooms node will reside for the given template.
* '''Groups node''': 
 
** '''Place under organization root''': If checked the Groups will be created directly under the root node. If unchecked there will be an extra field called “Node name” under the fronter part of the template where the setting is used. The name in this field will be the name of the sub node in fronter. (same as Rooms node)
o  '''Rooms node name''': Name of the node containing all rooms for the given template.
** '''Groups node name''': Name of the node containing Student and Teacher groups for the given template.
 
** '''Teacher groups node name''': Name of the node containing all Teacher groups for the given template.
o  '''Deleted node name''': Name of the node containing deleted rooms. (typically “Deleted Rooms”)
** '''Student groups node name''': Name of the node containing all the Student groups for the given template.
 
* '''Activity sites''':  
·        '''Groups node''': 
** '''Do not create:'''  It will not create any rooms 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)
o  '''Place under organization root''': If checked the Groups will be created directly under the root node. If unchecked there will be an extra field called “Node name” under the fronter part of the template where the setting is used. The name in this field will be the name of the sub node in fronter. (same as Rooms node)
** '''Based on template filter:'''  Create rooms based on a filter that is specified per template.
 
[[File:Fronter filters.png|none|thumb]]
o  '''Groups node name''': Name of the node containing Student and Teacher groups for the given template.
** '''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:Fronter searchfilters.png|none|thumb]]
o  '''Teacher groups node name''': Name of the node containing all Teacher groups for the given template.
** '''All:'''  Create all rooms.
 
** '''Description:'''  Description of the room. Changing this after a room is created will cause it to be updated.
o  '''Student groups node name''': Name of the node containing all the Student groups for the given template.
* '''Course sites''':
 
** '''Do not create:'''  It will not create any sites based on courses.
·        '''Activity sites''':  
** '''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.
o  '''Do not create:'''  It will not create any rooms based on activities.
[[File:Fronter filters.png|none|thumb]]
 
** '''All:'''  Create all sites.
o  '''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)
** '''Description:'''  Description of the site. Changing this after a site has been created will cause it to be updated.
 
o  '''Based on template filter:'''  Create rooms based on a filter that is specified per template.
 
o  '''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.
 
o  '''All:'''  Create all rooms.
 
o  '''Description:'''  Description of the room. Changing this after a room is created will cause it to be updated.
 
·        '''Course sites''': 
 
o  '''Do not create:'''  It will not create any sites based on courses.
 
o  '''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)
 
o  '''Based on template filter:'''  Create sites based on a filter that is specified per template.
 
o  '''All:'''  Create all sites.
 
o  '''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.
 
·        '''Upload student information''':
 
o  '''Address''':  Uploads the given information.
 
o  '''Phone:'''  Uploads the given information.
 
o  '''Mobile phone:'''  Uploads the given information.
 
o  '''Mail:'''  Uploads the given information.
 
·        '''Upload employee information:'''
 
o  '''Address:'''  Uploads the given information.
 
o  '''Phone:'''  Uploads the given information.
 
o  '''Mobile phone:'''  Uploads the given information.


o  '''Mail:'''  Uploads the given information.  
* '''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:Fronter criteria.png|none|thumb]]
* '''Upload student information''':
** '''Address''':  Uploads the given information.
** '''Phone:'''  Uploads the given information.
** '''Mobile phone:'''  Uploads the given information.
** '''Mail:'''  Uploads the given information.
* '''Upload employee information:'''
** '''Address:'''  Uploads the given information.
** '''Phone:'''  Uploads the given information.
** '''Mobile phone:'''  Uploads the given information.
** '''Mail:'''  Uploads the given information.  


== Technical settings ==
== Technical settings ==

Latest revision as of 08:31, 17 May 2017

This integration automatically creates and maintains users in Fronter, based on data from your student administration system. Additionally, it creates rooms, which teachers and students can use for teaching purposes. Our Fronter integration automatically maintains and deletes room, which are no longer in use. This automation frees up time which can be used on other tasks. The integration runs as a web service and automatically synchronizes passwords, so students only need one password for the school’s IT-system.

Prerequisites

Supported administrative systems

All

Module requirements

UMS

What to have ready

Fronter import node (Fronter)

Connection to Administrative system

Installation

In Configurator Click “Fronter” and then click “Organization settings”

Click “Add”

  • Description:  Name of setting.
  • AuthKey: Authentication key obtained from Fronter. (See next page)
  • Source: Obtained from Fronter.
  • Root ID: Obtained from Fronter.
  • Group name prefix: Prefix for all groups.
  • Group name postfix: postfix for all groups.
  • Teacher groups postfix: Postfix specifically for Teacher groups.
  • Template groups node name
  • Policy node name: The nod you in which you want to place the policy(security) groups.
  • All students group name: Students policy(Security) group name.
  • All students – no teachers group name:  Students only policy(Security) group name.
  • All teachers group name: Teacher policy(Security) group name.
  • Keep students alive for: Number of days to keep students alive in Fronter after they are gone from UMS.
  • Keep employees alive for: Number of days to keep employees alive in Fronter after they are gone from UMS.

Log in to your instance on Https://fronter.com

Go to “Admin” and click your root node ex. “Skole3”, when root node is chosen, click “Værktøj”. In the “Værktøj” menu click “Fronter integrations indstillinger”. Here you will see your AuthKey.

Configure Fronter “Site Settings”:

In Configurator Click “Fronter” and then click “Site settings”. Then click “Add”

  • Automation type:
    • 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 the course.
  • Delete sites:
    • Auto delete: Sites will be deleted 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, the sites will be created.
  • Delete x days after end:  Choose how many days after end the sites be deleted.
  • Teacher rights on sites:  Rights the teacher will have on the site when attached.
  • Login:  Choose which field from Students table should be used as login name.
  • Rooms node:
    • Place under organization root: If checked the rooms will be created directly under the root node. If unchecked there will be an extra field called “Node name” under the fronter part of the template where the setting is used. The name in this field will be the name of the sub node in fronter.
    • Place under organization root:  Checked
    • Place under organization root:  Unchecked
    • Top rooms node name: Name of the node where the rooms node and the deleted rooms node will reside for the given template.
    • Rooms node name: Name of the node containing all rooms for the given template.
    • Deleted node name: Name of the node containing deleted rooms. (typically “Deleted Rooms”)
  • Groups node
    • Place under organization root: If checked the Groups will be created directly under the root node. If unchecked there will be an extra field called “Node name” under the fronter part of the template where the setting is used. The name in this field will be the name of the sub node in fronter. (same as Rooms node)
    • Groups node name: Name of the node containing Student and Teacher groups for the given template.
    • Teacher groups node name: Name of the node containing all Teacher groups for the given template.
    • Student groups node name: Name of the node containing all the Student groups for the given template.
  • Activity sites:
    • Do not create:  It will not create any rooms 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 rooms based on a filter that is specified per template.
    • 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.
    • All:  Create all rooms.
    • Description:  Description of the room. Changing this after a room is created will cause it to be updated.
  • Course sites:
    • 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.
    • All:  Create all sites.
    • 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.
  • Upload student information:
    • Address:  Uploads the given information.
    • Phone:  Uploads the given information.
    • Mobile phone:  Uploads the given information.
    • Mail:  Uploads the given information.
  • Upload employee information:
    • Address:  Uploads the given information.
    • Phone:  Uploads the given information.
    • Mobile phone:  Uploads the given information.
    • Mail:  Uploads the given information.  

Technical settings

FAQ

Why do I not get the site created?

  1. Activity
    1. Is there a user on the activity with a primary template that has an office 365 setting attached
    2. Is the flag Aktivitet_LMS = True
  2. Course
    1. Is there a user on the course with a primary template that has an office 365 setting attached
    2. Is the flag Skolefag_LMS = True