Source:How to Configure Mail Notification-Jaglion/en: Difference between revisions

From SEPsesam
(Importing a new version from external source)
(Updating to match new version of source page)
(11 intermediate revisions by the same user not shown)
Line 1: Line 1:
<div class="noprint"><languages />
<noinclude><div class="noprint"><languages />
{{Copyright SEP AG en}}
{{Copyright SEP AG en}}
{{Navigation_latest|release=[[Special:MyLanguage/SEP_sesam_Release_Versions|4.4.3/4.4.3 ''Grolar'']]|link=[[Special:MyLanguage/SEP_sesam_Documentation#previous|documentation archive]]}}</div><br />
{{Navigation_latest|release=[[Special:MyLanguage/SEP_sesam_Release_Versions|4.4.3/4.4.3 ''Beefalo V2'']]|link=[[Special:MyLanguage/SEP_sesam_Documentation#previous|documentation archive]]}}</div><br />
==Overview==
===Overview===
<div class="boilerplate metadata" id="Additional resources" style="background-color:#ecedf1; color:#8695a7; border: 1px ridge #cdd3db; margin: 0.5em; padding: 0.5em; float: right; width: 25%; "><center><b>Additional resources</b></center>
<div class="boilerplate metadata" id="Additional resources" style="background-color:#ecedf1; color:#8695a7; border: 1px ridge #cdd3db; margin: 0.5em; padding: 0.5em; float: right; width: 25%; "><center><b>Additional resources</b></center>


{|style="margin: auto; margin-bottom:1em; width:100%; border:0px solid grey;"
{|style="margin: auto; margin-bottom:1em; width:100%; border:0px solid grey;"
| rowspan="2" style="padding:0px 10px 0px;" | [[File:SEP Tip.png|45px|link=Special:MyLanguage/Configuration_4.4#mail|Email settings and interfaces]]
| rowspan="2" style="padding:0px 10px 0px;" | [[File:SEP Tip.png|45px|link=Special:MyLanguage/4_4_3_Beefalo:Configuration#mail|Email settings and interfaces]]
| style="padding:0px 40px 0px 10px; color: grey; font-size: 90%; text-align:left;" | See also: [[Special:MyLanguage/Configuration_4.4#mail|Email settings and interfaces]] – [[Special:MyLanguage/SEP_sesam_Server_Disaster_Recovery|Disaster interface]]
| style="padding:0px 40px 0px 10px; color: grey; font-size: 90%; text-align:left;" | See also: [[Special:MyLanguage/4_4_3_Beefalo:Configuration#mail|Email settings and interfaces]] – [[Special:MyLanguage/SEP_sesam_Server_Disaster_Recovery|Disaster interface]]
|}
|}


Line 14: Line 14:
[[File:SEP Tip.png|45px|link=Special:MyLanguage/FAQ|FAQ]]
[[File:SEP Tip.png|45px|link=Special:MyLanguage/FAQ|FAQ]]
| style="padding:0px 40px 0px 10px; color: grey; font-size: 90%; text-align:left;" |
| style="padding:0px 40px 0px 10px; color: grey; font-size: 90%; text-align:left;" |
Check [[Special:MyLanguage/FAQ#encryption_and_compression|FAQ]] to find the answers to most common questions.
Check [[Special:MyLanguage/FAQ|FAQ]] to find the answers to most common questions.
|}
|}


Line 20: Line 20:
| rowspan="2" style="padding:0px 10px 0px;" | [[File:SEP Troubleshooting.png|45px|link=Special:MyLanguage/Troubleshooting_Guide|Troubleshooting Guide]]
| rowspan="2" style="padding:0px 10px 0px;" | [[File:SEP Troubleshooting.png|45px|link=Special:MyLanguage/Troubleshooting_Guide|Troubleshooting Guide]]
| style="padding:0px 40px 0px 10px; color: grey; font-size: 90%; text-align:left;" | Problems? Check the [[Special:MyLanguage/Troubleshooting_Guide| Troubleshooting Guide]].
| style="padding:0px 40px 0px 10px; color: grey; font-size: 90%; text-align:left;" | Problems? Check the [[Special:MyLanguage/Troubleshooting_Guide| Troubleshooting Guide]].
|}</div>
|}</div></noinclude>
SEP sesam email notification is based on [[Special:MyLanguage/SEP_sesam_Glossary#interfaces|''interface'']] scripts that has 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 has 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}}.  


Line 27: Line 27:
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.
*<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>: This interface 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. sm_disaster is always called after the task ''SESAM_BACKUP'' is finished.
*<tt>'''sm_disaster'''</tt>: This interface 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. sm_disaster 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:Configuration_interfaces.png|link=]]
[[Image:Configuration_interfaces_Beefalo_V2.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:Alarm_interface.png|link=]]
[[Image:Alarm_interface_Beefalo_V2.jpg|link=]]
<br clear=all>   
<br clear=all>   
</ol>
</ol>
Upon saving the template script is read and copied to the {{path|<SESAM_ROOT>/bin/sesam}}. Now you have to configure an [[Special:MyLanguage/How_to_configure_Mail_Notification#email|email account]] to enable sending the selected notifications by email.
Upon saving 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}}.
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.


By default, the interfaces are located in the SEP sesam {{path|<SESAM_ROOT>/skel/templates}} under the names:
By default, the interfaces are located in the SEP sesam {{path|<SESAM_ROOT>/skel/templates}} under the names:
Line 60: Line 60:
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''' -> '''E-mail Settings''', select '''Use Sesam mail program''' option and click '''New'''.</li>
<ol><li>From '''Configuration''' -> '''Email Settings''', select '''Use SEP sesam mail program''' option and click '''New'''.</li>
[[Image:Email_account.png|link=]]
[[Image:Email_account_Beefalo_V2.jpg|link=]]
<br clear=all>
<br clear=all>
<li>The ''E-mail Account'' window opens. Use the account name ''sesam'' (the default email account) as shown in the example below, and enter the emails of the recipients. For details, see [[Special:MyLanguage/Configuration_4.4#mail|Email settings]].</li>
<li>The ''Email Account'' window opens. Use the account name '''sesam''' (the default email account) as shown in the example below, and enter the email addresses of the recipients. For details, see [[Special:MyLanguage/4_4_3_Beefalo:Configuration#mail|Email settings]].</li>
[[Image:Configuring_email_account.png|link=]]
[[Image:Configuring_email_account_Beefalo_V2.jpg|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">
==See also==
===See also===
[[Special:MyLanguage/Configuration_4.4#mail|Email settings and interfaces]] – [[Special:MyLanguage/SEP_sesam_Server_Disaster_Recovery|Disaster interface]]</div>
[[Special:MyLanguage/4_4_3_Beefalo:Configuration#mail|Email settings and interfaces]] – [[Special:MyLanguage/SEP_sesam_Server_Disaster_Recovery|Disaster interface]]</div></noinclude>

Revision as of 09:32, 12 August 2020

Other languages:

Template:Copyright SEP AG en

Docs latest icon.png Welcome to the latest SEP sesam documentation version 4.4.3/4.4.3 Beefalo V2. For previous documentation version(s), check documentation archive.


Overview

SEP sesam email notification is based on interface scripts that has 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.

SEP sesam interfaces require a configured email account that is used for sending the selected notifications by email.

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: This interface 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

  1. From Configuration -> Interfaces, select the relevant interface type (Alarm, Disaster or Notify), depending on which information you want to receive.
  2. Information sign.png 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.

    Configuration interfaces Beefalo V2.jpg

  3. Window with the interface script opens. Click Save to activate the interface.
  4. Alarm interface Beefalo V2.jpg

Upon saving 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.

Information sign.png 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.

Now you have to configure an email account to enable sending the selected notifications by email.

Configuring email account and recipients

  1. From Configuration -> Email Settings, select Use SEP sesam mail program option and click New.
  2. Email account Beefalo V2.jpg
  3. The Email Account window opens. Use the account name sesam (the default email account) as shown in the example below, and enter the email addresses of the recipients. For details, see Email settings.
  4. Configuring email account Beefalo V2.jpg
  5. Click Send Test Email to check if your email account is configured properly, and then click OK.