SYSPRO Ribbon bar > Administration > Event Management

Event Management

You use this program to configure events that you want to monitor within SYSPRO as they occur. It enables you to invoke third-party applications (developed in an appropriate language) when a particular event occurs in SYSPRO (e.g. stock falls below zero).

The actions that can be associated to an event include launching programs (i.e. SYSPRO, NetExpress, or third party applications) and sending e-mail messages to specified persons. For example: Whenever the quantity on hand for a particular stock item falls below zero in a specific warehouse, SYSPRO can automatically notify the Stock Controller via e-mail that the event has occurred. The action of e-mailing the Stock Controller takes place within a few seconds of the event occurring.

Toolbar and menu

Field Description
Edit  
Add Select this to add a new event.
Change Select this to maintain the currently highlighted event.
Delete Select this to delete the currently highlighted event.

If you selected the option: Confirm Deletions, then you are prompted to confirm the deletion of the selected event.

Functions  
View Log File Select this to use the Event Management Log View program to view and/or report on the log file created from transactions generated by the Event Management program.

Listview

When you select the Event Management program, a listview displays the events currently configured.

Add Event

You use the Add option from the Edit menu to configure a new event.

Field Description
Event details

Name

Indicate a unique 20-character description for the event.

Event

Select Event

Indicate the event you want to monitor.

Parameter

Indicate the parameter you want to assign to the event.

This field is displayed only for events containing a parameter entry. For example: If you select the event: Supplier balance > parameter then an action would be triggered when the supplier's balance exceeds the amount entered at the parameter field).

Type

Indicate the mechanism that you want to activate when the event occurs in SYSPRO.

E-mail

Select this to send an e-mail message when the event occurs in SYSPRO (see Email ).

Run a SYSPRO program

Select this to run a SYSPRO program when the event occurs in SYSPRO Run a SYSPRO program.

Run any NetExpress program

Select this to run a NetExpress program when the event occurs in SYSPRO Run any NetExpress program.

Run an application

Select this to run an application when the event occurs in SYSPRO Run an application.

Write to log only

Select this to only write to the log file when the event occurs in SYSPRO.

Write to message inbox

Select this to send a message to a specific operator's inbox when the event occurs in SYSPRO Write to message inbox.

The message could be used to notify the operator of a task to be actioned or it could merely be informational.

The Message Inbox is accessed from the Main SYSPRO menu by selecting the Message Inbox option from the Window menu. The system can be set to check for messages automatically on startup by selecting the Check for messages option from the Messages tab of the Customize screen (see Messages).

Description

Describe the type of event being configured. This description is displayed as a listview column when you select to view the log file.

Options

Write to log

Select this to record the triggered event in a log file.

You can view and report on the log file from within the Event Management Editor by selecting View Log File from the Functions menu.

The name of the log file is xADMEVL and is located in your working directory.

Active

Select this to specify a range of inclusive dates within which the event must be activated.

From

Indicate the earliest date in the range.

To

Indicate the latest date in the range.

Save

Add the new event to the event management file.

The name of the file is xADMEVT and is located in your working directory.

Check Names

Verify that the e-mail address of the recipient is valid.

This applies only to the E-mail type.

Cancel

Ignore any details you entered and to return to the listview.

Email

This screen is displayed if you selected to send an e-mail message when the event occurs in SYSPRO.

Field Description
E-mail

Select this to associate an event with the sending of e-mail to selected recipients.

This applies only to the E-mail type.

To

You use this field to indicate one or more recipients of the e-mail. Use the semi-colon (;) to separate recipients.

Subject

You use this field to indicate the wording that must be displayed in the subject field of the e-mail message.

[Note]

You can use special reserved words in the subject line (see Reserved words in email).

Message

You use the message area of the e-mail window to optionally indicate the text that you want to send to the recipient (e.g. The stock on hand has fallen to below zero).

[Note]

You can use special reserved words in the message text area (see Reserved words in email).

Notify buyer

Select this to notify the buyer who placed the purchase order, when the goods arrive. The e-mail address associated with the buyer is added to the e-mail list.

[Note]

