Notifications, both system-generated in the Action List and those sent by the KC system via E-Mail, are created, customized and maintained using the Notification maintenance document.
• Dynamic Content Parameters: Content can include dynamically-updated record-specific details in both the subject and body by the configuration of various parameters using curly brackets to enclose uppercased, underscore-separated parameters.
• Recipient Role and Type Definition: Recipients can be specified by role, and carbon copy can be selected for receipt type for each added role.
The Notification (a.k.a. Notifications ) maintenance document is used to establish and maintain numeric codes and textual description values which are stored in database tables. This data serves as reference information that is made available for display and selection in various areas of the system, including e-docs and other maintenance e-docs. These are used to specify notification events and static content for dynamic use for specific e-docs. Information such as message content and recipient role is maintained here. Although the UI labels indicate plural notifications, one maintenance document is used to maintain one record in the table – in other words, a Notification maintenance document is used to maintain a single notification message.
|
Related Maintenance Document: The content maintained in this maintenance document can then be utilized by various modules and roles in the KC system. The related maintenance document is called Notification Module (or Notification Module Roles, depending on the UI element label). For more information, see “Notification Module” on page 832 in Maintenance > Shared. |
Figure 1050 Notifications Maintenance Document - Layout
The Edit Notifications section of the Notifications maintenance document is a unique section that allows you to specify and maintain the details associated with the reference table record in fields. The following table describes usage of each field.
Table 519 Notifications Maintenance Document > Edit Notifications Section - Field Descriptions
Field |
Description |
Notification Id |
This is a unique numeric value that is automatically assigned by the KC system upon creation of a new Notification maintenance document record. |
Module Code |
Required. Select the applicable functional module
from the list. |
Action Code |
Required. A numeric value that indicates the type of notification action that is to be associated with this notification record. This is the “notify when” action that prompts a programmed notification. |
Description |
Required. This is what the action that needs
notifications sent is commonly referred to as. Enter a textual name
of the notification type as it is to be commonly referred (for example,
Withdraw Event).
Click within the text box (or press the tab |
Subject |
Specify the content of the e-mail subject line field using text, markup, and/or defined data replacement parameters (a bracketed variable to display the unique document number (ID) to establish the subject line of messages sent to both the Action List and E-Mail inbox of end user recipients. |
Message |
This is the body of the notification. Type or paste code and text to specify the message content and look. Also accepted are variables (parameters for inclusion of dynamic content) enclosed within brackets using uppercased letters and underscores, and standard HTML tag formatting for links, line breaks, etc. For example: Click the expand text |
Prompt User |
Select if you want to be prompted by the KC system
before sending the notification to the user (recipient) when the
notification is set to be generated and sent. Click within the checkbox |
System Generated |
Select if you want this notification to be generated
automatically by the KC system. Click within the checkbox |
Active |
Check to indicate this record is on and currently
being used in the system. Uncheck to disable current availability
for system use – which still makes this record available for future
activation. Click within the checkbox |
The Edit Notification Recipients section of the Notifications maintenance document is a unique section that allows you to specify and maintain the details associated with the reference table record in fields. This is the section to use when you want to establish new or maintain existing recipients by role. Information about selection, entry, acceptable input, and usage functionality for each field is described in the table that follows.
Table 520 Notifications Maintenance Document - Edit Notification Recipients Section Field Descriptions
Field |
Description |
Role |
Required. Select the desired option from the
pre-populated list to specify a new notification recipient role. Use
the drop-down |
To or CC |
Required. Select either one of the two available
options for the type of notification delivery. CC is short for Carbon
Copy. Use the drop-down |
add/delete buttons |
After you’ve made your selections in the preceding two
required fields, click the add |
Figure 1051 Notifications Maintenance Document Example Values
This maintenance document includes the following features that are common to most KC maintenance documents:
Table 521 Links to Common Maintenance Document Component Instructions
Common Maintenance E-Doc Component |
Cross-Reference Links To Usage Instructions |
Document Header |
|
Document Overview Section |
|
Notes and Attachments Section |
|
Ad Hoc Recipients Section |
|
Route Log Section |
|
Action Buttons |
|
|
For information about searching for, initiating, editing, copying, submitting, saving, closing, canceling, and/or routing a maintenance document, see “Common Maintenance E-Doc Operations” in the Overview section. |
The Configuration Parameters differ by functional module. Some have default data, some vary by notification type, some require customization of the message body content for use.
|