Oracle® MICROS Simphony
Simphony JavaScript Extensibility API Reference Guide
Release 19.8
January 2025
Copyright
© 2025, Oracle and/or its affiliates.
Introduction
- JavaScript Extensibility will provide the same functionality around
OpsContext and DataStore as SIM and .Net Extensibility provide today. It
will provide the ability to subscribe to the same events that exist
today. Transaction Services and Extension Application Service (EAS) will
introduce a new API.
- JavaScript Extensibility executes under Windows, Linux and Android
and provides the same API (excl. platform specific limitations)
- JavaScript Extensibility executes under OPS, Transaction Services
and Kiosk and handles the appropriate events of the client.
- Replacing / Updating JavaScript does not require any ServiceHost
restart, subject to certain limitations.
- Ability to debug JavaScript as much as technically feasible and
without creating any security concerns is available
- JavaScript Extensibility will utilize the existing HTML5 custom
dialogs for any custom UI required with OPS. Any custom UI is handled as
a modal dialog. Any new UI requirements, such as in-page html controls,
will not be covered as part of the initial release.
Solution Overview
History of Simphony
Extensibility
Before Simphony version 19.6 two different Extensibility features
were available, these are part of the product almost since its initial
release. * SIM (System Interface Module) which is an interpreter using a
proprietary scripting language named Interface Script Language (ISL). No
development environment is needed to produce a SIM script. SIM scripts
are imported into the Simphony EMC. SIM scripts are not written out to
the disk, they are only present in memory on the POS client. SIM permits
to load and use .Net Framework assemblies as well as 3rd party
assemblies. SIM scripts that are not making use of any assembly will
reload without any restart of POS client. If any assembly is in use a
restart is required to fully reload an update. SIM supports POS clients
running Windows, Linux or Android. * .Net Extensibility which is a
published interface/API that allows 3rd party to build assemblies and
import those into Simphony EMC. A development environment is required,
next to basic understanding on how to build .Net Extensibility.
Extensibility assemblies are synced to the POS client DB. Writing them
out to disk and loading an assembly will only happen after the POS
client was restarted. .Net Extensibility also includes Extension
Application Service, which allows message based functionality outside of
POS operations. .Net Extensibility supports POS client running Windows
or Linux
No published Simphony Extensibility was available for Simphony
Transaction Services.
Introduction
of Simphony JavaScript Extensibility
With Simphony version 19.6 a new Simphony JavaScript Extensibility
API is introduced that includes the following features: * POS Client
Extensibility * Extension Application Service (EAS) * Transaction
Services Extensibility
Simphony JavaScript Extensibility uses an engine to process the
JavaScript provided. This is NOT a browser JavaScript environment. It
does not run in CEF (Chromium Embedded Framework) that is utilized for
i.e. Custom HTML5 dialogs. The JavaScript engine does not contain a DOM,
Window or built-in browser objects like XmlHttpRequest. Any 3rd party
library, like JQuery, that depends on a browser DOM or the presence of
XmlHttpRequest will not load.
Simphony JavaScript Extensibility has no relation to any JavaScript
being utilized within OPS Custom HTML5 dialogs, these are separate
entities. OPS Custom HTML5 dialogs are using a dedicated Simphony
JavaScript API named POSDialogAPI, without any relation to Simphony
JavaScript Extensibility.
Simphony JavaScript Extensibility has no relation to any JavaScript
being utilized within the HTML Kiosk, these are separate entities. HTML
Kiosk is using a dedicated JavaScript API named SimphonyKioskAPI,
without any relation to Simphony JavaScript Extensibility.
EMC Configuration
Each Host-Type / Environment (OPS, Transaction Services,
Extensibility Service, Kiosk) must use its own “root script”, i.e. if
support for OPS and STS is required, you need to have one root-script
for OPS and one root-script for Transaction Services.
This is an administrative limitation that is enforced to ensure the
correct script is loaded for the host-type in use. Nothing prevents you
from keeping a root script to the bare minimum and implement any logic
in a ‘common’ script (that can be used via import). On the other side if
there is only OPS support required, nothing stops you from having all
code reside in the single root-script.
Extension Application
Configuring Extension Application requires a privilege in the EMC
Roles module. Please ensure that this was granted.
In EMC, select the Enterprise, property, revenue center, or zone,
click Setup, and then click Extension Application.
Add a new record or edit an existing Extension Application record.
This will present on overview of any Application Content that is
available.
To insert a new JavaScript Application Content click on
Insert Application Content. Provide a
meaningful value for Zoneable Key and optionally a description.
In the following form, set Content Type to 22 -
Javascript and either enter your script or import this from a
file.
Switch back to the General tab and set the Host
Type to the correct value as explained in the previous chapter.
Calling
a JavaScript extensibility method via a Page button
globalThis
is the shorthand way to expose a method to
the global namespace of the JavaScript engine. Functions in general are
private.
The button should be configured as Function | Sim
Inquire. The button “Argument” should be:
extAppName:functionName[:arg1[:arg2[:arg3]]]
for example:
myExtApp:myFunction
myExtApp:myFunction:1
myExtApp:myFunction:1:localhost:tcp
In each case the arguments are pass in as strings.
globalThis
examples
//---------------------------------------------------
// No arguments for the exposed method
//---------------------------------------------------
globalThis.myFunction= function ()
{
//Your code
}
//---------------------------------------------------
// One argument for the exposed method
//---------------------------------------------------
globalThis.myFunction= function (a1)
{
//Your code
}
//---------------------------------------------------
// Two arguments for the exposed method
//---------------------------------------------------
globalThis.myFunction= function (a1, a2)
{
//Your code
}
Javascript API Object
The javascript engine has one object injected into its namespace:
SimphonyExtensibilityAPI.
- All API methods/properties are available on this object.
- The API object is grouped into various namespaces; an API of
APIs.
- Each sub-API contains methods/properties specific to its area of
interest.
Notes:
While many of these methods/properties are not available
elsewhere, some are shortcuts to existing functionality. The shortcuts
are provided when using existing functionality is syntactically
cumbersome.
- “AllocateXYZ()” methods are useful as the script writer does not
have to remember where the objects are available in the PosCore
namespace.
- “DynamicEnum” methods return javascript-friendly enumerations.
It should be understood that this documentation is for the latest
version of the API. It can be difficult to determine what is available
in your version of software. Therefore, we have added a method on the
API itself to provide every available method and property on that
version. The SimphonyExtensibilityAPI.GetDocumentation()
method provides a very compact representation of the API and can be
useful when developing in many versions of software.
SimphonyExtensibilityAPI
string GetDocumentation( string format ) |
This method returns a string which lists
the objects/properties/methods of the API for that version of
ServiceHost. The returned string can be saved to disk by the JS
extensibility application using the System.IO.File.WriteAllText()
method. The parameter specifies the format of the return string,
currently ignored. The current implementation returns a C#-like API
specification. |
Logger
The Logger object defines properties/methods for logging to the
ServiceHost EGateway log file. All logging is filtered through the
“ExtApps” setting in wwwroot_LoadHandlers.txt. The “ExtApps” setting
applies to all extension applications. One cannot raise a log level for
a particular extension application.
Log( string text ) |
logs a single line of text to the
ServiceHost egateway log. Equivalent to LogAlways(). |
Log( int logLevel‚ string text ) |
logs a single line of text to the
ServiceHost egateway log with respect to the ExtApps setting. For
example, if the ExtApps setting is 2, then the line will be written to
the log if the logLevel parameter is 0-2. |
LogAlways( string text ) |
always logs a single line of text to the
ServiceHost egateway log |
LogLightFlow( string text ) |
logs a single line of text to the
ServiceHost egateway log when the ExtApps setting is 1 or higher. |
LogGeneralFlow( string text ) |
logs a single line of text to the
ServiceHost egateway log when the ExtApps setting is 2 or higher. |
LogDetailFlow( string text ) |
logs a single line of text to the
ServiceHost egateway log when the ExtApps setting is 3 or higher. |
LogBufferDumps( string text ) |
logs a single line of text to the
ServiceHost egateway log when the ExtApps setting is 4 or higher. |
LogError( string text ) |
always logs a single line of text to the
ServiceHost egateway log with the “error” indication. |
LogWarn( string text ) |
always logs a single line of text to the
ServiceHost egateway log with the “warning” indication. |
LogInfo( string text ) |
always logs a single line of text to the
ServiceHost egateway log with the “info” indication. |
LogDebug( string text ) |
always logs a single line of text to the
ServiceHost egateway log with the “debug” indication. |
LogException( string text‚ Exception ex ) |
always logs a single line of text to the
ServiceHost egateway log. The exception must be provided. |
string Prefix |
string which identifies the current
running context. This includes the ext app name, script name, engine
type (root, worker,…), engine ID. This is useful for console.log()
functions. Every Logger.Log() message contains this prefix. |
int WsLogVerbosity |
This property corresponds to the “log
verbosity” setting in the workstation entry for this ServiceHost. It is
configured in EMC. |
Instance
The Instance object provides data specific to that specific
javascript engine instance of the script that accesses it.
string EngineType |
the engine type: “Root”, “Worker”,
“Service” |
long EngineID |
unique ID for the currently running
engine, similar to a thread id. Engine IDs are unique throughout the
lifetime of the ServiceHost application. Engine IDs can be used to send
messages from one engine to another, as well as identifying log
statements for a particular engine |
string EngineName |
The user-supplied name of the worker
engine. This is set the WorkerParameters object when creating a worker.
If an engine name is not supplied one will be generated
automatically. |
ApiWorkerParameters WorkerParameters |
The worker parameters object supplied when
creating the worker engine. This is valid only for worker engines and is
null otherwise. The ‘argument’ property for the worker can be access
from this object. |
ApiServiceParameters ServiceParameters |
The service parameters object supplied
when specifying |
Runtime
The Runtime object supplies properties/methods that pertain to the
javascript extensibility environment.
ApiWorkerParameters AllocateWorkerParameters() |
This method should be used by a script to
allocate parameters required for creating a worker engine. |
CreateWorker( ApiWorkerParameters parms ) |
Creates a worker engine. The engine will
start running soon after this method call. The engine will run on a
separate thread and will have access to the parameters used to create
it. |
ApiServiceParameters AllocateServiceParameters() |
method to allocate a ServiceParameters
object, used by transaction services and extension application services
to define the service script. |
ApiServiceParameters SetService( ApiServiceParameters serviceParameters ) |
method to set the service script for
transaction services and extensibility services |
HostType |
enumeration of the host type of the ext
app: OPS, TransactionServices, ExtensibilityService |
string ApplicationName |
the name of the extensibility application
for that script |
int ServiceHostID |
the current ServiceHostID of the
workstation |
bool ShutdownPending |
true if a shutdown is pending. Worker
engines can use this to detect if a service host shutdown is pending OR
the ext app is being destroyed. |
ApiWorkerParameters
string ContentName |
The extension application content zoneable
key for the worker script. This field must be set by the script. |
string Argument |
Optional string argument to be passed to a
worker. |
string Name |
Optional name for a worker engine. |
long ParentEngineID |
The engine ID of the engine that created
the worker. This ID can be used to send messages back to a parent
engine. |
ApiServiceParameters
string ContentName |
The extension application content zoneable
key for the service script. This field must be set by the script. |
Eventing
bool SubscribeToEvent( string eventID‚ object method ) |
subscribe to extensibility event,
equivalent to similar method in C#/SIM |
bool UnSubscribeFromEvent( string eventID‚ object method ) |
unsubscribe from extensibility event,
equivalent to similar method in C#/SIM |
PostMessage( long engineID‚ string message ) |
post message to a different engine in the
same ext application/host type context. An OPS engine cannot send a
message to a transaction services engine. |
PostMessageToRoot( string message ) |
shortcut for PostMessage() to the root
engine of the currently running ext app |
object GetNextEvent( int timeoutMS ) |
worker engines can receive events, this
method is used to pull the next event from the event queue associated
with that engine |
WaitForHtmlDialog( ExtensibilityHtmlDialogParameters parms‚ object method ) |
similar to the WaitForHtmlDialog in
SIM |
Continue |
shortcut to
EventProcessingInstruction.Continue |
AbortEvent |
shortcut to
EventProcessingInstruction.AbortEvent |
AbortEventMonitorProcessingAndContinueEvent |
shortcut to
EventProcessingInstruction.AbortEventMonitorProcessingAndContinueEvent |
Common
SleepMS( int milliseconds ) |
shortcut to System.Threading.Thread.Sleep(
milliseconds ) |
AllocateByteList() |
shortcut to allocate a generic byte
list |
AllocateStringList() |
shortcut to allocate a generic string
list |
object AllocatePosPrinterData() |
shortcut to allocate PosPrinterData
without parameters |
object AllocatePosPrinterData( TextAttribute textAtt‚ TextAlignment textAlign‚ TextSize textSize ) |
shortcut to allocate PosPrinterData with
parameters |
ExtensibilityDataInfo AllocateExtensibilityDataInfo( string name‚ string dataName‚ string textData ) |
use this to allocate extensibility data
based on string |
ExtensibilityDataInfo AllocateExtensibilityDataInfo( string name‚ string dataName‚ Byte[] binData ) |
use this to allocate extensibility data
based on Byte array |
object LoadCommonNetAsssembles( String[] assemblies ) |
load common .net assemblies and return
reference (mscorlib, System, System.Core) |
object LoadPosCore() |
load PosCore assembly and return
reference |
object LoadPosCommonClasses() |
load PosCommonClasses assembly and return
reference |
object LoadOps() |
load Ops assembly and return
reference |
string ReadConfigurationValue( string key‚ string dflt ) |
read a configuration value from
web.config.txt |
int ReadConfigurationValue( string key‚ int dflt ) |
read a configuration value from
web.config.txt and convert to an integer |
Context (any Host-Type)
string MapRootPath( string fileName ) |
Get application root path based on
file-name provided |
string PropertyNumber |
Property number as configured in EMC |
long PropHierStrucID |
internal Hierarchy Structure ID for this
Property |
int PropertyID |
internal Property ID |
string PropertyName |
Property name as configured in EMC |
string WorkstationName |
Workstation name as configured in EMC |
int WorkstationNumber |
Workstation number as configured in
EMC |
int WorkstationID |
internal Workstation ID |
string HostName |
Host-name of the device |
int OrganizationId |
internal Organization ID |
int LocationId |
internal Location ID |
int CurrentLangId |
internal, current Language ID |
int CurrentLangObjNum |
current Language object number |
Networking Networking |
Networking object |
int ServiceHostID |
internal ServiceHost ID |
string EGatewayURL |
URL of the EGateway resource |
string Version |
Version string of Simphony |
string IPaddress |
IP address of the device |
ApiOperatingSystem OperatingSystem |
see ApiOperatingSystem members below |
ApiOperatingSystem
bool IsWin32 |
True when running under Windows |
bool IsNotWin32 |
True for both Android and Linux |
bool IsAndroid |
True when running under Android |
bool IsLinux |
True when running under Linux |
Android camera to scan
barcodes/QR codes
Overview
The Simphony Android POS client has the capability to read barcodes
and QR codes from Android device’s camera using the third party library
Google MLkit.
The key functions of the Android Barcode scanner feature are:
- The Android POS application opens the camera with a button
click.
- SimphonyExtensibilityAPI is used to subscribe to Barcode events
- When a barcode or QR code is scanned, the POS sends the
Extensibility Barcode event to all subscribed JavaScript Extensibility
scripts.
- The JavaScript Extensibility scripts examine the Barcode data. They
might display or use the data, the format and the type of Barcode or QR
code on Ops.
Subscribing to Barcode
Scanner Events
JavaScript Extensibility scripts use the standard model for
subscribing to POS events. JavaScript Extensibility scripts use the
standard model for subscribing to POS events.
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsBarcodePreviewEvent', OnOpsBarCodeEvent);
Consuming Barcode Scanner
Events
The Barcode Scanner event follows the standard SIM event method
signature. The args are of type
OpsBarcodePreviewEventArgs
.
function OnOpsBarCodeEvent(sender, args)
{
if (!args.Handled)
{
args.Handled = true;
if (args.BarcodeString != null)
{
showMessage('Barcode' + args.BarcodeType +',' + args.BarcodeFormat + ',' + args.BarcodeString + ',' + args.RawBarcodeString );
}
else
{
showMessage('No Barcode scanned!');
}
}
return _api.Eventing.Continue;
}
All JavaScript Extensibility scripts that subscribe to this event are
executed. It is critical to validate that no other JavaScript
Extensibility script has consumed this data. It is also important for
JavaScript Extensibility scripts to set Handled
to true, so
that Barcode events are not processed twice. This should only be done if
the JavaScript Extensibility event consumes the Barcode scanner
data.
Notes on OpsBarcodePreviewEventArgs
:
ManuallyEntered |
Set if the barcode is keyed in rather than
scanned, using an Ops command. |
BarcodeType |
Get the barcode or QR code type. |
BarcodeFormat |
Get the barcode or QR code format. |
BarcodeString |
Get the barcode or QR code string
data. |
RawBarcodeString |
Sometimes the barcode or QR code string
data is set as rawdata. |
Handled |
Set to true when a JavaScript
Extensibility script consumes this Barcode. |
Limitations
This feature is only available for Android devices with camera.
Sample JavaScript
Extensibility Script
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsBarcodePreviewEvent', OnOpsBarCodeEvent);
//The button should be configured as Function | Sim Inquire. The button "Argument" should be <extAppName>:scanbarcode
globalThis.scanbarcode = function ()
{
// Open the camera and allow a barcode scan
_api.Environment.Context.CameraScanBarcodeOpen()
}
function OnOpsBarCodeEvent(sender, args)
{
if (!args.Handled)
{
args.Handled = true;
if (args.BarcodeString != null)
{
showMessage('Barcode' + args.BarcodeType +',' + args.BarcodeFormat + ',' + args.BarcodeString + ',' + args.RawBarcodeString );
}
else
{
showMessage('No Barcode scanned!');
}
}
return _api.Eventing.Continue;
}
function showMessage(msg)
{
let line = `${_api.Runtime.ApplicationName}: ${msg}`;
_api.Environment.Context.ShowMessage(line);
}
POS Events
Simphony OPS Extensibility (SIM, .Net) is event-oriented. JavaScript
Extensibility maintains this event oriented architecture in OPS also and
uses it in other Host-Types(Transaction Services, Kiosk, Extension
Application Service).
- Possible events(not complete). OPS provides currently 160+ events
- Menu-Item is rung and about to be posted(OPS)
- Service-Charge was rung and was posted(OPS)
- Check is about to be posted(OPS, STS and Kiosk)
- Inquiry / Run Extensibility App key is pressed(OPS)
- Extension Application Service(EAS) received message from a
client
- JavaScript engine receives application message(JavaScript
Extensibility)
- JavaScript engine is initialized(JavaScript Extensibility)
- JavaScript engine encountered any unhandled exception(JavaScript
Extensibility)
- Simphony OPS Extensibility is triggered by subscribing to an event.
JavaScript Extensibility continues to use this logic.
- JavaScript Extensibility for Transaction Services and Extension
Application Service (EAS) inherits this logic and is also based on
subscribing to events.
CAPSStartFailureNotificationEvent
Description: 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.
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('CAPSStartFailureNotificationEvent', method);
Arguments:
CAPSStartFailureNotificationEventArgs
OpsActiveKitchenThemeEvent
Description: Called when the kitchen theme has changed
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsActiveKitchenThemeEvent', method);
Arguments:
OpsActiveKithenThemeEventArgs
- Property: OpsActiveKithenThemeEventArgs.KdsThemeID
(System.Int64)
- Property: OpsActiveKithenThemeEventArgs.UpdateTime
(System.DateTime)
OpsAddCheckEvent
Description: Called when a check has been added to the current
check
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsAddCheckEvent', method);
Arguments:
OpsAddCheckEventArgs
OpsAddCheckEventPreview
Description: Called prior to adding a check to the current check
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsAddCheckEventPreview', method);
Arguments:
OpsAddCheckEventArgs
OpsAdjustClosedCheckEvent
Description: Called when the function “Adjust Closed Check” has been
completed.
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsAdjustClosedCheckEvent', method);
Arguments:
OpsAdjustClosedCheckEventArgs
- Property: OpsAdjustClosedCheckEventArgs.CheckCloseTime
(System.DateTime)
- Property: OpsAdjustClosedCheckEventArgs.CheckGuid
(System.String)
- Property: OpsAdjustClosedCheckEventArgs.CheckNumber
(System.Int32)
- Property: OpsAdjustClosedCheckEventArgs.CheckOpenTime
(System.DateTime)
- Property: OpsAdjustClosedCheckEventArgs.VssBasicData
(System.String)
- Property: OpsAdjustClosedCheckEventArgs.VssExtendedData
(System.String)
OpsAdjustClosedCheckEventPreview
Description: Called prior to when the function “Adjust Closed Check”
has been completed.
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsAdjustClosedCheckEventPreview', method);
Arguments:
OpsAdjustClosedCheckEventArgs
- Property: OpsAdjustClosedCheckEventArgs.CheckCloseTime
(System.DateTime)
- Property: OpsAdjustClosedCheckEventArgs.CheckGuid
(System.String)
- Property: OpsAdjustClosedCheckEventArgs.CheckNumber
(System.Int32)
- Property: OpsAdjustClosedCheckEventArgs.CheckOpenTime
(System.DateTime)
- Property: OpsAdjustClosedCheckEventArgs.VssBasicData
(System.String)
- Property: OpsAdjustClosedCheckEventArgs.VssExtendedData
(System.String)
OpsAndroidNfcEvent
Description:
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsAndroidNfcEvent', method);
Arguments:
OpsAndroidNfcEventArgs
- Property: OpsAndroidNfcEventArgs.Handled (System.Boolean)
- Property: OpsAndroidNfcEventArgs.Tag (System.Object)
OpsAsciiDataEvent
Description: Called when ASCII data is entered
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsAsciiDataEvent', method);
Arguments:
OpsCommandEventArgs
- Property: OpsCommandEventArgs.Command (System.Object)
OpsAsciiDataPreviewEvent
Description: Called prior to processing ASCII data
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsAsciiDataPreviewEvent', method);
Arguments:
OpsCommandPreviewEventArgs
- Property: OpsCommandPreviewEventArgs.Cancelled (System.Boolean)
- Property: OpsCommandPreviewEventArgs.Command (System.Object)
OpsAssignCashDrawerEvent
Description: Called when a cash drawer is assigned
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsAssignCashDrawerEvent', method);
Arguments:
OpsAssignCashDrawerEventArgs
- Property: OpsAssignCashDrawerEventArgs.CashDrawerNumber
(System.Int32)
OpsAsyncExtensibilityMessage
Description: Called when activate backup or restore primary KDS
Controller.
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsAsyncExtensibilityMessage', method);
Arguments:
OpsAsyncExtensibilityMessageArgs
- Property: OpsAsyncExtensibilityMessageArgs.Application
(System.String)
- Property: OpsAsyncExtensibilityMessageArgs.Arguments
(System.String)
- Property: OpsAsyncExtensibilityMessageArgs.Command
(System.String)
- Property: OpsAsyncExtensibilityMessageArgs.Response
(System.String)
- Property: OpsAsyncExtensibilityMessageArgs.ResponseCode
(System.Int32)
OpsAuthorizationEvent
Description: Called when a manager authorization is required
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsAuthorizationEvent', method);
Arguments:
OpsAuthorizationEventArgs
- Property: OpsAuthorizationEventArgs.AuthorizationDescription
(System.String)
- Property: OpsAuthorizationEventArgs.EmployeeID
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbKey.EmployeeID)
- Property: OpsAuthorizationEventArgs.FirstName (System.String)
- Property: OpsAuthorizationEventArgs.LastName (System.String)
- Property: OpsAuthorizationEventArgs.ObjectNumber (System.Int32)
- Property: OpsAuthorizationEventArgs.Privilege (System.Int32)
OpsAuthorizationPreviewEvent
Description: Called prior to when a manager authorization is
required
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsAuthorizationPreviewEvent', method);
Arguments:
OpsAuthorizationEventArgs
- Property: OpsAuthorizationEventArgs.AuthorizationDescription
(System.String)
- Property: OpsAuthorizationEventArgs.EmployeeID
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbKey.EmployeeID)
- Property: OpsAuthorizationEventArgs.FirstName (System.String)
- Property: OpsAuthorizationEventArgs.LastName (System.String)
- Property: OpsAuthorizationEventArgs.ObjectNumber (System.Int32)
- Property: OpsAuthorizationEventArgs.Privilege (System.Int32)
OpsAutomaticDiscountEvent
Description: Called when a payment has occurred. This event will be
called for each automatic discount on the check.
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsAutomaticDiscountEvent', method);
Arguments:
OpsAutomaticDiscountEventArgs
- Property: OpsAutomaticDiscountEventArgs.Amount (System.Decimal)
- Property: OpsAutomaticDiscountEventArgs.Count (System.Int32)
- Property: OpsAutomaticDiscountEventArgs.ObjectNumber
(System.Int32)
OpsBackupKdsActiveEvent
Description: Called when activate backup or restore primary KDS
Controller.
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsBackupKdsActiveEvent', method);
Arguments:
OpsBackupKdsActiveEventArgs
- Property: OpsBackupKdsActiveEventArgs.BackupIsActive
(System.Boolean)
- Property: OpsBackupKdsActiveEventArgs.KdsControllerID
(System.Int64)
OpsBarcodePreviewEvent
Description: Called prior to a barcode scan being processed
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsBarcodePreviewEvent', method);
Arguments:
OpsBarcodePreviewEventArgs
- Property: OpsBarcodePreviewEventArgs.BarcodeString
(System.String)
- Property: OpsBarcodePreviewEventArgs.ManuallyEntered
(System.Boolean)
OpsBeginCheckEvent
Description: Called when a new check is begun
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsBeginCheckEvent', method);
Arguments:
OpsBeginCheckEventArgs
- Property: OpsBeginCheckEventArgs.VssBasicData (System.String)
- Property: OpsBeginCheckEventArgs.VssExtendedData
(System.String)
OpsBeginCheckEventPreview
Description: Called prior to when a new check is begun
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsBeginCheckEventPreview', method);
Arguments:
OpsBeginCheckEventArgs
- Property: OpsBeginCheckEventArgs.VssBasicData (System.String)
- Property: OpsBeginCheckEventArgs.VssExtendedData
(System.String)
OpsCancelOrderEvent
Description: Called 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.
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsCancelOrderEvent', method);
Arguments:
OpsCancelOrderEventArgs
- Property: OpsCancelOrderEventArgs.EventName (System.String)
OpsCancelOrderEventPreview
Description: Called prior to when an order is being cancelled. See
documentation for OpsCancelOrderEvent.
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsCancelOrderEventPreview', method);
Arguments:
OpsCancelOrderEventArgs
- Property: OpsCancelOrderEventArgs.EventName (System.String)
OpsChangeDueEvent
Description: Called when the change due dialog is displayed
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsChangeDueEvent', method);
Arguments:
OpsChangeDueEventArgs
- Property: OpsChangeDueEventArgs.ChangeDue (System.Decimal)
- Property: OpsChangeDueEventArgs.Count (System.Int32)
- Property: OpsChangeDueEventArgs.ObjectNumber (System.Int32)
- Property: OpsChangeDueEventArgs.PaymentAmount (System.Decimal)
OpsChangeServingPeriodEvent
Description: Called when the serving period has changed
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsChangeServingPeriodEvent', method);
Arguments:
OpsChangeServingPeriodEventArgs
- Property: OpsChangeServingPeriodEventArgs.Procedure
(Micros.PosCore.Extensibility.SIM.ProcedureTypes)
- Property: OpsChangeServingPeriodEventArgs.ProcedureNumber
(System.Int32)
OpsChangeServingPeriodPreviewEvent
Description: Called prior to when the serving period has changed
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsChangeServingPeriodPreviewEvent', method);
Arguments:
OpsChangeServingPeriodEventArgs
- Property: OpsChangeServingPeriodEventArgs.Procedure
(Micros.PosCore.Extensibility.SIM.ProcedureTypes)
- Property: OpsChangeServingPeriodEventArgs.ProcedureNumber
(System.Int32)
OpsCheckCashDrawerEvent
Description:
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsCheckCashDrawerEvent', method);
Arguments: OpsTmedEventArgs
- Property: OpsTmedEventArgs.ChangeDue (System.Decimal)
- Property: OpsTmedEventArgs.ChargeTipTotal (System.Decimal)
- Property: OpsTmedEventArgs.Count (System.Int32)
- Property: OpsTmedEventArgs.CurrencyID
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbKey.CurrencyID)
- Property: OpsTmedEventArgs.Description (System.String)
- Property: OpsTmedEventArgs.EventName (System.String)
- Property: OpsTmedEventArgs.InterfaceLink
(Micros.PosCore.DataStore.DbRecords.DbInterfaceLink)
- Property: OpsTmedEventArgs.IsDebit (System.Boolean)
- Property: OpsTmedEventArgs.IsPayment (System.Boolean)
- Property: OpsTmedEventArgs.Name (System.String)
- Property: OpsTmedEventArgs.ObjectNumber (System.Int32)
- Property: OpsTmedEventArgs.OpenDrawer (System.Boolean)
- Property: OpsTmedEventArgs.PmsTotals
(Micros.PosCore.Checks.PmsTotals)
- Property: OpsTmedEventArgs.ReferenceEntries
(System.Collections.Generic.List`1)
- Property: OpsTmedEventArgs.RestrictLastItemVoid
(System.Boolean)
- Property: OpsTmedEventArgs.SimChangeDue (System.Decimal)
- Property: OpsTmedEventArgs.TillId
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbKey.TillDetailID)
- Property: OpsTmedEventArgs.TmedDef
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbTenderMedia)
- Property: OpsTmedEventArgs.TmedDetail
(Micros.PosCore.Extensibility.Ops.TenderMediaDetail)
- Property: OpsTmedEventArgs.Total (System.Decimal)
- Property: OpsTmedEventArgs.Void (System.Boolean)
- Property: OpsTmedEventArgs.VoidDetailLink (System.Int32)
- Property: OpsTmedEventArgs.VoidReason
(Micros.PosCore.Extensibility.Ops.OpsVoidReason)
OpsCheckForOpenChecksEvent
Description: Called when user clicks “Yes” button of the message
“There are no more open checks. Check again?”
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsCheckForOpenChecksEvent', method);
Arguments:
OpsCheckForOpenChecksEventArgs
OpsClockEvent
Description: Used for both clock in and out when workstation is in
‘red mode’ (disconnected from network)
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsClockEvent', method);
Arguments: OpsClockEventArgs
- Property: OpsClockEventArgs.EmployeeID
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbKey.EmployeeID)
- Property: OpsClockEventArgs.JobID (System.Int32)
- Property: OpsClockEventArgs.OnBreak (System.Boolean)
- Property: OpsClockEventArgs.VssBasicData (System.String)
- Property: OpsClockEventArgs.VssExtendedData (System.String)
OpsClockInEvent
Description: Called after clock-in
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsClockInEvent', method);
Arguments: OpsClockEventArgs
- Property: OpsClockEventArgs.EmployeeID
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbKey.EmployeeID)
- Property: OpsClockEventArgs.JobID (System.Int32)
- Property: OpsClockEventArgs.OnBreak (System.Boolean)
- Property: OpsClockEventArgs.VssBasicData (System.String)
- Property: OpsClockEventArgs.VssExtendedData (System.String)
OpsClockInPreviewEvent
Description: Called prior to a clock-in
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsClockInPreviewEvent', method);
Arguments: OpsClockEventArgs
- Property: OpsClockEventArgs.EmployeeID
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbKey.EmployeeID)
- Property: OpsClockEventArgs.JobID (System.Int32)
- Property: OpsClockEventArgs.OnBreak (System.Boolean)
- Property: OpsClockEventArgs.VssBasicData (System.String)
- Property: OpsClockEventArgs.VssExtendedData (System.String)
OpsClockOutEvent
Description: Called after clock-out
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsClockOutEvent', method);
Arguments: OpsClockEventArgs
- Property: OpsClockEventArgs.EmployeeID
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbKey.EmployeeID)
- Property: OpsClockEventArgs.JobID (System.Int32)
- Property: OpsClockEventArgs.OnBreak (System.Boolean)
- Property: OpsClockEventArgs.VssBasicData (System.String)
- Property: OpsClockEventArgs.VssExtendedData (System.String)
OpsClockOutPreviewEvent
Description: Called prior to a clock-out
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsClockOutPreviewEvent', method);
Arguments: OpsClockEventArgs
- Property: OpsClockEventArgs.EmployeeID
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbKey.EmployeeID)
- Property: OpsClockEventArgs.JobID (System.Int32)
- Property: OpsClockEventArgs.OnBreak (System.Boolean)
- Property: OpsClockEventArgs.VssBasicData (System.String)
- Property: OpsClockEventArgs.VssExtendedData (System.String)
OpsCloseCashDrawerEvent
Description: Called when a cash drawer is closed
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsCloseCashDrawerEvent', method);
Arguments:
OpsCloseCashDrawerEventArgs
- Property: OpsCloseCashDrawerEventArgs.CashDrawerNumber
(System.Int32)
- Property: OpsCloseCashDrawerEventArgs.Timeout (System.Boolean)
OpsCloseCheckEvent
Description: Called when a check is closed
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsCloseCheckEvent', method);
Arguments:
OpsCloseCheckEventArgs
- Property: OpsCloseCheckEventArgs.VssBasicData (System.String)
- Property: OpsCloseCheckEventArgs.VssExtendedData
(System.String)
OpsCloseCheckEventPreview
Description: Called prior to when a check is closed
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsCloseCheckEventPreview', method);
Arguments:
OpsCloseCheckEventArgs
- Property: OpsCloseCheckEventArgs.VssBasicData (System.String)
- Property: OpsCloseCheckEventArgs.VssExtendedData
(System.String)
OpsCMAdjustCashDepositEvent
Description:
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsCMAdjustCashDepositEvent', method);
Arguments:
OpsCMAdjustCashDepositEventArgs
- Property: OpsCMAdjustCashDepositEventArgs.AdjustCashDepositData
(Micros.PosCore.Extensibility.Ops.OpsCMAdjustCashDepositData)
OpsCMAdjustCountEvent
Description:
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsCMAdjustCountEvent', method);
Arguments:
OpsCMAdjustCountEventArgs
- Property: OpsCMAdjustCountEventArgs.AdjustCountData
(Micros.PosCore.Extensibility.Ops.OpsCMAdjustCountData)
OpsCMAdjustCountSheetEvent
Description:
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsCMAdjustCountSheetEvent', method);
Arguments:
OpsCMAdjustCountSheetEventArgs
- Property: OpsCMAdjustCountSheetEventArgs.AdjustCountSheetData
(Micros.PosCore.Extensibility.Ops.OpsCMAdjustCountSheetData)
OpsCMAdjustDepositReferenceEvent
Description:
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsCMAdjustDepositReferenceEvent', method);
Arguments:
OpsCMAdjustDepositReferenceEventArgs
- Property:
OpsCMAdjustDepositReferenceEventArgs.AdjustDepositReferenceData
(Micros.PosCore.Extensibility.Ops.OpsCMAdjustDepositReferenceData)
OpsCMAdjustStartingAmountEvent
Description:
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsCMAdjustStartingAmountEvent', method);
Arguments:
OpsCMAdjustStartingAmountEventArgs
- Property:
OpsCMAdjustStartingAmountEventArgs.AdjustStartingAmountData
(Micros.PosCore.Extensibility.Ops.OpsCMAdjustStartingAmountData)
OpsCMAssignTillToCashDrawerEvent
Description:
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsCMAssignTillToCashDrawerEvent', method);
Arguments:
OpsCMAssignTillToCashDrawerEventArgs
- Property: OpsCMAssignTillToCashDrawerEventArgs.AssignTillData
(Micros.PosCore.Extensibility.Ops.OpsCMAssignTillData)
OpsCMAssignUserToTillEvent
Description:
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsCMAssignUserToTillEvent', method);
Arguments:
OpsCMAssignUserToTillEventArgs
- Property: OpsCMAssignUserToTillEventArgs.AssignUserData
(Micros.PosCore.Extensibility.Ops.OpsCMAssignUserData)
OpsCMBankDepositReferenceEntryEvent
Description: Call When In cash Management Reference Entry value is
required
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsCMBankDepositReferenceEntryEvent', method);
Arguments:
OpsCMBankDepositReferenceEntryEventArgs
- Property: OpsCMBankDepositReferenceEntryEventArgs.BusinessDate
(System.DateTime)
- Property: OpsCMBankDepositReferenceEntryEventArgs.Reference
(System.String)
OpsCMCashPullEvent
Description:
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsCMCashPullEvent', method);
Arguments:
OpsCMCashPullEventArgs
- Property: OpsCMCashPullEventArgs.CashPullData
(Micros.PosCore.Extensibility.Ops.OpsCMCashPullData)
OpsCMChangeOrderEvent
Description:
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsCMChangeOrderEvent', method);
Arguments:
OpsCMChangeOrderEventArgs
- Property: OpsCMChangeOrderEventArgs.ChangeOrderData
(Micros.PosCore.Extensibility.Ops.OpsCMChangeOrderData)
OpsCMCloseEvent
Description:
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsCMCloseEvent', method);
Arguments:
OpsCMCloseEventArgs
- Property: OpsCMCloseEventArgs.CloseData
(Micros.PosCore.Extensibility.Ops.OpsCMCloseData)
OpsCMCountEvent
Description: FPPRT-1482. Cash Management events that pass receptacle
and monetary details
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsCMCountEvent', method);
Arguments:
OpsCMCountEventArgs
- Property: OpsCMCountEventArgs.CountData
(Micros.PosCore.Extensibility.Ops.OpsCMCountData)
OpsCMOpenEvent
Description:
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsCMOpenEvent', method);
Arguments: OpsCMOpenEventArgs
- Property: OpsCMOpenEventArgs.OpenData
(Micros.PosCore.Extensibility.Ops.OpsCMOpenData)
OpsCMPaidInOutEvent
Description:
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsCMPaidInOutEvent', method);
Arguments:
OpsCMPaidInOutEventArgs
- Property: OpsCMPaidInOutEventArgs.PaidInOutData
(Micros.PosCore.Extensibility.Ops.OpsCMPaidInOutData)
OpsCMReopenEvent
Description:
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsCMReopenEvent', method);
Arguments:
OpsCMReopenEventArgs
- Property: OpsCMReopenEventArgs.ReopenData
(Micros.PosCore.Extensibility.Ops.OpsCMReopenData)
OpsCMTransferEvent
Description:
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsCMTransferEvent', method);
Arguments:
OpsCMTransferEventArgs
- Property: OpsCMTransferEventArgs.TransferData
(Micros.PosCore.Extensibility.Ops.OpsCMTransferData)
OpsCMUnassignTillFromCashDrawerEvent
Description:
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsCMUnassignTillFromCashDrawerEvent', method);
Arguments:
OpsCMUnassignTillFromCashDrawerEventArgs
- Property: OpsCMUnassignTillFromCashDrawerEventArgs.UnassignTillData
(Micros.PosCore.Extensibility.Ops.OpsCMUnassignTillData)
OpsCMUnassignUserFromTillEvent
Description:
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsCMUnassignUserFromTillEvent', method);
Arguments:
OpsCMUnassignUserFromTillEventArgs
- Property: OpsCMUnassignUserFromTillEventArgs.UnassignUserData
(Micros.PosCore.Extensibility.Ops.OpsCMUnassignUserData)
OpsCMViewDetailEvent
Description:
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsCMViewDetailEvent', method);
Arguments:
OpsCMViewDetailEventArgs
- Property: OpsCMViewDetailEventArgs.ViewDetailData
(Micros.PosCore.Extensibility.Ops.OpsCMViewDetailData)
OpsCommandEvent
Description: Called when a command is processed (e.g. in response to
a Command Button press on a page)
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsCommandEvent', method);
Arguments:
OpsCommandEventArgs
- Property: OpsCommandEventArgs.Command (System.Object)
OpsCommandPreviewEvent
Description: Called prior to when a command is processed (e.g. in
response to a Command Button press on a page)
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsCommandPreviewEvent', method);
Arguments:
OpsCommandPreviewEventArgs
- Property: OpsCommandPreviewEventArgs.Cancelled (System.Boolean)
- Property: OpsCommandPreviewEventArgs.Command (System.Object)
OpsCreditCardAuthorizationEvent
Description: Called when a credit card has been authorized.
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsCreditCardAuthorizationEvent', method);
Arguments:
OpsCreditCardAuthorizationEventArgs
OpsCreditCardAuthorizationPreviewEvent
Description: Called prior to when a credit card has been
authorized.
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsCreditCardAuthorizationPreviewEvent', method);
Arguments:
OpsCreditCardAuthorizationEventArgs
OpsCustomDialogDebugModeReadyEvent
Description:
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsCustomDialogDebugModeReadyEvent', method);
Arguments:
OpsCustomDialogDebugModeReadyArgs
- Property: OpsCustomDialogDebugModeReadyArgs.URL (System.String)
OpsCustomDialogEvent
Description:
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsCustomDialogEvent', method);
Arguments:
OpsCustomDialogEventArgs
- Property: OpsCustomDialogEventArgs.Argument (System.String)
- Property: OpsCustomDialogEventArgs.Command (System.String)
- Property: OpsCustomDialogEventArgs.Response (System.String)
- Property: OpsCustomDialogEventArgs.Sender (System.String)
OpsCustomOrderDeviceEventArgs
Description: Called when an order device with a configured custom
string is accessed
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsCustomOrderDeviceEventArgs', method);
Arguments:
OpsCustomOrderDeviceEventArgs
- Property: OpsCustomOrderDeviceEventArgs.AllDetail
(System.Collections.Generic.List`1)
- Property: OpsCustomOrderDeviceEventArgs.CustomName
(System.String)
- Property: OpsCustomOrderDeviceEventArgs.Detail
(System.Collections.Generic.List`1)
- Property: OpsCustomOrderDeviceEventArgs.OrderDeviceIndex
(System.Int32)
- Property: OpsCustomOrderDeviceEventArgs.ReturnData
(System.Object)
- Property: OpsCustomOrderDeviceEventArgs.Target
(Micros.PosCore.Extensibility.Ops.DeviceType)
OpsCustomReceiptEvent
Description: Called to allow customization of text on a guest
receipt
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsCustomReceiptEvent', method);
Arguments:
OpsCustomReceiptEventArgs
- Property: OpsCustomReceiptEventArgs.HeaderAction
(Micros.PosCore.Extensibility.Ops.CustomPrintType)
OpsDatabaseTablesChangedEvent
Description: Called after the in-memory database has been updated
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsDatabaseTablesChangedEvent', method);
Arguments:
OpsDatabaseTablesChangedEventArgs
- Property: OpsDatabaseTablesChangedEventArgs.TableData
(System.Collections.Generic.IEnumerable`1)
Description: Called to allow extensibility the ‘last chance’ to
reformat the detail before it is displayed to its target type
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsDetailFormatQueryEvent', method);
- Property: OpsDetailFormatQueryEventArgs.Detail
(Micros.PosCore.Extensibility.Ops.CheckDetailItem)
- Property: OpsDetailFormatQueryEventArgs.NameText
(System.String)
- Property: OpsDetailFormatQueryEventArgs.ReturnData
(System.Object)
- Property: OpsDetailFormatQueryEventArgs.SalesCountText
(System.String)
- Property: OpsDetailFormatQueryEventArgs.Target
(Micros.PosCore.Extensibility.Ops.DeviceType)
- Property: OpsDetailFormatQueryEventArgs.TotalText
(System.String)
OpsDiscountEngineEvent
Description: Called when a discount has fired off
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsDiscountEngineEvent', method);
Arguments:
OpsDiscountEngineEventArgs
OpsDiscountEnginePreviewEvent
Description: Called prior to when a discount engine fires off
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsDiscountEnginePreviewEvent', method);
Arguments:
OpsDiscountEngineEventArgs
OpsDiscountOverrideEvent
Description: 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.
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsDiscountOverrideEvent', method);
Arguments:
OpsDiscountOverrideEventArgs
- Property: OpsDiscountOverrideEventArgs.Amount (System.Decimal)
- Property: OpsDiscountOverrideEventArgs.Count (System.Int32)
- Property: OpsDiscountOverrideEventArgs.DiscountOverride
(System.Decimal)
- Property: OpsDiscountOverrideEventArgs.ObjectNumber
(System.Int32)
OpsDscCancelledEvent
Description: Called when a discount has been cancelled
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsDscCancelledEvent', method);
Arguments:
OpsDiscountEventArgs
- Property: OpsDiscountEventArgs.Count (System.Int32)
- Property: OpsDiscountEventArgs.Description (System.String)
- Property: OpsDiscountEventArgs.DiscountDef
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbDiscount)
- Property: OpsDiscountEventArgs.EventName (System.String)
- Property: OpsDiscountEventArgs.MealEmplId
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbKey.EmployeeID)
- Property: OpsDiscountEventArgs.Name (System.String)
- Property: OpsDiscountEventArgs.NLU (System.Boolean)
- Property: OpsDiscountEventArgs.Percent (System.Decimal)
- Property: OpsDiscountEventArgs.TillId
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbKey.TillDetailID)
- Property: OpsDiscountEventArgs.Total (System.Decimal)
- Property: OpsDiscountEventArgs.Void (System.Boolean)
- Property: OpsDiscountEventArgs.VoidDetailLink (System.Int32)
- Property: OpsDiscountEventArgs.VoidReason
(Micros.PosCore.Extensibility.Ops.OpsVoidReason)
OpsDscCancelledVoidEvent
Description: Called when a discount void has been cancelled
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsDscCancelledVoidEvent', method);
Arguments:
OpsDiscountEventArgs
- Property: OpsDiscountEventArgs.Count (System.Int32)
- Property: OpsDiscountEventArgs.Description (System.String)
- Property: OpsDiscountEventArgs.DiscountDef
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbDiscount)
- Property: OpsDiscountEventArgs.EventName (System.String)
- Property: OpsDiscountEventArgs.MealEmplId
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbKey.EmployeeID)
- Property: OpsDiscountEventArgs.Name (System.String)
- Property: OpsDiscountEventArgs.NLU (System.Boolean)
- Property: OpsDiscountEventArgs.Percent (System.Decimal)
- Property: OpsDiscountEventArgs.TillId
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbKey.TillDetailID)
- Property: OpsDiscountEventArgs.Total (System.Decimal)
- Property: OpsDiscountEventArgs.Void (System.Boolean)
- Property: OpsDiscountEventArgs.VoidDetailLink (System.Int32)
- Property: OpsDiscountEventArgs.VoidReason
(Micros.PosCore.Extensibility.Ops.OpsVoidReason)
OpsDscEvent
Description: Called when a discount is applied
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsDscEvent', method);
Arguments:
OpsDiscountEventArgs
- Property: OpsDiscountEventArgs.Count (System.Int32)
- Property: OpsDiscountEventArgs.Description (System.String)
- Property: OpsDiscountEventArgs.DiscountDef
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbDiscount)
- Property: OpsDiscountEventArgs.EventName (System.String)
- Property: OpsDiscountEventArgs.MealEmplId
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbKey.EmployeeID)
- Property: OpsDiscountEventArgs.Name (System.String)
- Property: OpsDiscountEventArgs.NLU (System.Boolean)
- Property: OpsDiscountEventArgs.Percent (System.Decimal)
- Property: OpsDiscountEventArgs.TillId
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbKey.TillDetailID)
- Property: OpsDiscountEventArgs.Total (System.Decimal)
- Property: OpsDiscountEventArgs.Void (System.Boolean)
- Property: OpsDiscountEventArgs.VoidDetailLink (System.Int32)
- Property: OpsDiscountEventArgs.VoidReason
(Micros.PosCore.Extensibility.Ops.OpsVoidReason)
OpsDscPreviewEvent
Description: Called prior to when a discount is applied
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsDscPreviewEvent', method);
Arguments:
OpsDiscountEventArgs
- Property: OpsDiscountEventArgs.Count (System.Int32)
- Property: OpsDiscountEventArgs.Description (System.String)
- Property: OpsDiscountEventArgs.DiscountDef
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbDiscount)
- Property: OpsDiscountEventArgs.EventName (System.String)
- Property: OpsDiscountEventArgs.MealEmplId
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbKey.EmployeeID)
- Property: OpsDiscountEventArgs.Name (System.String)
- Property: OpsDiscountEventArgs.NLU (System.Boolean)
- Property: OpsDiscountEventArgs.Percent (System.Decimal)
- Property: OpsDiscountEventArgs.TillId
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbKey.TillDetailID)
- Property: OpsDiscountEventArgs.Total (System.Decimal)
- Property: OpsDiscountEventArgs.Void (System.Boolean)
- Property: OpsDiscountEventArgs.VoidDetailLink (System.Int32)
- Property: OpsDiscountEventArgs.VoidReason
(Micros.PosCore.Extensibility.Ops.OpsVoidReason)
OpsDscVoidEvent
Description: Called when a discount is voided
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsDscVoidEvent', method);
Arguments:
OpsDiscountEventArgs
- Property: OpsDiscountEventArgs.Count (System.Int32)
- Property: OpsDiscountEventArgs.Description (System.String)
- Property: OpsDiscountEventArgs.DiscountDef
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbDiscount)
- Property: OpsDiscountEventArgs.EventName (System.String)
- Property: OpsDiscountEventArgs.MealEmplId
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbKey.EmployeeID)
- Property: OpsDiscountEventArgs.Name (System.String)
- Property: OpsDiscountEventArgs.NLU (System.Boolean)
- Property: OpsDiscountEventArgs.Percent (System.Decimal)
- Property: OpsDiscountEventArgs.TillId
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbKey.TillDetailID)
- Property: OpsDiscountEventArgs.Total (System.Decimal)
- Property: OpsDiscountEventArgs.Void (System.Boolean)
- Property: OpsDiscountEventArgs.VoidDetailLink (System.Int32)
- Property: OpsDiscountEventArgs.VoidReason
(Micros.PosCore.Extensibility.Ops.OpsVoidReason)
OpsDscVoidPreviewEvent
Description: Called prior to when a discount is voided
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsDscVoidPreviewEvent', method);
Arguments:
OpsDiscountEventArgs
- Property: OpsDiscountEventArgs.Count (System.Int32)
- Property: OpsDiscountEventArgs.Description (System.String)
- Property: OpsDiscountEventArgs.DiscountDef
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbDiscount)
- Property: OpsDiscountEventArgs.EventName (System.String)
- Property: OpsDiscountEventArgs.MealEmplId
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbKey.EmployeeID)
- Property: OpsDiscountEventArgs.Name (System.String)
- Property: OpsDiscountEventArgs.NLU (System.Boolean)
- Property: OpsDiscountEventArgs.Percent (System.Decimal)
- Property: OpsDiscountEventArgs.TillId
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbKey.TillDetailID)
- Property: OpsDiscountEventArgs.Total (System.Decimal)
- Property: OpsDiscountEventArgs.Void (System.Boolean)
- Property: OpsDiscountEventArgs.VoidDetailLink (System.Int32)
- Property: OpsDiscountEventArgs.VoidReason
(Micros.PosCore.Extensibility.Ops.OpsVoidReason)
OpsErrorMessageEvent
Description: Called when OPS displays an error message. Useful for
logging.
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsErrorMessageEvent', method);
Arguments:
OpsErrorMessageEventArgs
- Property: OpsErrorMessageEventArgs.Message (System.String)
OpsEventsEndEvent
Description:
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsEventsEndEvent', method);
Arguments:
OpsEventsEndEventArgs
- Property: OpsEventsEndEventArgs.EventDefID (System.Int64)
OpsEventsEndPreviewEvent
Description:
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsEventsEndPreviewEvent', method);
Arguments:
OpsEventsEndEventArgs
- Property: OpsEventsEndEventArgs.EventDefID (System.Int64)
OpsEventsSelectEvent
Description:
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsEventsSelectEvent', method);
Arguments:
OpsEventsSelectEventArgs
- Property: OpsEventsSelectEventArgs.EventDefID (System.Int64)
- Property: OpsEventsSelectEventArgs.OperatorID (System.Int64)
OpsEventsSelectPreviewEvent
Description:
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsEventsSelectPreviewEvent', method);
Arguments:
OpsEventsSelectEventArgs
- Property: OpsEventsSelectEventArgs.EventDefID (System.Int64)
- Property: OpsEventsSelectEventArgs.OperatorID (System.Int64)
OpsEventsStartEvent
Description:
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsEventsStartEvent', method);
Arguments:
OpsEventsStartEventArgs
- Property: OpsEventsStartEventArgs.EventDefID (System.Int64)
OpsEventsStartPreviewEvent
Description:
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsEventsStartPreviewEvent', method);
Arguments:
OpsEventsStartEventArgs
- Property: OpsEventsStartEventArgs.EventDefID (System.Int64)
OpsExitEvent
Description: Called when OPS is closed
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsExitEvent', method);
Arguments: OpsExitEventArgs
OpsExitSimEvent
Description: (Called for SIM on exit)
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsExitSimEvent', method);
Arguments:
OpsStopSimEventArgs
OpsExtensibilityCancelledEvent
Description: Called when adding extensibility data to a check has
been cancelled.
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsExtensibilityCancelledEvent', method);
Arguments:
OpsExtensibilityEventArgs
- Property: OpsExtensibilityEventArgs.CurrentRound
(System.Boolean)
- Property: OpsExtensibilityEventArgs.ExtensibilityInfo
(Micros.PosCore.Extensibility.Ops.ExtensibilityDataInfo)
- Property: OpsExtensibilityEventArgs.Void (System.Boolean)
- Property: OpsExtensibilityEventArgs.VoidReason
(Micros.PosCore.Extensibility.Ops.OpsVoidReason)
OpsExtensibilityCancelledVoidEvent
Description: Called when a void of extensibility detail has been
cancelled
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsExtensibilityCancelledVoidEvent', method);
Arguments:
OpsExtensibilityEventArgs
- Property: OpsExtensibilityEventArgs.CurrentRound
(System.Boolean)
- Property: OpsExtensibilityEventArgs.ExtensibilityInfo
(Micros.PosCore.Extensibility.Ops.ExtensibilityDataInfo)
- Property: OpsExtensibilityEventArgs.Void (System.Boolean)
- Property: OpsExtensibilityEventArgs.VoidReason
(Micros.PosCore.Extensibility.Ops.OpsVoidReason)
OpsExtensibilityEvent
Description: Called when extensibility data has been removed from a
check either by void or transaction cancel
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsExtensibilityEvent', method);
Arguments:
OpsExtensibilityEventArgs
- Property: OpsExtensibilityEventArgs.CurrentRound
(System.Boolean)
- Property: OpsExtensibilityEventArgs.ExtensibilityInfo
(Micros.PosCore.Extensibility.Ops.ExtensibilityDataInfo)
- Property: OpsExtensibilityEventArgs.Void (System.Boolean)
- Property: OpsExtensibilityEventArgs.VoidReason
(Micros.PosCore.Extensibility.Ops.OpsVoidReason)
OpsExtensibilityPreviewEvent
Description: Called prior to when extensibility data has been removed
from a check either by void or transaction cancel
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsExtensibilityPreviewEvent', method);
Arguments:
OpsExtensibilityEventArgs
- Property: OpsExtensibilityEventArgs.CurrentRound
(System.Boolean)
- Property: OpsExtensibilityEventArgs.ExtensibilityInfo
(Micros.PosCore.Extensibility.Ops.ExtensibilityDataInfo)
- Property: OpsExtensibilityEventArgs.Void (System.Boolean)
- Property: OpsExtensibilityEventArgs.VoidReason
(Micros.PosCore.Extensibility.Ops.OpsVoidReason)
OpsExtensibilityVoidEvent
Description: Called when extensibility data has been voided
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsExtensibilityVoidEvent', method);
Arguments:
OpsExtensibilityEventArgs
- Property: OpsExtensibilityEventArgs.CurrentRound
(System.Boolean)
- Property: OpsExtensibilityEventArgs.ExtensibilityInfo
(Micros.PosCore.Extensibility.Ops.ExtensibilityDataInfo)
- Property: OpsExtensibilityEventArgs.Void (System.Boolean)
- Property: OpsExtensibilityEventArgs.VoidReason
(Micros.PosCore.Extensibility.Ops.OpsVoidReason)
OpsExtensibilityVoidPreviewEvent
Description: Called prior when extensibility data will be voided
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsExtensibilityVoidPreviewEvent', method);
Arguments:
OpsExtensibilityEventArgs
- Property: OpsExtensibilityEventArgs.CurrentRound
(System.Boolean)
- Property: OpsExtensibilityEventArgs.ExtensibilityInfo
(Micros.PosCore.Extensibility.Ops.ExtensibilityDataInfo)
- Property: OpsExtensibilityEventArgs.Void (System.Boolean)
- Property: OpsExtensibilityEventArgs.VoidReason
(Micros.PosCore.Extensibility.Ops.OpsVoidReason)
OpsFinalTenderEvent
Description: Called when the final tender of a check has been applied
(balance is 0)
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsFinalTenderEvent', method);
Arguments: OpsTmedEventArgs
- Property: OpsTmedEventArgs.ChangeDue (System.Decimal)
- Property: OpsTmedEventArgs.ChargeTipTotal (System.Decimal)
- Property: OpsTmedEventArgs.Count (System.Int32)
- Property: OpsTmedEventArgs.CurrencyID
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbKey.CurrencyID)
- Property: OpsTmedEventArgs.Description (System.String)
- Property: OpsTmedEventArgs.EventName (System.String)
- Property: OpsTmedEventArgs.InterfaceLink
(Micros.PosCore.DataStore.DbRecords.DbInterfaceLink)
- Property: OpsTmedEventArgs.IsDebit (System.Boolean)
- Property: OpsTmedEventArgs.IsPayment (System.Boolean)
- Property: OpsTmedEventArgs.Name (System.String)
- Property: OpsTmedEventArgs.ObjectNumber (System.Int32)
- Property: OpsTmedEventArgs.OpenDrawer (System.Boolean)
- Property: OpsTmedEventArgs.PmsTotals
(Micros.PosCore.Checks.PmsTotals)
- Property: OpsTmedEventArgs.ReferenceEntries
(System.Collections.Generic.List`1)
- Property: OpsTmedEventArgs.RestrictLastItemVoid
(System.Boolean)
- Property: OpsTmedEventArgs.SimChangeDue (System.Decimal)
- Property: OpsTmedEventArgs.TillId
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbKey.TillDetailID)
- Property: OpsTmedEventArgs.TmedDef
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbTenderMedia)
- Property: OpsTmedEventArgs.TmedDetail
(Micros.PosCore.Extensibility.Ops.TenderMediaDetail)
- Property: OpsTmedEventArgs.Total (System.Decimal)
- Property: OpsTmedEventArgs.Void (System.Boolean)
- Property: OpsTmedEventArgs.VoidDetailLink (System.Int32)
- Property: OpsTmedEventArgs.VoidReason
(Micros.PosCore.Extensibility.Ops.OpsVoidReason)
Description: Called to allow customization of check number
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsFormatCheckNumberEvent', method);
Arguments:
OpsGenerateAlternateCheckNumberEventArgs
- Property: OpsGenerateAlternateCheckNumberEventArgs.CheckNumber
(System.Int64)
- Property: OpsGenerateAlternateCheckNumberEventArgs.Target
(Micros.PosCore.Extensibility.Ops.DeviceType)
OpsInitEvent
Description: Called when OPS is started.
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsInitEvent', method);
Arguments: OpsInitEventArgs
OpsItemDoneEvent
Description: Called on item done in conversational ordering
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsItemDoneEvent', method);
Arguments:
OpsItemDoneEventArgs
OpsItemSelectedEvent
Description: Called on item selected in conversational ordering
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsItemSelectedEvent', method);
Arguments:
OpsItemSelectedEventArgs
OpsMiCancelledEvent
Description: Called when a menu item being ordered has been
cancelled
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsMiCancelledEvent', method);
- Property: OpsMenuItemEventArgs.BarcodeDef
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbBarcode)
- Property: OpsMenuItemEventArgs.Count (System.Int32)
- Property: OpsMenuItemEventArgs.Description (System.String)
- Property: OpsMenuItemEventArgs.DetailLink (System.Int32)
- Property: OpsMenuItemEventArgs.DiscItmzrID
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbKey.DscntItmzrID)
- Property: OpsMenuItemEventArgs.EventName (System.String)
- Property: OpsMenuItemEventArgs.ItemWeight (System.Decimal)
- Property: OpsMenuItemEventArgs.MainLevelIndex (System.Int16)
- Property: OpsMenuItemEventArgs.MiClass
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbMenuItemClass)
- Property: OpsMenuItemEventArgs.MiDefinition
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbMenuItemDefinition)
- Property: OpsMenuItemEventArgs.MiMaster
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbMenuItemMaster)
- Property: OpsMenuItemEventArgs.MiPrice
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbMenuItemPrice)
- Property: OpsMenuItemEventArgs.MiTaxClass
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbTaxClass)
- Property: OpsMenuItemEventArgs.Name (System.String)
- Property: OpsMenuItemEventArgs.NluIndex (System.Int16)
- Property: OpsMenuItemEventArgs.Reference (System.String)
- Property: OpsMenuItemEventArgs.SlsItmzrIndex (System.Int16)
- Property: OpsMenuItemEventArgs.SubLevelIndex (System.Int16)
- Property: OpsMenuItemEventArgs.SvcChgItmzrID
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbKey.SvcChgItmzrID)
- Property: OpsMenuItemEventArgs.Total (System.Decimal)
- Property: OpsMenuItemEventArgs.VoidDetailLink (System.Int32)
- Property: OpsMenuItemEventArgs.VoidReason
(Micros.PosCore.Extensibility.Ops.OpsVoidReason)
OpsMiCancelledReturnEvent
Description: Called when a menu item return has been cancelled
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsMiCancelledReturnEvent', method);
- Property: OpsMenuItemEventArgs.BarcodeDef
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbBarcode)
- Property: OpsMenuItemEventArgs.Count (System.Int32)
- Property: OpsMenuItemEventArgs.Description (System.String)
- Property: OpsMenuItemEventArgs.DetailLink (System.Int32)
- Property: OpsMenuItemEventArgs.DiscItmzrID
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbKey.DscntItmzrID)
- Property: OpsMenuItemEventArgs.EventName (System.String)
- Property: OpsMenuItemEventArgs.ItemWeight (System.Decimal)
- Property: OpsMenuItemEventArgs.MainLevelIndex (System.Int16)
- Property: OpsMenuItemEventArgs.MiClass
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbMenuItemClass)
- Property: OpsMenuItemEventArgs.MiDefinition
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbMenuItemDefinition)
- Property: OpsMenuItemEventArgs.MiMaster
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbMenuItemMaster)
- Property: OpsMenuItemEventArgs.MiPrice
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbMenuItemPrice)
- Property: OpsMenuItemEventArgs.MiTaxClass
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbTaxClass)
- Property: OpsMenuItemEventArgs.Name (System.String)
- Property: OpsMenuItemEventArgs.NluIndex (System.Int16)
- Property: OpsMenuItemEventArgs.Reference (System.String)
- Property: OpsMenuItemEventArgs.SlsItmzrIndex (System.Int16)
- Property: OpsMenuItemEventArgs.SubLevelIndex (System.Int16)
- Property: OpsMenuItemEventArgs.SvcChgItmzrID
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbKey.SvcChgItmzrID)
- Property: OpsMenuItemEventArgs.Total (System.Decimal)
- Property: OpsMenuItemEventArgs.VoidDetailLink (System.Int32)
- Property: OpsMenuItemEventArgs.VoidReason
(Micros.PosCore.Extensibility.Ops.OpsVoidReason)
OpsMiCancelledVoidEvent
Description: Called when a menu item void has been cancelled
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsMiCancelledVoidEvent', method);
- Property: OpsMenuItemEventArgs.BarcodeDef
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbBarcode)
- Property: OpsMenuItemEventArgs.Count (System.Int32)
- Property: OpsMenuItemEventArgs.Description (System.String)
- Property: OpsMenuItemEventArgs.DetailLink (System.Int32)
- Property: OpsMenuItemEventArgs.DiscItmzrID
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbKey.DscntItmzrID)
- Property: OpsMenuItemEventArgs.EventName (System.String)
- Property: OpsMenuItemEventArgs.ItemWeight (System.Decimal)
- Property: OpsMenuItemEventArgs.MainLevelIndex (System.Int16)
- Property: OpsMenuItemEventArgs.MiClass
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbMenuItemClass)
- Property: OpsMenuItemEventArgs.MiDefinition
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbMenuItemDefinition)
- Property: OpsMenuItemEventArgs.MiMaster
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbMenuItemMaster)
- Property: OpsMenuItemEventArgs.MiPrice
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbMenuItemPrice)
- Property: OpsMenuItemEventArgs.MiTaxClass
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbTaxClass)
- Property: OpsMenuItemEventArgs.Name (System.String)
- Property: OpsMenuItemEventArgs.NluIndex (System.Int16)
- Property: OpsMenuItemEventArgs.Reference (System.String)
- Property: OpsMenuItemEventArgs.SlsItmzrIndex (System.Int16)
- Property: OpsMenuItemEventArgs.SubLevelIndex (System.Int16)
- Property: OpsMenuItemEventArgs.SvcChgItmzrID
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbKey.SvcChgItmzrID)
- Property: OpsMenuItemEventArgs.Total (System.Decimal)
- Property: OpsMenuItemEventArgs.VoidDetailLink (System.Int32)
- Property: OpsMenuItemEventArgs.VoidReason
(Micros.PosCore.Extensibility.Ops.OpsVoidReason)
OpsMiEvent
Description: Called when a menu item has been ordered
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsMiEvent', method);
- Property: OpsMenuItemEventArgs.BarcodeDef
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbBarcode)
- Property: OpsMenuItemEventArgs.Count (System.Int32)
- Property: OpsMenuItemEventArgs.Description (System.String)
- Property: OpsMenuItemEventArgs.DetailLink (System.Int32)
- Property: OpsMenuItemEventArgs.DiscItmzrID
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbKey.DscntItmzrID)
- Property: OpsMenuItemEventArgs.EventName (System.String)
- Property: OpsMenuItemEventArgs.ItemWeight (System.Decimal)
- Property: OpsMenuItemEventArgs.MainLevelIndex (System.Int16)
- Property: OpsMenuItemEventArgs.MiClass
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbMenuItemClass)
- Property: OpsMenuItemEventArgs.MiDefinition
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbMenuItemDefinition)
- Property: OpsMenuItemEventArgs.MiMaster
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbMenuItemMaster)
- Property: OpsMenuItemEventArgs.MiPrice
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbMenuItemPrice)
- Property: OpsMenuItemEventArgs.MiTaxClass
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbTaxClass)
- Property: OpsMenuItemEventArgs.Name (System.String)
- Property: OpsMenuItemEventArgs.NluIndex (System.Int16)
- Property: OpsMenuItemEventArgs.Reference (System.String)
- Property: OpsMenuItemEventArgs.SlsItmzrIndex (System.Int16)
- Property: OpsMenuItemEventArgs.SubLevelIndex (System.Int16)
- Property: OpsMenuItemEventArgs.SvcChgItmzrID
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbKey.SvcChgItmzrID)
- Property: OpsMenuItemEventArgs.Total (System.Decimal)
- Property: OpsMenuItemEventArgs.VoidDetailLink (System.Int32)
- Property: OpsMenuItemEventArgs.VoidReason
(Micros.PosCore.Extensibility.Ops.OpsVoidReason)
OpsMiPreviewEvent
Description: Called prior to a menu item being ordered
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsMiPreviewEvent', method);
- Property: OpsMenuItemEventArgs.BarcodeDef
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbBarcode)
- Property: OpsMenuItemEventArgs.Count (System.Int32)
- Property: OpsMenuItemEventArgs.Description (System.String)
- Property: OpsMenuItemEventArgs.DetailLink (System.Int32)
- Property: OpsMenuItemEventArgs.DiscItmzrID
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbKey.DscntItmzrID)
- Property: OpsMenuItemEventArgs.EventName (System.String)
- Property: OpsMenuItemEventArgs.ItemWeight (System.Decimal)
- Property: OpsMenuItemEventArgs.MainLevelIndex (System.Int16)
- Property: OpsMenuItemEventArgs.MiClass
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbMenuItemClass)
- Property: OpsMenuItemEventArgs.MiDefinition
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbMenuItemDefinition)
- Property: OpsMenuItemEventArgs.MiMaster
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbMenuItemMaster)
- Property: OpsMenuItemEventArgs.MiPrice
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbMenuItemPrice)
- Property: OpsMenuItemEventArgs.MiTaxClass
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbTaxClass)
- Property: OpsMenuItemEventArgs.Name (System.String)
- Property: OpsMenuItemEventArgs.NluIndex (System.Int16)
- Property: OpsMenuItemEventArgs.Reference (System.String)
- Property: OpsMenuItemEventArgs.SlsItmzrIndex (System.Int16)
- Property: OpsMenuItemEventArgs.SubLevelIndex (System.Int16)
- Property: OpsMenuItemEventArgs.SvcChgItmzrID
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbKey.SvcChgItmzrID)
- Property: OpsMenuItemEventArgs.Total (System.Decimal)
- Property: OpsMenuItemEventArgs.VoidDetailLink (System.Int32)
- Property: OpsMenuItemEventArgs.VoidReason
(Micros.PosCore.Extensibility.Ops.OpsVoidReason)
OpsMiReturnEvent
Description: Called when a menu item has been returned
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsMiReturnEvent', method);
- Property: OpsMenuItemEventArgs.BarcodeDef
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbBarcode)
- Property: OpsMenuItemEventArgs.Count (System.Int32)
- Property: OpsMenuItemEventArgs.Description (System.String)
- Property: OpsMenuItemEventArgs.DetailLink (System.Int32)
- Property: OpsMenuItemEventArgs.DiscItmzrID
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbKey.DscntItmzrID)
- Property: OpsMenuItemEventArgs.EventName (System.String)
- Property: OpsMenuItemEventArgs.ItemWeight (System.Decimal)
- Property: OpsMenuItemEventArgs.MainLevelIndex (System.Int16)
- Property: OpsMenuItemEventArgs.MiClass
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbMenuItemClass)
- Property: OpsMenuItemEventArgs.MiDefinition
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbMenuItemDefinition)
- Property: OpsMenuItemEventArgs.MiMaster
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbMenuItemMaster)
- Property: OpsMenuItemEventArgs.MiPrice
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbMenuItemPrice)
- Property: OpsMenuItemEventArgs.MiTaxClass
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbTaxClass)
- Property: OpsMenuItemEventArgs.Name (System.String)
- Property: OpsMenuItemEventArgs.NluIndex (System.Int16)
- Property: OpsMenuItemEventArgs.Reference (System.String)
- Property: OpsMenuItemEventArgs.SlsItmzrIndex (System.Int16)
- Property: OpsMenuItemEventArgs.SubLevelIndex (System.Int16)
- Property: OpsMenuItemEventArgs.SvcChgItmzrID
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbKey.SvcChgItmzrID)
- Property: OpsMenuItemEventArgs.Total (System.Decimal)
- Property: OpsMenuItemEventArgs.VoidDetailLink (System.Int32)
- Property: OpsMenuItemEventArgs.VoidReason
(Micros.PosCore.Extensibility.Ops.OpsVoidReason)
OpsMiReturnPreviewEvent
Description: Called prior to a menu item being returned
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsMiReturnPreviewEvent', method);
- Property: OpsMenuItemEventArgs.BarcodeDef
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbBarcode)
- Property: OpsMenuItemEventArgs.Count (System.Int32)
- Property: OpsMenuItemEventArgs.Description (System.String)
- Property: OpsMenuItemEventArgs.DetailLink (System.Int32)
- Property: OpsMenuItemEventArgs.DiscItmzrID
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbKey.DscntItmzrID)
- Property: OpsMenuItemEventArgs.EventName (System.String)
- Property: OpsMenuItemEventArgs.ItemWeight (System.Decimal)
- Property: OpsMenuItemEventArgs.MainLevelIndex (System.Int16)
- Property: OpsMenuItemEventArgs.MiClass
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbMenuItemClass)
- Property: OpsMenuItemEventArgs.MiDefinition
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbMenuItemDefinition)
- Property: OpsMenuItemEventArgs.MiMaster
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbMenuItemMaster)
- Property: OpsMenuItemEventArgs.MiPrice
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbMenuItemPrice)
- Property: OpsMenuItemEventArgs.MiTaxClass
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbTaxClass)
- Property: OpsMenuItemEventArgs.Name (System.String)
- Property: OpsMenuItemEventArgs.NluIndex (System.Int16)
- Property: OpsMenuItemEventArgs.Reference (System.String)
- Property: OpsMenuItemEventArgs.SlsItmzrIndex (System.Int16)
- Property: OpsMenuItemEventArgs.SubLevelIndex (System.Int16)
- Property: OpsMenuItemEventArgs.SvcChgItmzrID
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbKey.SvcChgItmzrID)
- Property: OpsMenuItemEventArgs.Total (System.Decimal)
- Property: OpsMenuItemEventArgs.VoidDetailLink (System.Int32)
- Property: OpsMenuItemEventArgs.VoidReason
(Micros.PosCore.Extensibility.Ops.OpsVoidReason)
OpsMiVoidEvent
Description: Called when a menu item has been voided
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsMiVoidEvent', method);
- Property: OpsMenuItemEventArgs.BarcodeDef
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbBarcode)
- Property: OpsMenuItemEventArgs.Count (System.Int32)
- Property: OpsMenuItemEventArgs.Description (System.String)
- Property: OpsMenuItemEventArgs.DetailLink (System.Int32)
- Property: OpsMenuItemEventArgs.DiscItmzrID
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbKey.DscntItmzrID)
- Property: OpsMenuItemEventArgs.EventName (System.String)
- Property: OpsMenuItemEventArgs.ItemWeight (System.Decimal)
- Property: OpsMenuItemEventArgs.MainLevelIndex (System.Int16)
- Property: OpsMenuItemEventArgs.MiClass
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbMenuItemClass)
- Property: OpsMenuItemEventArgs.MiDefinition
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbMenuItemDefinition)
- Property: OpsMenuItemEventArgs.MiMaster
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbMenuItemMaster)
- Property: OpsMenuItemEventArgs.MiPrice
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbMenuItemPrice)
- Property: OpsMenuItemEventArgs.MiTaxClass
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbTaxClass)
- Property: OpsMenuItemEventArgs.Name (System.String)
- Property: OpsMenuItemEventArgs.NluIndex (System.Int16)
- Property: OpsMenuItemEventArgs.Reference (System.String)
- Property: OpsMenuItemEventArgs.SlsItmzrIndex (System.Int16)
- Property: OpsMenuItemEventArgs.SubLevelIndex (System.Int16)
- Property: OpsMenuItemEventArgs.SvcChgItmzrID
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbKey.SvcChgItmzrID)
- Property: OpsMenuItemEventArgs.Total (System.Decimal)
- Property: OpsMenuItemEventArgs.VoidDetailLink (System.Int32)
- Property: OpsMenuItemEventArgs.VoidReason
(Micros.PosCore.Extensibility.Ops.OpsVoidReason)
OpsMiVoidPreviewEvent
Description: Called prior to a menu item being voided
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsMiVoidPreviewEvent', method);
- Property: OpsMenuItemEventArgs.BarcodeDef
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbBarcode)
- Property: OpsMenuItemEventArgs.Count (System.Int32)
- Property: OpsMenuItemEventArgs.Description (System.String)
- Property: OpsMenuItemEventArgs.DetailLink (System.Int32)
- Property: OpsMenuItemEventArgs.DiscItmzrID
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbKey.DscntItmzrID)
- Property: OpsMenuItemEventArgs.EventName (System.String)
- Property: OpsMenuItemEventArgs.ItemWeight (System.Decimal)
- Property: OpsMenuItemEventArgs.MainLevelIndex (System.Int16)
- Property: OpsMenuItemEventArgs.MiClass
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbMenuItemClass)
- Property: OpsMenuItemEventArgs.MiDefinition
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbMenuItemDefinition)
- Property: OpsMenuItemEventArgs.MiMaster
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbMenuItemMaster)
- Property: OpsMenuItemEventArgs.MiPrice
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbMenuItemPrice)
- Property: OpsMenuItemEventArgs.MiTaxClass
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbTaxClass)
- Property: OpsMenuItemEventArgs.Name (System.String)
- Property: OpsMenuItemEventArgs.NluIndex (System.Int16)
- Property: OpsMenuItemEventArgs.Reference (System.String)
- Property: OpsMenuItemEventArgs.SlsItmzrIndex (System.Int16)
- Property: OpsMenuItemEventArgs.SubLevelIndex (System.Int16)
- Property: OpsMenuItemEventArgs.SvcChgItmzrID
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbKey.SvcChgItmzrID)
- Property: OpsMenuItemEventArgs.Total (System.Decimal)
- Property: OpsMenuItemEventArgs.VoidDetailLink (System.Int32)
- Property: OpsMenuItemEventArgs.VoidReason
(Micros.PosCore.Extensibility.Ops.OpsVoidReason)
OpsNavigationItemSelectedEvent
Description: Called when a navigation item is selected.
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsNavigationItemSelectedEvent', method);
Arguments:
OpsNavigationItemSelectedArgs
- Property: OpsNavigationItemSelectedArgs.ExtensibilityKey
(System.String)
- Property: OpsNavigationItemSelectedArgs.OnActivation
(System.Boolean)
OpsNewTransactionEvent
Description: Called when a new transaction is being initialized.
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsNewTransactionEvent', method);
Arguments:
OpsNewTransactionEventArgs
OpsNoSaleEvent
Description: Called on the ‘no sale’ function
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsNoSaleEvent', method);
Arguments: OpsNoSaleEventArgs
- Property: OpsNoSaleEventArgs.ReasonCodeDescription
(System.String)
- Property: OpsNoSaleEventArgs.ReasonCodeID (System.Int64)
OpsNoSalePreviewEvent
Description: Called prior to the ‘no sale’ function
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsNoSalePreviewEvent', method);
Arguments:
OpsNoSaleEventArgs
- Property: OpsNoSaleEventArgs.ReasonCodeDescription
(System.String)
- Property: OpsNoSaleEventArgs.ReasonCodeID (System.Int64)
OpsOpenCashDrawerEvent
Description: Called when a cash drawer is opened
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsOpenCashDrawerEvent', method);
Arguments:
OpsOpenCashDrawerEventArgs
- Property: OpsOpenCashDrawerEventArgs.CashDrawerNumber
(System.Int32)
OpsOrderChannelChangedEvent
Description: Called when the order channel has changed
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsOrderChannelChangedEvent', method);
Arguments:
OpsOrderChannelChangedEventArgs
- Property: OpsOrderChannelChangedEventArgs.OrderChannelObjectNumber
(System.Int32)
OpsOrderChannelChangedPreviewEvent
Description: Called prior to the order channel being changed
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsOrderChannelChangedPreviewEvent', method);
Arguments:
OpsOrderChannelChangedEventArgs
- Property: OpsOrderChannelChangedEventArgs.OrderChannelObjectNumber
(System.Int32)
OpsOrderTypeChangedEvent
Description: Called when the order type has changed
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsOrderTypeChangedEvent', method);
Arguments:
OpsOrderTypeChangedEventArgs
- Property: OpsOrderTypeChangedEventArgs.OrderTypeIndex
(System.Int32)
OpsOrderTypeChangedPreviewEvent
Description: Called prior to the order type being changed
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsOrderTypeChangedPreviewEvent', method);
Arguments:
OpsOrderTypeChangedEventArgs
- Property: OpsOrderTypeChangedEventArgs.OrderTypeIndex
(System.Int32)
OpsPageLoadedEvent
Description: Called when a page is loaded
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsPageLoadedEvent', method);
Arguments:
OpsPageLoadedEventArgs
- Property: OpsPageLoadedEventArgs.PageNumber (System.Int32)
OpsPickUpCheckEvent
Description: Called when a check is picked up
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsPickUpCheckEvent', method);
Arguments:
OpsPickUpCheckEventArgs
- Property: OpsPickUpCheckEventArgs.Count (System.Int32)
- Property: OpsPickUpCheckEventArgs.EventName (System.String)
- Property: OpsPickUpCheckEventArgs.Total (System.Decimal)
- Property: OpsPickUpCheckEventArgs.VssBasicData (System.String)
- Property: OpsPickUpCheckEventArgs.VssExtendedData
(System.String)
OpsPickUpCheckEventPreview
Description: Called prior to a check being picked up
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsPickUpCheckEventPreview', method);
Arguments:
OpsPickUpCheckEventArgs
- Property: OpsPickUpCheckEventArgs.Count (System.Int32)
- Property: OpsPickUpCheckEventArgs.EventName (System.String)
- Property: OpsPickUpCheckEventArgs.Total (System.Decimal)
- Property: OpsPickUpCheckEventArgs.VssBasicData (System.String)
- Property: OpsPickUpCheckEventArgs.VssExtendedData
(System.String)
OpsPickupLoanEvent
Description: Called when there is a pickup loan
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsPickupLoanEvent', method);
Arguments: OpsTmedEventArgs
- Property: OpsTmedEventArgs.ChangeDue (System.Decimal)
- Property: OpsTmedEventArgs.ChargeTipTotal (System.Decimal)
- Property: OpsTmedEventArgs.Count (System.Int32)
- Property: OpsTmedEventArgs.CurrencyID
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbKey.CurrencyID)
- Property: OpsTmedEventArgs.Description (System.String)
- Property: OpsTmedEventArgs.EventName (System.String)
- Property: OpsTmedEventArgs.InterfaceLink
(Micros.PosCore.DataStore.DbRecords.DbInterfaceLink)
- Property: OpsTmedEventArgs.IsDebit (System.Boolean)
- Property: OpsTmedEventArgs.IsPayment (System.Boolean)
- Property: OpsTmedEventArgs.Name (System.String)
- Property: OpsTmedEventArgs.ObjectNumber (System.Int32)
- Property: OpsTmedEventArgs.OpenDrawer (System.Boolean)
- Property: OpsTmedEventArgs.PmsTotals
(Micros.PosCore.Checks.PmsTotals)
- Property: OpsTmedEventArgs.ReferenceEntries
(System.Collections.Generic.List`1)
- Property: OpsTmedEventArgs.RestrictLastItemVoid
(System.Boolean)
- Property: OpsTmedEventArgs.SimChangeDue (System.Decimal)
- Property: OpsTmedEventArgs.TillId
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbKey.TillDetailID)
- Property: OpsTmedEventArgs.TmedDef
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbTenderMedia)
- Property: OpsTmedEventArgs.TmedDetail
(Micros.PosCore.Extensibility.Ops.TenderMediaDetail)
- Property: OpsTmedEventArgs.Total (System.Decimal)
- Property: OpsTmedEventArgs.Void (System.Boolean)
- Property: OpsTmedEventArgs.VoidDetailLink (System.Int32)
- Property: OpsTmedEventArgs.VoidReason
(Micros.PosCore.Extensibility.Ops.OpsVoidReason)
OpsPickupLoanPreviewEvent
Description: Called prior to when there is a pickup loan
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsPickupLoanPreviewEvent', method);
Arguments: OpsTmedEventArgs
- Property: OpsTmedEventArgs.ChangeDue (System.Decimal)
- Property: OpsTmedEventArgs.ChargeTipTotal (System.Decimal)
- Property: OpsTmedEventArgs.Count (System.Int32)
- Property: OpsTmedEventArgs.CurrencyID
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbKey.CurrencyID)
- Property: OpsTmedEventArgs.Description (System.String)
- Property: OpsTmedEventArgs.EventName (System.String)
- Property: OpsTmedEventArgs.InterfaceLink
(Micros.PosCore.DataStore.DbRecords.DbInterfaceLink)
- Property: OpsTmedEventArgs.IsDebit (System.Boolean)
- Property: OpsTmedEventArgs.IsPayment (System.Boolean)
- Property: OpsTmedEventArgs.Name (System.String)
- Property: OpsTmedEventArgs.ObjectNumber (System.Int32)
- Property: OpsTmedEventArgs.OpenDrawer (System.Boolean)
- Property: OpsTmedEventArgs.PmsTotals
(Micros.PosCore.Checks.PmsTotals)
- Property: OpsTmedEventArgs.ReferenceEntries
(System.Collections.Generic.List`1)
- Property: OpsTmedEventArgs.RestrictLastItemVoid
(System.Boolean)
- Property: OpsTmedEventArgs.SimChangeDue (System.Decimal)
- Property: OpsTmedEventArgs.TillId
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbKey.TillDetailID)
- Property: OpsTmedEventArgs.TmedDef
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbTenderMedia)
- Property: OpsTmedEventArgs.TmedDetail
(Micros.PosCore.Extensibility.Ops.TenderMediaDetail)
- Property: OpsTmedEventArgs.Total (System.Decimal)
- Property: OpsTmedEventArgs.Void (System.Boolean)
- Property: OpsTmedEventArgs.VoidDetailLink (System.Int32)
- Property: OpsTmedEventArgs.VoidReason
(Micros.PosCore.Extensibility.Ops.OpsVoidReason)
OpsPrinterDataEvent
Description: Called when header or footer lines that starts with
“@@”. Data to be printed can be added in PrinterData.
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsPrinterDataEvent', method);
Arguments: OpsPrinterDataArgs
- Property: OpsPrinterDataArgs.IsHeader (System.Boolean)
- Property: OpsPrinterDataArgs.IsTrailer (System.Boolean)
- Property: OpsPrinterDataArgs.PrinterData (System.Object)
- Property: OpsPrinterDataArgs.Request (System.String)
OpsReadyEvent
Description: Called when OPS has been initialized and is ready
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsReadyEvent', method);
Arguments: OpsReadyEventArgs
OpsReceiptCountEvent
Description: Called to allows extensibility to set the number of
receipts to be printed. Defaults to 1.
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsReceiptCountEvent', method);
Arguments:
OpsQueryPrintReceiptCountEventArgs
- Property: OpsQueryPrintReceiptCountEventArgs.Count
(System.Int32)
- Property: OpsQueryPrintReceiptCountEventArgs.IsTaxExempt
(System.Boolean)
OpsReopenClosedCheckEvent
Description: Called when a check is reopened
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsReopenClosedCheckEvent', method);
Arguments:
OpsReopenClosedCheckEventArgs
- Property: OpsReopenClosedCheckEventArgs.EventName
(System.String)
- Property: OpsReopenClosedCheckEventArgs.VssBasicData
(System.String)
- Property: OpsReopenClosedCheckEventArgs.VssExtendedData
(System.String)
OpsReopenClosedCheckEventPreview
Description: Called prior to when a check is reopened
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsReopenClosedCheckEventPreview', method);
Arguments:
OpsReopenClosedCheckEventArgs
- Property: OpsReopenClosedCheckEventArgs.EventName
(System.String)
- Property: OpsReopenClosedCheckEventArgs.VssBasicData
(System.String)
- Property: OpsReopenClosedCheckEventArgs.VssExtendedData
(System.String)
OpsReportGeneratedEvent
Description: Called when a report is generated.
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsReportGeneratedEvent', method);
Arguments:
OpsReportGeneratedEventArgs
- Property: OpsReportGeneratedEventArgs.AutosequenceNumber
(System.Int32)
OpsReportGeneratedPreviewEvent
Description: Called prior to a report being generated
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsReportGeneratedPreviewEvent', method);
Arguments:
OpsReportGeneratedEventArgs
- Property: OpsReportGeneratedEventArgs.AutosequenceNumber
(System.Int32)
OpsReprintClosedCheckEvent
Description: Called when a closed check is being reprinted
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsReprintClosedCheckEvent', method);
Arguments:
OpsReprintClosedCheckEventArgs
OpsReprintClosedCheckEventPreview
Description: Called prior to when a closed check is being
reprinted
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsReprintClosedCheckEventPreview', method);
Arguments:
OpsReprintClosedCheckEventArgs
OpsResourceNotFoundEvent
Description:
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsResourceNotFoundEvent', method);
Arguments:
OpsResourceNotFoundEventArgs
- Property: OpsResourceNotFoundEventArgs.BinaryResource
- Property: OpsResourceNotFoundEventArgs.HttpMethod
(System.String)
- Property: OpsResourceNotFoundEventArgs.ResourceExtension
(System.String)
- Property: OpsResourceNotFoundEventArgs.ResourceSupplied
(System.Boolean)
- Property: OpsResourceNotFoundEventArgs.Sender (System.String)
- Property: OpsResourceNotFoundEventArgs.TextResource
(System.String)
- Property: OpsResourceNotFoundEventArgs.URL (System.String)
OpsSelectedItemChangedEvent
Description: Called when the selected item in the main detail has
changed
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsSelectedItemChangedEvent', method);
Arguments:
OpsSelectedItemChangedEventArgs
OpsSelectedItemCompleteQueryEvent
Description: 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.
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsSelectedItemCompleteQueryEvent', method);
Arguments:
OpsSelectedItemCompleteQueryEventArgs
- Property: OpsSelectedItemCompleteQueryEventArgs.Complete
(System.Boolean)
- Property: OpsSelectedItemCompleteQueryEventArgs.DisplayError
(System.Boolean)
OpsShiftIncrementEvent
Description: Called when shift is incremented for an Employee or a
Cashier
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsShiftIncrementEvent', method);
Arguments:
OpsShiftIncrementEventArgs
- Property: OpsShiftIncrementEventArgs.DateTimeUtc
(System.DateTime)
- Property: OpsShiftIncrementEventArgs.ShiftNumber (System.Int32)
- Property: OpsShiftIncrementEventArgs.ShiftType (System.Int32)
- Property: OpsShiftIncrementEventArgs.TypeObjectNumber
(System.Int64)
OpsSignInEvent
Description: Called when an employee has signed in
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsSignInEvent', method);
Arguments:
OpsSignInPreviewEventArgs
- Property: OpsSignInPreviewEventArgs.EmployeeID
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbKey.EmployeeID)
- Property: OpsSignInPreviewEventArgs.VssBasicData
(System.String)
- Property: OpsSignInPreviewEventArgs.VssExtendedData
(System.String)
OpsSignInPreviewEvent
Description: Called prior to an employee sign in
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsSignInPreviewEvent', method);
Arguments:
OpsSignInPreviewEventArgs
- Property: OpsSignInPreviewEventArgs.EmployeeID
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbKey.EmployeeID)
- Property: OpsSignInPreviewEventArgs.VssBasicData
(System.String)
- Property: OpsSignInPreviewEventArgs.VssExtendedData
(System.String)
OpsSignOutEvent
Description: Called when an employe has signed out, either manually
or automatically
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsSignOutEvent', method);
Arguments:
OpsSignOutPreviewEventArgs
- Property: OpsSignOutPreviewEventArgs.EmployeeID
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbKey.EmployeeID)
- Property: OpsSignOutPreviewEventArgs.OpsSignOutEventRaisedFrom
(Micros.PosCore.Extensibility.Ops.OpsSignOutPreviewEventArgs.SignOutEventRaisedFrom)
- Property: OpsSignOutPreviewEventArgs.TenderMediaObjectNumber
(System.Int32)
- Property: OpsSignOutPreviewEventArgs.VssBasicData
(System.String)
- Property: OpsSignOutPreviewEventArgs.VssExtendedData
(System.String)
OpsSignOutPreviewEvent
Description: Called prior to an employee signing out, either manually
or automatically
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsSignOutPreviewEvent', method);
Arguments:
OpsSignOutPreviewEventArgs
- Property: OpsSignOutPreviewEventArgs.EmployeeID
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbKey.EmployeeID)
- Property: OpsSignOutPreviewEventArgs.OpsSignOutEventRaisedFrom
(Micros.PosCore.Extensibility.Ops.OpsSignOutPreviewEventArgs.SignOutEventRaisedFrom)
- Property: OpsSignOutPreviewEventArgs.TenderMediaObjectNumber
(System.Int32)
- Property: OpsSignOutPreviewEventArgs.VssBasicData
(System.String)
- Property: OpsSignOutPreviewEventArgs.VssExtendedData
(System.String)
OpsStartSimEvent
Description: (Called for SIM on start up)
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsStartSimEvent', method);
Arguments:
OpsStartSimEventArgs
OpsSvcCancelledEvent
Description: Called when applying a service charge has been
cancelled
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsSvcCancelledEvent', method);
Arguments: OpsSvcEventArgs
- Property: OpsSvcEventArgs.Count (System.Int32)
- Property: OpsSvcEventArgs.Description (System.String)
- Property: OpsSvcEventArgs.EventName (System.String)
- Property: OpsSvcEventArgs.Name (System.String)
- Property: OpsSvcEventArgs.Percent (System.Decimal)
- Property: OpsSvcEventArgs.SvcChargeDef
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbServiceCharge)
- Property: OpsSvcEventArgs.SvcChargeDetail
(Micros.PosCore.Extensibility.Ops.ServiceChargeDetail)
- Property: OpsSvcEventArgs.TillId
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbKey.TillDetailID)
- Property: OpsSvcEventArgs.Total (System.Decimal)
- Property: OpsSvcEventArgs.VoidAuthEmplId
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbKey.EmployeeID)
- Property: OpsSvcEventArgs.VoidDetailLink (System.Int32)
- Property: OpsSvcEventArgs.VoidReason
(Micros.PosCore.Extensibility.Ops.OpsVoidReason)
- Property: OpsSvcEventArgs.VoidReasonId
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbKey.VoidReasonID)
OpsSvcCancelledVoidEvent
Description: Call when voiding a service charge has been
cancelled
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsSvcCancelledVoidEvent', method);
Arguments: OpsSvcEventArgs
- Property: OpsSvcEventArgs.Count (System.Int32)
- Property: OpsSvcEventArgs.Description (System.String)
- Property: OpsSvcEventArgs.EventName (System.String)
- Property: OpsSvcEventArgs.Name (System.String)
- Property: OpsSvcEventArgs.Percent (System.Decimal)
- Property: OpsSvcEventArgs.SvcChargeDef
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbServiceCharge)
- Property: OpsSvcEventArgs.SvcChargeDetail
(Micros.PosCore.Extensibility.Ops.ServiceChargeDetail)
- Property: OpsSvcEventArgs.TillId
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbKey.TillDetailID)
- Property: OpsSvcEventArgs.Total (System.Decimal)
- Property: OpsSvcEventArgs.VoidAuthEmplId
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbKey.EmployeeID)
- Property: OpsSvcEventArgs.VoidDetailLink (System.Int32)
- Property: OpsSvcEventArgs.VoidReason
(Micros.PosCore.Extensibility.Ops.OpsVoidReason)
- Property: OpsSvcEventArgs.VoidReasonId
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbKey.VoidReasonID)
OpsSvcEvent
Description: Called when a service charge is applied
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsSvcEvent', method);
Arguments: OpsSvcEventArgs
- Property: OpsSvcEventArgs.Count (System.Int32)
- Property: OpsSvcEventArgs.Description (System.String)
- Property: OpsSvcEventArgs.EventName (System.String)
- Property: OpsSvcEventArgs.Name (System.String)
- Property: OpsSvcEventArgs.Percent (System.Decimal)
- Property: OpsSvcEventArgs.SvcChargeDef
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbServiceCharge)
- Property: OpsSvcEventArgs.SvcChargeDetail
(Micros.PosCore.Extensibility.Ops.ServiceChargeDetail)
- Property: OpsSvcEventArgs.TillId
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbKey.TillDetailID)
- Property: OpsSvcEventArgs.Total (System.Decimal)
- Property: OpsSvcEventArgs.VoidAuthEmplId
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbKey.EmployeeID)
- Property: OpsSvcEventArgs.VoidDetailLink (System.Int32)
- Property: OpsSvcEventArgs.VoidReason
(Micros.PosCore.Extensibility.Ops.OpsVoidReason)
- Property: OpsSvcEventArgs.VoidReasonId
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbKey.VoidReasonID)
OpsSvcPreviewEvent
Description: Called prior to when a service charge is applied
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsSvcPreviewEvent', method);
Arguments: OpsSvcEventArgs
- Property: OpsSvcEventArgs.Count (System.Int32)
- Property: OpsSvcEventArgs.Description (System.String)
- Property: OpsSvcEventArgs.EventName (System.String)
- Property: OpsSvcEventArgs.Name (System.String)
- Property: OpsSvcEventArgs.Percent (System.Decimal)
- Property: OpsSvcEventArgs.SvcChargeDef
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbServiceCharge)
- Property: OpsSvcEventArgs.SvcChargeDetail
(Micros.PosCore.Extensibility.Ops.ServiceChargeDetail)
- Property: OpsSvcEventArgs.TillId
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbKey.TillDetailID)
- Property: OpsSvcEventArgs.Total (System.Decimal)
- Property: OpsSvcEventArgs.VoidAuthEmplId
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbKey.EmployeeID)
- Property: OpsSvcEventArgs.VoidDetailLink (System.Int32)
- Property: OpsSvcEventArgs.VoidReason
(Micros.PosCore.Extensibility.Ops.OpsVoidReason)
- Property: OpsSvcEventArgs.VoidReasonId
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbKey.VoidReasonID)
OpsSvcTotalEvent
Description: Called when a check has been service totalled
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsSvcTotalEvent', method);
Arguments: OpsTmedEventArgs
- Property: OpsTmedEventArgs.ChangeDue (System.Decimal)
- Property: OpsTmedEventArgs.ChargeTipTotal (System.Decimal)
- Property: OpsTmedEventArgs.Count (System.Int32)
- Property: OpsTmedEventArgs.CurrencyID
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbKey.CurrencyID)
- Property: OpsTmedEventArgs.Description (System.String)
- Property: OpsTmedEventArgs.EventName (System.String)
- Property: OpsTmedEventArgs.InterfaceLink
(Micros.PosCore.DataStore.DbRecords.DbInterfaceLink)
- Property: OpsTmedEventArgs.IsDebit (System.Boolean)
- Property: OpsTmedEventArgs.IsPayment (System.Boolean)
- Property: OpsTmedEventArgs.Name (System.String)
- Property: OpsTmedEventArgs.ObjectNumber (System.Int32)
- Property: OpsTmedEventArgs.OpenDrawer (System.Boolean)
- Property: OpsTmedEventArgs.PmsTotals
(Micros.PosCore.Checks.PmsTotals)
- Property: OpsTmedEventArgs.ReferenceEntries
(System.Collections.Generic.List`1)
- Property: OpsTmedEventArgs.RestrictLastItemVoid
(System.Boolean)
- Property: OpsTmedEventArgs.SimChangeDue (System.Decimal)
- Property: OpsTmedEventArgs.TillId
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbKey.TillDetailID)
- Property: OpsTmedEventArgs.TmedDef
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbTenderMedia)
- Property: OpsTmedEventArgs.TmedDetail
(Micros.PosCore.Extensibility.Ops.TenderMediaDetail)
- Property: OpsTmedEventArgs.Total (System.Decimal)
- Property: OpsTmedEventArgs.Void (System.Boolean)
- Property: OpsTmedEventArgs.VoidDetailLink (System.Int32)
- Property: OpsTmedEventArgs.VoidReason
(Micros.PosCore.Extensibility.Ops.OpsVoidReason)
OpsSvcTotalPreviewEvent
Description: Called prior to when a check has been service
totalled
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsSvcTotalPreviewEvent', method);
Arguments: OpsTmedEventArgs
- Property: OpsTmedEventArgs.ChangeDue (System.Decimal)
- Property: OpsTmedEventArgs.ChargeTipTotal (System.Decimal)
- Property: OpsTmedEventArgs.Count (System.Int32)
- Property: OpsTmedEventArgs.CurrencyID
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbKey.CurrencyID)
- Property: OpsTmedEventArgs.Description (System.String)
- Property: OpsTmedEventArgs.EventName (System.String)
- Property: OpsTmedEventArgs.InterfaceLink
(Micros.PosCore.DataStore.DbRecords.DbInterfaceLink)
- Property: OpsTmedEventArgs.IsDebit (System.Boolean)
- Property: OpsTmedEventArgs.IsPayment (System.Boolean)
- Property: OpsTmedEventArgs.Name (System.String)
- Property: OpsTmedEventArgs.ObjectNumber (System.Int32)
- Property: OpsTmedEventArgs.OpenDrawer (System.Boolean)
- Property: OpsTmedEventArgs.PmsTotals
(Micros.PosCore.Checks.PmsTotals)
- Property: OpsTmedEventArgs.ReferenceEntries
(System.Collections.Generic.List`1)
- Property: OpsTmedEventArgs.RestrictLastItemVoid
(System.Boolean)
- Property: OpsTmedEventArgs.SimChangeDue (System.Decimal)
- Property: OpsTmedEventArgs.TillId
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbKey.TillDetailID)
- Property: OpsTmedEventArgs.TmedDef
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbTenderMedia)
- Property: OpsTmedEventArgs.TmedDetail
(Micros.PosCore.Extensibility.Ops.TenderMediaDetail)
- Property: OpsTmedEventArgs.Total (System.Decimal)
- Property: OpsTmedEventArgs.Void (System.Boolean)
- Property: OpsTmedEventArgs.VoidDetailLink (System.Int32)
- Property: OpsTmedEventArgs.VoidReason
(Micros.PosCore.Extensibility.Ops.OpsVoidReason)
OpsSvcVoidEvent
Description: Called when a service charge is void
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsSvcVoidEvent', method);
Arguments: OpsSvcEventArgs
- Property: OpsSvcEventArgs.Count (System.Int32)
- Property: OpsSvcEventArgs.Description (System.String)
- Property: OpsSvcEventArgs.EventName (System.String)
- Property: OpsSvcEventArgs.Name (System.String)
- Property: OpsSvcEventArgs.Percent (System.Decimal)
- Property: OpsSvcEventArgs.SvcChargeDef
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbServiceCharge)
- Property: OpsSvcEventArgs.SvcChargeDetail
(Micros.PosCore.Extensibility.Ops.ServiceChargeDetail)
- Property: OpsSvcEventArgs.TillId
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbKey.TillDetailID)
- Property: OpsSvcEventArgs.Total (System.Decimal)
- Property: OpsSvcEventArgs.VoidAuthEmplId
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbKey.EmployeeID)
- Property: OpsSvcEventArgs.VoidDetailLink (System.Int32)
- Property: OpsSvcEventArgs.VoidReason
(Micros.PosCore.Extensibility.Ops.OpsVoidReason)
- Property: OpsSvcEventArgs.VoidReasonId
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbKey.VoidReasonID)
OpsSvcVoidPreviewEvent
Description: Called prior to when a service charge is voided
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsSvcVoidPreviewEvent', method);
Arguments: OpsSvcEventArgs
- Property: OpsSvcEventArgs.Count (System.Int32)
- Property: OpsSvcEventArgs.Description (System.String)
- Property: OpsSvcEventArgs.EventName (System.String)
- Property: OpsSvcEventArgs.Name (System.String)
- Property: OpsSvcEventArgs.Percent (System.Decimal)
- Property: OpsSvcEventArgs.SvcChargeDef
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbServiceCharge)
- Property: OpsSvcEventArgs.SvcChargeDetail
(Micros.PosCore.Extensibility.Ops.ServiceChargeDetail)
- Property: OpsSvcEventArgs.TillId
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbKey.TillDetailID)
- Property: OpsSvcEventArgs.Total (System.Decimal)
- Property: OpsSvcEventArgs.VoidAuthEmplId
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbKey.EmployeeID)
- Property: OpsSvcEventArgs.VoidDetailLink (System.Int32)
- Property: OpsSvcEventArgs.VoidReason
(Micros.PosCore.Extensibility.Ops.OpsVoidReason)
- Property: OpsSvcEventArgs.VoidReasonId
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbKey.VoidReasonID)
OpsSystemCancelOrderEvent
Description: Called when OPS has been configured to cancel old
orders.
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsSystemCancelOrderEvent', method);
Arguments:
OpsSystemCancelOrderEventArgs
- Property: OpsSystemCancelOrderEventArgs.EventName
(System.String)
OpsSystemCancelOrderPreviewEvent
Description: Called prior to when OPS is configured to cancel old
orders.
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsSystemCancelOrderPreviewEvent', method);
Arguments:
OpsSystemCancelOrderEventArgs
- Property: OpsSystemCancelOrderEventArgs.EventName
(System.String)
OpsTaxDueEvent
Description: Called when a payment has occurred. The tax due is
passed in.
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsTaxDueEvent', method);
Arguments: OpsTaxDueEventArgs
- Property: OpsTaxDueEventArgs.Count (System.Int32)
- Property: OpsTaxDueEventArgs.ObjectNumber (System.Int32)
- Property: OpsTaxDueEventArgs.PaymentAmount (System.Decimal)
- Property: OpsTaxDueEventArgs.TotalTax (System.Decimal)
OpsTimerEvent
Description: (SIM only)
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsTimerEvent', method);
Arguments: OpsTimerEventArgs
OpsTmedEvent
Description: Called when a tender has been applied
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsTmedEvent', method);
Arguments: OpsTmedEventArgs
- Property: OpsTmedEventArgs.ChangeDue (System.Decimal)
- Property: OpsTmedEventArgs.ChargeTipTotal (System.Decimal)
- Property: OpsTmedEventArgs.Count (System.Int32)
- Property: OpsTmedEventArgs.CurrencyID
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbKey.CurrencyID)
- Property: OpsTmedEventArgs.Description (System.String)
- Property: OpsTmedEventArgs.EventName (System.String)
- Property: OpsTmedEventArgs.InterfaceLink
(Micros.PosCore.DataStore.DbRecords.DbInterfaceLink)
- Property: OpsTmedEventArgs.IsDebit (System.Boolean)
- Property: OpsTmedEventArgs.IsPayment (System.Boolean)
- Property: OpsTmedEventArgs.Name (System.String)
- Property: OpsTmedEventArgs.ObjectNumber (System.Int32)
- Property: OpsTmedEventArgs.OpenDrawer (System.Boolean)
- Property: OpsTmedEventArgs.PmsTotals
(Micros.PosCore.Checks.PmsTotals)
- Property: OpsTmedEventArgs.ReferenceEntries
(System.Collections.Generic.List`1)
- Property: OpsTmedEventArgs.RestrictLastItemVoid
(System.Boolean)
- Property: OpsTmedEventArgs.SimChangeDue (System.Decimal)
- Property: OpsTmedEventArgs.TillId
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbKey.TillDetailID)
- Property: OpsTmedEventArgs.TmedDef
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbTenderMedia)
- Property: OpsTmedEventArgs.TmedDetail
(Micros.PosCore.Extensibility.Ops.TenderMediaDetail)
- Property: OpsTmedEventArgs.Total (System.Decimal)
- Property: OpsTmedEventArgs.Void (System.Boolean)
- Property: OpsTmedEventArgs.VoidDetailLink (System.Int32)
- Property: OpsTmedEventArgs.VoidReason
(Micros.PosCore.Extensibility.Ops.OpsVoidReason)
OpsTmedPreviewEvent
Description: Called prior to a tender being applied
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsTmedPreviewEvent', method);
Arguments: OpsTmedEventArgs
- Property: OpsTmedEventArgs.ChangeDue (System.Decimal)
- Property: OpsTmedEventArgs.ChargeTipTotal (System.Decimal)
- Property: OpsTmedEventArgs.Count (System.Int32)
- Property: OpsTmedEventArgs.CurrencyID
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbKey.CurrencyID)
- Property: OpsTmedEventArgs.Description (System.String)
- Property: OpsTmedEventArgs.EventName (System.String)
- Property: OpsTmedEventArgs.InterfaceLink
(Micros.PosCore.DataStore.DbRecords.DbInterfaceLink)
- Property: OpsTmedEventArgs.IsDebit (System.Boolean)
- Property: OpsTmedEventArgs.IsPayment (System.Boolean)
- Property: OpsTmedEventArgs.Name (System.String)
- Property: OpsTmedEventArgs.ObjectNumber (System.Int32)
- Property: OpsTmedEventArgs.OpenDrawer (System.Boolean)
- Property: OpsTmedEventArgs.PmsTotals
(Micros.PosCore.Checks.PmsTotals)
- Property: OpsTmedEventArgs.ReferenceEntries
(System.Collections.Generic.List`1)
- Property: OpsTmedEventArgs.RestrictLastItemVoid
(System.Boolean)
- Property: OpsTmedEventArgs.SimChangeDue (System.Decimal)
- Property: OpsTmedEventArgs.TillId
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbKey.TillDetailID)
- Property: OpsTmedEventArgs.TmedDef
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbTenderMedia)
- Property: OpsTmedEventArgs.TmedDetail
(Micros.PosCore.Extensibility.Ops.TenderMediaDetail)
- Property: OpsTmedEventArgs.Total (System.Decimal)
- Property: OpsTmedEventArgs.Void (System.Boolean)
- Property: OpsTmedEventArgs.VoidDetailLink (System.Int32)
- Property: OpsTmedEventArgs.VoidReason
(Micros.PosCore.Extensibility.Ops.OpsVoidReason)
OpsTmedVoidEvent
Description: Called when a tender has been voided
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsTmedVoidEvent', method);
Arguments: OpsTmedEventArgs
- Property: OpsTmedEventArgs.ChangeDue (System.Decimal)
- Property: OpsTmedEventArgs.ChargeTipTotal (System.Decimal)
- Property: OpsTmedEventArgs.Count (System.Int32)
- Property: OpsTmedEventArgs.CurrencyID
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbKey.CurrencyID)
- Property: OpsTmedEventArgs.Description (System.String)
- Property: OpsTmedEventArgs.EventName (System.String)
- Property: OpsTmedEventArgs.InterfaceLink
(Micros.PosCore.DataStore.DbRecords.DbInterfaceLink)
- Property: OpsTmedEventArgs.IsDebit (System.Boolean)
- Property: OpsTmedEventArgs.IsPayment (System.Boolean)
- Property: OpsTmedEventArgs.Name (System.String)
- Property: OpsTmedEventArgs.ObjectNumber (System.Int32)
- Property: OpsTmedEventArgs.OpenDrawer (System.Boolean)
- Property: OpsTmedEventArgs.PmsTotals
(Micros.PosCore.Checks.PmsTotals)
- Property: OpsTmedEventArgs.ReferenceEntries
(System.Collections.Generic.List`1)
- Property: OpsTmedEventArgs.RestrictLastItemVoid
(System.Boolean)
- Property: OpsTmedEventArgs.SimChangeDue (System.Decimal)
- Property: OpsTmedEventArgs.TillId
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbKey.TillDetailID)
- Property: OpsTmedEventArgs.TmedDef
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbTenderMedia)
- Property: OpsTmedEventArgs.TmedDetail
(Micros.PosCore.Extensibility.Ops.TenderMediaDetail)
- Property: OpsTmedEventArgs.Total (System.Decimal)
- Property: OpsTmedEventArgs.Void (System.Boolean)
- Property: OpsTmedEventArgs.VoidDetailLink (System.Int32)
- Property: OpsTmedEventArgs.VoidReason
(Micros.PosCore.Extensibility.Ops.OpsVoidReason)
OpsTmedVoidPreviewEvent
Description: Called prior to a tender bring voided
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsTmedVoidPreviewEvent', method);
Arguments: OpsTmedEventArgs
- Property: OpsTmedEventArgs.ChangeDue (System.Decimal)
- Property: OpsTmedEventArgs.ChargeTipTotal (System.Decimal)
- Property: OpsTmedEventArgs.Count (System.Int32)
- Property: OpsTmedEventArgs.CurrencyID
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbKey.CurrencyID)
- Property: OpsTmedEventArgs.Description (System.String)
- Property: OpsTmedEventArgs.EventName (System.String)
- Property: OpsTmedEventArgs.InterfaceLink
(Micros.PosCore.DataStore.DbRecords.DbInterfaceLink)
- Property: OpsTmedEventArgs.IsDebit (System.Boolean)
- Property: OpsTmedEventArgs.IsPayment (System.Boolean)
- Property: OpsTmedEventArgs.Name (System.String)
- Property: OpsTmedEventArgs.ObjectNumber (System.Int32)
- Property: OpsTmedEventArgs.OpenDrawer (System.Boolean)
- Property: OpsTmedEventArgs.PmsTotals
(Micros.PosCore.Checks.PmsTotals)
- Property: OpsTmedEventArgs.ReferenceEntries
(System.Collections.Generic.List`1)
- Property: OpsTmedEventArgs.RestrictLastItemVoid
(System.Boolean)
- Property: OpsTmedEventArgs.SimChangeDue (System.Decimal)
- Property: OpsTmedEventArgs.TillId
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbKey.TillDetailID)
- Property: OpsTmedEventArgs.TmedDef
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbTenderMedia)
- Property: OpsTmedEventArgs.TmedDetail
(Micros.PosCore.Extensibility.Ops.TenderMediaDetail)
- Property: OpsTmedEventArgs.Total (System.Decimal)
- Property: OpsTmedEventArgs.Void (System.Boolean)
- Property: OpsTmedEventArgs.VoidDetailLink (System.Int32)
- Property: OpsTmedEventArgs.VoidReason
(Micros.PosCore.Extensibility.Ops.OpsVoidReason)
OpsTndrEvent
Description: (Only used for SIM)
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsTndrEvent', method);
Arguments: OpsTmedEventArgs
- Property: OpsTmedEventArgs.ChangeDue (System.Decimal)
- Property: OpsTmedEventArgs.ChargeTipTotal (System.Decimal)
- Property: OpsTmedEventArgs.Count (System.Int32)
- Property: OpsTmedEventArgs.CurrencyID
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbKey.CurrencyID)
- Property: OpsTmedEventArgs.Description (System.String)
- Property: OpsTmedEventArgs.EventName (System.String)
- Property: OpsTmedEventArgs.InterfaceLink
(Micros.PosCore.DataStore.DbRecords.DbInterfaceLink)
- Property: OpsTmedEventArgs.IsDebit (System.Boolean)
- Property: OpsTmedEventArgs.IsPayment (System.Boolean)
- Property: OpsTmedEventArgs.Name (System.String)
- Property: OpsTmedEventArgs.ObjectNumber (System.Int32)
- Property: OpsTmedEventArgs.OpenDrawer (System.Boolean)
- Property: OpsTmedEventArgs.PmsTotals
(Micros.PosCore.Checks.PmsTotals)
- Property: OpsTmedEventArgs.ReferenceEntries
(System.Collections.Generic.List`1)
- Property: OpsTmedEventArgs.RestrictLastItemVoid
(System.Boolean)
- Property: OpsTmedEventArgs.SimChangeDue (System.Decimal)
- Property: OpsTmedEventArgs.TillId
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbKey.TillDetailID)
- Property: OpsTmedEventArgs.TmedDef
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbTenderMedia)
- Property: OpsTmedEventArgs.TmedDetail
(Micros.PosCore.Extensibility.Ops.TenderMediaDetail)
- Property: OpsTmedEventArgs.Total (System.Decimal)
- Property: OpsTmedEventArgs.Void (System.Boolean)
- Property: OpsTmedEventArgs.VoidDetailLink (System.Int32)
- Property: OpsTmedEventArgs.VoidReason
(Micros.PosCore.Extensibility.Ops.OpsVoidReason)
OpsTndrPreviewEvent
Description: (Only used for SIM)
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsTndrPreviewEvent', method);
Arguments: OpsTmedEventArgs
- Property: OpsTmedEventArgs.ChangeDue (System.Decimal)
- Property: OpsTmedEventArgs.ChargeTipTotal (System.Decimal)
- Property: OpsTmedEventArgs.Count (System.Int32)
- Property: OpsTmedEventArgs.CurrencyID
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbKey.CurrencyID)
- Property: OpsTmedEventArgs.Description (System.String)
- Property: OpsTmedEventArgs.EventName (System.String)
- Property: OpsTmedEventArgs.InterfaceLink
(Micros.PosCore.DataStore.DbRecords.DbInterfaceLink)
- Property: OpsTmedEventArgs.IsDebit (System.Boolean)
- Property: OpsTmedEventArgs.IsPayment (System.Boolean)
- Property: OpsTmedEventArgs.Name (System.String)
- Property: OpsTmedEventArgs.ObjectNumber (System.Int32)
- Property: OpsTmedEventArgs.OpenDrawer (System.Boolean)
- Property: OpsTmedEventArgs.PmsTotals
(Micros.PosCore.Checks.PmsTotals)
- Property: OpsTmedEventArgs.ReferenceEntries
(System.Collections.Generic.List`1)
- Property: OpsTmedEventArgs.RestrictLastItemVoid
(System.Boolean)
- Property: OpsTmedEventArgs.SimChangeDue (System.Decimal)
- Property: OpsTmedEventArgs.TillId
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbKey.TillDetailID)
- Property: OpsTmedEventArgs.TmedDef
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbTenderMedia)
- Property: OpsTmedEventArgs.TmedDetail
(Micros.PosCore.Extensibility.Ops.TenderMediaDetail)
- Property: OpsTmedEventArgs.Total (System.Decimal)
- Property: OpsTmedEventArgs.Void (System.Boolean)
- Property: OpsTmedEventArgs.VoidDetailLink (System.Int32)
- Property: OpsTmedEventArgs.VoidReason
(Micros.PosCore.Extensibility.Ops.OpsVoidReason)
OpsTotalDueEvent
Description: Called when a payment has occurred. The total tue is
passed in.
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsTotalDueEvent', method);
Arguments:
OpsTotalDueEventArgs
- Property: OpsTotalDueEventArgs.Count (System.Int32)
- Property: OpsTotalDueEventArgs.ObjectNumber (System.Int32)
- Property: OpsTotalDueEventArgs.PaymentAmount (System.Decimal)
- Property: OpsTotalDueEventArgs.TotalDue (System.Decimal)
OpsTransactionCancelEvent
Description: Called when a transaction is cancelled
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsTransactionCancelEvent', method);
Arguments:
OpsTransactionCancelPreviewEventArgs
OpsTransactionCancelPreviewEvent
Description: Called prior to a transaction cancel
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsTransactionCancelPreviewEvent', method);
Arguments:
OpsTransactionCancelPreviewEventArgs
OpsTransferCheckEvent
Description: Called when a check is transferred
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsTransferCheckEvent', method);
Arguments:
OpsTransferCheckEventArgs
OpsTransferCheckEventPreview
Description: Called prior to a check being transferred
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsTransferCheckEventPreview', method);
Arguments:
OpsTransferCheckEventArgs
OpsUnassignCashDrawerEvent
Description: Called when a cash drawer is unassigned
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsUnassignCashDrawerEvent', method);
Arguments:
OpsUnassignCashDrawerEventArgs
- Property: OpsUnassignCashDrawerEventArgs.CashDrawerNumber
(System.Int32)
OpsVoidCheckEvent
Description: Called when a check is being voided
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsVoidCheckEvent', method);
Arguments:
OpsVoidCheckEventArgs
- Property: OpsVoidCheckEventArgs.EventName (System.String)
OpsVoidCheckEventPreview
Description: Called prior to a check being previewed
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsVoidCheckEventPreview', method);
Arguments:
OpsVoidCheckEventArgs
- Property: OpsVoidCheckEventArgs.EventName (System.String)
OpsVoidClosedCheckEvent
Description: Called when a closed check is voided
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsVoidClosedCheckEvent', method);
Arguments:
OpsVoidClosedCheckEventArgs
- Property: OpsVoidClosedCheckEventArgs.EventName (System.String)
OpsVoidClosedCheckEventPreview
Description: Called prior to a void check being voided
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsVoidClosedCheckEventPreview', method);
Arguments:
OpsVoidCheckEventArgs
- Property: OpsVoidCheckEventArgs.EventName (System.String)
OpsVoidReasonEvent
Description: 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.
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsVoidReasonEvent', method);
Arguments:
OpsVoidReasonEventArgs
- Property: OpsVoidReasonEventArgs.Prompt (System.Boolean)
- Property: OpsVoidReasonEventArgs.Reason
(Micros.PosCore.Extensibility.Ops.OpsVoidReasonEventArgs.ReasonType)
- Property: OpsVoidReasonEventArgs.ReasonTODOTest (System.Int32)
OpsVoucherEvent
Description: Called when a voucher is printed.
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsVoucherEvent', method);
Arguments:
OpsVoucherEventArgs
- Property: OpsVoucherEventArgs.PayableBase
(Micros.Payment.PayableBase)
- Property: OpsVoucherEventArgs.PrintData (System.Object)
- Property: OpsVoucherEventArgs.VoucherData
(Micros.PosCore.Common.Classes.IVoucherData)
OpsWeighedMiEvent
Description: Called when a weighed item is ordered. Allows the tare
weight to be set or changed.
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsWeighedMiEvent', method);
- Property: OpsMenuItemTareWeightEventArgs.Description
(System.String)
- Property: OpsMenuItemTareWeightEventArgs.EventName
(System.String)
- Property: OpsMenuItemTareWeightEventArgs.ItemWeight
(System.Decimal)
- Property: OpsMenuItemTareWeightEventArgs.MainLevelIndex
(System.Int16)
- Property: OpsMenuItemTareWeightEventArgs.MiClass
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbMenuItemClass)
- Property: OpsMenuItemTareWeightEventArgs.MiDefinition
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbMenuItemDefinition)
- Property: OpsMenuItemTareWeightEventArgs.MiMaster
(Micros.PosCore.Extensibility.DataStore.DbRecords.DbMenuItemMaster)
- Property: OpsMenuItemTareWeightEventArgs.Name (System.String)
- Property: OpsMenuItemTareWeightEventArgs.SubLevelIndex
(System.Int16)
- Property: OpsMenuItemTareWeightEventArgs.TareWeight
(System.Decimal)
OpsWorkstationDownEvent
Description: (Called for SIM when workstation is down)
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsWorkstationDownEvent', method);
Arguments:
OpsWorkstationDownEventArgs
OpsWorkstationUpEvent
Description: (Called for SIM on start up)
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('OpsWorkstationUpEvent', method);
Arguments:
OpsWorkstationUpEventArgs
SubmitCheckEvent
Description: gets triggered for both Service-Total and as well on the
last, final tender. The behavior around aborting SubmitCheckEvent is
Host-Type specific (i.e. Transaction Service would reject the
transaction, OPS would cancel the pending tender). SubmitCheckEvent
allows to iterate through check and check details via a Canonical model
of the check. SubmitCheckEvent allows to add Extensible Info Detail to
check or check detail. SubmitCheckEvent can be rejected via
Extensibility and could be rejected by core. It allows the Ext.App to
attach state data to the event, which will be passed on to
SubmitCheckRejectedEvent. SubmitCheckEvent runs for any Ext.App that
subscribed until one of the Ext.App aborts or all them succeeded.
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('SubmitCheckEvent', method);
Arguments:
SubmitCheckEventArgs
- Property: SubmitCheckEventArgs.Check
(Micros.PosCore.Extensibility.Ops.CheckBase)
- Property: SubmitCheckEventArgs.RejectedMessage (System.String)
SubmitCheckNotificationEvent
Description: SubmitCheckNotificationEvent runs for all Ext.Apps that
subscribed to SubmitCheckEvent, a property will indicate failure and
another property the name of the Ext.App that aborted.
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('SubmitCheckNotificationEvent', method);
Arguments:
SubmitCheckNotificationEvent
- Property: SubmitCheckNotificationEvent.AbortedByExtApp
(System.Boolean)
- Property: SubmitCheckNotificationEvent.ExtAppsThatExecuted
(System.Collections.Generic.IList`1)
- Property: SubmitCheckNotificationEvent.ExtAppThatAborted
(System.String)
- Property: SubmitCheckNotificationEvent.RejectedMessage
(System.String)
- Property: SubmitCheckNotificationEvent.Success (System.Boolean)
SubmitCheckRejectedEvent
Description: SubmitCheckRejectedEvent runs only for Ext.Apps that
executed SubmitCheckEvent already, but not for the one that aborted
SubmitCheckEvent. These Ext.Apps will receive SubmitCheckRejectedEvent
in reverse order.
Example
var _api = SimphonyExtensibilityAPI;
_api.Eventing.SubscribeToEvent('SubmitCheckRejectedEvent', method);
Arguments:
SubmitCheckRejectedEventArgs
- Property: SubmitCheckRejectedEventArgs.AbortedByExtApp
(System.Boolean)
- Property: SubmitCheckRejectedEventArgs.ExtAppsThatExecuted
(System.Collections.Generic.IList`1)
- Property: SubmitCheckRejectedEventArgs.ExtAppThatAborted
(System.String)
- Property: SubmitCheckRejectedEventArgs.RejectedMessage
(System.String)