--- title: "Event Definition Maintenance" canonical: "https://kb.myframeworks.com.au/space/FRAM/28405008/Event%20Definition%20Maintenance" format: markdown --- > ⚠️ When changes are made to Event Definitions, from the Event Definition Maintenance screen, you MUST [How do I trim the agents in Frameworks?](https://sterkb.atlassian.net/wiki/pages/createpage.action?spaceKey=FFAQ&title=How%20do%20I%20trim%20the%20agents%20in%20Frameworks%3F) for the changes to take effect. Please contact [Support ](https://kb.myframeworks.com.au/page/support)for assistance. # Overview The **Event Definitions Maintenance** module 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, send a SMS, E-mail, and Frameworks notifications as well as send to a 3rd Party application when an Event has been triggered. > ⚠️ Feature codes **DNA** must be activated first to allow DeTrack Notification Actions, **GNA** must be activated first to allow GetSwift Notification Actions and **SNA** must be activated first to allow Standard Notification Actions of Email, SMS and Frameworks Notifications. To access Event Notifications, perform the following: 1. Click the **Frameworks Menu** and navigate to **System Administration Event Notifications > Setup & Administration > Event Definition Maintenance **from the navigation tree. 2. Click **Find** to refresh the list of already created **Event Definitions. ** # Navigating the Event Definition Maintenance Screen Once you have opened the **Event Definitions Maintenance** screen you will be able to view, create, edit and maintain the events and action you are subscribed to.  > ℹ️ Click on the **Event Definition ID** hyperlink to view the **Event ID** and which **Actions **the Event ID has been configured and subscribed to. ![image](media://e101910f-ba40-4991-910c-f8f089d30e88) The Event Definition Maintenance Screen is made up of 5 sections, these are: ## 1. Event Definitions List This section displays all of the currently created event definitions. Selecting the **Event Definition ID** hyperlink allows you view and edit the details  ## 2. Event ID Information From here you can view the information about the Event and subscribe to it, as a whole.  > ℹ️ Only one Event or Event Definition can be defined for each type of Event ID. If you try to add a new Event Definition to an Event ID that already has a defined event, message "*Event already exists*" is displayed. In this case, you need to find the ID and add the new notification details to it. If the Event ID **Task** is selected then the **Task ID** and **Task Service **is required.  ## 3. Actions List In this section you are able to view the list of **Actions **that have been added to an Event and which are being subscribed to. The currently available action are: - **Notification**: This sends a Frameworks user notification, on the home dashboard. - **Email**: This sends an email notification. - **SMS**: This sends an SMS/text notification (requires a 3rd party SMS provider). - **Track**-**GetSwift**: This sends to the GetSwift tracking system. (Requires feature code GNA) - **Track**-**Detrack**: This sends to the DeTrack tracking system. (Requires feature code DNA) - **Create**-**Task**: This create a Task for a Frameworks user to complete. - **API**-**Notification**: This sends a notification via an API call. To view the **actions details** select an action and they will display to the right ## 4. Actions Details In this section you are able to **view** and **edit** the details of a selected action and **add** and **remove** actions for an Event Id.  ## 5. Command Buttons Using the buttons at the bottom of the screen you are able to create **New **event definitions, **Edit** exiting event definition and **Copy **exiting event definition. > ✅ Refer to one of the following links for information on how to create and setup [Notification Action](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28408822), [Email Action](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28408730), [SMS Action](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28383270), [Create-Task Action](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28391066), [Truck Tracker - IHG Integration](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28410612), [Detrack - System Administration & Setup](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28388444) and create a [Frameworks Web Hooks - Setup and Configuration](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28391110). # Event Types An Event allows you to define what information is to be sent to Frameworks Users, internal staff or third parties when an Event Notification is triggered. There are 2 different types of Events: 1. An Event triggered by a User performing an action in Frameworks (user triggered events). 2. An Event not triggered by a User’s action in Frameworks. > ✅ Refer to [Notification Tasks](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28386136) for more information on scheduled task triggered events.
For more information about the event ID's, click here.  The table below provides further information about User triggered events & scheduled task triggered events. | **Event ID** | **Type of Event ID / Trigger** | **Description** | | --- | --- | --- | | **CreditApproval** | Scheduled Task | Registers an Event Notification after searching Frameworks for all Orders due for delivery (via the "Delivery Date" field in the scheduled task) that require credit approval.
*For example,* an Automated Notification can then be setup to the Credit Department with a link to the Sales Order transaction. | | **DeliveryDateChanged** | User Triggered Event | Setting up and subscribing to this event will register an Event Notification when a User has changed the Delivery Date on a Sales Order for a Customer.
Any subscribed actions (SMS, email or User Notification) will then be triggered as part of this event.
*For example,* an Automated Notification can be setup to the Frameworks User the order was assigned to with a link to the Sales Order. | | **DespatchConfirmation** | Scheduled Task | Registers an Event Notification after searching Frameworks for all Orders that are to be delivered one full day prior to the Delivery Date.
*For example,* an Automated Notification can then be setup to the Customer xx days (the days are defined via the "Delivery Date" field in the scheduled task) prior to the delivery date confirming the delivery is still OK to proceed & asking the Customer if they have any last minute changes. | | **DespatchNotice** | User Triggered Event | Setting up and subscribing to this event will register an Event Notification after searching Frameworks for when a Transport manifest has been printed. The Transport manifest is printed from the Run Sheets screen in [Event Definition Maintenance](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28405008).
Any subscribed actions (SMS, email or User Notification) will then be triggered as part of this event.
*For example,* an Automated Notification can be setup to the Customer advising them that their delivery has left the yard. | | **/anchLinkedOrdersNotReceipted** | Scheduled Task | Registers an Event Notification after searching Frameworks for linked Purchase Orders that have not yet been receipted.
*For example,* an Automated Notification can then be setup to the Frameworks User the order was assigned to with a link to the Stock Receipt & link Sales Order. | | **OrderBackOrdered** | User Triggered Event | Setting up and subscribing to this event will register an Event Notification when a backorder is created from either [Event Definition Maintenance](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28405008)
Any subscribed actions (SMS, email or User Notification) will then be triggered as part of this event. | | **OrderConfirmation** | User Triggered Event | Setting up and subscribing to this event will register an Event Notification when a User has created a Sales Order for a Customer.
Any subscribed actions (SMS, email or User Notification) will then be triggered as part of this event.
*For example,* an Automated Notification can be setup to the Customer containing a formal Frameworks document (eg: the invoice format document) and/or an Automated Notification can be setup to the Frameworks User the order was assigned to with a link to the Sales Order. | | **OrderModified** | User Triggered Event | Setting up and subscribing to this event will register an Event Notification when a User has modified a Sales Order for a Customer.
Any subscribed actions (SMS, email or User Notification) will then be triggered as part of this event. | | **OrderVoided** | User Triggered Event | Setting up and subscribing to this event will register an Event Notification when a User has voided a Sales Order for a Customer.
Any subscribed actions (SMS, email or User Notification) will then be triggered as part of this event. | | **QuoteConfirmed** | User Triggered Event | Setting up and subscribing to this event will register an Event Notification when a User has confirmed a Sales Quote for a Customer.
Any subscribed actions (SMS, email or User Notification) will then be triggered as part of this event. | | **QuoteEntryComplete** | User Triggered Event | Setting up and subscribing to this event will register an Event Notification when the action menu item **Mark as Entry Complete** is selected and applied in the Sales Order maintenance screen for a sales Quote. This depends on the branch **Default Order Complete** flag and the system settings - flag **FWConfirm.**
Any subscribed actions (SMS, email or User Notification) will then be triggered as part of this event. | | **QuoteFollowup** | Scheduled Task | Registers an Event Notification after searching Frameworks for all Quotes where the Follow-Up Date has been set (via the "Follow Up" field in the scheduled task) and is now due.
*For example,* an Automated Notification can then be setup to the Frameworks User the quote is assigned to with a link to the quote or an Automated Notification can also be setup to the Account Sales Rep with a link to the quote. | | **QuoteLost** | User Triggered Event | Setting up and subscribing to this event will register an Event Notification when a User has registered the [Event Definition Maintenance](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28405008) via deleting a quote.
Any subscribed actions (SMS, email or User Notification) will then be triggered as part of this event.
*For example,* an Automated Notification can be setup to the Customer with the quote attached, asking for feedback and/or an Automated Notification can also be setup to the Frameworks User the quote is assigned to with a link to the Sales quote transaction & the reason for the loss. | | **QuoteWon** | User Triggered Event | Setting up and subscribing to this event will register an Event Notification when a User has [Event Definition Maintenance](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28405008) on behalf of a Customer via accepting a quote.
Any subscribed actions (SMS, email or User Notification) will then be triggered as part of this event.
*For example,* an Automated Notification can be setup to the Frameworks User the quote is assigned to with a link to the Sales order transaction and/or an Automated Notification can also be setup to the Customer thanking the Customer for the job. | | **QuoteVoided** | User Triggered Event | Setting up and subscribing to this event will register an Event Notification when a User has voided a Sales Quote for a Customer.
Any subscribed actions (SMS, email or User Notification) will then be triggered as part of this event. | | **tpaOrderCreated** | User Triggered Event | Setting up and subscribing to this event will register an Event Notification when a Trade Portal Order or Quote is created.
Any subscribed actions (SMS, email or User Notification) will then be triggered as part of this event. | | **SaleOrderReqDeliveryDatePast** | Scheduled Task | Registers an Event Notification after searching Frameworks for Sales Orders that have not been delivered and passed their required delivery date (older than today).
*For example,* an Automatic Notification can then be setup to the Frameworks User the order is asigned to with a link to the Sales Order transaction. | | **SalesOrderTemplate** | User Triggered Event | Provides the a user with the ability to send a notification to a Customer on an ad-hoc basis from within the Sales Order screen. The User triggers the event.
Any subscribed actions (SMS, email or User Notification) will then be available as an option for the User in Sales Orders via **Actions** then the **Send Message** option.
> ✅ Refer to [Event Definition Maintenance](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28405008) & [Sending Sales Order confirmations to customers by e-mail or SMS or Notifications to Users](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28383336) for further information. | | **orderPickComplete** | User Triggered Event | Setting up and subscribing to this event will register an Event Notification when the **Checked** button is clicked AND the user clicks **Save** in Enterprise Pick and Release.
Any subscribed actions (SMS, email or User Notification) will then be triggered as part of this event. | | **pickingComplete** | User Triggered Event | Setting up and subscribing to this event will register an Event Notification when the **Complete** button is clicked in Enterprise Pick and Release.
Any subscribed actions (SMS, email or User Notification) will then be triggered as part of this event. | | **OrderReleased** | User Triggered Event | Setting up and subscribing to this event will register an Event Notification when the **Release** then the **Save** button is clicked in Enterprise and Standard Pick and Release
Any subscribed actions (SMS, email or User Notification) will then be triggered as part of this event.
*For example,* an Automated Notification can be setup advising the Customer their order has been picked and is ready to be release and delivered. | | **SalesOrderInvoice** | User Triggered Event | Setting up and subscribing to this event will register an Event Notification when a Sales Order is released into an Invoice.
Any subscribed actions (SMS, email or User Notification) will then be triggered as part of this event.
*For example,* an Automated Notification can be setup to the Customer with the invoice attached. | | **POSPaidUp** | User Triggered Event | The system will monitor when a Barossa Voucher is captured in Point of Sale and the sale is fully tendered.  An event is created to register or top up the Barossa vouchers | | **Task** | Scheduled Task | This allows you to subscribe to a scheduled task that has no been predefined. For this you will need to:
- Either type the *Task ID of the scheduled job that will query the database and create the tasks *in the **Task ID** field Info: Refer to [Event Definition Maintenance](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28405008) - Or type the *Task Service* in the **Task Service** field. To do this open the appropriate scheduled/notification task then select the Support Information tab to identify the appropriate Task Service. > Macro (inline-external-image) | | **TenderReceipt** | User Triggered Event | Setting up and subscribing to this event will register an Event Notification when Tendering and Slyp is used.
Any subscribed actions (SMS, email or User Notification) will then be triggered as part of this event.
> ✅ Refer to [Event Definition Maintenance](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28405008). | | **EPCTradeNetUpdated** | User Triggered Event | Setting up and subscribing to this event will register an Event Notification when the EPC Tradenet Scheduled task has been run and received data.
Any subscribed actions (SMS, email or User Notification) will then be triggered as part of this event.
> ✅ Refer to [Event Definition Maintenance](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28405008). |
# Using the Helper When the Helper field **Search** option is used, it displays the **Notifications Event Definition Helper** screen which provides you with a list of variable event codes for use when setting up event notifications. ![image](media://b9609d73-b1e1-4e18-8194-9504fcff6722) When you use the helper and select a defined variable code (for example, {order:contactEmail}), the data that is used is retrieved from the saved version of the Event. > **Example:** > > The data is used from saved Sales Orders. The format of a variable code is **{order:full code}**. > > - {order:contactPhone} > - {order:contactEmail} > - {order:numTran} > > ![image](media://6f9f1ad5-1b67-43cb-93a7-4e0a031650d8)
For more information about common variable codes to use for notifications, click here.  | **Action** | **Field** | **Event ID** | **Variable Code** | **Description** | | --- | --- | --- | --- | --- | | Email | To | *OrderConfirmation* | {order:contactEmail} | Automatically sends the e-mail notification to the Customer's contact e-mail address listed in the relevant Sales Order. | | Subject | *OrderConfirmation* | Notification of order {order:numTran} | Outputs the Sales Order Transaction Number into the Subject line of the notification, following the words "Notification of Order". | | *SalesOrderTemplate* | Order Confirmation Email to customer {order:numTran} | Outputs the Sales Order Transaction Number into the Subject line of the notification, following the words "Order Confirmation Email to customer". | | *SalesOrderTemplate* | Reminder for Order {order:numTran} | Outputs the Sales Order Transaction Number into the Subject line of the notification, following the words "Reminder for Order". | | Body | *OrderConfirmation* | Order {order:numTran} has been confirmed. | Outputs the Sales Order Transaction Number into the body of the e-mail informing the user that the Sales Order Transaction Number has been confirmed. | | *SalesOrderTemplate* | This is a reminder that you have a pending order {order:numTran} to be released tomorrow. | Outputs the Sales Order Transaction Number into the body of the e-mail informing the user that they have a pending order to be released tomorrow. | | Notification | Subject | *OrderConfirmation* | Order Notification {order:numTran} | Outputs the Sales Order Transaction Number into the User Notification. | | Body | *OrderConfirmation* | The order {order:numTran} has been sent and assigned to you. | Outputs the Sales Order Transaction Number into the body of the User Notification message. | | SMS | Body | *OrderConfirmation* | Order {order:numTran} has been confirmed. | Outputs the Sales Order Transaction Number into the SMS informing the user that the Sales Order Transaction Number has been confirmed. |
## Event Notification Conditions Event conditions are 4GL statements using any fields in the entity and must return a true/false value.  e.g. **order:idBranch eq 10** > ⚠️ Conditions must NOT have {} around the field names.
Fo1r more information about Common Condition Statements, click here.  | **Condition Type** | **Sample Condition Statement** | **Tips** | | --- | --- | --- | | Customer Attributes | order:idBranch = 10 and
customer:getAttributeValue("Email-DeliveryDateChanged" = true | Is using customer attributes in condition statements, the attribute must be defined and ticked/active under the category “notice” with customer maintenance - Attributes:
![image](media://6a1ce449-c744-4cd0-86e1-1dbbf8174433) |
# Additional Information > ✅ Refer to [Notification Tasks ](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28386136) for more information.