Skip to end of metadata
Go to start of metadata

 System Flags
FlagDescription
FeatureDNA

Allow DeTrack Notification Actions.

The Feature code 'FeatureDNA' must be enabled to allow the DeTrack Notification Actions. To utilise this feature please contact Sterland Computing.  

FeatureGNA

Allow GetSwift Notification Actions.

The Feature code 'FeatureGNA' must be enabled to allow the GetSwift Notification Actions. To utilise this feature please contact Sterland Computing


FeatureSNA 

Allow Standard Notification Actions of Email, SMS and Frameworks Notifications.

The Feature code 'FeatureSNA' must be enabled to allow the Standard Notification Actions of Email, SMS and Frameworks Notifications. To utilise this feature please contact Sterland Computing

Event Notifications allow you to configure notifications (specific to Frameworks modules) to advise users, internal staff or external parties such as a customer of predefined events (event triggers) that occur within the application, assisting you with improved communications. The notification can be issued via email, via SMS/Text message or via an internal Frameworks notification to a Frameworks User. The format and content of the message is configurable.

  • An Event is simply something that occurs in Frameworks. For example, a User updates a Sales Order or confirms a Sales Order. A record is then created in the database advising that the event has occurred (eg: User xxx updated the Order. This includes information on what was created or updated). A background task then scans all events and sends event notifications where each event meets the criteria.
  • Frameworks Notifications inform the User of an event, allowing them to launch the associated activity to perform the next business process step.
  • The Actions that a User has access to are determined by the feature codes FeatureDNA, FeatureGNA & FeatureSNA. Refer to System Flags above for further information.

(warning) Currently (as at ), only Sales Order Event Notifications can be setup. The Notification Event Actions allow you to access any information on a Sales Order. Purchase Orders and other modules will be available in a future release of Frameworks. (warning)

 Further detailed system administration information about how Event Notifications work

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 SMS, E-mail, Frameworks notifications (user messages) & GetSwift ( a specific Mitre 10 integration).

