BEM Guide

Overview

The e5 Event Manager provides a facility to notify users of actions required of them within the e5 system. Events can be defined against an Object (an object being, for example, a Purchase Order) and specific processing specified when that event occurs.

For example, you may specify an event as Order needs Authorising against an object of Purchase Order. The event process may then be simply to run the notification program which will place a diary entry in each users diary that may authorise that order.

Many event processes may be run for the same event. In the above example, a second process may be to print out a copy of the order. This is done by defining more than one Event Handler program to the event.

Event Manager is concerned with:

Identifying Objects
Events which can occur against those Objects
Identifying programs where those Events happen (Event Source programs)
Identifying programs which can react to those Events (Event Handler programs)
Creating a list showing which Events are to be handled

e5 provides some Object, Event data with the product together with a number of Event Handler programs. This data is 'ship-protected' which allows you to View the data but prevents the amendment or deletion of the aforementioned data.

NOTE All e5 supplied Event Handler programs notify the relevant user that the Event has taken place by creating an entry in the user's Diary.

Using the Diary Screen

The Event Manager diary screen MXEJ is the first screen you will see when logging on to an e5 system with Event Manager installed. The screen presents you with a list of events that you need to action. These events may be a mix of system generated events or manually created reminders.

You can, for system generated events, go directly to the screen required to perform an action by double clicking on the diary entry. You may also delete events, create new ones and if you have the relevant authority, view events on behalf of another user. You can also transfer events from your own diary to that of another user.

The events have a priority defined against them, you can use the single click sort to show the events in priority order. It is also possible, through use of the selection window, to limit the events shown to a particular priority.

Escalation

It is possible within e5 to define an escalation structure to be used in relation to Business Event Manager. The structure is set up with one user as the head of the structure. Under them there can be a number of children defined.

The escalation structure can then be defined against an event, to indicate that escalation is to be used for this event.

Transfer From/To

As of v5.5 it is possible within to transfer sets of Diary Entries from their current Acton User to a different User.

Defining Objects

You must define an object before an event can happen to it. Each object must be linked to an underlying database table within the e5 system. A number of objects are pre-defined and are shipped with the system. You can add new events to these objects, or create new Event handler programs for them, but they cannot be amended.

Each Object must have at least one key row. If an Object is edited so that it has no key data the system will issue an error message on update. But if a valid table is identified and no keys are defined, the key rows will default to the relevant keys from the identified table. You cannot add to or delete from the list of default keys from a table, you can only amend the associated description.

A Table can only be linked to one Object.

On update a unique system wide number is created as the Object Identifier. An Object created by e5 is identified by a negative number, while an Object created by your organisation will be given a positive number.

Object Maps

To allow for the manual creation of Diary entries linked to a specific Object instance the Maps related to the Objects can be defined by matching the Map Fields to the Object Key columns. Once done this will allow the Session actions 'Diary Create' and 'Diary Find' on those Maps.

Creating Diary Entries

You can use QED to generate new diary entries based on existing events or events that you create yourself. See NOTE_EVENT and NOTE_DIARY_LINE for more information. Alternatively, manually create Object instance related Diary entries where the Session 'Diary Create' action is available.

Supplied events are triggered by the system automatically and will generate diary entries as these events occur in the system.

In addition, you can create diary entries manually by using the Edit Insert command from the standard Diary list screen. See screen MXEK for more information on creating diary entries.

Where the Action email text (max 240 characters) with Object key value substitution is limiting a Send Include may be created and referenced which may be up to 2000 characters and contain Substitution references to any Object Base Table column. See the supplied 01/BEM_SEND_RMTE_DFLT include which contains further help on usage.

A generic handler program XFK is available for further customisation of diary actions. See screen MXEH for more information.

If you create a new action list entry that is related to the generic handler program mentioned above ( XFK), then it is possible for you to customise your own events and generate Database triggers so that you are notified when specific events occur at database level.

This gives you the opportunity to create diary entries for events such as Orders over a £10000 being created.

Delivery/Read Receipts

Each BEM Object Event Action can be set to request both an email Delivery Receipt and/or a Read Receipt for correctly configured supported mail servers. Messaging is configured to process these receipts back into the system to update the source diary entries Receipt status. This indicates which Diary entry emails have been delivered and/or read. Also other status values such as 'Delayed' or 'Out of Office' are possible.

Remote Event Actions

Where the extra processing to implement remotely actioned events has been done you may define up to 6 Remote Action Keywords/Descriptions. This would result in one of 4 levels of Remote Action BEM email being sent to a User (dependant upon the users BEM Email Level) allowing either a plain text reply or the clicking of a http URL link to implement a desired action.

NOTE Only BEM Event ORD_AUTHORISATION Order Authorisation has the necessary extra Remote Event Action processing.

Supplied Objects and Events