This option is displayed only for the Inventory event: Goods receipt.

Notify user

Select this to send an email to the requisition user as well as to the recipients listed in the To field. At least one recipient must be listed in the To field.

When you select this option, the e-mail defined against the requisition user is used (see User Maintenance), so ensure that this is defined.

[Note]

This option is displayed only for the PO events: Requisition routed to another user (req & receipt) and Requisition routed to another user (req only).

No default E-mail recipient

Select this to only send e-mail to the recipients configured within the Conditional E-mail by List function.

In this scenario, e-mail is sent only when the defined criteria are matched.

[Note]

If you do not select this option, then at least one e-mail recipient must be specified at the To field.

In this scenario, e-mail is sent to the recipient if the underlying event occurs, but the specific criteria entered are not matched. For example: stock goes negative for items other than that defined in the Conditional E-mail by List function (i.e. the underlying event is stock on hand going negative).

Conditional E-mail by list

Select this to send e-mail to specific recipients based on a conditional expression (see Event Management Mail Selections) that includes the warehouse. For example: The stock controller can be notified when a specific stock code goes negative in a specific warehouse.

This function applies only for specific Inventory events.

Run a SYSPRO program

This screen is displayed if you selected to run a SYSPRO program when the event occurs in SYSPRO.

Field Description
SYSPRO program

You use this option to associate the event to the running of a standard SYSPRO program.

[Note]
  • This applies only if you selected Run a SYSPRO program at the Type field.

  • Parameters are not passed when calling SYSPRO programs. If you require parameters, then you must use the Run any NetExpress program option.

  • Once an event has been activated, and it is configured to run a SYSPRO program, the original program will not work properly if it attempts to interact with the Event system.

Program name

Indicate the program that you want to load when the event occurs.

Description

Indicate a description of the program that is being run. This defaults to the description assigned to SYSPRO program.

Run any NetExpress program

This screen is displayed if you selected to run a NetExpress program when the event occurs in SYSPRO.

Field Description
NetExpress program

Select this to associate the event to the running of a NetExpress program.

Description

Optionally indicate a description of the program that is being run.

Program

Indicate the NetExpress program (including the full path) that you want to load when the event occurs.

The NetExpress program that is executed is written automatically to SYSPRO's Job Logging system.

[Note]

If the program was constructed using standard SYSPRO techniques, then the field LINK-EXTRA will contain the key of the code that triggered the event (e.g. in the case of stock falling to below zero, this would be the stock code itself).

For Inventory events, the stock code and the warehouse code is passed to the NetExpress program. The stock code is in position 1-30 and the warehouse code is in position 31-32.

Run an application

This screen is displayed if you selected to run an application when the event occurs in SYSPRO.

Field Description
Application

Select this to associate the event to the running of third party application software.

Description

Optionally indicate a description of the application that you want to run.

Command line

Indicate the executable file together with parameters that will launch the selected application when the event occurs.

To reduce the number of characters used on the command line, you can specify the path to the executable at the Start in field.

You can use reserved words in the command line (see Reserved words in the command line).

Start in

Indicate the full path to the executable that will launch the designated application software.

Write to message inbox

This screen is displayed if you selected to write to the message inbox when the event occurs in SYSPRO.

Field Description
Message inbox details

Subject text

Enter the message text you want to display in the message inbox.

You can use the Explain function from the Select Event function to view the keywords you can use in the subject text field.

Send to operator

Enter the operator to whom the message must be sent. The operator code you enter must exist and be valid.

Program to run

Enter a program that you want to run from the message inbox.

This field is optional.

Post message with today's date

If you select this option, then the message is written to the Message Inbox regardless of the number of times the event is activated on the same date.

If you do not select this option, then a single message is written to the Message Inbox irrespective of the number of times the event is activated on the same day.

Prevent duplicate message being displayed

If you select this option, then duplicate messages are not displayed in the target operator's inbox. Duplicate messages are those where the subject text and the program to run are identical.

List of SYSPRO Events

This screen is displayed when you select the Select Event function.

Field Description
AP events  
New supplier added  
Supplier balance > parameter  
AR events  
New customer added

