Source:How to Configure Mail Notification-Jaglion/en: Difference between revisions
(Updating to match new version of source page) |
m (FuzzyBot moved page Source:How to Configure Mail Notification/en to Source:How to Configure Mail Notification-Jaglion/en without leaving a redirect: Part of translatable page "Source:How to Configure Mail Notification") |
||
(11 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
< | <noinclude><languages /> | ||
==Overview== | ==Overview== | ||
</noinclude>SEP sesam offers two ways to send emails from the application: using the built-in email interface or a local email client. With integrated email interface you can send emails directly from the interface. To use the integrated email interface, [[#email|create an account]] with your mailbox credentials. | |||
In addition, you can configure to receive various email notifications from SEP sesam. SEP sesam provides email notification system, which uses a configured <tt>sesam</tt> mail account to connect to the mail server and send automated mail notifications from the configured mailbox. | |||
SEP sesam email notification system is based on [[Special:MyLanguage/SEP_sesam_Glossary#interfaces|''interface'']] scripts that have to be activated first. You can activate them via [[Special:MyLanguage/How_to_configure_Mail_Notification#interfaces|GUI]] or manually by [[Special:MyLanguage/How_to_configure_Mail_Notification#copy|copying]] the templates that are available in the SEP sesam directory {{path|<SESAM_ROOT>/skel/templates}}. | |||
SEP sesam email notification is based on [[Special:MyLanguage/SEP_sesam_Glossary#interfaces|''interface'']] scripts that | |||
The following ''interfaces'' exist: | The following ''interfaces'' exist: | ||
*<tt>'''sm_notify'''</tt>: ''Notify'' is executed on the SEP sesam Server. It can be used for reporting on successfully finished events, such as backup, restore, migration, media initialization, and start/finish of a NEWDAY event. | *<tt>'''sm_notify'''</tt>: ''Notify'' is executed on the SEP sesam Server. It can be used for reporting on successfully finished events, such as backup, restore, migration, media initialization, and start/finish of a NEWDAY event. | ||
*<tt>'''sm_alarm'''</tt>: ''Alarm'' is executed on the SEP sesam Server to warn the system administrator when a fatal error occurs or in case of a license violation. | *<tt>'''sm_alarm'''</tt>: ''Alarm'' is executed on the SEP sesam Server to warn the system administrator when a fatal error occurs or in case of a license violation. | ||
*<tt>'''sm_disaster'''</tt>: | *<tt>'''sm_disaster'''</tt>: ''Disaster'' must be properly configured to help carry out the disaster recovery process. For details on how to prepare, see [[Special:MyLanguage/SEP_sesam_Server_Disaster_Recovery|SEP sesam Server Disaster Recovery]]. The disaster interface sends an email describing the recovery procedure in the event of a disaster and an attachment containing the SEP sesam bootstrap database with all essential data for the disaster recovery. <tt>sm_disaster</tt> is always called after the task ''SESAM_BACKUP'' is finished. | ||
=={{anchor|interfaces}}Configuring interfaces== | =={{anchor|interfaces}}Configuring interfaces== | ||
The interface templates are located in the SEP sesam directory {{path|<SESAM_ROOT>/skel/templates}}. You can activate them automatically via GUI or manually by copying them. | The interface templates are located in the SEP sesam directory {{path|<SESAM_ROOT>/skel/templates}}. You can activate them automatically via GUI or manually by copying them. | ||
==={{anchor|GUI}}Activating ''interfaces'' via SEP sesam GUI=== | ==={{anchor|GUI}}Activating ''interfaces'' via SEP sesam GUI=== | ||
<ol><li>From '''Configuration''' -> '''Interfaces''', select the relevant interface type (''Alarm'', ''Disaster'' or ''Notify''), depending on which information you want to receive.</li> | <ol><li>From '''Configuration''' -> '''Interfaces''', select the relevant interface type (''Alarm'', ''Disaster'' or ''Notify''), depending on which information you want to receive.</li> | ||
{{note|The ''Disaster'' interface should always be configured to help carry out the disaster recovery process in case of a SEP sesam Server breakdown. This means that you have to configure at least one backup task with the name ''SESAM_BACKUP''. For details, see [[Special:MyLanguage/SEP_sesam_Server_Disaster_Recovery#preparation|SEP sesam Server Disaster Recovery]].}} | {{note|The ''Disaster'' interface should always be configured to help carry out the disaster recovery process in case of a SEP sesam Server breakdown. This means that you have to configure at least one backup task with the name ''SESAM_BACKUP''. For details, see [[Special:MyLanguage/SEP_sesam_Server_Disaster_Recovery#preparation|SEP sesam Server Disaster Recovery]].}} | ||
[[Image: | [[Image:Configuration_interfaces_Apollon.jpg|850px|link=]] | ||
<br clear=all> | <br clear=all> | ||
<li>Window with the ''interface script'' opens. Click '''Save''' to activate the interface.</li> | <li>Window with the ''interface script'' opens. Click '''Save''' to activate the interface.</li> | ||
[[Image: | [[Image:Alarm_interface_Apollon.jpg|500px|link=]] | ||
<br clear=all> | <br clear=all> | ||
</ol> | </ol> | ||
The template script is read and copied to the {{path|<SESAM_ROOT>/bin/sesam}}. You can customize the script according to your needs. Now you have to configure an [[Special:MyLanguage/How_to_configure_Mail_Notification#email|email account]] to enable sending the selected notifications by email. | |||
==={{anchor|copy}}Activating interfaces manually=== | ==={{anchor|copy}}Activating ''interfaces'' manually=== | ||
Alternatively, you can activate the interfaces by copying the existing templates from the SEP sesam directory {{path|<SESAM_ROOT>/skel/templates}} to the directory {{path|<SESAM_ROOT>/bin/sesam}}. You can customize the script according to your needs. | Alternatively, you can activate the interfaces by copying the existing templates from the SEP sesam directory {{path|<SESAM_ROOT>/skel/templates}} to the directory {{path|<SESAM_ROOT>/bin/sesam}}. You can customize the script according to your needs. | ||
Line 57: | Line 40: | ||
Note that on Windows, all interfaces/commands have the ending <tt>.cmd</tt> or <tt>.ps1</tt> when using Powershell. | Note that on Windows, all interfaces/commands have the ending <tt>.cmd</tt> or <tt>.ps1</tt> when using Powershell. | ||
To activate the interfaces, copy the selected interfaces manually to {{path|<SESAM_ROOT>/bin/sesam}}. | To activate the interfaces, copy the selected interfaces manually to {{path|<SESAM_ROOT>/bin/sesam}}. | ||
{{note|The ''Disaster'' interface should always be configured to help | {{note|The ''Disaster'' interface should always be configured to help perform the disaster recovery process in case of a SEP sesam Server breakdown. This means that you have to configure at least one backup task with the name ''SESAM_BACKUP''. For details, see [[Special:MyLanguage/SEP_sesam_Server_Disaster_Recovery#preparation|SEP sesam Server Disaster Recovery]].}} | ||
Now you have to configure an [[Special:MyLanguage/How_to_configure_Mail_Notification#email|email account]] to enable sending the selected notifications by email. | Now you have to configure an [[Special:MyLanguage/How_to_configure_Mail_Notification#email|email account]] to enable sending the selected notifications by email. | ||
=={{anchor|email}}Configuring email account and recipients== | =={{anchor|email}}Configuring email account and recipients== | ||
<ol><li>From '''Configuration''' -> ''' | |||
[[Image: | To send emails from the application, you can use either a local email client or the integrated SEP sesam email interface. To use the integrated email interface create a mail account following the procedure described below. You can also create multiple mail accounts based on your requirements. Each account specifies the sender email and the list of recipients, which can be customized for specific emails. | ||
This procedure describes how to set up a the default <tt>sesam</tt> account that is required by the SEP sesam notifications. You can use a different account name to create a custom account. | |||
<ol><li>From '''Configuration''' -> '''Email Settings''', select '''Use SEP sesam mail program''' option and click '''New'''.</li> | |||
[[Image:Email_account_Apollon.jpg|700px|link=]] | |||
<br clear=all> | <br clear=all> | ||
<li>The '' | <li>The ''Email Account'' window opens. Use the account name '''sesam''' (all lowercase) as shown in the example below, and enter the information as required: | ||
[[Image: | *'''''Account''''': Name of the account (mandatory) | ||
*'''''Customer''''': Name of the customer | |||
*'''''Sender''''': Email address of the sender | |||
*'''''SMTP server''''': Name or IP address of the outgoing mail server | |||
*'''''SMTP user''''': User name for SMTP server | |||
*'''''Password''''': Password for the mail server. Password is mandatory if SMTP server requires authentication. | |||
*'''''SMTP port''''': Optionally, specify the SMTP port. | |||
* '''''Recipient''''': Email address of the recipient | |||
*'''''CC''''': Email address for copy of the email | |||
*'''''BCC''''': Email address for hidden copy of the email | |||
*'''''SSL''''': Optionally, you can select encryption type to connect securely via SSL or TLS. | |||
If no SMTP user name is specified, it is assumed that no authorization is required at the SMTP server.</li> | |||
[[Image:Configuring_email_account_Apollon.jpg|500px|link=]] | |||
<br clear=all> | <br clear=all> | ||
<li>Click '''Send Test Email''' to check if your email account is configured properly, and then click '''OK'''.</li> | <li>Click '''Send Test Email''' to check if your email account is configured properly, and then click '''OK'''.</li> | ||
</ol> | </ol> | ||
<div class="noprint"> | <noinclude><div class="noprint">{{Copyright}}</div></noinclude> | ||
Latest revision as of 11:26, 22 March 2024
Overview
SEP sesam offers two ways to send emails from the application: using the built-in email interface or a local email client. With integrated email interface you can send emails directly from the interface. To use the integrated email interface, create an account with your mailbox credentials.
In addition, you can configure to receive various email notifications from SEP sesam. SEP sesam provides email notification system, which uses a configured sesam mail account to connect to the mail server and send automated mail notifications from the configured mailbox.
SEP sesam email notification system is based on interface scripts that have to be activated first. You can activate them via GUI or manually by copying the templates that are available in the SEP sesam directory <SESAM_ROOT>/skel/templates
.
The following interfaces exist:
- sm_notify: Notify is executed on the SEP sesam Server. It can be used for reporting on successfully finished events, such as backup, restore, migration, media initialization, and start/finish of a NEWDAY event.
- sm_alarm: Alarm is executed on the SEP sesam Server to warn the system administrator when a fatal error occurs or in case of a license violation.
- sm_disaster: Disaster must be properly configured to help carry out the disaster recovery process. For details on how to prepare, see SEP sesam Server Disaster Recovery. The disaster interface sends an email describing the recovery procedure in the event of a disaster and an attachment containing the SEP sesam bootstrap database with all essential data for the disaster recovery. sm_disaster is always called after the task SESAM_BACKUP is finished.
Configuring interfaces
The interface templates are located in the SEP sesam directory <SESAM_ROOT>/skel/templates
. You can activate them automatically via GUI or manually by copying them.
Activating interfaces via SEP sesam GUI
- From Configuration -> Interfaces, select the relevant interface type (Alarm, Disaster or Notify), depending on which information you want to receive.
- Window with the interface script opens. Click Save to activate the interface.
Note | |
The Disaster interface should always be configured to help carry out the disaster recovery process in case of a SEP sesam Server breakdown. This means that you have to configure at least one backup task with the name SESAM_BACKUP. For details, see SEP sesam Server Disaster Recovery. |
The template script is read and copied to the <SESAM_ROOT>/bin/sesam
. You can customize the script according to your needs. Now you have to configure an email account to enable sending the selected notifications by email.
Activating interfaces manually
Alternatively, you can activate the interfaces by copying the existing templates from the SEP sesam directory <SESAM_ROOT>/skel/templates
to the directory <SESAM_ROOT>/bin/sesam
. You can customize the script according to your needs.
By default, the interfaces are located in the SEP sesam <SESAM_ROOT>/skel/templates
under the names:
sm_notify sm_alarm sm_disaster
Note that on Windows, all interfaces/commands have the ending .cmd or .ps1 when using Powershell.
To activate the interfaces, copy the selected interfaces manually to <SESAM_ROOT>/bin/sesam
.
Note | |
The Disaster interface should always be configured to help perform the disaster recovery process in case of a SEP sesam Server breakdown. This means that you have to configure at least one backup task with the name SESAM_BACKUP. For details, see SEP sesam Server Disaster Recovery. |
Now you have to configure an email account to enable sending the selected notifications by email.
Configuring email account and recipients
To send emails from the application, you can use either a local email client or the integrated SEP sesam email interface. To use the integrated email interface create a mail account following the procedure described below. You can also create multiple mail accounts based on your requirements. Each account specifies the sender email and the list of recipients, which can be customized for specific emails.
This procedure describes how to set up a the default sesam account that is required by the SEP sesam notifications. You can use a different account name to create a custom account.
- From Configuration -> Email Settings, select Use SEP sesam mail program option and click New.
- The Email Account window opens. Use the account name sesam (all lowercase) as shown in the example below, and enter the information as required:
- Account: Name of the account (mandatory)
- Customer: Name of the customer
- Sender: Email address of the sender
- SMTP server: Name or IP address of the outgoing mail server
- SMTP user: User name for SMTP server
- Password: Password for the mail server. Password is mandatory if SMTP server requires authentication.
- SMTP port: Optionally, specify the SMTP port.
- Recipient: Email address of the recipient
- CC: Email address for copy of the email
- BCC: Email address for hidden copy of the email
- SSL: Optionally, you can select encryption type to connect securely via SSL or TLS.
- Click Send Test Email to check if your email account is configured properly, and then click OK.