Specific switch to enable course category synchronisation. If this box is not ticked, no synchronisation will be done on course categories by any action whatsoever (CLI, cron, or manual)

The LDAP context(s) where the LDAP groups representing course categories are stored. Different contexts can be separated by semicolons.

An LDAP filter to discriminate the relevant LDAP records in the contexts above.

The group attribute where the primary category identifier is stored.

The group attribute where the category identification number is stored (generally identical to the above). It aims to fill in the category IDNumber.

A regular expression with at least one sub-pattern to extract the identification number value. By default the catch-all pattern '(.*)' will be used.

A pattern for building the value of the category identification number, such as a character string accepting a %CCID% placeholder to inject the result of the previous extractor.

The name of the LDAP attribute carrying the category name.

To be ticked if the category name gives the full path of names from the root, for example: Pedagogy/Year 1/Economics-Management, or only the simple name of the category. In the latter case, use of the parent reference below is expected.

The LDAP attribute containing the reference to the parent category.

A regular expression with at least one sub-pattern to extract the identification number value. By default the catch-all pattern '(.*)' will be used.

A pattern for building the value of the parent category identifier, such as a character string accepting a %PCID% placeholder to inject the result of the previous extractor.

Specific switch to enable course synchronisation. If this box is not ticked, no synchronisation will be done on courses by any action whatsoever (CLI, cron, or manual).

The LDAP context(s) where the LDAP groups representing courses are stored. Different contexts can be separated by semicolons.

An LDAP filter to select the LDAP groups representing courses.

The name of the LDAP attribute carrying the course primary identifier.

A regular expression with a capture sub-pattern to extract the course identifier value. By default the catch-all pattern will be used: '^(.*)$'.

A character string accepting a %ID% placeholder to insert the capture above. By default the expression '%ID%' will be used, which corresponds to the capture without modification.

The Moodle field in the 'course' table on which the course identifier matching is done.

The name of the LDAP attribute carrying the course short name (shortname).

A regular expression with a capture sub-pattern to extract the course primary identifier value. By default the catch-all pattern will be used: '^(.*)$'.

A character string accepting a %VALUE% placeholder to insert the capture above.

LDAP attribute containing the course full name. The full value of this field is carried over into the course long name in Moodle.

LDAP attribute containing the external identification number of the course.

A regular expression with a capture sub-pattern to extract the course identification number value (idnumber). By default the catch-all pattern will be used: '^(.*)$'.

A character string accepting a %VALUE% placeholder to insert the capture above. By default the expression '%VALUE%' will be used, which corresponds to the capture without modification.

The LDAP attribute carrying the reference to the course category. Several syntaxes are possible (see below).

If the syntax is a composite syntax or a path, the separator that separates the different portions of the placement path.

The synchronisation accepts 4 syntaxes:

• The composite syntax: The composite syntax is a path syntax, in which the various nodes can contain several pieces of information, separated by the composite data separator (see global settings).
• A path of names: A succession of intermediate node names from the root, separated by the path separator.
• An internal identifier (database id)
• The external identifier (IDNumber) of the category

In the last two cases, as the absolute position of the category cannot be known, the categories must exist before the synchronisation.

The external identifier (idnumber) of the category to use if no category information is provided in the course record, or if this information is invalid. If there is no default and the category provided cannot be used, then the course will not be created, or its category information will not be updated.

The LDAP field that contains the HTML text of the course summary.

An LDAP field that contains non-empty information to indicate course visibility. If no field is specified, course visibility is not synchronised.

The LDAP field that carries the name of a course template for creating the course. The value must be the short name of a course existing in Moodle and having a backup archive in the “course backup area” (*)

(*) Warning: backups naturally stored in the “personal backup area” are not eligible for template restoration.

A regular expression with a capture sub-pattern to extract the course template name value. By default the catch-all pattern will be used: '^(.*)$'.

A character string accepting a %VALUE% placeholder to insert the capture above. By default the expression '%VALUE%' will be used, which corresponds to the capture without modification.

If this value is given, then all courses created without an explicit template reference will be based on this course (by short name). The template value “default” is also accepted and uses this default value.

Course synchronisation supports direct processing of user or user-cohort enrolments if the structure of the LDAP entry representing the course contains the necessary fields.

The join key (Moodle field) on which user matching is done.

The LDAP field that contains the list of teachers with the power to modify the course.

The LDAP field that contains the list of teachers without the power to modify the course.

A regular expression with a capture sub-pattern. The captured value must be a primary identifier of the user (defined according to the standard LDAP settings). By default the catch-all pattern will be used: '^(.*)$'.

A regular expression with a capture sub-pattern to capture the net value of the user identifier. By default the catch-all pattern will be used: '^(.*)$'.

If this field is used, then the user identifier value extracted from the previous result is considered a DN of a third LDAP entity in which the terminal value of the user identifier must be looked up (indirection search).

For role assignments based on the multivalued attribute “member” (or another membership attribute as defined by the LDAP authentication settings), the synchroniser is able to discern identifiers relating to single users or cohorts. The cohort detector is a characteristic regular expression detecting the “cohort” type in the member record.

A regular expression with a capture sub-pattern to capture the net value of the cohort identifier (idnumber). By default the catch-all pattern will be used: '^(.*)$'.

Determines which enrolment method will carry the synchronised enrolment.

Back to the technical guide index - Back to the component index - Back to the plugin index - Back to the catalog