Customizing Emails with Additional Settings for Two-Factor Authentication (Administrator)

Applies To: CommCell Console

You can customize the emails sent for Two-Factor Authentication.

All of the following additional settings must be added to customize the emails:

CustomTFAEmailSubject: Customize the subject line
CustomTFAEmailWithSecret: Customize the email containing the secret key and the PIN
CustomTFAEmailWithoutSecret: Customize the email containing the PIN

Procedure

To the CommServe computer, add the additional settings as shown in the following table.

For instructions about adding an additional setting from the CommCell Console, see Adding or Modifying Additional Settings from the CommCell Console.

Additional Setting	Category	Type	Value	Example
CustomTFAEmailSubject	CommServDB.GxGlobalParam	STRING	Enter the text that will appear in the email subject line.	An extra level of security was added to the CommCell login
CustomTFAEmailWithSecret	CommServDB.GxGlobalParam	STRING	Enter the text that will appear in the email body as follows: These place holders are required: $$_URL_$$ - In the email body, this is replaced with the URL to the PIN generator documentation. $$_SECRET_$$ - In the email body, this is replaced with the secret key. $$_LOGIN_$$ - In the email body, this is replaced with the user name. $$_PIN_$$ - In the email body, this is replaced with the one time PIN. This place holder is optional: $$_NEWLINE_$$ - In the email body, this is replaced with a blank line.	Entered in the Value box: `Documentation URL:$$_NEWLINE_$$$$_URL_$$ $$_NEWLINE_$$$$_NEWLINE_$$Login:$$_NEWLINE_$$$$_LOGIN_$$$$_NEWLINE_$$$$_NEWLINE_$$Secret:$$_NEWLINE_$$$$_SECRET_$$$$_NEWLINE_$$$$_NEWLINE_$$One Time Pin:$$_NEWLINE_$$$$_PIN_$$$$_NEWLINE_$$$$_NEWLINE_$$Thank you.` Appears in the email body: `Documentation URL: http://documentation.commvault.com/commvault/vxx/article?p=features/two_factor_auth/c_tfa_pin_mobile_apps.htm Login: nonadmin Secret: FYG526UZLBHXIJPE One Time Pin: 969410 Thank you.`
CustomTFAEmailWithoutSecret	CommServDB.GxGlobalParam	STRING	Enter the text that will appear in the email body as follows: These place holders are required: $$_LOGIN_$$ - In the email body, this is replaced with the user name. $$_PIN_$$ - In the email body, this is replaced with the one time PIN. These place holders are optional: $$_URL_$$ - In the email body, this is replaced with the URL to the PIN generator documentation. $$_SECRET_$$ - In the email body, this is replaced with the secret key. $$_NEWLINE_$$ - In the email body, this is replaced with a blank line.	Entered in the Value box: `Login:$$_NEWLINE_$$$$_LOGIN_$$$$_NEWLINE_$$$$_NEWLINE_$$One Time Pin:$$_NEWLINE_$$$$_PIN_$$$$_NEWLINE_$$$$_NEWLINE_$$Thank you.` Appears in the email body: `Login: nonadmin One Time Pin: 969410 Thank you.`

Additional Setting

Category

Type

Value

Example

CustomTFAEmailSubject

CommServDB.GxGlobalParam

STRING

Enter the text that will appear in the email subject line.

An extra level of security was added to the CommCell login

CustomTFAEmailWithSecret

CommServDB.GxGlobalParam

STRING

Enter the text that will appear in the email body as follows:

These place holders are required:

$$_URL_$$ - In the email body, this is replaced with the URL to the PIN generator documentation.
$$_SECRET_$$ - In the email body, this is replaced with the secret key.
$$_LOGIN_$$ - In the email body, this is replaced with the user name.
$$_PIN_$$ - In the email body, this is replaced with the one time PIN.

This place holder is optional:

$$_NEWLINE_$$ - In the email body, this is replaced with a blank line.

Entered in the Value box:

Documentation URL:$$_NEWLINE_$$$$_URL_$$ $$_NEWLINE_$$$$_NEWLINE_$$Login:$$_NEWLINE_$$$$_LOGIN_$$$$_NEWLINE_$$$$_NEWLINE_$$Secret:$$_NEWLINE_$$$$_SECRET_$$$$_NEWLINE_$$$$_NEWLINE_$$One Time Pin:$$_NEWLINE_$$$$_PIN_$$$$_NEWLINE_$$$$_NEWLINE_$$Thank you.

Appears in the email body:

Documentation URL:
 http://documentation.commvault.com/commvault/vxx/article?p=features/two_factor_auth/c_tfa_pin_mobile_apps.htm
 Login:
 nonadmin
 Secret:
 FYG526UZLBHXIJPE
 One Time Pin:
 969410
 Thank you.

CustomTFAEmailWithoutSecret

CommServDB.GxGlobalParam

STRING

Enter the text that will appear in the email body as follows:

These place holders are required:

$$_LOGIN_$$ - In the email body, this is replaced with the user name.
$$_PIN_$$ - In the email body, this is replaced with the one time PIN.

These place holders are optional:

$$_URL_$$ - In the email body, this is replaced with the URL to the PIN generator documentation.
$$_SECRET_$$ - In the email body, this is replaced with the secret key.
$$_NEWLINE_$$ - In the email body, this is replaced with a blank line.

Entered in the Value box:

Login:$$_NEWLINE_$$$$_LOGIN_$$$$_NEWLINE_$$$$_NEWLINE_$$One Time Pin:$$_NEWLINE_$$$$_PIN_$$$$_NEWLINE_$$$$_NEWLINE_$$Thank you.

Appears in the email body:

Login:
 nonadmin
 One Time Pin:
 969410
 Thank you.

Customizing Emails with Additional Settings for Two-Factor Authentication (Administrator)

Procedure

Page contents