--- alias: user-guide-create-notification tags: - notifications description: "Create notifications by defining details, assigning recipients, and setting visibility filters for timely alerts" --- # Create Notification :lock: Notification.**Create** :lock: Notification.**CreateTemplate** :lock: Notification.**CreateFromTemplate** ## Overview This **Business Data** entity is used to create a **Notification**. You can also create a template using a similar procedure and use a template to create a new object. This selection is done in the main entity menu. ## Setup No specific setup is required other than to meet the preconditions of the transaction. ## Preconditions * The **notifications** module is properly licensed in the system. ## Sequence of Steps ### Step 1: Create Notification 1. Enter the notification **Name**. This field can be left empty if there is a **Name Generator** configured to provide unique names automatically. 2. Select the notification **Type**. The list of possible values is taken from the lookup table **Notification Type**. 3. Enter a **Title**. It is possible to add hyperlinks to objects using the following syntax: * Unversioned entities: * `[Entity Type Entity Name]`. For example, the title: **Material [Material Lot1] was put on hold for reason [Reason Reason1]** will create two hyperlinks - one for **Material** Lot1 and another for **Reason** Reason1. * Versioned entities: * `[Entity Type Revision Name]`. For example, the title **[ProductRevision Product1 [B]]** will create a hyperlink to **Product** Product1 **Revision B** with the **Default** version. * `[Entity Type Revision and Version Name]`. For example, the title **[ProductRevision Product1 [C.2]]** will create a hyperlink to **Product** Product1 **Revision C** with version **2**. !!! note For more information, see [Revisions](../../general/revisions/index.md). 4. Optionally, enter the details using the **Rich Text** editor. !!! note In the **Details** field you can also use the same syntax structure as above to create other/additional hyperlinks. 5. Select the severity of the **Notification**. The severity is taken from the lookup table *NotificationSeverity*. The generic table *NotificationSeverity* configures the behavior for the different **Notification** severities defining the colors and display mode of the **Notification**. 6. Select the type of assignment: * **Everyone** - for every Employee * **Employee** - for a particular Employee * **Role** - for a particular Role 7. Specify whether an email should be sent to the assigned party. 8. Optionally, specify a distribution list that will receive an email notification. 9. Optionally, define the type of visibility filter to be applied: None, Area, Facility, Resource, Step. Visibility filters can be used to filter the **Notifications** to be displayed in the **Notifications** window according to the user's Employee Workgroup. All the **Notifications** for an Employee regardless of their visibility, will be accessible in the *My Notifications* page. 10. Optionally, define additional context for the **Notification**, which can also be used for visibility filtering. Some contexts are mandatory, based on the defined visibility: * **Facility** * **Area** * **Resource** * **Step** * **Material** 11. Define the Clearance mode: * *ManualEveryUser* - every user must clear it. * *ManualSingleUser* - the first user will clear it for everyone. * *Automatic* - the notification will be cleared by the system when the Valid To date/time is reached. 12. In *Valid To* define the date up to which the clearance is valid. This field is mandatory for ManualEveryUSer and Automatic, but optional for ManualSingleUSer. 13. Select **Create** to complete the operation. ![create_notification][create_notification] !!! info Depending on the Future Actions configuration, the **Material** may be put on hold. !!! note Specific configuration entries must be filled so that the **Notification** can be delivered properly via email. To configure this feature, start by editing the following configuration options for `/Cmf/System/Configuration/Mail` (values listed as an example): | Configuration Path |Value| |-----|-----| | LocalSupport | `Local Support Team` | | Credentials/UserName | `username@outlook.com` | | Credentials/UserPassword | `********` | | EnableSSL | `true` | | From | `username@outlook.com` | | Port | `25` | | SMTP | `smtp-mail.outlook.com` | Table: Configurations for Email Notifications !!! info More information can be seen in the [Configuration](../../administration/configuration.md) section of the user guide. Create the Notification as explained above. ![create_notification_email_example_step_one][create_notification_email_example_step_one] When the notification is sent, an email will be received in the configured address. ![create_notification_email_example_step_two][create_notification_email_example_step_two] [create_notification]: images/create_notification.png [create_notification_email_example_step_one]: images/create_notification_email_example_step_one.png [create_notification_email_example_step_two]: images/create_notification_email_example_step_two.png