The following table lists all the objects and their associated events supplied as standard with e5 .

Supplied Objects

Object	Description
ANY	Dummy For General Use
AR_QUERY	Query Management Events
BANK_CODE	Bank Code
COMMON_TEXT	Common Text
CONTRACT	Contract
CONTRACT_LINE	A line on a Contract
CREDDIARY	AR Credit Diary Object
CUSTOMER	A purchaser of Company's Goods/Services
E_SUPP_DOC	e-Supplier Documents Pending
FLIGHT_COST_LINE	Flight Cost Line
GENERIC_OBJECT	Generic Object
GENERIC_SUSPENSE	Generic Suspense Data
GL_BATCH	GL Data Entry Batch Header
GL_CMPY	A General Ledger Company
INVALID_FLIGHT_COST	Invalid Flight Cost
GOODS_RECEIPT	A Goods Receipt Or Return
INVALID_ORDER	In Error Order
ORDER	Order For Goods/Services To A Supplier
ORDER_LINE	A line On An Order
PL_APPRVL_ARRNGMNT	PL Arrangements Requiring Approval
PL_AUTH_DOCUMENT	PL Invoices Requiring Authorisation
PROCESS	An e5 Process
PL_INVALID_BATCH	Invalid PL Batches
PL_ORDER_LINK	PL Data Entry v. Order
PL_TRAN_LINE	Purchase Ledger Transaction Line
PL_TRANSACTION	Purchase Ledger Transactions
POP_AUTH_DOCUMENT	Documents Requiring Authorisation
PP_DIARY	Proposed Project Diary
PP_PROCESS	Proposed Project Process Flow
PROP_PROJ_REJECT	Proposed Project Rejection
PROPOSED_PROJECT	Proposed Project
REQUISITION	A Requisition
REQUISITION_LINE	A line on a Requisition
ROLL_AP	Accounts Payable Period Roll
ROLL_AR	Accounts Receivable Period Roll
ROLL_CR	Cash Receipting Period Roll
ROLL_IM	Inventory Management Period Roll
ROLL_PM	Purchasing Management Period Roll
SERVICE	AP Service Ledger
SI_CONTRACT_AUTH	SI Contract Authorisation
SI_DOCUMENT_AUTH	SI Document Authorisation
SL_ALLOC_BATCH	AR Suspended Allocation Batch
SL_TRAN_ITEM	Sales Ledger Transaction Item
SL_TRANSACTION	Sales Ledger Transactions
STOCK_TAKE	Stock Take Authorisation
SUPPLIER	Supplier of Goods/Services to Company
SUPPLIER_CATLG	Supplier Catalogue
SUPPLIER_DIARY	Supplier Diary
TIMESHEET	Timesheet Header
TIMESHEET AUTH	Timesheet Authorisation Record
USER	An e5 User
WEB_SERVICE_EXPORT	Web Service Export for ALL e5 Tables
WEB_TRANSACTION	Web Service Transaction

Supplied Events

Object	Event	Event Description
AR_QUERY	QUERY_ACTION	Credit Management Query Request
	QUERY_CLEAR	Credit Management Query Cleared
	QUERY_OPEN	Credit Management Query Open
BANK_CODE	STMT_TAKEON_FAIL	Bank Stmnt Upload Failed.
COMMON_TEXT	AUTH_REJ	Authorisation Rejection
CONTRACT	CON_AUTHORISATION	Contract Needs Authorising
CONTRACT	CONTRACT_REVIEW	Contract Needs Reviewing
CONTRACT_LINE	CONL_AUTHORISATION	Contract Line Needs Authorising
CREDDIARY	CREDIT_LIMIT_REQ	Credit Limit Request
	DIARY_ACTION	Credit Control Diary Action
	PROMISE_TO_PAY	Promise To Pay
	FAILED_TO_PAY	Failure To Pay
	PAYMENT_VARIANCE	A Promise to Pay Payment Variance
	DDI_REJECTION	Direct Debit Instruction Rejected
	DD_REJECTION	Direct Debit Rejected
CUSTOMER	CR_LIMIT_EXCEEDED	Customer Credit Limit Exceed
	APPROVAL_INSERT	Customer Approval Required
	APPROVAL_REJECT	Customer Approval Rejected
	CUSTOMER_CR_EXCEED	Customer has exceeded their Credit Limit
	CUSTOMER_CR_STOP	Customer has had their credit stopped
	CUSTOMER_CR_UTIL	Customer Credit Limit Utilisation
	CUSTOMER_LEGAL	Customer account has been placed in Legal Hands
FLIGHT_COST_LINE	FLIGHT_COSTY_EXCEPT	Flight Costing Line Exception
GENERIC_OBJECT	ESCALATE_EVENT	Escalation Event
	REMINDER_EVENT	Reminder Event
	REMOTE_CONNECTION	Remote Connection
