← Back to plugin index

Self Reg Users Reminder Task
Description
Server task that looks at all self-registered users and sends a reminder email to self-registered users that have never logged in after a configurable number of minutes.
Type name
SelfRegUsersReminderTask
Class
com.airlock.iam.servicecontainer.app.application.configuration.task.SelfRegUsersReminderTask
May be used by
Task Schedule
License-Tags
SelfRegistration
Properties
Email Service (emailService)
Description
Email service through which the emails are sent if the user did never login. This property is mandatory if "Never Logged In Minutes" is configured.
Attributes
Plugin-Link
Optional
Assignable plugins
Dummy Email Service SMTP Email Service
Email Property Name (emailPropertyName)
Description

Name of the context data field that contains the user's email address. Used to send an email if the user did never login.

Attributes
String
Optional
Default value
email
Example
email
Example
new_email
Already Sent Property Name (alreadySentPropertyName)
Description

Name of the context data field where it is remembered that a reminder email has been sent already. If this is not configured, an email will be sent every time the task is executed. Make sure to also configure this field in the user persister.

Attributes
String
Optional
Example
activity_reminder_sent
Language Property Name (languagePropertyName)
Description

Name of the context data field that contains the user language. Used when sending a reminder email if the user did never login.

Attributes
String
Optional
Default value
language
Example
language
Default Language (defaultLanguage)
Description

Default language to be used if none is defined for the user.

Attributes
String
Optional
Default value
de
Example
de
Example
fr
Example
en
Not Logged In Reminder Email Subject Key (notLoggedInReminderEmailSubjectKey)
Description
Resource key for the email subject. Used when sending an email if the user did never login.
Attributes
String
Optional
Default value
selfregistration.reminder-email-subject
Example
selfregistration.reminder-email-subject
Example
selfregistration.not-logged-in-reminder-email-subject
Not Logged In Reminder Email Body Key (notLoggedInReminderEmailBodyKey)
Description
Resource key for the email body (the message). Used when sending an email if the user did never login.
Attributes
String
Optional
Default value
selfregistration.reminder-email-body
Example
selfregistration.reminder-email-body
Example
selfregistration.not-logged-in-reminder-email-body
Resources File Prefix (resourcesFilePrefix)
Description
Language dependent string resources (e.g. texts for email subject and body) are located in property files. This setting configures the prefix of these property files. Used when sending an email if the user did never login.

Example: If the value of this property is strings, the language dependent files must be "strings_de.properties", "strings_en.properties" and so on and the default file must be "strings.properties".

Attributes
String
Optional
Default value
strings
User Persister (userPersister)
Description
User persister plugin used to read and modify user account data.
Attributes
Plugin-Link
Mandatory
Assignable plugins
Cipher User Persister Combining Extended User Persister Database User Persister Dummy Extended User Persister LDAP Connector LDAP User Persister Property User Persister
User Iterator (userIterator)
Description
The user iterator plugin used to iterate over all users.
Usually this is the same as the UserPersister.
Attributes
Plugin-Link
Mandatory
Assignable plugins
Active Directory Connector Cipher User Persister Combining Extended User Persister Combining User Persister Database User Persister Dummy Extended User Persister LDAP Connector LDAP User Persister Property User Persister
Never Logged In Minutes (neverLoggedInMinutes)
Description
Number of minutes after registration after which the action is executed if the user did not log in.
Attributes
Integer
Mandatory
YAML Template (with default values) 

type: SelfRegUsersReminderTask
id: SelfRegUsersReminderTask-xxxxxx
displayName: 
comment: 
properties:
  alreadySentPropertyName:
  defaultLanguage: de
  emailPropertyName: email
  emailService:
  languagePropertyName: language
  neverLoggedInMinutes:
  notLoggedInReminderEmailBodyKey: selfregistration.reminder-email-body
  notLoggedInReminderEmailSubjectKey: selfregistration.reminder-email-subject
  resourcesFilePrefix: strings
  userIterator:
  userPersister: