NotificationAspect

Sends a notification email to one or several users.

Examples

The following example sends a notification email based on the template Notification_Directory_Guest.cshtml and the subject computed by SubjectExpression_L1, which both use data from Workflow_Directory_Guest:Directory_Guest, and on the styles from Notification_Directory_Guest.css.

<NotificationAspect Identifier="Notification_Directory_Guest" ExpressionBinding="Workflow_Directory_Guest:Directory_Guest" RazorFile_L1="./Templates/Notification_Directory_Guest.cshtml" CssFile="./Templates/Notification_Directory_Guest.css" SubjectExpression_L1="C#:guest:return &quot;Validating data for guest: &quot; + guest.FirstName + guest.LastName;">
    <PointCut Activity="Directory_Guest_AdvancedStart:Request" ActivityState="ActionWithRefine-Executed" Mode="After" />    <Recipient Type="Binding" Binding="Directory_Guest:Mail" /></NotificationAspect>

The notification will be sent after the Request activity of the Directory_Guest_AdvancedStart workflow is executed. See pointcuts for more details.

The notification will be sent to all email addresses defined by Directory_Guest:Mail. See recipients for more details.

Properties

Property	Details
Identifier required	Type String Description Unique identifier of the aspect.
Binding optional	Type String Description Binding whose difference with ExpressionBinding defines the property that corresponds to identities' email addresses, when Type is set to Binding.
CssFile optional	Type String Description Path to the css file that defines the styles for the email. Note: the path must be relative to the configuration folder, and the file must be inside it.
ExpressionBinding optional	Type String Description Binding: - that defines the variable type used in the potential expressions specified in the aspect; - whose difference with Binding defines the property involved in the aspect. Note: required when handling the property of multi-valued objects, for example records, to make sure to modify the property in all records and not only in one.
Priority default value: 0	Type Int32 Description Execution priority among all aspects. At a given activity state, the aspect with the highest priority will be triggered first. Note: the priority can be a negative value.
RazorFile_L1 optional	Type String Description Path to the Razor cshtml file that defines the email's body template in language 1 (up to 16). Note: the path must be relative to the configuration folder, and the file must be inside it.
SubjectExpression_L1 optional	Type String Description C# expression that defines the email's subject in language 1 (up to 16). The expression's variable type is defined in ExpressionBinding.

Child Element: PointCut

A pointcut is a mechanism telling Usercube when to execute the linked aspect.

The position of the pointcut is specified by an activity state and a mode (before or after).

Property	Details
Activity required	Type Int64 Description Identifier of the activity whose specified state triggers the aspect.
ActivityState required	Type Enumeration Description Identifier of the activity state that triggers the aspect.
Mode default value: 0	Type PointCutMode Description Mode defining when exactly the aspect is triggered around the specified workflow's activity state. 0 - Before: the aspect will be executed on entry to the specified activity state, regardless of the transition used. 1 - After: the aspect will be executed on exit from the specified activity state, regardless of the transition used.

Child Element: Recipient

A recipient defines one or several identities who will receive a notification from NotificationAspect.

Examples

The following example sends a notification email to the actors of the next step of the workflow.

<NotificationAspect Identifier="Notification_Directory_User" ExpressionBinding="Workflow_Directory_User:Directory_User" RazorFile_L1="Template/Notification_Directory_User.cshtml" CssFile="Template/Notification_Directory_User.css">  <PointCut Activity="Directory_User_StartInternal:Request" ActivityState="ActionWithRefine-Executed" Mode="After" />
  <Recipient Type="Actor" />
</NotificationAspect>

The following example sends a notification email to the performers of the Request activity of the Directory_User_StartInternal workflow when the state is Executed.

<NotificationAspect Identifier="Notification_Directory_User" ExpressionBinding="Workflow_Directory_User:Directory_User" RazorFile_L1="Template/Notification_Directory_User.cshtml" CssFile="Template/Notification_Directory_User.css">  <PointCut Activity="Directory_User_StartInternal:Request" ActivityState="ActionWithRefine-Executed" Mode="After" />
  <Recipient Type="Performer" Activity="Directory_User_StartInternal:Request" ActivityState="ActionWithRefine-Executed" />
