Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents


Introduction

User Notification is a Plugin Default Properties to automatically send assignees email notification on every new activity tasks. Plugin Default Properties allows you to pre-select and set properties for plugins that you intend to use in your application.

User Notification is implemented at the application level and

...

borderColorgreen
borderWidth1
titleBGColor#ddffcc
borderStylesolid
titleDefinition

...

allows for greater customization of the notification content.

...

 A one-time setup process, this plugin will be called every time a new activity task is created

...

Panel
borderColorpurple
borderWidth1
titleBGColor#ddccff
borderStylesolid
titleNew Feature

This feature is enhanced in Joget Workflow v6 to support placing assignment link with a special hash variable.

Image Removed

. If you use User Notification plugin, you do not need to create the tools for Emails in your process design.


User Notification Properties

Configure User Notification

Image Added

Figure 1: User Notification Properties

NameDescription
CC

Fully qualified address is expected.

Multiple values can be accepted by separating them with semicolons.

Info

CC: lets you send a copy of a message to someone who's interested, but is not the primary recipient.

SubjectGeneric email subject to be used across all newly created assignment.
Email Message

Generic email message to be used across all newly created assignment

.

 

Panel
borderColorpurple
borderWidth1
titleBGColor#ddccff
borderStylesolid
titleNew Feature
This is a new feature in Joget Workflow v6

.

You can use the special hash variable #assignment.link# to anchor the task hyperlink at a specified line in your email message.

By default, the task hyperlink will appear at the bottom of the email message.

HTML Content?
Check if "Email Message" is intended to be a HTML content.
Click checkbox to enable HTML content in email message, especially if you provide the "Link Name" as a hyperlink.

Image AddedImage Removed

Figure 2: User Notification Properties - Notification Link

NameDescription
URL

 URL

Info
titleSample
Include a link that points to a Userview Inbox.
http://localhost:8080/jw/web/userview/leave_request_app/leave_userview//inbox
In addition, you will need to include the extra parameter below in order for the assignment to show up.
http://localhost:8080/jw/web/userview/leave_request_app/leave_userview//inbox?_mode=assignment
Link Name

 Link label

Info
titleSample
Open my assignment

to open the assignment. Click the "HTML Content" checkbox to enable HTML content in email message if you provide the "Link Name" as a hyperlink.

Parameter Name
Activity Instance ID will be passed to this parameter.
 


Info
titleSample

If you are pointing to an Inbox element in URL attribute above, then you should set this to:-

activityId

Parameter Passover Method
  • None
  •  As URL Request Parameter
  • Append to URL
 


Info
titleSample

If you are pointing to an Inbox element in URL attribute above, then you should set this to:-

As URL Request Parameter

SMTP Settings

Image AddedImage Removed

Figure 3: User Notification Properties - SMTP Settings

NameDescription
Base URLSpecify the server context path.
From

Sender email address to send email to the assignee and/or CC.

Info
titleExample

no-reply@your-company-name.com

SMTP Host

Email Server SMTP Host

Info
titleExample

smtp.gmail.com

SMTP Port

Email Server SMTP Port

Info

Typically, port 465 for SSL security option and 587 for TLS

Security
  • None
  • TLS
  • SSL
SMTP Username

Email Server Account Username

Info

On Google email account, use your full email address.

SMTP Password

Email Server Account Password

Info

Password submitted will be encrypted for security reason.

...

Web Push Settings

Image Added


NameDescription

Disable Web Push Notifications

Click the checkbox to disable mobile web notification.

Attachments

If the form you used for the workflow process contains an image or file attachment, you can configure these properties to include the attachments in the email.

Image Added

NameDescription

Form

Select the Form containing the file or image attachment.
Form Upload FieldsSelect the field ids containing the file or image attachments. You can add more than one attachment field.
FilesConfigure here if you want to attach specific files file the Joget server, via "system path" or "URL".

Advanced

Image Modified

Figure 4: User Notification Properties - Advanced

NameDescription
 Activity ExclusionInclude activity that you do not wish to notify its assignee.

Related: Video Tutorial on User Notification based on Joget Workflow v3

Widget Connector
width640
urlhttp://www.youtube.com/watch?v=V7iclW1EhoQ
height360

Note: This tutorial video is also applicable to Joget Workflow v6.

 

 


Download Demo App

...