TypoScript Constants
Properties
termsUrl
termsUrl
-
- Type
- string
Page (id or id,type) or url where the terms of usage are shown.
Note
If set, overrides file.termsFile.
Note
This is used in conjunction with the field 'terms_acknowledged'.
file.templateFile
file.templateFile
-
- Type
- file[html,htm,tmpl,txt]
- Default
- EXT:agency/Resources/Private/Templates/AgencyRegistrationTemplate.html
File name of the HTML template
file.attachmentFile
file.attachmentFile
-
- Type
- file[pdf,doc,txt]
- Default
- EXT:agency/Resources/Public/Examples/tx_agency_sample.txt
File name of a file to be attached to the registration confirmation email.
file.termsFile
file.termsFile
-
- Type
- file[pdf,doc,sxw,txt]
- Default
- EXT:agency/Resources/Public/Examples/tx_agency_terms.txt
File name of the terms of usage file.
Note
This is used in conjunction with the field 'terms_acknowledged'.
file.privacyPolicyFile
file.privacyPolicyFile
-
- Type
- file[pdf,doc,sxw,txt]
- Default
- EXT:agency/Resources/Private/Templates/AgencyPrivacyPolicy.txt
File to be shown as the privacy policy.
privacyPolicyUrl
privacyPolicyUrl
-
- Type
- string
Page (id or id,type) or url where the privacy policy is shown. If set, it overrides the privacy policy file. This is needed for compliance with DSGVO / GDPR .
enableHTMLMail
enableHTMLMail
-
- Type
- boolean
- Default
- 1 (true)
If set, emails sent to the front end user will be sent in HTML format. A plain text version will always be included in the emails.
enableEmailAttachment
enableEmailAttachment
-
- Type
- boolean
- Default
- 0 (false)
If set, and if enableHTMLMail is also set, the attachment file - specified by file.attachmentFile - will be attached to the registration confirmation HTML email.
enableAutoLoginOnConfirmation
enableAutoLoginOnConfirmation
-
- Type
- boolean
- Default
- 0 (false)
If set, the user will be automatically logged in upon confirmation of his registration.
enableAutoLoginOnCreate
enableAutoLoginOnCreate
-
- Type
- boolean
- Default
- 0 (false)
Enable auto-login on account creation: if set and if email confirmation is not set, the user will be automatically logged in upon creation of his(her) account.
enableAutoLoginOnInviteConfirmation
enableAutoLoginOnInviteConfirmation
-
- Type
- boolean
- Default
- 1 (true)
If set, the user will be automatically logged in upon confirmation of his (her) invitation.
autoLoginRedirect_url
autoLoginRedirect_url
-
- Type
- string
When auto login is enabled, URL to which the user may be redirected upon login.
HTMLMailCSS
HTMLMailCSS
-
- Type
- string
- Default
- EXT:agency/template/tx_agency_htmlmail_xhtml.css
File name of the HTML emails style sheet. If HTML emails are enabled, this file contains the CSS style sheet to be incorporated in these emails.
-
- Type
- string
- Default
- MyTypo3Site@mydomain.org
Administration email address. This email address will be the sender email address and the recipient of administrator notifications.
siteName
siteName
-
- Type
- string
- Default
- My Typo3 Site
Name of the registering site. If set, this will be used as the email address name in all sent emails and may be used as a signature on the mails.
formFields
formFields
-
- Type
- positive integer / stdwrap
- Default
- username, password, gender, first_name, last_name, status, date_of_birth, email, address, city, zone, static_info_country, zip, telephone, fax, language, title, company, www, mail_html, categories, image, comments, terms_acknowledged, privacy_policy_acknowledged, disable
List of fields to be included on the Agency Registration form. Should be a subset of the columns of the 'fe_users' table.
Note
If the Mail (mail) extension is not installed, fields categories and mail_html are ignored (removed from the list).
Note
Check your HTML template for the presence of the markers of the fields
requiredFields
requiredFields
-
- Type
- positive string
- Default
- username,password,first_name,last_name,email
List of fields that must be filled in on the Agency Registration form. Should be a subset of the list specified on the 'formFields' property.
Note
captcha_response should not be set as a required field.
doNotEnforceUsername
doNotEnforceUsername
-
- Type
- boolean
- Default
- 0 (false)
If set, field username is not forced to be part of formFields and requiredFields.
unsubscribeAllowedFields
unsubscribeAllowedFields
-
- Type
- string
- Default
- module_sys_dmail_newsletter
Unsubscribe allowed fields: List of fields that are allowed to be updated by an UNSUBSCRIBE link without any login.
Note
Applies to setfixed links from mailing applications with the following query string values: &agency[cmd]=setfixed&sFK=UNSUBSCRIBE. A value for a field listed may be specified with a string of the form: &fD[fieldName]=value. The value of the field of the will be updated when the link is processed.
codeLength
codeLength
-
- Type
- int
- Default
- 8
Length of the authentication codes.
Note
Direct Mail extension uses only 8 in its calculations.
formName
formName
-
- Type
- string
Name of the HTML form. The name is also referenced on the
on. See below.Change Country Attribute
onChangeCountryAttribute
onChangeCountryAttribute
-
- Type
- string
- Default
- javascript:window.document.forms['fe_users_form'].submit();
Javascript to execute when the selected country is changed in the country selector box.
defaultCODE
defaultCODE
-
- Type
- string
Default CODE, when not specified on the inserted plugin record. May be CREATE or EDIT or empty.
pid
pid
-
- Type
- page_id
Front end user records PID. If the records edited/created are located in another page than the 'current,' the PID of that page should be specified here.
userGroupsPidList
userGroupsPidList
-
- Type
- list of page_id's
User groups records PID list: List of page id's on which user groups records are located.
Note
Note: If specified, user groups records will be assumed to be located on one of the specified pages, rather than on the page specified by 'pid'.
categories_PIDLIST
categories_PIDLIST
-
- Type
- positive integer / stdwrap
- Default
- 0
PID list for Direct Mail categories. The Direct mail categories used by the plugin will be restricted to those found on the pages identified by the PID's in this list.
pidTitleOverride
pidTitleOverride
-
- Type
- string
The specified string will override the title of the System Folder page specified by the pid property. The title of the System Folder is used in some online and email messages in the default HTML template.
registerPID
registerPID
-
- Type
- page_id
Registration page PID: PID of the page on which the extension is inserted with the intent of serving as the Agency Registration page. If not set, will default to 'current' page.
editPID
editPID
-
- Type
- page_id
Profile editing page PID: PID of the page on which the extension is inserted with the intent of serving as the front end user profile editing page. If not set, will default to 'current' page.
linkToPID
editPID
-
- Type
- page_id
Link to after edit PID: PID of a page to be linked to after the user has completed the editing of his/her profile. See also linkToPIDAddButton.
linkToPIDAddButton
linkToPIDAddButton
-
- Type
- page_id
Add a button to link to after edit. If set, an additional button is displayed on the profile editing page, or on the profile editing preview page, to save the changes and link to the page specified by linkToPID.
confirmPID
confirmPID
-
- Type
- page_id
Confirmation page PID: PID of the page on which the extension is inserted with the intent of serving as the front end user confirmation page (or setfixed page!).
confirmInvitationPID
confirmInvitationPID
-
- Type
- page_id
Confirmation of invitation page PID: PID of the page on which the extension is inserted with the intent of serving as the front end user confirmation page (or setfixed page!) when replying to an invitation. Meaningful only if email confirmation request is enabled.
Note
If not set, will take the same value as confirmPID.
passwordPID
passwordPID
-
- Type
- page_id
Password page PID: PID of the page on which the plugin is inserted with the intent of entering a new password.
confirmType
confirmType
-
- Type
- int
- Default
- 0
Confirmation page Type: Type (or pageNum) of the confirmation page. Meaningful only if email confirmation request is enabled.
loginPID
loginPID
-
- Type
- page_id
Login page PID: PID of the page on which the New login box extension is inserted with the intent of serving as the front end user login page. If not set, will default to 'current' page.
enablePreviewRegister
enablePreviewRegister
-
- Type
- boolean
- Default
- 1 (true)
Enable preview on registration. If set, the registration dialog will include a preview of the front end user data before it is saved.
enablePreviewEdit
enablePreviewEdit
-
- Type
- boolean
- Default
- 1 (true)
Enable preview on profile update. If set, the profile update dialog will include a preview of the front end user data before it is saved.
enableAdminReview
enableAdminReview
-
- Type
- boolean
- Default
- 0 (false)
Enable administrative review. If set, the site administrator will be asked to accept the registration before it becomes enabled.
enableEmailConfirmation
enableEmailConfirmation
-
- Type
- boolean
- Default
- 1 (true)
Enable email confirmation request: If set, an email will be sent to the prospective front end user requesting a confirmation of registration.
useEmailAsUsername
useEmailAsUsername
-
- Type
- boolean
- Default
- 0 (false)
Enable the use of the email address as username.
Note
If enableEmailConfirmation is also set, the email field will NOT be included in the front end user profile editing form.
generateUsername
generateUsername
-
- Type
- boolean
- Default
- 0 (false)
Generate the username. If set, the username is assumed to be generated.
Note
Hook registrationProcess_beforeConfirmCreate must be configured.
generatePassword
generatePassword
-
- Type
- integer
- Default
- 0
Generate the password: If non-zero, a random password is generated. The number of characters in the password is given by this parameter.
allowUserGroupSelection
allowUserGroupSelection
-
- Type
- boolean
- Default
- 0 (false)
Allow selection of usergroup on registration. If set, the user may select to adhere to user group(s) when registering.
Note
The selectable usergroups must be located in the page identified by the pid constant.
Note
If constants userGroupUponRegistration and userGroupAfterConfirmation are set, the usergroups they specify are not selectable.
Note
Field usergroup must be included in the list specified by constant formFields.
allowUserGroupUpdate
allowUserGroupSelection
-
- Type
- boolean
- Default
- 0 (false)
Allow selection of usergroup on editing. If set, the user may edit the list of user groups to which he(she) belongs.
Note
See also constant allowUserGroupSelection.
allowMultipleUserGroupSelection
allowMultipleUserGroupSelection
-
- Type
- boolean
- Default
- 0 (false)
Allow selection of multiple usergroups. If set, the user may select to adhere to multiple user groups.
Note
See also constants allowUserGroupSelection and allowUserGroupUpdate.
allowedUserGroups
allowedUserGroups
-
- Type
- string
Comma separated list of user groups to be selectable. If 'ALL', then all groups are allowed.
Note
See also constant allowUserGroupSelection.
allowedSubgroups
allowedSubgroups
-
- Type
- string
Comma separated list of subgroups from which all user groups shall be selectable. The user groups from allowedUserGroups shall be added also.
Note
See also constant allowedUserGroups.
deniedUserGroups
deniedUserGroups
-
- Type
- string
Comma separated list of user groups to be never selectable. These usegroups supersede the resulted user grous from allowedUserGroups and allowedSubgroups.
Note
See also constants allowedUserGroups and allowedSubgroups.
keepUnselectableUserGroups
keepUnselectableUserGroups
-
- Type
- boolean
- Default
- 0 (false)
If set und if a FE user is changing his FE user group then all the other FE user groups which are not shown in the select box will remain. If unset then the user will only keep the user group selected by himself and the reserved user groups which consist of the temporal user groups from the registration process: userGroupUponRegistration, userGroupAfterConfirmation, userGroupAfterAcceptation . This is only useful if allowUserGroupUpdate has been set, too.
Note: See also the constants allowedUserGroups., allowedSubgroups and deniedUserGroups
Note
See also constants allowedUserGroups, allowedSubgroups and deniedUserGroups..
enableEmailOnApprove
enableEmailOnApprove
-
- Type
- boolean
- Default
- 1 (true)
Enable email on approval. If set, an email will be sent to the front end user when he confirms his registration. Effective only if email confirmation request is enabled.
enableEmailOnRefuse
enableEmailOnRefuse
-
- Type
- boolean
- Default
- 1 (true)
Enable email on refusal: If set, an email will be sent to the prospective front end user when he refuses to confirm his registration. Effective only if email confirmation request is enabled.
enableEmailOnAdminRefuse
enableEmailOnAdminRefuse
-
- Type
- boolean
- Default
- 1 (true)
Enable email on denial: If set, an email will be sent to the prospective front end user when the site administrator refuses to confirm his registration.
enableEmailOnRegister
enableEmailOnRegister
-
- Type
- boolean
- Default
- 1 (true)
Enable email on registration: If set, an email will be sent to the front end user confirming his registration. Ignored if email confirmation request is enabled.
enableEmailOnUpdate
enableEmailOnUpdate
-
- Type
- integer
- Default
- 1
Enable email on profile update. If set to 1, an email will be sent to the front end user to confirm the update of his profile. If set to 2, only the changed fields will be sent.
enableEmailOnDelete
enableEmailOnDelete
-
- Type
- boolean
- Default
- 1 (true)
Enable email on delete. If set, an email will be sent to the front end user to confirm the deletion of his account.
enableEmailOnUnsubscribe
enableEmailOnUnsubscribe
-
- Type
- boolean
- Default
- 1 (true)
Enable email on unsubscribe: If set, an email will be sent to the front end user end its subscription to newsletters through a link from a mailing application.
enableEmailPassword
enableEmailPassword
-
- Type
- boolean
- Default
- 0 (false)
Enable email for password creation: If set, an email can be sent to the front end user who has forgotten his password.
enableAdminNotifyConfirmation
enableAdminNotifyConfirmation
-
- Type
- boolean
- Default
- 1 (true)
If set, an email will be sent to the site administrator when a request for confirmation of registration is sent to a user.
enableAdminNotifyOnApprove
enableAdminNotifyOnApprove
-
- Type
- boolean
- Default
- 1 (true)
Enable admin notification on approval: If set, an email will be sent to the site administrator when a user confirms his registration.
enableAdminNotifyOnRefuse
enableAdminNotifyOnRefuse
-
- Type
- boolean
- Default
- 1 (true)
Enable admin notification on refusal. If set, an email will be sent to the site administrator when a user refuses to confirm his registration.
enableAdminNotifyOnRegister
enableAdminNotifyOnRegister
-
- Type
- boolean
- Default
- 1 (true)
Enable admin notification on registration. If set, an email will be sent to the site administrator when a user registers. This is ignored if email confirmation request is enabled.
enableAdminNotifyOnUpdate
enableAdminNotifyOnUpdate
-
- Type
- boolean
- Default
- 1 (true)
Enable admin notification on update: If set, an email will be sent to the site administrator when a user updates his profile.
enableAdminNotifyOnDelete
enableAdminNotifyOnDelete
-
- Type
- boolean
- Default
- 1 (true)
Enable admin notification on deletion: If set, an email will be sent to the site administrator when a user deletes his account.
enableAdminNotifyOnEnter
enableAdminNotifyOnEnter
-
- Type
- boolean
- Default
- 0 (false)
Enable admin notification on entering: If set, an email will be sent to the site administration when a user clicks on the link to log in.
enableAdminNotifyOnAdminAccept
enableAdminNotifyOnAdminAccept
-
- Type
- boolean
- Default
- 1 (true)
Enable admin notification on approval by admin: If set, an email will be sent to the site administration when a registration is accepted by the administration.
enableAdminNotifyOnAdminRefuse
enableAdminNotifyOnAdminRefuse
-
- Type
- boolean
- Default
- 1 (true)
Enable admin notification on refusal by admin: If set, an email will be sent to the site administration when a registration is refused by the administration.
enableAdminNotifyOnUnsubscribe
enableAdminNotifyOnUnsubscribe
-
- Type
- boolean
- Default
- 1 (true)
Enable admin notification on unsubscribe: If set, an email will be sent to the site administration when the user ends his membership through a link from a mailing application.
enableAdminNotifyOnPassword
enableAdminNotifyOnPassword
-
- Type
- boolean
- Default
- 1 (true)
Enable admin notification on lost password: If set, an email will be sent to the site administration when the user requests to recreate his lost password..
mailCheckedUponRegistration
mailCheckedUponRegistration
-
- Type
- boolean
- Default
- 0 (false)
Check all the checkboxes for Mail categories in creation dialogues.
userGroupUponRegistration
userGroupUponRegistration
-
- Type
- string
User group(s) upon registration: The value of the user group field. Must be a list of integers WITHOUT spaces between the comma separated values! Furthermore, these integers MUST point to actual fe_groups records!
userGroupAfterConfirmation
userGroupAfterConfirmation
-
- Type
- string
User group(s) after confirmation: The value of the user group(s) assigned to the front end user after receipt of his confirmation.
userGroupAfterAcceptation
userGroupAfterAcceptation
-
- Type
- string
User group(s) after acceptation: The value of the user group(s) assigned to the front end user after acceptation of his(her) registration, when the administrative review is enabled.
Note
If administrative review is not enabled, this property is ignored.
passwordAtLeast
passwordAtLeast
-
- Type
- string
Minimum password length: The minimum number of characters that the password must contain.
passwordAtMost
passwordAtMost
-
- Type
- string
Maximum password length: The maximum number of characters that the password may contain.
usernameAtLeast
usernameAtLeast
-
- Type
- string
Minimum username length: The minimum number of characters that the username must contain.
usernameAtMost
usernameAtMost
-
- Type
- string
Maximum username length: The maximum number of characters that the username may contain.
nameAtMost
nameAtMost
-
- Type
- integer
- Default
- 80
Maximum name length: The maximum number of characters that the name of the front end user may contain.
alphaSpecials
alphaSpecials
-
- Type
- string
Allow special characters to alpha: The parse values for the alpha check normally contain alphabethical letters. Here you can add also special characters (e.g. German Umlauts) to the username.
alphaSpecials = äöüß
forceFileDelete
forceFileDelete
-
- Type
- boolean
- Default
- 1 (true)
If set, on record deletion, related images and files will be deleted even if the record in the database is only marked
deleted.
maxImages
maxImages
-
- Type
- integer
- Default
- 6
Number of images that may be uploaded. Value: An integer larger than 0 and smaller than 7.
Note
Has no effect if the field 'image' is not in the list formFields.
salutation
salutation
-
- Type
- string
If set, should be either 'formal' or 'informal'.
Note
This property will change the salutation mode used in the labels displayed in the front end, provided that this is meaningful in the language being displayed and that translators have provided the informal version.
useShortUrls
useShortUrls
-
- Type
- boolean
- Default
- 1 (true)
Enable the use of short URLs in email messages sent to users is enabled. Do not disable this if possible, because a short URL provides the highest security level.
useLocalization
useLocalization
-
- Type
- boolean
- Default
- 0 (false)
Enable the localization for selectable items.
useLocalCountry
useLocalCountry
-
- Type
- boolean
- Default
- 0 (false)
Show the country names in their local languages.
shortUrlLife
shortUrlLife
-
- Type
- int+
- Default
- 30
Short URL cache lifespan. This is the number of days that short URL's will be kept in the DB. After this delay, the short URL's will be removed. Confirmation URL's included in email messages older than this number of days will not work.
dateFormat
dateFormat
-
- Type
- string
- Default
- d-m-Y
date format You should also change the error message output if you change this.
day: d - day of the month, 2 digits with leading zeros; i.e. "01" to "31" j - day of the month without leading zeros; i.e. "1" to "31" month: m - month; i.e. "01" to "12" n - month without leading zeros; i.e. "1" to "12" year: Y - year, 4 digits; e.g. "1999" y - year, 2 digits; e.g. "99"
dateSplit
dateSplit
-
- Type
- string
- Default
- -
split characters for the dateFormat. This is a regular expression and might need the escape character ''! Use
dateto separate the date with a dotSplit = \. ..
mergeLabels
mergeLabels
-
- Type
- boolean
- Default
- 1 (true)
If set then the labels for select boxes found in setup are merged to the labels already in the TCA, which might come from TCEFORM.fe_users altLabels or
add. IfItems 0, then only the labels fromplugin.are taken.tx_ agency._ LOCAL_ LANG. de. fe_ users. x. I. x