Notification service
To provide feedback on job statuses, enable the Notification feature of ShareScan. The Notification service notifies the pre-configured recipients based on events occurring in ShareScan that are configured to use an SMTP notification.
The Notification service is located on the Configure Services tab under Common Services.
This service provides the following main functions:
Configuring Service: Notification settings
ShareScan sends an SMTP message through the email server specified in the SMTP Server address. With a predefined setting, the message contains customized messages that display specific data, for example, Subject, Header, Body, and Footer. The notifications can be descriptions of errors, warnings, or informational data from completed scan jobs.
Setting |
Description |
---|---|
Configured |
Select the Yes check box so that a device can use the service. Clear the check box to prevent a device from using the service. |
SMTP Server Configuration |
Contains the settings that you use to configure the SMTP server. |
SMTP Server Type |
|
SMTP Server |
SMTP server name, which is the DNS name of the e-mail server that is used to send the SMTP message. |
SMTP Server Port |
SMTP server port to be used. Default SMTP port is 25. Default secure SMTP port is 587. |
Secure SMTP |
Select the Yes check box to use SSL for securing SMTP transactions. You can only configure this option if SMTP Server Authentication is set to Use Credentials. |
SMTP Server Authentication |
Authentication method used to send SMTP mail to the SMTP server. In the second column, double-click the authentication option to select either Anonymous or Use Credentials or Use Modern Authentication (OAuth2):
|
Username |
SMTP username (not available when selecting Use Modern Authentication (OAuth2) as SMTP Server Authentication). |
Password |
SMTP password (not available when selecting Use Modern Authentication (OAuth2) as SMTP Server Authentication). |
Domain |
SMTP domain (not available when selecting Use Modern Authentication (OAuth2) as SMTP Server Authentication). |
Token Vault / Authentication method |
The authentication method connecting to Token Vault. Only available when selecting Use Modern Authentication (OAuth2) as SMTP Server Authentication). |
Token Vault / Username |
Username of the domain user connecting to Token Vault (only available when selecting Use Modern Authentication (OAuth2) as SMTP Server Authentication). If Password is selected as Authentication method, the username must be specified in the DOMAIN\Username format. If One-time passcode is selected as Authentication method, the username must be specified in the User Principal Name (UPN) format. |
Token Vault / Password |
Password of the domain user connecting to Token Vault (only available when selecting Use Modern Authentication (OAuth2) as SMTP Server Authentication and Password as Authentication method). |
Token Vault / Domain |
Domain of the user connecting to Token Vault (only available when selecting Use Modern Authentication (OAuth2) as SMTP Server Authentication and Password as Authentication method). |
One-time passcode |
A valid one-time passcode of the domain user connecting to Token Vault, which was generated by Token Vault or an authenticator app set up on the Token Vault UI (only available when selecting Use Modern Authentication (OAuth2) as SMTP Server Authentication and One-time passcode as Authentication method). |
Token Vault / Authorization Provider ID |
Identifier of the Token Vault authorization provider that is associated with this Notification service (only available when selecting Use Modern Authentication (OAuth2) as SMTP Server Authentication). |
E-Mail Address |
All the addresses must be in the SMTP format (admin@company.com). |
From |
Email address from which email messages are sent (originator of the message). |
To |
Email address to which an email is delivered (recipient of the message). Semicolons are used to separate addresses. |
Cc |
Email address to which an email is delivered (carbon copied recipient of the message). Semicolons are used to separate addresses. |
Send to Session Logon user |
Select the Yes check box to send a notification email to a Session Logon user or clear the check box if you do not want to send it. |
Message |
Specifies the settings for the components of a message. |
Subject |
Specifies the subject that appears in the email. |
Header |
Specifies the header to include in the email error message, which is appended to the top of the message. Press Ctrl+Enter to start a new line. |
Body |
Specifies the custom text that is included in the email error message, which is appended to the body of the message. Press Ctrl+Enter to start a new line. |
Footer |
Specifies the text that is included in the email error message appended to the bottom of the message. Press Ctrl+Enter to start a new line. |
Message Type |
The following SMTP message types are available:
|
Enable for all Connector Profiles settings
You can enable the Notification service for all your configured connector profiles.
Setting |
Description |
---|---|
Enabled |
Select the Yes check box to enable the service for all Connector profiles. Clear the check box to disable the service for all Connector profiles. |
Notification level |
The following notification levels are available:
|
Enable for all Devices settings
You can enable the Notification service for all devices controlled by your ShareScan Manager.
Setting |
Description |
---|---|
Enabled |
Select the Yes check box to enable the service for all devices. Clear the check box to disable the service for all devices. |
Enable for licensing notification
You can enable the service for license-related purposes.
Setting |
Description |
---|---|
Enabled |
Select the Yes check box to enable notification for licensing issues. |
Enable for watcher licensing notification
You can enable the service for watcher license-related purposes.
Setting |
Description |
---|---|
Enabled |
Select the Yes check box to enable notification for watcher licensing issues. |
To |
Specifies an email address to which a notification email is delivered. Use semicolons to separate addresses. |
Send notification at these page usage percentages |
Separate the percentage values with semicolon. |
When you click the Test button, and the Notification service is correctly configured, a test message appears. If the configuration includes an invalid email server or addresses, an error is not generated or reported.
To ensure that the service works correctly, send a test message and make sure that it is sent with the correct information. At runtime, the ShareScan Manager uses the information to trigger an email notification based on the notification level.