Differences

This shows you the differences between two versions of the page.

--- docs:2500_config_apps:1200_add_edit_notifications [2022/08/18 12:28] – removed - external edit (Unknown date) 127.0.0.1
+++ docs:2500_config_apps:1200_add_edit_notifications [2022/09/13 18:15] (current) – external edit 127.0.0.1
@@ Line 1: / Line 1: @@
+[<10>]
+====== Adding/Editing Notifications ======
+The following section describes how to work with the editor of notifications when adding a new notification or editing an existing one. Notifications are described in the [[docs:2000_concepts:0900_prod_feats:0300_comm_with_other_systems|Communication with Other Systems]] section.
+The editor of notifications can be started as described in the [[docs:2500_config_apps:0300_work_config_elements|Working with Configuration Elements]] section. The following properties should be specified:
+===== Name =====
+Specify the name of the notification uniquely identifying it within the business space version. The following restrictions apply:
+  - The name must start with a character (not digit) or underscore symbol. All other symbols in the name must be either characters (including underscore symbol) or digits. No spaces or special symbols are allowed.
+  - The name must be unique among the names of other business objects, business object groups and notifications.
+  - The name cannot start with one of the instance prefixes – ''This'', ''That'', ''Added'', ''Removed'', ''LoggedIn'' or ''Changed''.
+  - The name cannot be one of the reserved names – ''File'', ''Day'', ''Question'', ''EmailSender'', ''ReceivedEmail'', ''IncomingEmail''.
+  - The name cannot be the name of the basic attribute types – Number, Date, ''Duration'', ''Timestamp'', ''Shortcut'', ''Document'' or ''Picture''.
+===== Attributes =====
+Any notification must have at least one attribute defined. Attributes are defined and displayed in the Attributes table of the Attributes tab.
+  - To add a new attribute, click on the {{docs:icons:icon_add.png?nolink&15|}} icon at the top of the Attributes table. See [[docs:2500_config_apps:0700_add_edit_attributes|Adding/Editing Attributes]] for details how to add attributes of the specific types.
+  - To edit/view an existing attribute select the attribute in the table and change its properties in the Selection Properties window. See [[docs:2500_config_apps:0700_add_edit_attributes|Adding/Editing Attributes]] for details how to edit attributes of the specific types.
+  - To delete an existing attribute click on the attribute you want to delete in the Attributes table and click on the {{docs:icons:icon_delete.png?nolink&15|}} icon at the top of the Attributes table
+===== Description =====
+Specify any text that describes what the notification is for, when it is sent etc. Providing a description is not mandatory but is highly recommended. Any description if defined is included into the generated documentation for the business space version – see [[docs:2500_config_apps:3100_gen_doc|Generating Documentation]].