Customer balance > % of credit limit

Activation point

  • When the customer's balances is greater than (the customer's credit limit multiplied by the parameter value divided by 100).

    For example: Parameter value entered = 90. Customer's credit limit = 10 000. The trigger is activated when the customer's balance exceeds 9 000, (i.e. 10 000 x 90/100).

You would typically use this trigger to alert you when customers are nearing their credit limit.

[Note]
  • If you are using master/sub accounts, then the credit check is performed against the customer (master or sub account) to which invoices are linked (Browse on Master Sub-accounts).
  • The event is only fired when the customer's credit limit is exceeded the first time.
Customer now within credit limit

Customer balance > parameter

Customer placed on hold

Activation point:

Customer released from hold

Activation point:

Asset events

.

Minimum book value reached

Capex budget exceeded on line addition

Activation point:

  • When a capex requisition line is added to a capex item and the value of the requisition line causes the budget value of the capex item to be exceeded (Asset Capex Items).

Capex budget exceeded on line approval

Activation point:

  • When a capex requisition line is approved and the value of the requisition line causes the budget value of the capex item to be exceeded (Asset Capex Items).

Capex budget exceeded on line spending

Activation point:

  • When using the Purchase Order Receipts or Part Billings program to process a receipt for a capex requisition line and the receipt value causes the budget value of the capex item to be exceeded.

Capex spending on line not approved

Activation point:

Capex spending on closed line  
Cash Book events  
Bank balance < parameter

GL events  
G/L Ytd actual > Ytd budget by % parameter

Inventory events  
New stock item added

Stock on hand negative

Stock less than safety

Stock less than minimum

This event is executed only on the first instance that the condition occurs for a specific stock item. The event is not triggered if the stock on hand for the item is already below minimum and a transaction is processed that further reduces the stock on hand.

Stock above maximum

Allocation exceeds quantity on hand

This event is executed only on the first instance that the condition occurs for a specific stock item.

Activation points:

  • Sales Order Entry: When the warehouse is being updated from a new line or from a changed line.
  • Sales Order Single Level Bill of Materials: When updating the warehouse on validating an optional line and when allocating stock.
  • EDI Sales Order Import: When the warehouse is updated as the lines are being checked.
  • Sales Order Purge: When updating the warehouse after allocating a scheduled order line.
  • Sales Order Back Order Releases Import: When the warehouse is updated from an accepted line and when a kit component is updated.
  • Blanket Sales Order Review and Confirmation: When the warehouse is updated because of added lines.
Allocation + minimum exceeds on hand

This event is executed only on the first instance that the condition occurs for a specific stock item.

Activation points:

  • Sales Order Entry: When the warehouse is being updated from a new line or from a changed line.
  • Sales Order Single Level Bill of Materials: When updating the warehouse on validating an optional line and when allocating stock.
  • EDI Sales Order Import: When the warehouse is updated as the lines are being checked.
  • Sales Order Purge: When updating the warehouse after allocating a scheduled order line.
  • Sales Order Back Order Releases Import: When the warehouse is updated from an accepted line and when a kit component is updated.
  • Blanket Sales Order Review and Confirmation: When the warehouse is updated because of added lines.
Goods receipt

Goods in Transit under receipt

Goods in Transit over receipt

Lot quantity on hand falls to zero

Physical cost change

Cost modification

List price or code changed

PO events  
Requisition routed to another user (req & receipt)

Activation point:

  • Purchase Order Receipts - when a purchase order line linked to a requisition is receipted.

  • Requisition Entry – when a requisition line is routed to another user.

    [Note]

    Within the Requisition Entry program you can enable the preference: Trigger event once only when routing consecutive requisition lines to activate this event for each requisition routed to another user, regardless of the number of lines held against the requisition.

Requisition routed to another user (req only) This event is essentially the same as the event: Requisition routed to another user (req & receipt), except that it is only activated for Requisitions and not for Purchase Order Receipts.

The activation point is therefore:

  • Requisition Entry – when a requisition line is routed to another user.

    [Note]

    Within the Requisition Entry program you can enable the preference: Trigger event once only when routing consecutive requisition lines to activate this event for each requisition routed to another user, regardless of the number of lines held against the requisition.