An example of how Event Notifications work:
In Sales Orders, when an order is confirmed, this causes a notification SalesOrderConfirmation to be triggered. The Event Notification then makes a copy of the Sales Order and adds this copy to the Notification queue. A background program runs on the Task Scheduler 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 Setting up & sending Sales Order confirmations to customers by e-mail, SMS or Frameworks Notifications

 Event Notifications consists of the following options/activities
  • Event Definitions Maintenance allows you to create and maintain Events (via defined Event ID's / triggers) and subscribe yourself, other Frameworks Users, internal staff or third parties to SMS, E-mail or Frameworks User Notifications when an Event has been triggered.
  • 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-mail, 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:


Accessing Event Notifications

To access Event Notifications, perform the following:

1. Click  then type Event Notifications (or select Event Notifications from the System Administration navigation tree) then select the relevant option from within the navigation tree

OR

Type the function within Event Notifications you would like to access . For example, click then type Event Definition Maintenance.


Creating Events & Subscribing Users, Internal Staff or Third Parties (eg: Customers) to Event Notifications

Event Definitions Maintenance allows you to create and maintain Events (via defined Event ID's / triggers) and subscribe yourself, other Frameworks Users, internal staff or third parties to SMS, E-mail or Frameworks User Notifications when an Event has been triggered.

(info) Feature codes FeatureDNA must be activated first to allow DeTrack Notification Actions, FeatureGNA must be activated first to allow GetSwift Notification Actions & FeatureSNA must be activated first to allow Standard Notification Actions of Email, SMS and Frameworks Notifications. Refer to System Flags above for further information.


To access Event Definition Maintenance, perform the following:

1. Click  then type Event Definition Maintenance (or select Event Definition Maintenance from the System Administration navigation tree).

2. All events already defined are displayed on the screen.

(info) The button refreshes the events on the screen.

3. Refer to the following processes for further information:


Creating a new Event & subscribing Users, staff or third parties

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:

  • An Event triggered by a User performing an action in Frameworks (user triggered events).
  • An Event not triggered by a User’s action in Frameworks (scheduled task triggered events).

To create an Event, perform the following:

1. Click .

(info) 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 <event id> already exists" is displayed. In this case, you need to find the ID and add the new notification details to it.

2. Select the event id to setup a notification for via the drop down arrow in the Event ID: field.

 Further information about Event ID's

The table below provides further information about User triggered events & scheduled task triggered events.

Event IDType of Event ID / TriggerDescription
CreditApproval

Scheduled Task


Registers an Event Notification after searching Frameworks (via the Sales Orders requiring Credit Approval scheduled task) 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. 

DeliveryDateChangedUser 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.

DispatchConfirmationScheduled Task

Registers an Event Notification after searching Frameworks (via the Dispatch Confirmation scheduled task) 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.

DispatchNoticeUser 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 Pick & Despatch.

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.

LinkedOrdersNotReceiptedScheduled Task

Registers an Event Notification after searching Frameworks (via the Linked Purchase Orders Not Receipted scheduled task) 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.

OrderBackOrderedUser Triggered Event

Setting up and subscribing to this event will register an Event Notification when a backorder is created from either Pick and Release or Frameworks Enterprise Picking

Any subscribed actions (SMS, email or User Notification) will then be triggered as part of this event.

OrderConfirmationUser 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.

OrderModifiedUser 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.

QuoteConfirmedUser 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.

QuoteFollowupScheduled Task

Registers an Event Notification after searching Frameworks (via a Quote Followup scheduled task) 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.

QuoteLostUser Triggered Event

Setting up and subscribing to this event will register an Event Notification when a User has registered the loss of a Sales Quote 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.

QuoteWonUser Triggered Event

Setting up and subscribing to this event will register an Event Notification when a User has accepted a Sales Quote 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.

SaleOrderReqDeliveryDatePastScheduled Task

Registers an Event Notification after searching Frameworks (via the Sales Orders Required Delivery Date Past scheduled task) 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 Setting up & sending E-mail or SMS messages to Customers or Notifications to users via Sales Orders & Setting up & sending Sales Order confirmations to customers by e-mail or SMS or Notifications to Users for further information.

 Example Event Notification

Set up of the notification:

Email Template to send a notification via a Sales Order:

SalesOrderInvoice

User Triggered Event


Registers 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.

3. Tick subscribed to register the event and receive any subscribed actions (SMS, e-mail or User Notifications).

4. Type a generic description for the event in the Description field.

(tick) For example, "Quotes where the Follow-Up Date has been set and is due" for the "QuoteFollowup" Event ID.

5. If you want to schedule the job yourself, type the Task ID of the scheduled job that will query the database and create the tasks in the Task ID field.

(tick) Schedule the appropriate Notification Task to obtain the Task ID. Refer to Notification Tasks for further information.

6. If you want to schedule the job yourself, type the Task Service in the Task Service field.

(tick) Open the appropriate Notification Tasks, then select the Support Information tab to identify the appropriate Task Service.


7. Click to add a new E-mail, SMS or User notification to be issued when the event is triggered. Refer to the following links for information on what to include into various fields based on the Event ID being created (refer to step 2 above).

 Email Action fields & descriptions

FieldDescription
Action

Select email via the drop down arrow  in the Action field.

Subscribed

Tick Subscribed to subscribe the person's email address/s to the notification

(info) You can un-tick Subscribed at any time if the Frameworks User, internal staff member or third party (such as a Customer) no longer wishes to receive the email notification.

Description

Type a description to explain the email notification into the Description field. For example, "Notification of Order" for an OrderConfirmation Event ID.

Condition

if you require assistance with coding the Condition text, please contact Sterland Computing.

(tick) Refer to Help with using Event Codes for assistance.

From

Type the email address in the From field that the notification will use as the sender when sending the notification.

To

Type the email address in the To field that the notification will be e-mailed to.

(tick) Refer to Help with using Event Codes for assistance.

Cc

Type the email address in the Cc field of the e-mail address that will also be copied when the notification is issued.

Bcc

Type the email address in the Bcc field of the e-mail address that will also be blind copied when the notification is issued.

Helper

Refer to Help with using Event Codes below for further information.

Subject

Type the subject of the e-mail into the Subject field.

(tick) Refer to Help with using Event Codes for assistance.

Show Body as HTML

Tick Show Body as HTML to display how the body of the message will appear when e-mailed. Tick again to alternate to display the body of the message as HTML.

Body

Type the e-mail message to be sent into the Body field.

(tick) Refer to Help with using Event Codes for assistance.


Attach Report

Select the appropriate report to attach via the drop down arrow  in the Attach Report field. 

(info) The "Order Confirmation" report attaches the Order Confirmation PDF to an email notification.

Attachments

(info)  The ability to add attachments will be available in a future release of Frameworks.

 Notification Action fields & descriptions

FieldDescription
Action

Select Notification via the drop down arrow  in the Action field.

Subscribed

Tick Subscribed to subscribe the person's Frameworks User ID to the notification.

(info) You can un-tick Subscribed at any time if the Frameworks User no longer wishes to receive the notification.

Description

Type a description to explain the user notification into the Description field. For example, "Send a Framework user notification".

Condition

If you require assistance with coding the Condition text, please contact Sterland Computing.

(tick) Refer to Help with using Event Codes for assistance.

To

Type the Frameworks User ID in the To field that the notification will be sent to.

(tick) Refer to Help with using Event Codes for assistance.

Helper

Refer to Help with using Event Codes below for further information.

Subject

Type the subject of the User Notification into the Subject field.

(tick) Refer to Help with using Event Codes for assistance.

Body

Type the User Notification message to be sent into the Body field.

Attachments

(info)  The ability to add attachments will be available in a future release of Frameworks.

 SMS Action fields & descriptions

FieldDescription
Action

Select Sms via the drop down arrow  in the Action field.

Subscribed

Tick Subscribed to subscribe the person's Mobile number to the SMS notification.

(info) You can un-tick Subscribed at any time if the person no longer wishes to receive the notification.

Description

Type a description to explain the SMS into the Description field. For example, "Send an SMS/Text notification".

Condition

If you require assistance with coding the Condition text, please contact Sterland Computing.

(tick) Refer to Help with using Event Codes for assistance.

To

Type the mobile number in the To field that the notification will be sent to.

Helper

Refer to Help with using Event Codes below for further information.

Body

Type the SMS message to be sent into the Body field.

(tick) Refer to Help with using Event Codes for assistance.

8. Click .


Help with using Event Codes

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.

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. For example, the data is used from saved Sales Orders.

The format of a variable code is {order:full code}.

For example,

  • {order:contactPhone}
  • {order:contactEmail}
  • {order:numTran}

Below are common variable codes you may choose to use for Email, SMS or User actions/notifications:

 Common variable codes to use for Notifications
ActionFieldEvent IDVariable CodeDescription

Emaiil




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".

SalesOrderTemplateOrder 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".
SalesOrderTemplateReminder for Order {order:numTran}Outputs the Sales Order Transaction Number into the Subject line of the notification, following the words "Reminder for Order".
BodyOrderConfirmationOrder {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.
SalesOrderTemplateThis 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.
NotificationSubjectOrderConfirmationOrder Notification {order:numTran}Outputs the Sales Order Transaction Number into the User Notification.
BodyOrderConfirmationThe order {order:numTran} has been sent and assigned to you. Outputs the Sales Order Transaction Number into the body of the User Notification message.
SMSBodyOrderConfirmationOrder {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.


Notifications Event Queue

The Notifications Events Queue is the repository for all Notification Events that have been issued. The Notification Event Queue allows you to enquire upon any events to check when they occurred and whether or not the notification E-mail, SMS or User Notification messages were sent, or there were errors.

To access the Notifications Event Queue, perform the following:

1. Click  then type Notifications Event Queue (or select Notifications Event Queue from the System Administration then Event Notifications then Setup & Administration navigation tree).


2. Search for the Notification Event by Event ID or All in the Event field, then by the date range in the When From & When To fields, then click .

(info) By default, Processed is ticked which shows all Notification Events that have been issued.

3. Click the Event ID link to view details of the Event Notification.

4. You may also want to tick Errors to search for only events where an error has been identified and the notification was not sent, then click the Event ID link to identify why the Notification wasn't sent.

The Log explains why the Notification was not sent.

5. Refer to FAQ How do I check for failed notifications and what do I do if notification/s have failed? for further information.


Notifications Event Queue Processor Control

The Notification Event Queue Processor Control is used to switch on and off the event processing. All Events in the Notifications Event Queue will not be processed if the Notification Event Queue Processor Control is off.

To access, stop & start the Notifications Event Queue Processor Control, perform the following:

1. Click  then type Notifications Event Queue Processor Control (or select Notifications Event Queue Processor Control from the System Administration then Event Notifications then Setup & Administration navigation tree).

2. To stop event processing, click .

3. Click . Event processing should be stopped.


4.Click

5. Click . Event processing should be running.



Event Queue Processor

The 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. From the Event Queue Processor, you can schedule when and how often each Event Trigger process runs.

To access the Event Queue Processor, perform the following:

1. Click  then type Event Queue Processor (or select Event Queue Processor from the System Administration then Event Notifications then Setup & Administration navigation tree).

2. If applicable, modify the Processor Pause Interval. Defaults to 20.

3. If applicable, tick  Debug Logging.  

4. If applicable, modify the Log File threshold size (MB). Defaults to 5MB. 

5. Click the  tab to schedule when the Sales Orders requiring Credit Approval scheduled task should run. Refer to Scheduling tasks to run One Time only, Daily, Weekly, Fortnightly or Monthly to update this information.

6. Click  to submit the task. 

7.  If run now, the tab displays the results of the completed task. If you ran the task immediately, you can click on the reports generated. If run later, the Task Scheduler Queue contains the output.


Purge Notification Queue

The Purge Notification Queue is used to delete old events.

To access the Purge Notification Queue, perform the following:

1. Click  then type Purge Notification Queue (or select Purge Notification Queue from the System Administration then Event Notifications then Setup & Administration navigation tree).

2. Tick  Purge to delete old events that have been processed.  

3. Type the required cut off date in the Cut Off field or use the date finder  to define a date to purge all events. 

4Tick  Include Events with errors to delete old events, including those with errors.  

5. If applicable, select one Event ID only to delete events for via the drop down arrow  in the Event Filter field.


6. Click the  tab to schedule when the  Purge Notification scheduled task should run., Refer to Scheduling tasks to run One Time only, Daily, Weekly, Fortnightly or Monthly to update this information.

7. Click  to submit the task. 

8. If run now, the tab displays the results of the completed task. If you ran the task immediately, you can click on the reports generated. If run later, the Task Scheduler Queue contains the output.


Notification Tasks

Notification Tasks are background tasks that create Events (as per the name of the task) based on Nuvu queries. These are the background tasks scheduled to run on the Frameworks Task Scheduler that scan the database and register the event with the Notification Queue and provide all the source data required by the Event Actions.

To access Notification Tasks, perform the following:

1. Select System Administration then Event Notifications then Notification Tasks then the actual Notification Task you would like to access.


2. Refer to Notification Tasks for further information.