</NotificationAspect>

The following example sends a notification email to the email address, stored in Mail, of the user(s) from Directory_User targeted by the workflow, so here the new user created by the Directory_User_StartInternal workflow.

<NotificationAspect Identifier="Notification_Directory_User" ExpressionBinding="Workflow_Directory_User:Directory_User" RazorFile_L1="Template/Notification_Directory_User.cshtml" CssFile="Template/Notification_Directory_User.css">  <PointCut Activity="Directory_User_StartInternal:Request" ActivityState="ActionWithRefine-Executed" Mode="After" />
  <Recipient Type="Binding" Binding="Directory_User:Mail" />
</NotificationAspect>

The following example sends a notification email to all identities whose email addresses are defined as {lastName}@company.com.

<NotificationAspect Identifier="Notification_Directory_User" ExpressionBinding="Workflow_Directory_User:Directory_User" RazorFile_L1="Template/Notification_Directory_User.cshtml" CssFile="Template/Notification_Directory_User.css">  <PointCut Activity="Directory_User_StartInternal:Request" ActivityState="ActionWithRefine-Executed" Mode="After" />
  <Recipient Type="Expression" Expression="C#:user:return user.LastName+"@company.com";" />
</NotificationAspect>

The following example sends a notification to all identities with a profile that includes the right permission.

<NotificationAspect Identifier="Directory_User_New" ExpressionBinding="Workflow_Directory_User:Directory_User" RazorFile_L1="Directory/User/Directory-User-Notification-New.cshtml" CssFile="Notifications.css">  <PointCut Activity="Directory_User_NewInternal:Persist" ActivityState="Persist-Invoked" Mode="After" />  <PointCut Activity="Directory_User_NewExternal:Persist" ActivityState="Persist-Invoked" Mode="After" />
  <Recipient Type="Profile" />
</NotificationAspect>

Knowing that we also have:
<Profile Identifier="Workforce/Notifications/Directory_User_New" DisplayName_L1="Workforce/Notifications/New User" IsComponent="true" /><AccessControlRule Profile="Workforce/Notifications/Directory_User_New" EntityType="Directory_User" Identifier="Composite_Notifications_Directory_User_New*" DisplayName_L1="Composite_Notifications_Directory_User_New*">
  <Entry Permission="/Custom/WorkflowsNotifications/Directory_User_NewInternal/Persist/Invoked" />  <Entry Permission="/Custom/WorkflowsNotifications/Directory_User_NewExternal/Persist/Invoked" />
</AccessControlRule>

Property	Details
Activity optional	Type Int64 Description Identifier of the activity whose last performers are to be notified, when Type is set to Performer. Note: must be set together with ActivityState.
ActivityState optional	Type Enumeration Description Identifier of the activity state whose last performers are to be notified, when Type is set to Performer. Note: must be set together with Activity.
Binding optional	Type Int64 Description Binding of the property that represents the notification's recipients, when Type is set to Binding.
EmailAddresses optional	Type String Description Email addresses of the notification's recipients, when Type is set to Hardcoded.
Expression optional	Type String Description C# expression that returns the email addresses of the notification's recipients, as strings or IEnumerable<string>, when Type is set to Expression. The expression's variable type is defined in ExpressionBinding in the associated NotificationAspect. See more details on C# expressions.
IsCC default value: false	Type Boolean Description true to send the notification email to the recipient(s) as a carbon copy (CC).
Type required	Type RecipientType Description Type of recipients for the email notification. Actor: the identities with the permissions to act on the next step of the workflow specified in the pointcut. Performer: the actors of a past workflow step specified in Activity and ActivityState. Binding: the identities whose email addresses are designated by the property specified in Binding. Hardcoded: the identities whose email addresses are specified explicitly in EmailAddresses. Expression: the identities whose email addresses match the C# expression specified in Expression. Profile: the identities with the permission /Custom/WorkflowsNotifications/{workflow_identifier}/ {activity_identifier}/{activityTemplateState_shortIdentifier}.