Email Actions
One of the capabilities provided by the default function provider is the ability to initiate emails from the DataSplice Server in response to an event. After the email server has been defined correctly in the default function provider section, the email actions are available as call plug-in function actions in the event chain settings section. This area is where the parameters of the email action are defined.
Defining the Parameters and Details of an Email Action
- Select the view of interest.
- Select
Event Chain Settingsfrom the Configuration Section drop-down. - From the Select Chain drop-down, choose the type of event this action will be associated with, such as Insert or Update.
- Click in the section corresponding to the type of action that is desired. For example, if the email action should be initiated in the event of an error, click in the Error Action section to give it focus. Otherwise, click in the Basic Actions section to give it focus.
- Click the Create New Action button
. - In the resulting Create New Event Action dialog box, select
Call Plug-in Function.
- Select
Call Plug-in Functionfrom the list of basic actions to display the associated details. - Define the Event Details fields appropriately.
Option Name Description Provider Select Default Functions Plug-in.Function Group Select Email.Function Name Select Send Emailif the email message body will be composed directly within the function parameters to follow. SelectSend Email from Templateif the email message body will be defined in a separate template file.Action Condition A Boolean expression that, when evaluated to trueorblank, will perform the defined barcode printing action. Leave this blank or set totrueto force this email action to always execute in this event chain. This can be set to a condition if the email action should only be executed if certain criteria are met.Continue on Failure Checkbox to specify if the action should continue processing if an error occurs during its execution. Action Description Free form field that allows administrators to keep notes describing this action.
- Define the Parameter Bindings appropriately. This section contains the parameters that are passed to the barcode printing plug-in function.
Parameter Name Description Server Name The name of the email server, as specified in the default function provider section. Recipient The email address of the recipient of this message. This can be a literal value, such as admin@companyname.comor an attribute that has been previously populated, such as${ADMIN_EMAIL_ADDRESS}.Sender The email address of the recipient of this message. This can be a literal value, such as fstanley@companyname.comor an attribute that has been previously populated, such as${DS_USER_EMAIL_ADDRESS}.Subject The subject of the email message. This can be a literal value, such as Erroror a combination of literal characters and dynamic values, such asError in ${DS_VIEW} view.Message Body The contents of the email message. This can be literal text, such as An error occurred, or a combination of literal text and dynamic values, such asUser ${DS_USER} encountered an error in the ${DS_VIEW} view. The exact error message was: %e.The percent character,
%, is used as an escape character to allow for dynamic information to be passed into the body of the email message. The available values are as follows:- %a - Inserts a table with the current attributes and their corresponding values.
- %e - Inserts all relevant information about the error message, if an error occurred.
- %r - Inserts information for the current record, if available.
- %u - Inserts information about the current client connection, such as user name, domain, and IP address.
- %% - Inserts a single percent character.
- Click the Save Changes button
.
Last modified 2006-06-01 04:22 PM