Designing User Message Forms

The user message forms are custom dialogs that are presented to users when they are invited to interact with user messages. The dialogs are separate user interface elements that can be accessed via the ${UserMessage_Link} link in user message notification emails.

The user message uses the System_UserMessage_Notification definition in the partition of the user message as the email source. If this definition does not exist, it uses the GLOBAL.System_UserMessage_Notification definition. Note that the source of GLOBAL.System_UserMessage_Notification cannot be edited and contains no link to the form, so you duplicate it and place it in the same partition as your user message.

Tip: When you duplicate GLOBAL.System_UserMessage_Notification, the system automatically removes the System_ prefix from the name; you have to revert this. The user message will only use System_UserMessage_Notification, not UserMessage_Notification.

Prerequisites

  • The Module.Forms license key set to true.
  • Users interacting with user message forms need at least Use privileges on Restricted Scheduler Session Specification, Edit Processes on the user message Process Definition, and the scheduler-business-user role.
  • A link to the form must be available; usually sent in the email.
  • A user message Process Definition

Procedure

Create the Form

  1. Navigate to Definitions > Processes.
  2. Choose Open Form Editor from the context menu of your user message.
  3. Drag a Text control onto the first gray square in the title bar of the form, specify a title.
  4. For each parameter you want the user to see or interact with, you add a control.
  5. Choose Save and Close.

Duplicate the Notification Process Definition

  1. Navigate to Definitions > Processes.
  2. Choose Duplicate from the context menu of the GLOBAL.System_UserMessage_Notification Process Definition.
  3. In the newly opened editor, add the System_ prefix and select another partition; if you have no partition, close the editor and follow the Create a Partition procedure below. Proceed with step 2 of this procedure once the new partition has been created.
  4. In the Source field, add a link to the user message form (${UserMessage_Link}).
  5. Click Save & Close.
  6. Change the partition of the user message definition to the same as the newly created System_UserMessage_Notification definition; you may as well duplicate it.

Create a Partition (Optional)

  1. Navigate to "Security > Partitions".
  2. Choose Create Partition from the context menu.
  3. Specify a Name and optionally a Description.
  4. Click Save & Close.

Example

Link to the Form

You add a link to the user message form to the System_UserMessage_Notification in your partition by specifying the ${UserMessage_Link} in the href attribute.

A Mail definition Source field:

Copy 
dy>Dear ${Subject_Name}<br/>
<br/>
${UserMessage_Operator} ${UserMessage_Action} User Message "${UserMessage_Text}" to ${UserMessage_NewAssignee}. [?if test="parameters.UserMessage_OldAssignee !== null"?] It was previously assigned to ${UserMessage_OldAssignee}.[?endif?]<br/>
User Message Files:<br/>
${UserMessage_FileLinks}<br/>
<br/>
[?=UserMessage.renderHistoryAsHTML(parameters.UserMessage_UniqueId, 'email')?]<br/>
<br/>
This is an automatically generated email. If this email was sent in error please contact the system administrator.<br/>
</body></html>
[Headers]
subject=Notification: ${UserMessage_Text}

In the following Mail definition, Click <a href="${UserMessage_Link}.htm">here</a> to reply.<br /> was inserted into the Source field below:

Copy 
<html><body>Dear ${Subject_Name}<br/>
<br/>
${UserMessage_Operator} ${UserMessage_Action} User Message "${UserMessage_Text}" to ${UserMessage_NewAssignee}. [?if test="parameters.UserMessage_OldAssignee !== null"?] It was previously assigned to ${UserMessage_OldAssignee}.[?endif?]<br/>
User Message Files:<br/>
${UserMessage_FileLinks}<br/>
<br/>
[?=UserMessage.renderHistoryAsHTML(parameters.UserMessage_UniqueId, 'email')?]<br/>
<br/>

Click <a href="${UserMessage_Link}.htm">here</a> to reply.<br />

This is an automatically generated email. If this email was sent in error please contact the system administrator.<br/>
</body></html>
[Headers]
subject=Notification: ${UserMessage_Text}

See Also

usermessage user message