Goods receipt from purchase order

Activation point:

  • Purchase Order Receipts and Inspection - when receipting an item.

    [Note]

    When using this event to trigger an email, the keywords %wh and %other are interchangeable within the email body.

    If, however, you are defining a conditional email, then the %wh keyword must be used to make the mail conditional on the actual warehouse.

    This is because the %other keyword can contain up to 30 characters and will always evaluate the condition on the full 30-characters of the variable (the %other keyword contains the warehouse code in positions 1-2, the purchase order number in positions 4-9, a hyphen (-) in position 10 and the purchase order line number in positions 11-14). To make the mail conditional on the stock code, use the %key keyword.

SO events  
Sales order released from credit check

New sales order fails credit check

This event is triggered when a sales order causes a customer's credit limit to be exceeded and the order is placed in suspense.

Activation points:

  • When converting a quotation to a sales order.

  • When creating a sales order.

  • When copying a sales order.

Credit note issued

Sales order line into backorder

Price overridden by operator

Activation point:

  • Sales Order Entry: When the price (or price code) is overridden at the time of adding a line.

    The event is not activated if maintaining an existing line for which the price has already been overridden (i.e. the price code is '.') and the price is changed again. However, the event is activated if the price code is changed.

Purchase order raised from sales order

Activation point:

  • Sales Order Entry: When a purchase order is created from a sales order.

Purchase order receipt from sales order

Activation point:

  • Purchase Order Receipt: When receipting a purchase order line that is linked to a sales order line. If an item is receipted into inspection, then the event is activated only when the item is accepted.

Invoice process failed during document print

Activation point:

  • This event is only relevant if you are printing an invoice (using the Document Print program), to a device printer and the print Preview option is not selected.

    The event is activated if a failure occurs while printing an invoice and only some lines have been printed, or a failure occurs while the invoice process is in the update phase.

BOM events  
ECC status change event  
WIP events  
Job costs exceed expected

Run hours of operation exceed expected

Job receipted into stock

Quotation events  
Quotation ready for printing

Estimate available for use

Non-stocked pricing available for use

System Admin events  
'File in use' message

Access security breach attempt

Activation point:

  • When an operator attempts to run a program to which the operator does not have access (i.e. when the 'Access denied' message is displayed).
AR Business Objects  
New customer added by ARSSCS  
Customer placed on hold by ARSSCS  
Customer released from hold by ARSSCS  
PO Business Objects  
Explain Select this to view additional information for the highlighted event.
Select Select the highlighted event as the event type.
Close Select this to return to the previous screen.

Reserved words

Reserved words must be entered in lowercase, as indicated in the table.

[Note]

The content of the variable %desc (or %name) varies according to the type of event being triggered.

Usually it contains the description of the bank, or stock code, or customer etc. In some cases, however, there is no obvious description and the table below indicates the text that will be used:

EVENT %DESC CONTENTS
Requisition routed to another user Routing narrative
Purchase order receipts Stock description for the purchase order line

Reserved words in email

Field Description
%key

This indicates the main key field that caused the event (e.g. stock code).

%other

This indicates the secondary or other key that caused the event.

In the case of purchase order receipt events it will contain the warehouse code in positions 1-2, the purchase order number in positions 4-9, a hyphen (-) in position 10 and the purchase order line number in positions 11-14).

For requisition routing, this variable will contain the user from whom the requisition was routed.

For the credit limit event, this variable will contain the following data depending on the program that caused the event to occur:

  • Sales Order Entry - sales order number
  • Invoice Posting - invoice number
  • Cash Posting - check reference
%wh

This indicates the warehouse (for inventory events) in which the warehouse is used.

%desc

This indicates the description of the main key (e.g. stock description). The contents of this field will vary according to the event being triggered.

%name

This reserved word is interchangeable with %desc.

%oper

This indicates the operator who was running the system at the time the event occurred.

%prog

This indicates the name of the program that was running at the time the event occurred (e.g. IMP010 would be inserted if the Inventory Movements program caused the event to occur).

