This document will outline optional system preferences that can be used to personalise how the self registration form functions.
For a more general guide to setting up the self registration form, please check our
Help Centre.
Navigate to the system preferences
Go to Koha administration > Global System Preferences and search for self registration.
This will bring up a table of system preferences related to the self registration form.
Function of the different system preferences
PatronSelfRegistrationAdditionalInstructions
This allows messages and instructions to be added to the page that appears after the self registration form has been filled in and successfully saved. This system preference will be collapsed by default, but clicking Click to edit will cause a free text box to open out.
Collapsed:
Dropped out:
Regular text and HTML tags can be used with this system preference for different style options. For example, the line Make sure to note your login details has been added in plain text to the system preference and saved.
The same line appears on the completed registration page but has not particular style settings added to it.
By editing the system preference to include bold tags, the same message appears in bold on the completed registration page.
PatronSelfRegistrationBorrowerMandatoryField
This allows staff to set a field as required on the self registration form, meaning the form cannot be saved when the particular fields are blank.
To fill in this system preference click into the locked field
This will cause a popup box with the various available fields will appear.
Place a tick in the box to the left hand side of the field(s) to be made mandatory and click Save to the bottom right hand side of the pop up box.
The pop up box will disappear and the system preference will be populated with the selected fields.
On the OPAC, required fields will appear in red with the word Required to the right hand side of the field.
PatronSelfRegistrationBorrowerUnwantedField
This allows staff to remove fields from the self registration form.
To fill in this system preference, click into the locked field and a popup box with the various available fields will appear.
Place a tick in the box to the left hand side of the field(s) to be removed from the self registration field and click Save to the bottom right hand side of the pop up box. The pop up box will disappear and the system preference will be populated with the selected fields.
Before the system preference was filled out:
After system preference has been filled:
PatronSelfRegistrationConfirmEmail
This can be set to require the self registering patron to input their email twice on the form to confirm it is the right format.
If this system preference is set to Require patrons will have to enter their email on the self registration form twice.
If this is set to Don't require then patrons will only have to enter their email once.
PatronSelfRegistrationDefaultCategory
This system preference will need to be filled in for the self registration form to function on the OPAC. This system preference causes the patron category field to be automatically filled with a standard, default patron category. It will be possible for people who are registering to change this category, but the form will always load initially with the default patron category.
For more information on patron categories, please check our
Help Centre.
Select the patron category to be set as the default option on the self registration form from the dropdown.
Please note, the system preference includes a warning about which patron category to select.
This screenshot shows a new self registration form with the Category option automatically set to Graduate, as defined in the PatronSelfRegistrationDefaultCategory system preference.
This option can be selected to show a dropdown of other patron category options.
PatronSelfRegistrationEmailMustBeUnique
This requires the email field to be filled with an email address that does not already exist on the system. If the form is completed and the email field is filled with an address that already exists on the system, the form will not be saved. For this function to be enabled the system preference must be set to Consider patron's email (borrowers email) as unique on self registering.
If this system preference is set to Don't consider patron's email email (borrowers email) as unique on self registering then self registering patrons will be able to create an account with an email that is already in use on another patron account.
PatronSelfRegistrationExpireTemporaryAccountsDelay
This system preference allows self registered patrons to be deleted if their patron category is not changed within a set period of time after they are initially created. The default patron category will be determined by the PatronSelfRegistrationDefaultCategory, addressed earlier in this document.
The PatronSelfRegistrationExpireTemporaryAccountsDelay contains a blank box for a number to represent the amount of days before a patron account will be deleted. If this system preference is filled in and the associated cronjob is set to run, the patron category will need to be changed within the set time period. If a self registered patron's category is not changed within the set period of time, they will be deleted.
If this system preference is left blank then self registered patrons will not be automatically deleted.
PatronSelfRegistrationLibraryList
This allows staff to limit the branch(es) the self registration will be available for.
If this system preference is left blank then all branches will be available on the self registration form.
To fill in the system preference, identify the code of the library branch(es) self registration should be available for.
For details about library codes, please check our
Help Centre.
If multiple branches are being inserted into this field the format of the information is important. It must be shaped as Branch 1|Branch 2, the name of the first branch, a line and then the name of the second branch.
Also, ensure the code for the branch is used not the actual name of the branch.
Once the system preference has been filled in the Home library dropdown on the self registration form will only display the identified branches as options.
This allows the username and password to be automatically filled in the login and password fields on the OPAC once the self registration form has been successfully saved.
Example when the system preference is set to Display and prefill password and login form after a patron has self registered.
Example when the system preference is set to Don't display and prefill password and login form after a patron has self registered.
PatronRegistrationVerifyByEmail
This system preference will require self registered patron to confirm their registration by an email sent to the submitted email.
If this system preference is set to Require that a self registering patron verify themselves via email a message will appear after the self registration form is successfully saved informing the patron they need to activate their account via the email, as well as confirming the email address the verification link will be sent to.
If this system preference is set to Don't require that a self registering patron verify themselves via email, no email will be sent when the self registration form is successfully saved.
Version | Date | Detail | Author |
1.0 | 16/02/21 | Document created | Holly Cooper |
1.2 | 17/02/21 | Details of sys. prefs. added | Holly Cooper |
1.3 | 18/02/21 | Adding headings and screenshots | Holly Cooper |
1.4 | 23/02/21 | Adding details | Holly Cooper |
1.5 | 11/04/22 | Updating for new release | Holly Cooper |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|