Setting Up Alerts
This topic discusses how to use the Alerts Setup component (EPPAN_ALERTS_SETUP) and Email Options component (EPPAN_EMAIL_OPTNS) .
|
Page Name |
Definition Name |
Usage |
|---|---|---|
|
EPPAN_ALERTS_SETUP |
Define alert options by feature. |
|
|
EPPAN_EMAIL_OPTNS |
Define email alert options. |
|
|
Preview Alerts Email - Header Text |
EPPAN_EMLPREV_SEC2 |
Preview the email alert header text entered on the Define Alerts Email - Header Text page. |
|
Define Alerts Email - Header Text |
EPPAN_EMLTXT_SEC |
Enter default header text that you want to send out in text-based email alerts. |
|
Preview Alerts Email - Footer Text |
EPPAN_EMLPREV_SEC2 |
Preview the email alert footer text entered on the Define Alerts Email - Footer Text page. |
|
Define Alerts Email - Footer Text |
EPPAN_EMLTXT_SEC |
Enter default footer text that you want to send out in text-based email alerts. |
|
Preview Alerts Email - Header HTML |
EPPAN_EMLPREV_SEC |
Preview the email alert header HTML entered on the Define Alerts Email - Header HTML page. |
|
Define Alerts Email - Header HTML |
EPPAN_EMLHTML_SEC |
Enter default header HTML that you want to send out in HTML-based email alerts. |
|
Preview Alerts Email - Footer HTML |
EPPAN_EMLPREV_SEC |
Preview the email alert footer HTML entered on the Define Alerts Email - Footer HTML page. |
|
Define Alerts Email - Footer HTML |
EPPAN_EMLHTML_SEC |
Enter default footer HTML that you want to send out in HTML-based email alerts. |
|
Send Test Email |
EPPAN_EMAIL_TEST |
When you click the Send Text Test Email button, you can send a test email to a desired email address using the default text header and footer definitions. When you click the Send HTML Test Email button, you can send a test email to a desired email address using the default HTML header and footer definitions. |
Use the Alerts Setup page (EPPAN_ALERTS_SETUP) to define alert options by feature.
Navigation:
This example illustrates the fields and controls on the Alerts Setup page. You can find definitions for the fields and controls later on this page.
Field or Control |
Description |
|---|---|
Feature |
Displays the name of the feature for which you are setting up alerts options. |
Active |
Select to enable alerts for the feature. |
Feature Details
Field or Control |
Description |
|---|---|
Type |
Displays the aspect of the feature for which alerts can be configured. |
Description |
Enter a description of the aspect of the feature for which alerts can be configured. This description text appears on the Add Alerts Subscription page and Update Alerts Subscription page within the selected feature. |
Image Type |
Select the type of image source that you want to use to provide the image for the alert subscription. Available values are Catalog and URL. |
Image Object Name |
If you have selected an image type of Catalog, select the image that you want to appear with the description text on the Add Alerts Subscription page and Update Alerts Subscription page within the selected feature. |
URL |
If you have selected an image type of URL, enter the URL to the image that you want to appear with the description text on the Add Alerts Subscription page and Update Alerts Subscription page within the selected feature. |
Use the Define Alerts Email page (EPPAN_EMAIL_OPTNS) to define email alert options.
Navigation:
This example illustrates the fields and controls on the Define Alerts Email page. You can find definitions for the fields and controls later on this page.
You must have an SMTP server set up to send email alerts. When sending test emails using the Define Alerts Email page, the system uses the SMTP server specified in the application server configuration file.
Field or Control |
Description |
|---|---|
Allow HTML Email |
Select to enable the Alerts framework to send HTML-formatted emails depending on each user’s defined alert preferences. Note: This check box has no bearing on the test emails that can be sent from this page. |
Header and Footer Setup
Field or Control |
Description |
|---|---|
Items |
Header Text. Click the Preview button to access the Preview Alerts Email - Header Text page, where you can preview the email alert header text entered on the Define Alerts Email - Header Text page. Click the Edit button to access the Define Alerts Email - Header Text page, where you can enter email alert header text. Footer Text. Click the Preview button to access the Preview Alerts Email - Footer Text page, where you can preview the email alert footer text entered on the Define Alerts Email - Footer Text page. Click the Edit button to access the Define Alerts Email - Footer Text page, where you can enter email alert footer text. Header HTML. Click the Preview button to access the Preview Alerts Email - Header HTML page, where you can preview the email alert header HTML entered on the Define Alerts Email - Header HTML page. Click the Edit button to access the Define Alerts Email - Header HTML page, where you can enter email alert header HTML. Footer HTML. Click the Preview button to access the Preview Alerts Email - Footer HTML page, where you can preview the email alert footer HTML entered on the Define Alerts Email - Footer HTML page. Click the Edit button to access the Define Alerts Email - Footer HTML page, where you can enter email alert footer HTML. |
Field or Control |
Description |
|---|---|
Subject |
Enter the default subject text that you want to send out with email alerts. |
Reply To |
Enter the default reply email address that you want to provide in email alerts. |
Send Text Test Email |
Click to access the Send Test Email page, where you can send a test email using the header and footer text you have defined in the Header and Footer Setup group box. |
Send HTML Test Email |
Click to access the Send Test Email page, where you can send a test email using the header and footer HTML you have defined in the Header and Footer Setup group box. |