Customize email messages
You can customize the various email messages that are sent by the virtual server. Messages that are sent in response to an alert can be sent by email, SMS, or both.
-
On the STA Token Management console, select Comms > Communications > Email Messages.
-
Select Custom.
-
Select an Email Message Type.
-
Select the Format for the email message.
-
To customize the Subject and Body of the message, use the email message tags.
-
If required, customize the SMS Content that is sent.
The SMS Content field is presented for messages that support sending messages by both email and SMS. SMS messages greater than 160 characters, including spaces, span multiple SMS messages.
An SMS credit is consumed for each SMS alert message, unless the virtual server is configured to use an SMS gateway.
The following events cause corresponding SMS messages to be sent:
-
SP Alert: These alerts are available only for virtual service provider accounts.
-
Alert: These alerts are available in all account service types (virtual service provider, subscriber, evaluation).
-
HAlerts: These are system alerts and are valid only for the hosting service.
-
Enrollment: These messages are sent as part of a provisioning or self-enrollment process.
-
-
Select Apply.
Email message tags
Use the following tags to insert information from the virtual server into your message content. Many tags are available for only specific messages.
Tag | Description |
---|---|
<BR> |
A line break that causes text following this tag to appear on a new line |
<accountName /> |
Company name associated with the virtual server |
<remaining /> |
The remaining, or unused, capacity in the virtual server |
<total /> |
The total capacity allocated to the virtual server |
<active /> |
Virtual server service as set by the service provider (enabled or disabled) |
<type /> |
Virtual server service type (virtual service provider, subscriber, evaluation) |
<daysLeft /> |
Day before the service stop date |
<stepDate /> |
Service stop date as set by the service provider |
<dateTime /> |
Timestamp of an event |
<firstName> |
First name of a user |
<lastName> |
Last name of a user |
<reportName /> |
Name of a report |
<name /> |
User ID |
<taskeID /> |
Provisioning task number generated by the virtual server |
<count /> |
Number of users that did not complete self-enrollment before the provisioning task expired |
<username /> |
A user’s UserID (User Detail) |
<Uaddress /> |
Address (User Detail) |
<Ucity /> |
City (User Detail) |
<Uprovince /> |
State or province (User Detail) |
<Upostal /> |
Postal or zip code (User Detail) |
<Ucountry /> |
Country (User Detail) |
<orgName /> |
Account name (Virtual Server) |
<Oaddress /> |
Account address (Virtual Server) |
<Oprovince /> |
Account state or province (Virtual Server) |
<Opostal /> |
Account postal or zip code (Virtual Server) |
<Ocountry /> |
Account country (Virtual Server) |
<capLeft /> |
Remaining virtual server license capacity |
<capTotal /> |
Total license capacity for the virtual server |
<expiryDate /> |
Server license expiration date |
<expiryTime /> |
Days remaining before license expires |
<capLeft /> |
Service capacity remaining |
<capTotal /> |
Service capacity total |
<tokenList /> |
Serial numbers of tokens that are no longer associated with users |
<freeSpace /> |
Disk space remaining |
<diskSize/> |
Total disk space |
<percentageFree /> |
Percentage of available space versus total disk size |
<consoleLink /> |
Unique URL for validating the operator and logging on to the STA consoles |
<username /> |
Unique userID used by the operator to log on to the STA consoles |
<unlockTime/> |
The time when a user account will automatically unlock |
<organization /> |
Account to which a user belongs |
<state /> |
Operator account status (active, pending, suspended) |
<remaining /> |
Quantity of SMS credits in inventory for the virtual server |
<selfEnrollURL /> |
Unique URL sent to the user for self-enrollment |
<addList /> |
List of users added by synchronization with an external user data source |
<ignoreList /> |
Total number of users not updated during synchronization because these users already exist in the virtual server |
<updateList /> |
Total number of users removed by synchronization, because the users no longer exist in the external data source |
<removeList /> |
List of users who were removed by synchronization because the users no longer exist in the external data source |
<totalMarkforRemoval /> |
Total number of users who were not found in the external data source during synchronization. These users are removed from the virtual server after 24 hours have elapsed. |
<markedList /> |
List of users who were not found in the external data source during synchronization. These users are removed from the virtual server after 24 hours have elapsed. |
<tokenType /> |
Type of token. You can add this optional tag to the self-enrollment email message. The email recipient can use the token type to look up token-specific information. In the email, the <tokenType/> tag is replaced with the specific token type. |
<time /> |
Date and time of the request by a user to be issued a token |
<oldState /> |
State of the token (such as assigned, active, and so on) when the token was assigned to the user |
<newState /> |
State a token is moved to by the virtual server when the user to which it was assigned can no longer be found |
<serial /> |
Serial number of a token |
<remaining /> |
Quantity of a token type remaining in inventory |
<total /> |
Total quantity of tokens registered in the virtual server |
<failAttempts /> |
The number of consecutive failed logon attempts |
Email message types
You can customize the following email message types:
Account Capacity
Type | SP Alert |
Event | Sent when the virtual server capacity falls below the configured event threshold. |
Subject | <productName /> Account Capacity |
Body | The account <accountName /> is approaching their capacity with <remaining /> remaining of <total /> allocated to them |
SMS Content | Account <accountName /> approaching capacity. <remaining />/<total /> left |
Account Removed
Type | SP Alert |
Event | Sent when an account (virtual server) is removed |
Subject | <productName /> Account Removed |
Body | The account <accountName /> has been removed by <operator /> |
SMS Content | Account <accountName /> removed by <operator /> |
Account Status Change
Type | SP Alert |
Event | Sent when a virtual server account is enabled or disabled |
Subject | <productName /> Account Status Change |
Body | The account <accountName /> has changed to an <active /> <type /> |
SMS Content | Account <accountName /> changed to an <active /> <type /> |
Account Stop Date
Type | SP Alert |
Event | Sent X days in advance of the service stop date |
Subject | <productName /> Account Stop Date |
Body | The account <accountName /> is approaching their stop date. There are <daysLeft /> day(s) till the stop date on <stopDate /> |
SMS Content | <daysLeft /> day(s) till stop on <stopDate /> for account <accountName /> |
Active Evaluation Stop Date
Type | SP Alert |
Event | Sent X days in advance of the service stop date for evaluation accounts |
Subject | <productName /> Evaluation Stop Date |
Body | The account <accountName /> is approaching their evaluation stop date. There are <daysLeft /> day(s) till the stop date on <stopDate /> |
SMS Content | <daysLeft /> day(s) till stop on <stopDate /> for eval account <accountName /> |
Auth Node Changes
Type | SP Alert |
Event | Sent if an element of the service is downgraded or unavailable. |
Subject | <productName /> Auth Node Changes |
Body | The Auth Node <nodeName /> in account <accountName /> was <action /> by <changedBy /> |
SMS Content | Auth Node <nodeName /> in <accountName /> <action /> by <changedBy /> |
Auth Service Down
Type | SP Alert |
Event | Sent if an element of the service is downgraded or unavailable |
Subject | <productName /> Authentication Service Error |
Body | This message is to report that the <productName /> authentication service was found to be unresponsive at <dateTime />, during a scheduled check of the service |
SMS Content | <productName /> down at <dateTime /> |
BlackBerry PIN
Type | Enrollment |
Event | Sent to Users receiving BlackBerry token by email. First of two messages. |
Subject | <productName /> Auth Node Changes |
Body | <firstName /> <lastName />: This e-mail will assist you in the installation and activation of your new SafeNet token into your Blackberry. Step one is to install the Token Authenticator and Token Attachment handler application on your BlackBerry. Step two is the installation and activation of the actual token. Please make note of the PIN below, as it is required to activate your token. To install the Token Authenticator "Over-the-Air", browse to the URL below with your BlackBerry. If the application is installed via Desktop Manager (USB) or Blackberry Enterprise Server, this step is not necessary. Again, please make note of your token activation PIN. Your token will be issued to you shortly. <blackberryURL /> Your token activation PIN is: <tokenPIN /> |
SMS Content |
|
Completed Report
Type | Alert |
Event | Sent to recipients receiving reports by email |
Subject | <productName /> Report Results |
Body | <accountName /> Results of the report <reportName /> are attached. |
SMS Content |
|
Enrollment Lockout
Type | Alert |
Event | Sent when a user exceeds the maximum number of attempts to self-enroll. |
Subject | Enrollment Lockout |
Body | <accountName />, The user <name /> has been locked out of self-enrollment at <dateTime /> because there have been too many failed attempts to enroll. |
SMS Content | User <name /> has been locked out of self-enrollment |
Enrollment Out of Band
Type | Enrollment |
Event | Sent when a user during enrollment of a token provisioned using a shipping authority. |
Subject | Enrollment Validation |
Body | This email is to validate an ongoing enrollment attempt. Your validation code is <code />. If you are not in the process of enrolling a token, this e-mail can be ignored. |
SMS Content | Your enrollment validation code is <code />. |
Expired Reservation
Event | Sent when a provisioning task expires before all users in the task have completed self-enrollment. |
Subject | <productName /> Reservation is Expired |
Body | Provisioning task <taskID /> has expired in account <accountName /> with <count /> users still pending enrollment. They will no longer be able to complete enrollment. |
SMS Content | Reservation expired for user <userName /> |
Hardware Assignment Notification
Type | Alert |
Event | Sent when manually assigning a hardware token. |
Subject | <productName /> Token Assignment Notification |
Body | A hardware token has been assigned
<firstName /> <lastName />: <userName /> At: <Uaddress /> <Ucity /> <Uprovince /> <Upostal /> <Ucountry />
In company: <orgName /> At: <Oaddress /> <Ocity /> <Oprovince /> <Opostal /> <Ocountry /> |
SMS Content |
|
Hardware Provisioning Notification
Type | Alert |
Event | Sent when auto-provisioning a hardware token. |
Subject | <productName /> Token Provisioning Notification |
Body | A hardware token has been provisioned
<firstName /> <lastName />: <userName /> At: <Uaddress /> <Ucity /> <Uprovince /> <Upostal /> <Ucountry />
In company: <orgName /> At: <Oaddress /> <Ocity /> <Oprovince /> <Opostal /> <Ocountry /> |
SMS Content |
|
License Expiry
Type | HAlert |
Event | Sent X days before license expires. |
Subject | <productName /> License Expiry Warning |
Body | This message is a warning that your <productName /> system is nearing its license expiry. Your license expires on <expiryDate />. You have <expiryTime /> day(s) left before <productName /> shuts down. |
SMS Content | License expiry warning: Your license expires on <expiryDate /> |
License Accounts
Type | Alert |
Event | Sent when remaining account capacity falls below minimum threshold. |
Subject | <productName /> License Capacity Warning |
Body | This message is a warning that your <productName /> system is nearing its maximum account capacity. |
SMS Content |
List of Token Users Not Found
Type | Alert |
Event | Lists tokens no longer associated with users caused when users are removed from external user source before revoking token. |
Subject | List of <productName /> Token Users Not Found |
Body | The following list contains tokens that have had their state set to <newState /> because the users they were assigned to can no longer be found by STA. <tokenList /> |
SMS Content | Tokens have been orphaned in STA. Log in to see the details. |
Low Disk Space
Type | HAlert |
Event | Sent when disk space falls below minimum threshold. |
Subject | <productName /> Low Disk Space Warning |
Body | This message is to report that the free disk space on system drive <driveLetter /> is low. Details: Time of Report: <dateTime /> Free Space: <freeSpace /> bytes. Disk Size: <diskSize /> bytes. Percentage Free: <percentageFree /> |
SMS Content | Low disk space warning. <percentageFree />% free on <driveLetter /> |
Mail Test
Type | Alert |
Event | Sent when testing email/SMTP settings. |
Subject | <productName /> E-mail Configuration Test |
Body | E-mail configuration is correct if you have received this message. |
SMS Content | SMS configuration is correct if you have received this message. |
Operator E-mail Validation
Type | Enrollment |
Event | Sent to user when promoted to virtual server operator. |
Subject | <productName /> Email Validation |
Body | To activate your Operator account in the <productName /> Authentication Manager you must logon by following the link and using the e-mail address indicated below: Logon link: <consoleLink /> E-mail: <userName /> |
SMS Content | Welcome to <productName />. Logon at <consoleLink /> |
Operator Lockout Alert
Type | Alert |
Event | Sent to an operator when a user account becomes locked. (Account Lockout/Unlock Policy) |
Subject | <productName /> User Lockout Alert |
Body | Attention: The following user has been locked out of authentication access until <unlockTime />, following <failedAttempts /> consecutive failed logon attempts: Name: <firstName /> <lastName /> Username: <userName /> Account: <organization /> |
SMS Content | Account <userName /> in organization <organization /> has been locked. |
Operator Status Change
Type | Alert |
Event | Sent when an operator’s status changes. (active, pending, suspended) |
Subject | Operator Status Change |
Body | Attention: The following operator's state has been changed to <state /> User Account: <userName /> Account: <accountName /> |
SMS Content | <organization />: <userName />'s operator status changed to <state /> |
Operator Unlock Alert
Body | Attention: The following user's authentication access has been unlocked: Name: <firstName /> <lastName /> Username: <userName /> Account: <organization /> |
SMS Content | Account Unlock Alert: User: <userName /> Organization <organization /> |
Organization Capacity
Type | Alert |
Event | Sent when virtual server capacity falls below threshold. |
Subject | <productName /> Capacity |
Body | <accountName /> You are approaching your maximum capacity. <remaining /> left out of <total /> |
SMS Content | Approaching capacity: <remaining /> left of <total /> |
Organization SMS Credits
Type | Alert |
Event | Sent when virtual server SMS credits falls below threshold. |
Subject | <productName /> SMS Credits |
Body | <accountName />, Your available SMS credits are getting low. You have <remaining /> left. |
SMS Content | SMS Credits low. <remaining /> left |
Provisioning Canceled
Event | Self-enrollment instructions sent to users as part of a provisioning task. |
Subject | <productName /> Provisioning Canceled |
Body | <firstName /> <lastName />, your pending token provisioning has been canceled. The enrollment link you received in a previous email is no longer active. |
SMS Content | Your token provisioning has been canceled. |
Push Notification Rejection Internal Operator Alert
Type | Alert |
Event | Sent to the operator when a user rejects a push notification. |
Subject | <productName /> Push Notification Rejection Alert |
Body | The user account <userid /> in organization <organization /> denied and reported a push notification:
Organization name: <organizationName /> Resource name: <resourceName /> Client IP address: <clientIP /> Location: <clientLocation /> |
SMS Content | Account <userid /> in <organizationName /> denied and reported a push notification. |
Push Notification Rejection User Alert
Body | <firstName /> <lastName />, this auto-send authentication request was denied from your <deviceOS /> <deviceType /> device, and reported to your administrator: Organization name: <organizationName /> User ID: <userid /> Resource name: <resourceName /> Client IP address: <clientIP /> Location: <clientLocation /> |
SMS Content | Auto-send was denied from your <deviceOS /> <deviceType /> device. |
Self-Enrollment
You can use the optional <tokenType/> tag in this email message. The email recipient can use the token type to look up token-specific information.
Type | Enrollment |
|
Event | Self-enrollment instructions sent to users as part of a provisioning task. The self-enrollment email is sent when:
|
|
Subject | <productName /> Self-enrollment |
|
Body | <firstName /> <lastName />: Your self-enrollment account has been created. If you are enrolling a hardware token, and do not have your token yet, please contact your system administrator. |
|
SMS Content | <productName /> Self Enrollment: Enroll at <selfEnrollURL /> |
Self Service Report Lost Token
Type | Enrollment |
Event | Self-service Confirmation of Lost Token |
Subject | <productName /> Self-enrollment |
Body | <firstName /> <lastName />: Please click the following link to confirm your lost token report. <url /> If the above link does not work, please copy and paste this url to your web browser. Please confirm your lost token report within the next 10 minutes. |
SMS Content | Please click the following link to confirm your lost token report. <url />. Please confirm your lost token report within the next 10 minutes. |
Self Service Request Token
Type | Enrollment |
Event | Sent when a user initiated token request is received from self-service. |
Subject | Self-service Confirmation of Token Request |
Body | <firstName /> <lastName />: Please click the following link to confirm that you requested a token. <url /> If the above link does not work, please copy and paste this url to your web browser. Please confirm your request within the next 10 minutes. |
SMS Content | Please click the following link to confirm that you requested a token. <url />. Please confirm your request within the next 10 minutes. |
Self Service Temp Password
Body | <firstName /> <lastName />: Your self-service temporary sign in password is: <password /> Please use this password to sign in within the next 10 minutes. |
SMS Content | Your self-service temporary sign in password is: <password />. Please use this password to sign in within the next 10 minutes. |
Service Notification
Type | Alert |
Event | Sent when a service notification is enabled by a service provider and delivery method is email. |
Subject | <productName /> Service Notification |
Body | <productName /> Service Notification – contents of this message should be changed to reflect the notification. |
SMS Content | <productName /> Service Notification |
SIM Service Failed
Type | Alert |
Event | Sent when a SIM/OTA service is unable to provision a user. |
Subject | SIM Provisioning Failed |
Body | Task <taskID /> to MSISDN <MSISDN /> for user <userName /> has failed after <attempts /> attempt(s). |
SMS Content | <productName /> Service Notification |
SIM Service Retry
Type | Alert |
Event | Sent when a SIM/OTA service retries a provisioning task. |
Subject | SIM Provisioning requires retry |
Body | Task <taskID /> to MSISDN <MSISDN /> for user <userName /> has not been completed after <attempts /> attempt(s). It will be attempted <remaining /> more times. |
SMS Content | Task <taskID /> for <userName />@<MSISDN /> has failed after <attempts /> attempt(s). |
Sync Notification
Event | Sent whenever an LDAP sync task updates the virtual server. |
Subject | LDAP Sync notification |
Body | The following actions have been processed for <orgName />: The following <totalAdded /> new users have been added: <addList />
The following <totalUpdated /> existing users have been updated: <updateList /> The following <totalRemoved /> users have been removed: <removeList />
The following <totalMarkForRemoval /> users have been marked for deletion: <markedList /> They will continue to exist for 24 hours, during which period they have been marked as disabled. If this was a result of a misconfiguration, fixing the configuration will re-enable the users. Note: If you have deleted a user in LDAP, re-creating a new user with the same user name will NOT restore the existing user. |
SMS Content | Task <taskID /> for <userName />@<MSISDN /> has failed after <attempts /> attempt(s). |
Token Request Ack
Type | Enrollment |
Event | Sent to user to acknowledge request to be issued a token. |
Subject | <productName /> Token Request Acknowledged |
Body | This message is to confirm that your request for a <tokenType /> token has been received as of <time />. |
SMS Content | Your request for a <productName /> token has been received. |
Token Request Deny
Subject | <productName /> Token Request Denied |
Body | This message is to inform you that your request for a <tokenType /> token has been denied. |
SMS Content | Your request for a <productName /> token has been denied. |
Token User Not Found
Type | Alert |
Event | Sent when token state is change when the user to which it was assigned is not found. |
Subject | <productName /> Token User Not Found |
Body | The token <serial /> which was assigned to user <userName /> has been changed from state <oldState /> to <newState /> This has occurred because the user <userName /> can no longer be found by <productName /> . |
SMS Content | Token <serial /> has been orphaned as user <userName /> cannot be found. |
Token User Replaced
Type | Alert |
Event | Sent when a User (UserID) with an assigned token is overwritten with an user from a different user source with an identical UserID. For example, a manually created userID is overwritten during LDAP synchronization which includes an identical UserID. |
Subject | <productName /> Token User Replaced |
Body | The token <serial /> which was assigned to user <userName /> has been changed from state <oldState /> to <newState /> This has occurred because the user <userName /> has been overwritten by a new user <userName />. |
SMS Content | Token <serial /> orphaned because user <userName /> was over written. |
Token Request Approval 2
Body | LEVEL 2 APPROVAL The following user has requested a token in <accountName />. User:<userName /> First Name:<firstName /> Last Name:<lastName /> Email<email /> Token type requested: <typeRequested /> To approve this request click on this link: <approveURL />. To reject this request click on this link: <rejectURL />. This request can also be approved or rejected by logging into the <productName /> Manager. |
SMS Content | Self-service token request <taskID />. Click URL or logon to approve or reject. |
Token Request Issuer
Type | Enrollment |
Event | Sent to issuing authorities when a token request has all necessary approvals. |
Subject | <productName /> Self-service token request |
Body | The following user has requested a token in <accountName />. User:<userName /> First Name:<firstName /> Last Name:<lastName /> Email<email /> Token type requested: <typeRequested /> To issue this request click on this link: <issueURL />. This request can also be issued by logging into the <productName /> Manager. |
SMS Content | Self-service token request <taskID />. Click the URL or logon to issue or reject. |
Token Request Receipt
Type | Enrollment |
Event | Sent to the requesting user to confirm receipt of the request from the self-service site. |
Subject | <productName /> Token request receipt notification |
Body | REQUEST RECEIPT PROCESSING <firstName /> <lastName />, Your request for a token has been received and is awaiting approval. Your request will be processed within the next <expireLength /> days. |
SMS Content | Your request for a token has been received. |
Token Request Shipper
Type | Enrollment |
Event | Sent to the shipping authority once the token request has received the issuing authority approval (if enabled.) |
Subject | <productName /> Self-service token request |
Body | The token for the following request needs to be shipped in <accountName />. User:<userName /> First Name:<firstName /> Last Name:<lastName /> Email<email /> Token type requested: <typeRequested /> After the token required for this request has been shipped, the request can be marked as shipped by logging into the <productName /> Manager. |
SMS Content | Self-service token request <taskID /> ready for shipping. |
Token Request Validation
Subject | Token Request Validation |
Body | <P>Click on the link below or paste link into a browser to validate your token request.</P> <P>Requests that are not validated with <Days /> are automatically rejected.</P> <P>Validation URL: <URL /></P> |
SMS Content | Go to <URL /> to validate token request. |
Token Sub Capacity
Type | Alert |
Event | Sent when remaining quantity of tokens in inventory falls below the minimum threshold. |
Subject | <productName /> Token Capacity |
Body | <accountName />, You are approaching your remaining capacity available to you. <remaining /> left out of <total /> |
SMS Content | Approaching capacity: <remaining /> left of <total /> |
User Lockout Alert
Type | Alert |
Event | Sent to user when their account becomes locked due to excessive failed consecutive logon attempts |
Subject | <productName /> User Lockout Alert |
Body | <accountName />, You are approaching your remaining capacity available to you. <remaining /> left out of <total /<firstName /> <lastName />, you have been locked out of authentication access until <unlockTime />, following <failedAttempts /> consecutive failed logon attempts. |
SMS Content | Your <productName /> account has been locked until <unlockTime /> |
User Unlock Alert
Type | Alert |
Event | Sent to user when their account becomes unlocked. |
Subject | <productName /> User Unlock Alert |
Body | <firstName /> <lastName />, you can again attempt to logon to the authentication service. |
SMS Content | Your <productName /> account has been unlocked. |