--- title: "Setup & Administration" canonical: "https://kb.myframeworks.com.au/space/FRAM/28386126/Setup%20%26%20Administration" format: markdown --- # Overview Event Notifications consists of a background task that constantly checks for new event notifications. When an Event Notification is created (The notifications are created in specific points in the code that we call triggers. Each of these triggers is very specific and is on a task), it stores all of the information requested, then adds the Event Notification to the queue for the background task to pick up. The background task then applies all of the actions defined on the notification event, including creating a task for a user, sending an SMS, sending an email, sending a Frameworks notifications (user messages), and sending them to a 3rd party, like GetSwift and Detrack. > **An example of how Event Notifications work:** > > In Sales Orders, when an order is confirmed, > > 1. This causes a notification **SalesOrderConfirmation** to be triggered. > 2. The Event Notification then makes a copy of the Sales Order and adds this copy to the Notification queue. > 3. A background program runs on the [Scheduler Administration ](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28405088) to pick up the notification and then completes the Actions defined within the event. > > For a Sales Order confirmation, you might decide to create Notification Event Actions to send an SMS and an Email when an order has been confirmed. When the Sales Order confirmation event is read by the Task Scheduler background task, it knows it must send an E-Mail and an SMS. For further information about the Sales Order Confirmation, refer to [Event Notifications](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28404886) # Event Notifications consists of the following options/activities: - **Event Definitions Maintenance** allows you to create and maintain events via defined event ID's and triggers and subscribe yourself, other Frameworks users, internal staff, or third parties to create a task for a user, send an SMS, send an email, send Frameworks notifications (user messages), and send to a 3rd party when an event has been triggered. > ℹ️ Any changes to the event definition require you to restart the event processor.  Event definitions are cached by the event processor.  Use the Event Process Controller to stop and restart. - **Notifications Event Queue **is the repository for all Notification Events, including those that have and haven't been processed. It allows you to enquire upon any events to confirm they occurred, the appropriate actions (e.g., email, SMS, or user notification message) were sent, or there were errors. - **Notification Event Queue Processor Control **is used to switch on and off the event processing. - **Event Queue Processor** monitors the Notifications Event Queue and processes each event & notification based on the event actions (that is, SMS, email, or a Frameworks User Notification) configured for the event. - **Purge Notification Queue** is used to delete old events. - **Notification Tasks **are background tasks that create events (as per the name of the task) based on Nuvu queries. # Refer to the following processes for further information > Macro (ui-children) # Additional Information > ✅ Refer to [Sales Orders Required Delivery Date Past ](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28405282) for further information.
Feature Codes and Related System Settings - Flags/General | **Feature Codes** | **Description** | | --- | --- | | **DNA** | The Feature code **DNA** must be enabled to allow the **DeTrack Notification Actions**.
![image]() | | **GNA** | The Feature code **GNA** must be enabled to allow the **GetSwift Notification Actions.**
![image]() | | **SNA** | The Feature code **SNA** must be enabled to allow the **Standard Notification Actions** of Email, SMS and Frameworks Notifications.
![image]() | > ℹ️ To uses any of the feature codes please contact your [Support](https://kb.myframeworks.com.au/page/support) | **System Settings - Flags** | **Description** | | --- | --- | | **SMTPFromLocked ** | When ticked, this will force the email to be sent using the system From address always rather than the **SMTPFrom** address. | | **System Settings - General** | **Description** | | --- | --- | | **SMSProvAdd** | In order to send SMS messages via event notification, the customer must also be registered with a 3rd party SMS provider eg utbox. Set this flag to the customers' provider | | **SMTPFrom**
**SMTPHost**
**SMTPPass**
**SMTPUser** | Frameworks Notifications use a direct API call to a SMTP server from the Frameworks Application Server.  (Not via NuVu or OS mail or any other means - such as [Setup SMS messages to Customers](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28386048))
These **system settings** need to be defined and the SMTP server needs to allow access from the Frameworks server.
> ⚠️ If the SMTP server requires authentication then the SMTPUser and SMTPPass (Username and Password) settings are required.  The SMTP server must be able to accept base64 authentication type if authentication is required. You will need to speak to your System administrator or IT Provider to confirm if authentication via username and password is required.
- The **SMTPFrom **Address should be set here. Frameworks Notifications will set the reply to address, but email will be sent from this address. Most SMTP servers will not allow changing the from address. the above **SMTPFromLocked **flag overcomes this. - Set the **SMTPHost **value, System administrator or IT Provider can provide this setting if unknown. |