%prgdesc

This indicates the description of the program running at the time the event occurred (e.g. Inventory Movements would be inserted if the program IMP010 caused the event to occur).

%balance

This indicates the balance of the main key after the event (e.g. if the event is Bank balance < parameter then %balance would contain the balance of the bank after the event has occurred.

This reserved word is applicable only to events for which this makes any sense (i.e. the Bank balance event).

For the credit limit events, %balance refers to the percentage of the customer's balance versus the credit limit. Therefore, if the balance of the customer (including outstanding order value) after the event, is standing at 56% of the credit limit, then %balance would contain 56.

%onhand

This works in a similar way to the %balance reserved word, but applies to stock warehouse events only. Therefore, %onhand will contain the stock on hand after the stock warehouse event has occurred.

%value

This indicates the value of the transaction that caused the event (e.g. if event is Bank balance < parameter and the withdrawal value is $1000 then %value would contain 1000). This reserved word is applicable only to events for which this is appropriate.

%qty

This indicates the quantity of the transaction that caused the event (e.g. if the stock on hand falls to below safety, then %qty would contain the quantity of the transaction that caused the on hand to fall below safety. This reserved word is applicable only to events for which this is appropriate.

%coid

This indicates the company id being currently processed.

Reserved words in the command line

Field Description
%key

This indicates the main key field that caused the event (e.g. stock code).

%other

This indicates the secondary or other key that caused the event (e.g. warehouse in the case of events relating to the stock warehouse file).

%desc

This indicates the description of the main key (e.g. stock description).

%name

This reserved word is interchangeable with %desc.

%oper

This indicates the operator who was running the system at the time the event occurred.

%coid

This indicates the company id being currently processed.

%log

This indicates the key to the log record just written (i.e. the application can read directly onto the event log file and retrieve the information required about the event).

%qty

This indicates the transaction quantity (inventory-related events).

%wh

This indicates the warehouse code (inventory-related events).

%onhand

This indicates the quantity on hand balance (inventory-related events).

Examples

Example 1:

The following example describes how you would set up an event to email a specific person if the quantity of stock item A113 in warehouse 'S' falls below the minimum quantity.

  1. From the listview pane of the Event Management program, select Add from the Edit menu. Alternatively, select the Add icon from the toolbar.

  2. Enter a name for the event (for example Stock A113 Below Minimum).

  3. At the Event field, select the option: Stock less than minimum.

  4. At the Type field, select Email.

  5. Optionally enter a description for the event.

  6. At the email Subject field, enter %key below minimum.

  7. In the email body, enter: For warehouse %wh

  8. Select the option: No default Email recipient

  9. Select the function: Conditional Email by List

  10. From the Event Mail Selection Maintenance listview, select Add from the Edit menu. Alternatively, select the Add icon from the toolbar.

  11. Accept the default line number displayed.

  12. At the Expression field, enter %key = "A113" AND %wh = "S"

  13. At the Recipient List field enter the name of the person the email must be sent to when the event occurs.

  14. Select the Save function from the Event Mail Selection Maintenance screen.

  15. Select the Save function from the Add Event screen.

Notes and warnings

Prerequisites

  • The Office Automation and Messaging module must be installed as part of your registration license before you can use this program (Company Maintenance).

Restrictions and limits

  • If you intend using the e-mail facility of this program, you must have either Microsoft Exchange or Microsoft Outlook installed on your workstation.

  • Events of type SYSPRO are only triggered when the specified condition is met from within a SYSPRO program and not when the transaction is processed via e.Net.

    For example, a trigger will fire when a sales order is created using the IMP040 program, but the same trigger will not fire when the order is created using the SORTOI business object.

Add an event

  • From the Event Management program select Add from the Edit menu.

    Alternatively, select the Add icon from the toolbar.

Change an event

  • From the Event Management program select Change from the Edit menu.

    Alternatively, select the Change icon from the toolbar.

Delete an event

  • From the Event Management program select Delete from the Edit menu.

    Alternatively, select the Edit icon from the toolbar.

View log file

This task enables you to view and/or report on the log file created from transactions generated by the Event Management program.