View source for enrol/shibboleth

{{Moodle 1.9}}
[[Category:Administrator]]

==Introduction==

This course enrolment method allows you to select and automatically enrol users into courses, on the basis of the values of their [[Shibboleth]] attributes.

==Installation==

This is a course enrolment plugin, and is available for download on the official [http://moodle.org/mod/data/view.php?id=6009|Moodle modules and plugins page].

To install, copy the "shibboleth" folder into your moodle/enrol/ directory. Then edit the enrol_shibboleth_config.php file to suit the settings of your Shibboleth federation and of your Moodle server - you still may modify these afterwards to fine tune your plugin installation.

Once this is done, connect to your Moodle as an administrator, and visit the Site Administration->Notifications page for the database tables to set up automatically.

To use this plugin, you have to be logged into your Moodle as an administrator. Visit the Administration->Courses->Enrolments page. You may enable the plugin by clicking the corresponding checkbox, and edit it's settings using the Edit link.


==Usage==

The attributes available are listed under the "Possible attributes" drop-down menu. For help on these attributes, click the querstion mark icon next to this menu.

Enter the courses the user is to be enrolled into as a list of semicolon-separated (integer) values, plus the values of the Shibboleth attributes against which every user will be verified at login time. These are cumulative requirements (logical AND). Any user logging into Moodle using the Shibboleth login and having Shibboleth attributes corresponding to your selection will automatically be enrolled in the desired courses using the specified role. The use of a hyphen ("-") in an attrivbute value indicates an interval (x = a-b is equivalent to x >= a AND x <= b).

If you wish to perform more complex selections, you may enter a boolean expression yourself. The expression can use any amount of space-separated tokens. Tokens can be (be careful to put at least one space between each of these tokens) :

* a Shibboleth attribute (between brackets: [])
* an attribute value (between curvy braces: {})
* any combination of parentheses : ()
* any combination of AND, OR, =, <, >, <=, >=
* intervals are not permitted, use a combination of > and of < instead

Each newly created rule is displayed in gray : you have to enable it for it to become active. To enable a rule, click the eye icon of the corresponding line in the "Actions" column (note that deactivating the rule does not unenrol users enrolled by this rule, it just prevents future user logins to enrole more people).
To edit a rule, click the "edit" icon.
To delete a rule (this will unenrol users enrolled by this rule as well!), click the cross icon.

The last column displays the actual number of people enrolled so far by each rule. You may click "details" to display the actual names and roles assigned to these people by this rule, or click "unenrol" to unenrol these people.

==Troubleshooting==

In case no attributes are visible when using the "Show my Shibboleth visible attributes" link, you may want to verify if a Shibboleth session is active and if your Shibboleth attributes names indeed begin with $shibparsbeginwith (see enrol_shibboleth_config.php).