Instructions for adding new field to and existing notification message. |
Legacy ID:KA337334 Instructions for adding new field to and existing notification message.
The instructions provided are for adding a new field to the HPD:Helpdesk form and having the new field displayed in the "Assignee Assignment" notification.
The instructions goes into detail, what must be done to have a new field displayed in the notification. - Update to the exact notification record in the SYS:Notification Message form - Modifications/updates to forms - Modifications/updates to filters - Modification/update to filter guide
I have made notes for filters which a module/application specific. The documentation example uses HELPDESK related notification filters only. To add notification to a different module, you must use the appropriate filters. I have made NOTES as to which filters are application/module specific.
In the last section, I have briefly documented the steps needed if a new notification message is required for an existing module/application. If you are adding new fields to the notification messages, you must follow the instructions on "Adding a new field" at the beginning of the document
This document does not cover creating new notifications for new applications.
Please note, this is a SYS form change. All changes must be documented, and tested thoroughly to ensure that other workflow is not impacted. Any changes to the SYS form, may be overwritten with any new ITSP upgrade and version changes… therefore, the changes must be reapplied.
NOTE: these are not official "HOW TO DOCUMENTATION". From the User Tool, - Go to the SYS:Notification Messages form - Go to the record(s) that you want the field to be display in.
Example: - chose message tag "HPD-INC-AssigneeAssignment" for Assignment notification - added "dave:#dave# to the Email Message Body - you may want to add values in: - Pager Message Alpha - Notification Text - Email Subject Line From the ADMIN tool (forms)
- Go to the HPD:Helpdesk form - Add & place new field to HPD:Helpdesk - Configure field property for new field
From the ADMIN tool (forms)
- Go to the NTE:SYS-Individual NT Control form - Copy new field from HPD:Helpdesk (this way you bring over the new fields attributes) - Place new field in the NTE:SYS-Individual NT Control form in the appropriate section.
Note: ensure that the database ID of the new field is the same as the database ID of the field that was created in HPD:Helpdesk.
From the ADMIN tool (forms)
- go to the NTE:SYS-NT Process Control form - Copy new field from HPD:Helpdesk (this way you bring over the new fields attributes) - Place new field in the NTE:SYS-NT Process Control form in the appropriate section
Note: ensure that the database ID of the new field is the same as the database ID of the field that was created in HPD:Helpdesk.
From the ADMIN tool (forms)
- go to the NTE:SYS-Group NT Control form - Copy new field from HPD:Helpdesk (this way you bring over the new fields attributes) - Place new field in the NTE:SYS-Group NT Control form in the appropriate section.
Note: ensure that the database ID of the new field is the same as the database ID of the field that was created in HPD:Helpdesk.
From the ADMIN tool (filters)
- go to INC:899z-NotificationGenerator-PNPC`! filter - go to the IF ACTION tab - go to the first action (PUSH) - go to the Name field and select the new field you have added in the above forms - go to the Value field and select the new field you have added in the above forms - Press the modify button to save action - Press Save to save filter changes
From the ADMIN tool (filters)
- go to NPC:020S-GetINCData filter - go to the IF ACTION tab - go to the first action (PUSH) - go to the Name field and select the new field you have added in the above forms - go to the Value field and select the new field you have added in the above forms - Press the modify button to save action - Press Save to save filter changes
NOTE: you must select the appropriate "NPC:020S-GetxxxData" filter based on the module/application as the filter set fields from the selected form (xxx=INC)
From the ADMIN tool (filter)
- go to NPC:180S-CreateNTRecord-PNTI filter - go to the IF ACTION tab - go to the first action (PUSH) - go to the Name field and select the new field you have added in the above forms - go to the Value field and select the new field you have added in the above forms - Press the modify button to save action - Press Save to save filter changes
From the ADMIN tool (filter)
- go to NTG:030S-SetFieldsfromNPC filter
note: you may need to generate a change/save to this filter. If the filter are cached in the system, the new field added to the forms above may not affect. Making a change and triggering a save will re-cache the filter. You may wish to skip this step
- go to and select "Custom" in the fields section - press Modify Action button to save set fields action - press SAVE to save filter - go to and enable "Matching IDs" - press Modify Action button to save set fields action - press SAVE to save filter
From the ADMIN tool (filter)
- go to NTG:180M-CreateNTRecord-PNTI`! filter
note: you may need to generate a change/save to this filter. If the filter is cached in the system, the new field added to the forms above may not affect. Making a change and triggering a save will re-cache the filter. You may wish to skip this step.
- go to and select "Custom" in the fields section - press Modify Action button to save set fields action - press SAVE to save filter - go to and enable "Matching IDs" - press Modify Action button to save set fields action - press SAVE to save filter
From the ADMIN tool (filter)
Create a new filter similar to "zNTI:100-TranslateNotificationMessage-INC3" with set fields action to add new field created - Go to "zNTI:102-TranslateNotificationMessage-INC3"
NOTE: you must select a filter associated to the module/application you want to make the changes to. (ie…"zNTI:102-TranslateNotificationMessage-xxx3" xxx = INC for Helpdesk)
Rename filter;
- perform SAVE AS on filter FILE SAVE AS
- new filter created
- Go to the "If Actions" tab of the new filter - delete all actions (inherited from the original filter)… or keep one SET FIELDS as an example
Add new action - z1D Translation Text = REPLACE($z1D Translation Text$, "#new field name#", $new field name$) - Field Name = z1D Translation Text - Value = REPLACE($z1D Translation Text$, "#new field name#", $new field name$)
From the ADMIN tool (Filter Guides)
- go to Filter Guides - go to zNTI:Translate NTMessages filter guide - from the Filter in form, select newly created filter - press the ADD button to add to "FILTERS IN GUIDE"
To Test Changes
- go to the User Tool and submit a change with information in the new field
NOTE: in the example. The new field name is actually… "new field" - on the toolbar go to Incident Functions View Audit Logs notification tab
To view Notification record - press the Details button
Brief overview of creating new notification.
These are examples only.
- you need to create a new filter - select form/table in which this notification will execute from - the RUN IF qualification must be changed/set to have the filter notification run at the appropriate time. - you must create your own notification tag - the notification tag triggers through notification workflow the appropriate message notification to be sent - you must create your own "Notification Message" in SYS:Notification Messages - you must add the notification tag used in the previous filter - you must change the text of the messages - if you are using new variables, you must follow the instructions on adding a new field to a notification message |