GENERIC_SUSPENSE	SUSP_COMPLETED	Suspense Completed
	SUSP_NOTIFY_USER	Notify Suspense Data Entry to User Role
	SUSP_OUTSTANDING	Suspense Outstanding
	SUSP_REJECTED	Suspense Rejected
GL_BATCH	NOTIFY_AUTHORISE	Notify User A Batch Requires
	NOTIFY_COMPLETION	Notify User To Complete Transaction
	REMOVE_AUTHORISE	Remove Notification For Batch
	REMOVE_COMPLETION	Remove Completion Note For Transaction
	GL_VALUE_AUTH_REQ	Notify user a batch requires authorisation
	GL_VALUE_AUTH_DEL	Remove notification for batch authorisation
GL_CMPY	GL_AUDIT_IMBALANCE	Process ED4 - GL Audit Imbalance
GL_CMPY	ROLL_GL	General Ledger Period Roll
INVALID_FLGHT_COST	FLGHT_COST_EXCEPTN FLGHT_COST_IN_ERR FLGHT_COST_REGEN	Flight Costing Exception Flight Cost In Error Flight Cost Regeneration
INVALID_ORDER	IN_ERROR_ORDER ORDER_REVIEW	Order Has gone Into Error Consolidated Order Review Required
JB_PROP_REVW	JB_PROP	JB Proposal Review Required
JB_PROP_REVW	JB_PROP_AUTH	JB Proposal Authorisation Required
ORDER	ORD_AUTHORISATION	Order Needs Authorising
	ORDER_ACKNOWLEDGE	Order Acknowledgement Is Required
	CA_FUNDS_CHECK	Commitment Accounting Funds Check Failure
	PT_FUNDS_CHECK	Project Tracking Funds Check Failure
	E_SUPP_ACCPT_I	e-Supplier Accept Invoice
	E_SUPP_ACCPT	e-Supplier Accept Advice Note
	E_SUPP_PEND_I	e-Supplier Pending Invoice
	ORDER_RCPT_REQD	Order Requires Receipting
	ORDER_COMPLETE	Order has been completed
	ORDER_POST_AUTH	Order has been authorised
ORDER_LINE	GRN_CANCELLED	GRN Cancelled
	GRN_REJECT	Goods Returned/Rejected
	ORDL_AUTHORISATION	Order Line Needs Authorising
	CMPLT_FAILED s	ORDER line still has uncompleted GRN
PL_APPRVL_ARRNGMNT	APPRVL_ARRNGMNT	Arrangements Require Approval
PL_AUTH_DOCUMENT	PL_AUTH_DOCUMENT	Authorise Document
PL_INVALID_BATCH	INVALID_INVOICE	AP Invalid Invoices
	PL_BATCH_REVIEW	PL Batch for Review
	FAILED_FLIGHT_TOL	AP CIDOCS Tran has failed tolerance
	FAILED_FLIGHT_VER	AP CIDOCS Tran has failed verification
PL_TRAN_LINE	INV_HELD_MISC	Held Invoice Due To Misc Charge
	INV_HELD_PRICE	Held Invoice Due To Price Mismatch
	INVL_AUTHORISATION	Invoice Line Needs Authorisation
	QTY_QUERY	Quantity Query
	VALUE_QUERY	Value Query
PL_TRANSACTION	ASSOC_TRAN_CANCEL	Associated Transaction Cancel
	INV_AUTHORISATION	Invoice Needs Authorisation
	INV_CREATED	Invoice Created
	INV_TERMS_MISMATCH	Settlement Terms differ Invoice
	SYSTEM_DEBIT_NOTE	System Generated Debit Note
	SCANNED_INV_CREATE	Invoice Created from Scanned Image
PP_DIAY	DIARY_INSERT	Proposed Project Diary Insert
PP_DIAY	PP_DIARY_ACTION	Proposed Project Diary Action
PP_PROCESS	PP_APPROVAL_1	Proposed Project Approval 1
	PP_APPROVAL_2	Proposed Project Approval 2
	PP_APPROVAL_3	Proposed Project Approval 3
	PP_CHANGE_STATUS	Proposed Project Change Status
	PP_REMINDER	Proposed Project Status Reminder
PROCESS	PROCESS_ABEND	Process Has Abended
PROCESS	PROCESS_COMPLETE	Process Has Completed
REQUISITION	REQ_AUTHORISATION	Requisition Needs Authorising
REQUISITION_LINE	REQL_ALT_SUPP	Default Supplier Overridden
	REQL_AUTHORISATION	Requisition Line Needs Authorising
	REQL_BYR_CONTRACT	Int Flag Frce/Override Contract
	REQL_ITEM_CONTRACT	Int Flag and >1 Forced Contract
	REQL_NO_PRICING	Pricing Needed Prior To Authorisation
	REQL_ORDER_CREATE	Requisition Requires Order Create
	REQL_REOPEN	Requisition Line Reopened After Amend
	REQL_STOCK_NOUSE	Stock Issue Not Accepted
	REQL_SUPP_MISSING	No Supplier on Requisition Line
