This article describes how to set up a notification channel for alerts and messages that shall be sent by Smart ID Digital Access component to the user. You can specify an sms channel, an email channel, or both.
Prerequisites
- Before setting up sms notification channel, make sure that the correct sms plug-in is available. Read more below in "Available sms plug-ins".
Optional:
If you shall configure a TLS-enabled notification server:
- The certificate of the Certificate Authority must be obtained. This can be done in several different ways and is not covered by these instructions. The certificate should be in PEM format.
Step by step instruction
Log in to Digital Access Admnin
- Log in to Digital Access Admin with an administrator account.
Set up email notification channel
- In Digital Access Admin, go to Manage System.
- Click Notification Settings > E-mail channel.
- Check Enable e-mail channel.
- In the Host input field enter the IP address or DNS name of the server that sends PIN, password and seed to the receiver. Default is localhost.
- In the Port input field enter the port for the server. Default is 25.
- In the Sender's e-mail Address input field enter the email address that sends the notifications, for example, admin@nexustest.com.
Enter UserName and Password for the account with SMTP Server.
- Enter Local Host name used for the EHLO and HELO messages.
- Check the Start TLS option to upgrade the current insecure connection to the SMTP Server to a secure connection This option works only when the SMTP Server support STARTTLS command.
Click Save.
Set up sms notification channel
- In Digital Access Admin, go to Manage System.
- Click Notification Settings > SMS channel.
Here you will see the registered SMS channels in order, that is, they will be tried out from top to bottom. If the first fails the second will be tried and so on. - Click Add SMS Channel...
- Enter Display Name for the SMS channel.
Select a Plug-in from the drop-down list and click Next.
- Enter the configuration parameters for the selected sms channel. For more information, click the ?-sign. To edit a channel, click the corresponding link. To change the order of the channels, click the order links.
- Click Finish.
Use Short URL
When sending out provisioning URLs for Smart ID Mobile App or OATH, the character size of the URL can exceed the sms limit. In such cases, the Digital Access component can create a short URL that redirects to the actual URL automatically. To enable this feature do the following steps:
- In Digital Access Admin, go to Manage System.
- Click Notification Settings > SMS Channel...
- Check Use Short URLs.
- Click Save.
Add sms plug-in
Read more below in "Available sms plug-ins".
- In Digital Access Admin, go to Manage System.
- Click Notification Settings > SMS Plug-ins.
- Select the file with the plug-in and click Upload Plug-in.
- Click Save.
Optional: Configure TLS-enabled notification server
For proper TLS functionality the remote certificate (presented by the Notification server) must be trusted by the Digital Access component. You must add a Certificate Authority (CA).
- Go to Add certificates and follow the instructions under heading "Add certificate authority".
- When finished, click Publish.
For more information, see Configure TLS-enabled notification server in Digital Access.
Available SMS plug-ins
Plug-ins are used for communicating with different SMS vendors. The most common plug-ins are listed below, but you can also add other sms plug-ins, see above under "Add sms plug-in".
SMTP Plugin | Plugin for SMS distribution via the SMTP (mail) protocol. |
HTTP Plugin | Plugin for SMS distribution via the HTTP/S protocol. |
CIMD Plugin | Plugin for SMS distribution via CIMD version 2.0 protocol. |
Netsize Plugin | Plugin for SMS distribution via Netsize Online API. |
SMPP Plugin | Plugin for SMS distribution according to the SMPP protocol version 3.4. |