Difference between revisions of "Password Variables to Set or Reset User Passwords"

From SmartWiki
Jump to: navigation, search
(Areas for review)
(Areas for review)
Line 17: Line 17:
  
 
==Areas for review==
 
==Areas for review==
There may be references to the soon-to-be deprecated variables within your system. These will need to be changed prior to the upgrade. Check the following areas:
+
There may be references to the soon-to-be deprecated variables within multiple areas of your system. These will need to be changed prior to the upgrade. For example:
  
 
===Password and Activation Policies===
 
===Password and Activation Policies===
These email templates are located at '''Menu Icon''' > '''Global Settings''' > '''Security''' tab >''' Password and Activation Policies''' > '''Activation Emails''' tab. Clicking the '''Sample Template''' link will replace the existing email template, with a sample template from SmartSimple which contains the new activation link variable. You can of course modify this template as needed but be sure to place the variable in the appropriate place.
+
These email templates are located at '''Menu Icon''' > '''Global Settings''' > '''Security''' tab >''' Password and Activation Policies''' > '''Activation Emails''' tab. Clicking the '''Sample Template''' link will replace the existing email template, with a sample template from SmartSimple which contains the new activation link variable. You can modify this template as needed but be sure to place the variable in the appropriate place.
  
 
===User Signup Pages===
 
===User Signup Pages===
Depending on how your user signup pages are configured, you may also need to update signup page templates for new users which can be found at '''Menu Icon''' > '''Global Settings''' > '''Communications''' >''' System Email Templates'''. You can filter the list by searching for “Signup Page”.
+
Depending on how your user signup pages are configured, you may need to update signup page templates for new users which can be found at '''Menu Icon''' > '''Global Settings''' > '''Communications''' >''' System Email Templates'''. You can filter the list by searching for “Signup Page”.
  
 
You can also review the list of all User Signup Pages by navigating to: '''Menu Icon > Global Settings > Users > Signup Pages'''
 
You can also review the list of all User Signup Pages by navigating to: '''Menu Icon > Global Settings > Users > Signup Pages'''
  
 
===Workflow and System Email Templates===
 
===Workflow and System Email Templates===
Password variables can also be found in workflow emails, usually in User workflow type where workflow can activate and send an activation email to a user.<br />Sometimes password variables can also be used in standard workflow emails. This makes them difficult to find.
+
Password variables can also be found in workflow emails, usually in User workflow type where workflow can activate and send an activation email to a user. Sometimes password variables can also be used in standard workflow emails.
  
The recommendation on how to find them is to follow the following steps:
+
An easy way to see and check the content of all system emails for deprecated variables is to:
  
* Navigate to '''Menu Icon > Global Settings > Communications > System Email Templates'''. You can filter the list by searching for “Workflow Email”.
+
* Navigate to '''Menu Icon > Global Settings > Communications > System Email Templates'''.
* Depending on your specific system configuration you might have many emails to review.
+
* Click the '''Export Emails''' button top left above the list. This will export the list system emails as an excel file.
* The easiest way to do this is to export them using the '''Export Emails''' button.
+
* Search the column called '''Email Body''' for all deprecated variables contained within system emails. If you find anything that needs to be updated, go back into the system and update relevant email by clicking on the pencil button next to the relevant system email template.
* This will export the list to an excel file.
 
* Now you can search excel for all variables. If you find anything which needs to be updated you can go back to the system and update relevant email by clicking on the pencil button next to the relevant template.
 
  
 
==See Also==
 
==See Also==

Revision as of 11:51, 26 October 2023

Overview

In the upcoming November 2023 release, the use of password variables will be deprecated to enhance security measures and align with best practices. Instead of using the soon to be deprecated password variable @password@ which sends a password in plain text in the email body, all systems will be required to adopt the following activation link variable. This variable will redirect users to a designated page where they can securely set their desired password:

https://@url@@activationlink@
An example of the activation link variable when used with a new user email.

Therefore, the following variables will be deprecated and will not work after the November upgrade:

  • @password@ - Generates a new password for new users
  • @randompassword@ - Generates a random password for existing users
  • @passwordresetlink@ - A link that allows existing users to reset their passwords
  • @checkactivatedpassword@ - Checks if a user is activated. If sent to a user who is not activated, it generates a new password. If the user is activated, it will send the words “existing password”.
  • @checkportalpassword@ - If sent to a new user, it will generate a new password. If sent to an existing user, it will send the words “existing password” and promote the user to an admin/portal type user.

If you need help updating email templates for new users or password resets, reach out to our Support team.

Areas for review

There may be references to the soon-to-be deprecated variables within multiple areas of your system. These will need to be changed prior to the upgrade. For example:

Password and Activation Policies

These email templates are located at Menu Icon > Global Settings > Security tab > Password and Activation Policies > Activation Emails tab. Clicking the Sample Template link will replace the existing email template, with a sample template from SmartSimple which contains the new activation link variable. You can modify this template as needed but be sure to place the variable in the appropriate place.

User Signup Pages

Depending on how your user signup pages are configured, you may need to update signup page templates for new users which can be found at Menu Icon > Global Settings > Communications > System Email Templates. You can filter the list by searching for “Signup Page”.

You can also review the list of all User Signup Pages by navigating to: Menu Icon > Global Settings > Users > Signup Pages

Workflow and System Email Templates

Password variables can also be found in workflow emails, usually in User workflow type where workflow can activate and send an activation email to a user. Sometimes password variables can also be used in standard workflow emails.

An easy way to see and check the content of all system emails for deprecated variables is to:

  • Navigate to Menu Icon > Global Settings > Communications > System Email Templates.
  • Click the Export Emails button top left above the list. This will export the list system emails as an excel file.
  • Search the column called Email Body for all deprecated variables contained within system emails. If you find anything that needs to be updated, go back into the system and update relevant email by clicking on the pencil button next to the relevant system email template.

See Also