Setting Account Expiration

Setting Account Expiration Overview

This guide is for setting days of the expiration date of an account, days to inform before the expiration date, configuring background tasks for sending notification emails, and deactivating accounts whose expiration date has passed.


Why would you set expiration to a user account?

  • It allows you to disable the account automatically if the user account is inactive for a configurable duration.
  • It allows you to create a temporary user account added to a user group that will expire automatically on the specified dates.

How does this work?

If the functionality is enabled, it will take effect on the set 'Expirable User Groups'. if there is nothing set, it will affect all the user accounts on the website.

  • The system will get the 'Number Of Days To Keep Account Alive' if a new user account was created
  • If the account is inactive, it will send an 'Account Expired Notification' email 'Days Prior To Suspension We Should Notify User' at a specified time in the 'Account Expires Notification Task' and 'Deactivation Expired Accounts Task'

How to configure the Account Expired Setting

STEP-BY-STEP
  • 1
    Log in as an administrator and go to the Admin Dashboard.
    Learn how to log in here →
  • 2
    Click Settings
  • 3
    Select Site Settings
  • 4
    Search 'Account Expired Setting'
  • 5
    Click the Edit icon
  • 6
    The Edit screen will appear with the following fields:
    • Number Of Days To Keep Account Alive: The number of days will be added to the expiration date once creating a new account or extending the expiration date of an account.
    • Days Prior To Suspension We Should Notify User: Days prior to suspension we should notify the user by email.
    • Expirable User Groups: Users in these groups will have an expiry date.
      Learn how to a specified User Group here →
    • Extend Expiration Date Page Template: set up the template for extending the expiration date page
      Account Expiration
  • 2
    Click Save

How to configure the Account Expires Notification Task

This background task is used to send mail notifications to accounts that are near expiration date

STEP-BY-STEP
  • 1
    Log in as an administrator and go to the Admin Dashboard.
    Learn how to log in here →
  • 2
    Click Settings
  • 3
    Select System Settings > Background Tasks
    Account Expiration
  • 4
    Search 'Account Expires Notification Task'
  • 5
    Click Config icon
  • 6
    Config screen appears. The administrator can update the task with 2 modes:
    Account Expiration
    • Interval: running by an interval time
    • Daily: running every day at a specific time
  • 7
    Click Save

How to configure the Deactivation Expired Accounts Task

This background task is used to send mail notifications to accounts that are near expiration date

STEP-BY-STEP
  • 1
    Log in as an administrator and go to the Admin Dashboard.
    Learn how to log in here →
  • 2
    Click Settings
  • 3
    Select System Settings > Background Tasks
    Account Expiration
  • 4
    Search 'Deactivation Expired Accounts Task'
  • 5
    Click Config icon
    Account Expiration
  • 6
    Config screen appears
    Account Expiration
  • 7
    Config schedule information for the task and click Save

How to activate an account

This background task is used to send mail notifications to accounts that are near expiration date

STEP-BY-STEP
  • 1
    Log in as an administrator and go to the Admin Dashboard.
    Learn how to log in here →
  • 2
    Click User Management
  • 3
    Select Users
  • 4
    Click the Edit icon to edit the user you want to activate
    Account Expiration
  • 5
    The edit screen appears. Navigate to Status
    Account Expiration
  • 6
    Set status to Active
  • 7
    Click Save
  • 8
    This user will be activated and the expiration date will be the activation date increased by the number of days added (config in site setting)

Changing an email template for an Expired Account notification

STEP-BY-STEP
  • 1
    Log in as an administrator and go to the Admin Dashboard.
    Learn how to log in here →
  • 2
    Click User Management
  • 3
    Select Email Setting > Email Templates
  • 4
    A list of email templates in the system appears
  • 5
    On the Subject column, search for 'Account Expired Notification'
  • 6
    Click Edit
    Account Expiration
  • 7
    The edit screen appears to adjust the email template
    Account Expiration
  • 8
    Click Add property to use available properties in the body.
    Account Expiration
  • 9
    Click Save