---
title: "Interactive or Real-Time Events"
canonical: "https://kb.myframeworks.com.au/space/FRAM/28391040/Interactive%20or%20Real-Time%20Events"
format: markdown
---
# Overview
Interactive events or real-time events are created when a specific task is performed within Frameworks, such as when a sales order is released.
This document is designed to help explain what each interactive event is and how it is triggered within Frameworks.
# Sales Quote Events
Below are the Frameworks Events that are related to processes around the sales quotes within Frameworks. Click on a heading below for more information.
## Quote Confirmed
The system will monitor when the quote is completed in sales order processing and send the event when the action menu option '**Mark as Entry Complete**' is selected and applied in sales order maintenance.
> **Use Case Example**
>
> When a Sales Quote has been marked as competed you can create a task for a user to complete.
For more information about the quoteConfirmed event, click here.
| **Event Name** | quoteConfirmed |
| --- | --- |
| **Event Trigger** | The sales order Actions menu option '**Mark as Entry Complete**' has been applied to a sales quote.
> ⚠️ This option depends on the the branch maintenance **Default Order Complete** flag and the **FWConfirm** system setting - flag. |
| **Possible Conditions on Action** | *Please consult with *[*Support*](https://kb.myframeworks.com.au/page/support)* if you required more information* |
| **Associated Frameworks Program/Activity ** | SalesOrderNewMainBA |
## Quote Won
The system will monitor when a sales quote has been accepted in sales order maintenance.
> **Use Case Example**
>
> When a Sales Quote has been Accepted you can send an email to the sales rep or the customer's account manager.
For more about the quoteWon event, click here.
| **Event Name** | quoteWon |
| --- | --- |
| **Event Trigger** | The sales order Actions menu option **Accept Quote **has been applied to a sales quote. |
| **Possible Conditions on Action** | *Please consult with *[*Support*](https://kb.myframeworks.com.au/page/support)* if you required more information* |
| **Associated Frameworks Activity ** | SalesOrderNewMainBA |
## Quote Lost
The system will monitor when the quote is voided with a 'lost' reason in sales order maintenance.
For more information about the quoteLost event, click here.
| **Event Name** | quoteLost |
| --- | --- |
| **Event Trigger** | The sales order Actions menu option **Void Quote **has been applied AND a **Reason** is selected associated with a **lost quote.** |
| **Possible Conditions on Action** | *Please consult with *[*Support*](https://kb.myframeworks.com.au/page/support)* if you required more information.* |
| **Associated Frameworks Activity ** | SalesOrderNewMainBA |
## Quote Voided/Deleted
The system will monitor when a sales order is voided in sales order maintenance
For more information about the orderVoided event, click here.
| **Event Name** | orderVoided |
| --- | --- |
| **Event Trigger** | The sales order Actions menu option **Void order **has been applied to a sales quote. |
| **Possible Conditions on Action** | *Please consult with *[*Support*](https://kb.myframeworks.com.au/page/support)* if you required more information* |
| **Associated Frameworks Activity ** | SalesOrderNewMainBA |
# Sales Orders Events
Below are events that are related to processes around sales orders within Frameworks. Click on a heading below for more information.
## Order Placed
The system will monitor for the first time a sales order is completed in sales order processing and send the event when the action menu option '**Mark as Entry Complete**' is selected and applied in sales order maintenance. Any succeeding order uncompleted and completed changes will not generate an event notification.
> **Use Case Example**
>
> When you want to send a notification to your customers the first time an Order is marked completed.
For more information about the event, click here.
| Event Name | orderPlaced |
| --- | --- |
| Event Trigger | The sales order Actions menu option '**Mark as Entry Complete**' has been applied to a sales order for the first time.
> ℹ️ It is recommended that if the branch maintenance **Default Order Complete** flag is **disabled** and the **FWConfirm** system setting - flag is **enabled.** |
| Additional Conditions | *Please consult with *[*Support*](https://kb.myframeworks.com.au/page/support)* if you required more information* |
| Associated Frameworks Activity | SalesOrderNewMainBA |
## Order Confirmations
The system will monitor when a sales order is completed in sales order processing and send the event when the action menu option '**Mark as Entry Complete**' is selected and applied in sales order maintenance.
> **Use Case Example**
>
> When a Sales Order has been marked as competed you can create a task for a user to complete.
> ✅ If the **Order Placed **event is being used for customer notifications try using Order Confirmations for internal notifications.
For more information about the event, click here.
| **Event Name** | orderConfirmation |
| --- | --- |
| **Event Trigger** | The sales order Actions menu option '**Mark as Entry Complete**' has been applied to a sales order.
> ⚠️ This option depends on the the branch maintenance **Default Order Complete** flag and the **FWConfirm** system setting - flag. |
| **Possible Conditions on Action** | - customer.getAttributeValue("Email-OrderConfirmation") = True
- customer.getAttributeValue("SMS-OrderConfirmation") = True |
| **Associated Frameworks Activity ** | SalesOrderNewMainBA |
## Order Modified
The system will monitor when a sales order's header or order lines are changed after it has been marked as completed in sales order maintenance.
> ⚠️ There is also a [Background Events](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28391010) that will create this event for all open sales orders with delivery dates before the cut-off date and the despatch method is the selected despatch method. Refer to [Sales Orders Required Delivery Date Past](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28405282) for more information.
For more information about the event, click here.
| **Event Name** | orderModified |
| --- | --- |
| **Event Trigger** | The sales order IS marked as **Entry Complete **AND the sales order's header details OR order lines have been changed.
> ⚠️ This option depends on the the branch maintenance **Default Order Complete** flag and the **FWConfirm** system setting - flag. |
| **Possible Conditions on Action** | *Please consult with *[*Support*](https://kb.myframeworks.com.au/page/support)* if you required more information* |
| **Associated Frameworks Activity ** | SalesOrderMainBL, SalesOrderNewMainBA, BulkDeliveryNotificationsSchedBS |
## Order Voided
The system will monitor when a sales order is voided in sales order maintenance.
For more information about the event, click here.
| **Event Name** | orderVoided |
| --- | --- |
| **Event Trigger** | The sales order Actions menu option **Void order **has been applied to a sales order. |
| **Possible Conditions on Action** | *Please consult with *[*Support*](https://kb.myframeworks.com.au/page/support)* if you required more information* |
| **Associated Frameworks Activity ** | SalesOrderNewMainBA |
## Sales Order Message Template
The system allows the sending of ad-hoc emails, SMS and home notifications in the sales order maintenance 'Send Message' actions menu. Multiple templates for each type may be stored and accessed from this menu allowing the user to have access to a number of pre-built templates to quickly send standard messages to the customer or user.
For more information about the event, click here.
| **Event Name** | salesOrderTemplate |
| --- | --- |
| **Event Trigger** | User triggered through the **Send Message** option in the sales order maintenance actions menu |
| **Possible Conditions on Action** | *Please consult with *[*Support*](https://kb.myframeworks.com.au/page/support)* if you required more information* |
| **Associated Frameworks Activity ** | |
> ✅ Refer to [Sales Order Send Message Template](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28383336) for more information.
# Pick & Release and Transport Scheduling Events
Below are events that are related to processes around the picking and releasing of sales orders and the despatch processes within Frameworks. Click on a heading below for more information.
## Back Order
The system will monitor when the sales order is back ordered through Pick & Release or if the sales order is split. An event will be created for the original sales order and an event will be created for the back order.
For more information about the event, click here.
| **Event Name** | orderBackOrdered |
| --- | --- |
| **Event Trigger** | The sales order is **back ordered** OR the sales order is **split.** |
| **Possible Conditions on Action** | *Please consult with *[*Support*](https://kb.myframeworks.com.au/page/support)* if you required more information* |
| **Associated Frameworks Activity ** | PickReleaseEntMainBA: back ordered, PickReleaseMainBA: back ordered, SplitTransactionMainBA: backorder |
## Picking Marked Checked
The system will monitor enterprise picking and will create an event when the picking of the order has been checked.
> ⚠️ **Important**: To use this event you will require Enterprise Picking to be enabled.
For more information about the event, click here.
| **Event Name** | orderPickComplete |
| --- | --- |
| **Event Trigger** | The **Checked** button is clicked AND the user clicks **Save** in Enterprise Pick and Release. |
| **Possible Conditions on Action** | *Please consult with *[*Support*](https://kb.myframeworks.com.au/page/support)* if you required more information* |
| **Associated Frameworks Activity ** | PickReleaseEntBL:, pickingIsComplete: orderPickComple |
## Picking Marked Complete
The system will monitor enterprise picking and will create an event when the picking of an order is complete.
> ⚠️ **Important**: To use this event you will require Enterprise Picking to be enabled.
For more information about the event, click here.
| **Event Name** | pickingComplete |
| --- | --- |
| **Event Trigger** | The **Complete** button is clicked in Enterprise Pick and Release. |
| **Possible Conditions on Action** | *Please consult with *[*Support*](https://kb.myframeworks.com.au/page/support)* if you required more information* |
| **Associated Frameworks Activity ** | PickReleaseEntBL:, pickingIsChecked: pickingComplete |
## Order Delivery Date Changed
The system will send a notification when the delivery date of a sales order is changed in sales order maintenance.
For more information about the event, click here.
| **Event Name** | deliveryDateChanged |
| --- | --- |
| **Event Trigger** | Change of **delivery date** on the sales order |
| **Possible Conditions on Action** | (only if an order has been been marked complete)
*Please consult with *[*Support*](https://kb.myframeworks.com.au/page/support)* if you required more information* |
| **Associated Frameworks Activity ** | SalesOrderNewMainBA |
## Order Released
The system will monitor when the sales order is released in pick & release for Standard Pick and Release and Enterprise Pick and Release.
For more information about the event, click here.
| Event Name | orderReleased |
| --- | --- |
| Event Trigger | The **Release** button is clicked AND then the '**Save** button is clicked in Standard Pick and Release and Enterprise Pick and Release. |
| Possible Conditions on Action | *Please consult with *[*Support*](https://kb.myframeworks.com.au/page/support)* if you required more information* |
| Associated Frameworks Activity | PickReleaseBL:releaseOrder, PickReleaseEntBL:, releaseOrder: orderReleased |
## Order Invoiced
The system will monitor when the sales order's invoice details is posted, after the order has been released.
For more information about the event, click here.
| Event Name | salesorderlnvoice |
| --- | --- |
| Event Trigger | In the background when the invoice is **Posted**. This occurs automatically (via a control task) after a user has released a sales order. |
| Possible Conditions on Action | *Please consult with *[*Support*](https://kb.myframeworks.com.au/page/support)* if you required more information* |
| Associated Frameworks Activity | PickReleaseBL:releaseOrder, PickReleaseEntBL:, releaseOrder: orderReleased |
## Despatch Notice
The system will send this notification when the [Transport Scheduling](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28389732) system prints a run sheet.
For more information about the event, click here.
| **Event Name** | despatchNotice |
| --- | --- |
| **Event Trigger** | The **Print Runsheet** button is clicked on the runsheet in [Runsheet Maintenance](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28399634). |
| **Possible Conditions on Action** | *Please consult with *[*Support*](https://kb.myframeworks.com.au/page/support)* if you required more information* |
| **Associated Frameworks Activity ** | printRun_bl.p |
# Other Events
Below are events that are related to other processes within Frameworks. Click on a heading below for more information.
## Customer Order Created
The system will monitor when a customer order is completed and a new sales order is generated.
For more information about the event, click here.
| **Event Name** | copOrderCreated |
| --- | --- |
| **Event Trigger** | The **Complete** button is clicked in customer order maintenance. |
| **Possible Conditions on Action** | *Please consult with *[*Support*](https://kb.myframeworks.com.au/page/support)* if you required more information* |
| **Associated Frameworks Activity ** | CentralOrderMainBA |
## POS Fully Paid:
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
For more information about the event, click here.
| **Event Name** | POSPaidUp |
| --- | --- |
| **Event Trigger** | Tender is complete in POS AND the sale is fully tendered AND there is a Barossa Voucher on the sale that needs to be processed through the Barossa API's |
| **Possible Conditions on Action** | *Please consult with *[*Support*](https://kb.myframeworks.com.au/page/support)* if you required more information* |
| **Associated Frameworks Activity ** | PointOfSaleMainBA, PointOfSaleBL, VoucherBL |
## Task
The system will monitor when a production task is created or the assignee or if the due date of a production task is modified.
For more information about the event, click here.
| **Event Name** | Task |
| --- | --- |
| **Event Trigger** | Task is created in sales order maintenance OR amended in Process Management. |
| **Possible Conditions on Action** | *Please consult with *[*Support*](https://kb.myframeworks.com.au/page/support)* if you required more information* |
| **Associated Frameworks Activity ** | ProcessTaskMainBA, SalesOrderMainBL |
## Trade Portal Order Created
The system will monitor when a trade portal order or trade portal quote is created
For more information about the event, click here.
| **Event Name** | tpaOrderCreated |
| --- | --- |
| **Event Trigger** | The **Create Quote **or **Create Order** button is clicked in the Trade Portal once the order has been finalised |
| **Possible Conditions on Action** | *Please consult with *[*Support*](https://kb.myframeworks.com.au/page/support)* if you required more information* |
| **Associated Frameworks Activity ** | processCompTP_bl |
> ✅ Refer to [Trade Portal Automated Notifications](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28408848) for more information.
## EPC TradeNet Updated
The system will monitor when your EPC is updated by the TradeNet.
For more information about the event, click here.
| Event Name | EPCTradeNetUpdated |
| --- | --- |
| Event Trigger | The **EPC Tradenet Scheduled task** has been run and received data. |
| Possible Conditions on Action | *Please consult with *[*Support*](https://kb.myframeworks.com.au/page/support)* if you required more information* |
| Associated Frameworks Activity | EPCTradeNetSchedBS |
> ✅ Refer to [Trade Portal Automated Notifications](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28408848) for more information.
## Tender Slyp Receipts
The system will monitor when a transaction is tendered so it can trigger the **Slyp-Receipt **action.
> ✅ Refer to [Automatically Import EPC products from TradeNet](https://sterlandsupport.atlassian.net/wiki/spaces/fwksproau/pages/30507190) for more information.
For more information about the event, click here.
| Event Name | tenderReceipt |
| --- | --- |
| Event Trigger | When a transaction is tendered and Slyp is used. |
| Possible Conditions on Action | *Please consult with *[*Support*](https://kb.myframeworks.com.au/page/support)* if you required more information* |
| Associated Frameworks Activity | CreditMainBA, TenderEntryMainBA |
> ✅ Refer to [Trade Portal Automated Notifications](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28408848) for more information.
# Additional Information
> ✅ Refer to [Automated Event Actions](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28402264) for more information on how to define which actions these event will perform.
> ✅
> ✅ Refer to the [Setup & Administration](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28386126) User Manual for more information.
> ⚠️ Interested in Frameworks Automated Notification System? Contact us now by visiting our [**Support**](https://kb.myframeworks.com.au/page/support) page or call us