Click or drag to resize

OpsEventType Enumeration

Enumeration of all ops event types

Namespace:  Micros.PosCore.Extensibility.Ops
Assembly:  PosCore (in PosCore.dll) Version: 18.2
Syntax
C#
public enum OpsEventType
Members
  Member nameDescription
OpsSignInPreviewEventCalled prior to an employee sign in
OpsSignInEventCalled when an employee has signed in
OpsSignOutPreviewEventCalled prior to an employee signing out, either manually or automatically
OpsSignOutEventCalled when an employe has signed out, either manually or automatically
OpsClockEventUsed for both clock in and out when workstation is in 'red mode' (disconnected from network)
OpsClockInPreviewEventCalled prior to a clock-in
OpsClockInEventCalled after clock-in
OpsClockOutPreviewEventCalled prior to a clock-out
OpsClockOutEventCalled after clock-out
OpsAsciiDataPreviewEventCalled prior to processing ASCII data
OpsAsciiDataEventCalled when ASCII data is entered
OpsMiVoidPreviewEventCalled prior to a menu item being voided
OpsMiReturnPreviewEventCalled prior to a menu item being returned
OpsMiPreviewEventCalled prior to a menu item being ordered
OpsMiVoidEventCalled when a menu item has been voided
OpsMiReturnEventCalled when a menu item has been returned
OpsMiEventCalled when a menu item has been ordered
OpsMiCancelledReturnEventCalled when a menu item return has been cancelled
OpsMiCancelledVoidEventCalled when a menu item void has been cancelled
OpsMiCancelledEventCalled when a menu item being ordered has been cancelled
OpsDscEventCalled when a discount is applied
OpsDscPreviewEventCalled prior to when a discount is applied
OpsDscCancelledVoidEventCalled when a discount void has been cancelled
OpsDscCancelledEventCalled when a discount has been cancelled
OpsDscVoidEventCalled when a discount is voided
OpsDscVoidPreviewEventCalled prior to when a discount is voided
OpsSvcEventCalled when a service charge is applied
OpsSvcPreviewEventCalled prior to when a service charge is applied
OpsSvcVoidEventCalled when a service charge is void
OpsSvcVoidPreviewEventCalled prior to when a service charge is voided
OpsSvcCancelledVoidEventCall when voiding a service charge has been cancelled
OpsSvcCancelledEventCalled when applying a service charge has been cancelled
OpsExtensibilityEventCalled when extensibility data has been removed from a check either by void or transaction cancel
OpsExtensibilityPreviewEventCalled prior to when extensibility data has been removed from a check either by void or transaction cancel
OpsExtensibilityVoidPreviewEventCalled prior when extensibility data will be voided
OpsExtensibilityCancelledVoidEventCalled when a void of extensibility detail has been cancelled
OpsExtensibilityCancelledEventCalled when adding extensibility data to a check has been cancelled.
OpsExtensibilityVoidEventCalled when extensibility data has been voided
OpsSvcTotalEventCalled when a check has been service totalled
OpsSvcTotalPreviewEventCalled prior to when a check has been service totalled
OpsPickupLoanEventCalled when there is a pickup loan
OpsPickupLoanPreviewEventCalled prior to when there is a pickup loan
OpsTndrEvent(Only used for SIM)
OpsTndrPreviewEvent(Only used for SIM)
OpsTmedEventCalled when a tender has been applied
OpsTmedPreviewEventCalled prior to a tender being applied
OpsTmedVoidEventCalled when a tender has been voided
OpsTmedVoidPreviewEventCalled prior to a tender bring voided
OpsFinalTenderEventCalled when the final tender of a check has been applied (balance is 0)
OpsDetailFormatQueryEventCalled to allow extensibility the 'last chance' to reformat the detail before it is displayed to its target type
OpsSelectedItemChangedEventCalled when the selected item in the main detail has changed
OpsSelectedItemCompleteQueryEvent Called to allow extensibility to determine if the parent item is complete. Sometimes the rules for condiments encoded in the database are not sufficient to allow or disallow the ordering of certain items. By capturing this event extensibility writers can inspect the parent item and its condiments and perform custom logic particular to the target establishment's business rules.
OpsAddCheckEventCalled when a check has been added to the current check
OpsAddCheckEventPreviewCalled prior to adding a check to the current check
OpsAdjustClosedCheckEventCalled when the function "Adjust Closed Check" has been completed.
OpsAdjustClosedCheckEventPreviewCalled prior to when the function "Adjust Closed Check" has been completed.
OpsBeginCheckEventCalled when a new check is begun
OpsBeginCheckEventPreviewCalled prior to when a new check is begun
OpsCloseCheckEventCalled when a check is closed
OpsCloseCheckEventPreviewCalled prior to when a check is closed
OpsReprintClosedCheckEventCalled when a closed check is being reprinted
OpsReprintClosedCheckEventPreviewCalled prior to when a closed check is being reprinted
OpsReopenClosedCheckEventCalled when a check is reopened
OpsReopenClosedCheckEventPreviewCalled prior to when a check is reopened
OpsPickUpCheckEventCalled when a check is picked up
OpsPickUpCheckEventPreviewCalled prior to a check being picked up
OpsTransferCheckEventCalled when a check is transferred
OpsTransferCheckEventPreviewCalled prior to a check being transferred
OpsVoidCheckEventCalled when a check is being voided
OpsVoidCheckEventPreviewCalled prior to a check being previewed
OpsVoidClosedCheckEventCalled when a closed check is voided
OpsVoidClosedCheckEventPreviewCalled prior to a void check being voided
OpsCancelOrderEventCalled when an order is cancelled and DOM is enabled (RVC Parameter | General | 50 – Enable Dynamic Order Mode). If DOM is not enabled, the TransactionCancel events will be called instead.
OpsCancelOrderEventPreviewCalled prior to when an order is being cancelled. See documentation for OpsCancelOrderEvent.
OpsPrinterDataEventCalled when header or footer lines that starts with "@@". Data to be printed can be added in PrinterData.
OpsTransactionCancelPreviewEventCalled prior to a transaction cancel
OpsTransactionCancelEventCalled when a transaction is cancelled
OpsPageLoadedEventCalled when a page is loaded
OpsCommandPreviewEventCalled prior to when a command is processed (e.g. in response to a Command Button press on a page)
OpsCommandEventCalled when a command is processed (e.g. in response to a Command Button press on a page)
OpsReceiptCountEventCalled to allows extensibility to set the number of receipts to be printed. Defaults to 1.
OpsCustomReceiptEventCalled to allow customization of text on a guest receipt
OpsFormatCheckNumberEventCalled to allow customization of check number
OpsVoidReasonEvent Allows extensibility to override the option bit controlling prompting for a void reason code. If extensibility sets the 'Prompt' field to false then there will be no prompt for a reason code.
OpsCustomOrderDeviceEventArgsCalled when an order device with a configured custom string is accessed
OpsVoucherEventCalled when a voucher is printed.
OpsAuthorizationEventCalled when a manager authorization is required
OpsAuthorizationPreviewEventCalled prior to when a manager authorization is required
OpsChangeServingPeriodEventCalled when the serving period has changed
OpsChangeServingPeriodPreviewEventCalled prior to when the serving period has changed
OpsNoSaleEventCalled on the 'no sale' function
OpsNoSalePreviewEventCalled prior to the 'no sale' function
OpsOrderTypeChangedEventCalled when the order type has changed
OpsOrderTypeChangedPreviewEventCalled prior to the order type being changed
OpsOpenCashDrawerEventCalled when a cash drawer is opened
OpsCloseCashDrawerEventCalled when a cash drawer is closed
OpsAssignCashDrawerEventCalled when a cash drawer is assigned
OpsUnassignCashDrawerEventCalled when a cash drawer is unassigned
OpsStartSimEvent(Called for SIM on start up)
OpsWorkstationUpEvent(Called for SIM on start up)
OpsExitSimEvent(Called for SIM on exit)
OpsWorkstationDownEvent(Called for SIM when workstation is down)
OpsDiscountOverrideEvent Called to allow extensibility to change the amount of a discount. Typically this is used to prevent the entered discount from exceeding some predetermined limit. For example, there may be a 10% employee discount but there is a maximum per day If an extensibility application kept track of discounts by employee by day then it could lower the discount amount based on the daily totals for that employee.
OpsChangeDueEventCalled when the change due dialog is displayed
OpsTaxDueEventCalled when a payment has occurred. The tax due is passed in.
OpsTotalDueEventCalled when a payment has occurred. The total tue is passed in.
OpsReadyEventCalled when OPS has been initialized and is ready
OpsAutomaticDiscountEventCalled when a payment has occurred. This event will be called for each automatic discount on the check.
OpsReportGeneratedEventCalled when a report is generated.
OpsReportGeneratedPreviewEventCalled prior to a report being generated
OpsCreditCardAuthorizationEventCalled when a credit card has been authorized.
OpsCreditCardAuthorizationPreviewEventCalled prior to when a credit card has been authorized.
OpsActiveKitchenThemeEventCalled when the kitchen theme has changed
OpsErrorMessageEventCalled when OPS displays an error message. Useful for logging.
OpsTimerEvent(SIM only)
OpsNewTransactionEventCalled when a new transaction is being initialized.
OpsSystemCancelOrderEventCalled when OPS has been configured to cancel old orders.
OpsSystemCancelOrderPreviewEventCalled prior to when OPS is configured to cancel old orders.
OpsExitEventCalled when OPS is closed
OpsInitEventCalled when OPS is started.
CAPSStartFailureNotificationEvent Called when CAPS (Check and Posting) fails to start. Since this failure occurs in the background capturing this event means extensibility can take appropriate action such as displayed a message to the user every 15 minutes.
OpsDatabaseTablesChangedEventCalled after the in-memory database has been updated
OpsWeighedMiEventCalled when a weighed item is ordered. Allows the tare weight to be set or changed.
OpsNavigationItemSelectedEventCalled when a navigation item is selected.
OpsBackupKdsActiveEventCalled when activate backup or restore primary KDS Controller.
OpsAsyncExtensibilityMessageCalled when activate backup or restore primary KDS Controller.
OpsItemDoneEventCalled on item done in conversational ordering
OpsItemSelectedEventCalled on item selected in conversational ordering
OpsDiscountEnginePreviewEventCalled prior to when a discount engine fires off
OpsDiscountEngineEventCalled when a discount has fired off
OpsShiftIncrementEventCalled when shift is incremented for an Employee or a Cashier
OpsCheckForOpenChecksEvent Called when user clicks "Yes" button of the message "There are no more open checks. Check again?"
OpsEventsStartPreviewEvent
OpsEventsStartEvent
OpsEventsEndPreviewEvent
OpsEventsEndEvent
OpsEventsSelectPreviewEvent
OpsEventsSelectEvent
OpsCMBankDepositReferenceEntryEventCall When In cash Management Reference Entry value is required
OpsCheckCashDrawerEvent
See Also