ROLL_AP	ROLL_AP	Accounts Payable Period Roll
ROLL_AR	ROLL_AR	Accounts Receivable Period Roll
ROLL_CR	ROLL_CR	Cash Receipting Period Roll
ROLL_IM	ROLL_IM	Inventory Management Period Roll
ROLL_PM	ROLL_PM	Purchasing Management Period Roll
SERVICE	SERVICE_REVIEW	Service Requires Review
SI_CONTRCT_AUTH	CNTRCT_AUTH	SI Contract Authorisation
	CNTRCT_AUTH_DSBL	SI Contract Auth for Disable
	CNTRCT_AUTH_ENBL	SI Contract Auth for Enable
	CNTRCT_REJECTION	SI Contract Auth Rejection
SI_DOCUMENT_AUTH	DOC_AUTHORISATION	SI Document Authorisation
SI_DOCUMENT_AUTH	DOC_REJECTION	SI Document Auth Rejection
SL_ALLOC_BATCH	BATCH_NOT_FOUND	AR Suspended Allocation Batch Not Found
	BATCH_PREV_CONFIRM	AR Allocation Batch Previously Confirmed
	BATCH_PREV_REJECT	AR Allocation Batch Previously Rejected
	BATCH_REJECTION	AR Suspended Allocation Batch Rejection
SL_TRANSACTION	ADJUST_AUTH	Cash Alloc Adjustment Authorisation Reqd
	ADJUST_REJECT	Adjustment Authorisation Rejection
	TRANSACTION_AMEND	Transaction Amend
STOCK_TAKE	STAKE_AUTH	Stock Take Authorisation
SUPPLIER	CATALOGUE_REVIEW	Supplier Item Catalogue Review
	PM_APPROVAL_INSERT	Supplier Approval Required
	PM_APPROVAL_REJECT	Supplier Approval Rejected
	PM_REGISTER_ACCEPT	Supplier Registration Accepted
	PM_REGISTER_NOTIF	A Supplier has registered an interest in supplying goods
	PM_REGISTER_REJECT	Supplier Registration Rejected
SUPPLIER_CATLG	CATLG_REVIEW	Supplier Item Catalogue Review
SUPPLIER_DIARY	MSG_ABOUT_PAYM	Message from Supplier about Payment
	MSG_ABOUT_TENDER	Message from Supplier about eSupplier Enquiry
	MSG_ABOUT_TERMS	Message from Supplier about Terms
	MSG_ABOUT_TRAN	Message from Supplier about Transaction
	MSG_TO_BUYER	Message to Buyer from Supplier
TIMESHEET	LATE	Timesheet is Overdue
	REJECTED	Timesheet has been Rejected
	SUBMISSION	Timesheet Requires Submitting
TIMESHEET_AUTH	AUTHORISATION	Timesheet Requires Authorisation
USER	DATE_EXCEEDED	Number of Days Between Logon Exceeded
	RETRY_EXCEEDED	Number of Password Retries Exceeded
	RESET_FAILURE	Password Reset Failure
WEB_SERVICE_EXPORT	WEB_SERVICE_EXPORT	Web Service Export for ALL Tables
WEB_TRANSACTION	NOTIFY_ERROR	Notify User a Transaction Errored
	SENT	Notify Web Transaction 'Sent'
	TO_ACTION	Notify Web Transaction 'To Action'

Supplied Send/Confirm Email Text Includes

The following table lists all the Send Include Text supplied as standard with e5 .

Supplied Send Email Text

Include	Description
BEM_SEND_ORDL_AUTH	Remote Send email Order Line Auth. Text
BEM_SEND_ORDL_CMPL	Remote Send email Order Line Compl. Text
BEM_SEND_ORDR_AUTH	Remote Send Order Authorise Email Text
BEM_SEND_ORDR_CMPL	Remote Send email Order Complete Text
BEM_SEND_PROC_CMPL	Remote Send email Process Complete Text
BEM_SEND_PURCH_AUT	Remote Send email Purch Doc Auth Text
BEM_SEND_QTY_MMTCH	Remote Send email Quantity Mismatch Text
BEM_SEND_RMTE_DFLT	Remote Send email Default Text
BEM_SEND_SLTR_AMAP	Remote Send email SL Tran Amnd Approval

Supplied Confirmation Email Text

Include	Description
BEM_CNFM_PROC_COMP	Remote Action Cnfrm ACCEPT/REJECT Example

NOTE The menu path shown is the default for the system. Your company may have customised menu options, so the path shown may not be accurate. Please contact your system administrator for details.