OpsContext Properties |
The OpsContext type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | ActiveSeat |
The currently active seat that will be used on the next ordered parent
|
| ActivityLog |
Activity Log
|
| AlertContext | |
| AlwaysHideFrame | |
| AmountDueHeader |
The title of the column showing the amount due when displaying a list of open checks.
|
| AuthenticationStatus |
The Ops Authentication Status returned from the ServiceAuthenticator
|
| AutoServiceChargeDescriptor |
The text to be used as a label when displaying the auto service charge.
|
| AvailableMemory | Available memory in system |
| BackupPrinterNum | Backup Printer Number |
| BanquetCheckPrinterNum | Laser Printer Number |
| BatteryLifePercent | |
| Blank |
Returns blank (for blank binding purposes such as the status bar)
|
| CALUrl | |
| CAPSConnectionStatus | This element will display offline or online depending on whether the workstation can communicate with CAPS. |
| CashManagementInfo | |
| ChangeDueDescriptor |
The text to be used as a label when displaying the change due to the customer.
|
| Check | The current check header if a check is open. |
| CheckActive |
True if there is a currently active guest check.
|
| CheckAutoServiceCharge |
Total Auto Service Charges that have been applied to the currently active check.
|
| CheckAutoServiceChargeZero |
True if Total Auto Service Charges that have been applied to the currently active check is not zero.
|
| CheckChangeDue |
The change to be given to the customer after all all items, charges, taxes and payments have been totalized.
|
| CheckChangeDueZero |
True if The change due on the currently active check is not zero.
|
| CheckContext |
Check data
|
| CheckCurrencySymbol |
The symbol of the currency currently being used by OPS.
|
| CheckCurrentEventActualStartDateTime |
Actual start date/time of any group event associated with the current check.
|
| CheckCurrentEventEndDateTime |
Scheduled end date/time of any group event associated with the current check.
|
| CheckCurrentEventName |
Name of any group event associated with the current check.
|
| CheckCurrentEventShortCode |
Short code of any group event associated with the current check.
|
| CheckDetail | The current check detail if a check is open. |
| CheckDiscount |
Total discounts that have been applied to the currently active check.
|
| CheckDiscountZero |
True if Total discounts that have been applied to the currently active check is not zero.
|
| CheckEmployeeCheckName |
The name of the employee that picked up or began the check.
|
| CheckGroup |
The group number if this check is assigned to a table and there are multiple groups at the table.
|
| CheckGuestCount |
The number of guests assigned to the check.
|
| CheckGuestCountIdentification |
Guest count identification. The format is "GST # if count not 0, blank otherwise.
|
| CheckGuestCountText |
The number of guests assigned to the check.
|
| CheckHeaderLines |
Return check standard header lines which max line equals 6
|
| CheckHeaderLinesCount |
Return Check Header Lines' Count
|
| CheckIdHeader |
The title of the column showing the check Id when displaying a list of open checks.
|
| CheckIsOpen | Indicates if a check is currently open. |
| CheckName |
Name of the currently active guest check if a name was assigned to the check.
|
| CheckNameHeader |
The title of the column showing the check name due when displaying a list of open checks.
|
| CheckNumber |
Number of the currently active guest check.
|
| CheckNumberHeader |
The title of the column showing the check number when displaying a list of open checks.
|
| CheckNumberText |
Number of the currently active guest check as a string.
Returns an empty string if there is no check active.
|
| CheckOpenHeader |
The title of the column showing the amount due when displaying a list of open checks.
|
| CheckOpenTime |
The time the check was begun.
|
| CheckOther |
Total of other charges that have been applied to the currently active check.
|
| CheckOtherZero |
True if Total of other charges that have been applied to the currently active check is not zero.
|
| CheckPayment |
Total payments that have been applied to the currently active check.
|
| CheckPaymentZero |
True if Total payments that have been applied to the currently active check is not zero.
|
| CheckSubtotal |
Subtotal of the items on the currently active check.
|
| CheckSubtotalZero |
True if Subtotal of the items on the currently active check is not zero.
|
| CheckSummaryDataList |
A list of check summary information for all open checks.
|
| CheckTableAndGroupText |
Check Table Text And Group in format
"TBL {TableTextAndGroup}"
Where {TableTextAndGroup} =
The "table number/group" if non-blank and table number is used. if table is 0 then blank is returned.
The "table name/group" if non-blank and table name is used. if table is 0 then blank is returned.
|
| CheckTableName |
The table name if this check is assigned to a table.
|
| CheckTableNumber |
The table number if this check is assigned to a table.
|
| CheckTax |
Total tax that has been applied to the currently active check.
|
| CheckTaxZero |
True if Total tax that has been applied to the currently active check is not zero.
|
| CheckTotalDue |
The total due on the currently active check. This is the sum of all items, charges, taxes and payments.
|
| CheckTotalDueCurrency |
The total due on the currently active check. This is the sum of all items, charges, taxes and payments
in current displayed currency
|
| CheckTotalDueRoundedUp |
The total due on the currently active check rounded up to the nearest whole currency unit.
|
| CheckTotalDueRoundedUpCurrency |
The total due on the currently active check rounded up to the nearest whole currency unit
in current displayed currency.
|
| CheckTotalDueZero |
True if The total due on the currently active check is not zero. This is the sum of all items, charges, taxes and payments.
|
| CheckTrailerLines |
Return check standard trailer lines
|
| CheckTrailerLinesCount |
Return Check Trailer Lines' Count
|
| ClearScreenAfterTransaction | |
| ClickCount |
For internal use only.
|
| ClosedCheckEmployees |
A unique list of employees that exist in the current filtered set of closed checks.
|
| ClosedCheckFilter |
Data used to filter ClosedCheckSummaryDataList
|
| ClosedCheckSummaryDataList |
A list of check summary information for closed checks.
|
| ComboMealSidePrompt |
Combo Meal Side Prompt
|
| CommandLog |
A list of CommandLogEntries
|
| Company |
Company.
|
| ConnectionStatusIsOnline |
TRUE if the connection status is online. FALSE if we are Offline or OfflineWithoutPermission.
|
| ConnectionStatusText |
Text describing the current communications status.
|
| Container |
The object that contains this OpsContext instance.
|
| Copyright |
Copyright.
|
| CurbsideCheckActive |
True if there is a currently active curbside guest check.
|
| CurrencySymbolOnRight |
True if the currency decimal character is on the right side of the total
|
| CurrencyUseThousandSeparator |
True if the base currency uses thousand separator character.
|
| CurrentBaseCurrencyDp |
The number of decimal places to be displayed when displaying currency amounts.
|
| CurrentChildItem |
Number of the currently selected child item on the check.
|
| CurrentChildsParentItem |
Number of the parent of the currently selected child item on the check.
If a condiment of a Combo meal side is selected, the condiments parent is the Combo Meal side (not the Combo Meal parent).
|
| CurrentCurrencyDp |
The number of decimal places to be displayed when displaying currency amounts
for current displayed currency.
|
| CurrentCurrencySymbol |
The symbol of the currency currently being displayed.
|
| CurrentDateTime |
The current date and time.
|
| CurrentDateTimeText | The current date and time as a long string. eg. 1/3/2002 12:00:00 AM |
| CurrentDecimalSeparator |
The decimal separator currently used by OPS when displaying currencies.
|
| CurrentDisplayedCurrencyID |
The Currency ID of the current displayed currency
|
| CurrentLangId |
Identifier of the current language id being used by OPS.
|
| CurrentLangObjNum |
Identifier of the current language object number being used by OPS.
|
| CurrentLocaleId |
Identifier of the current locale Id being used by OPS
|
| CurrentLocaleInfoPrint | |
| CurrentLongDateTimeText |
The current date and time as a long string. eg. Thursday, January 03, 2002 12:00:00 AM
|
| CurrentOrderConfirmationBoard |
The Current Order Confirmation Board which displays data.
|
| CurrentParentItem |
Number of the currently selected parent item on the check.
|
| CurrentParentItemAnonymous | True if the current parent item is anonymous. |
| CurrentParentItemCount |
Number of parent items on the currently active check.
|
| CurrentParentItemName |
The name of the currently selected parent item.
|
| CurrentParentItemValid |
True if the CurrentParentItem is a valid parent item.
|
| CurrentPrintLocaleId |
Identifier of the current locale id of print being used by OPS
|
| CurrentThousandSeparator |
The thousand separator currently used by OPS when displaying currencies.
|
| CursorOn |
Get the cursor settings from the db.
|
| DataStore |
Please do not use this Property. Use the DataStore instead.
|
| DataStoreConnectionStatusIsOnline | Obsolete.
TRUE if the DataStore connection status is online. FALSE if we are Offline.
|
| DataStoreConnectionStatusText | Obsolete.
Text describing the current DataStore communication status with central server.
|
| DefaultKeyboardState |
This bool is used to check if the default alpha-numeric keyboard is being used.
|
| DeliveryCheckActive |
True if there is a currently active delivery guest check.
|
| DeliveryTakeoutInfo | |
| DiscountDescriptor |
The text to be used as a label when displaying the check's Discount total.
|
| DiscountEngineLog |
Discount Engine Log
|
| DisplayDetail |
Provided DisplayDetail Property, Only copy required data from sorted check detail
to DisplayDetailList list object of ExtensibilityOpsDisplayDetailClass.
DisplayDetailList will be expose to Starbux.py for PrintLabel Job.
|
| DisplayType | The display type of the workstation |
| DTOCheckActive |
True if there is a currently active takeout, curbside or delivery guest check.
|
| EGatewayURL |
EGateway URL
|
| EmployeeHeader |
The title of the column showing the owning employee when displaying a list of open checks.
|
| EmployeeSignedIn |
Flag indicating if an employee is signed in
|
| EmplSession | The employee session data if an employee is signed in. |
| EndorsementPrinterNum | Endorsement Printer Number |
| EnterpriseConnectionStatus | Obsolete. This element will display offline or online depending on whether the workstation can communicate with the Enterprise. |
| EntryArea |
Contains entered information such as keyboard entry. On the sign in screen this field will be masked.
|
| EntryAreaValue |
Contains entry area information as a decimal entry. Will be null if entry area is invalid
decimal entry OR entry area is blank.
|
| ErrorBeeperEnabled |
True if the error beeper has been enabled for this workstation.
|
| ExtensibilityState | |
| FlowDirection | |
| FullCheckSummaryDataList |
A list of check summary information for all open checks.
|
| GuestCheckPrinterNum | Guest Check Printer Number |
| HoldIndicator |
Contains status text of the 'Hold Status' for 'Hold Indicator' status bar.
|
| HoldIndicatorFlag |
Contains status of the 'Hold Status' as a boolean value specially for mobile devices.
|
| HoldState | |
| HostName |
Gets the programmed HostName for this servicehost.
|
| Initialized |
Returns true if this OpsContext instance has been initialized.
|
| IPaddress |
Get IP Address of OPS.
|
| IsCurrentCurrencyBase |
True if the current displayed currency is the base currency.
|
| IsFastTransaction |
Return true if fast transaction check
Otherwise a guest check
|
| IsHHT |
Is Hand helds
|
| IsTouchSplitCheckPage |
- Getter or Setter to know if CheckDetailArea2.xaml.cs
is called from TouchSplit Command or not
since CheckDetailArea2.xaml.cs can be called from
ViewCheckDetail Command as well
- is set to true in Operations.Check.SplitCheck.cs
|
| IsVoidOrReturnTransaction |
Return true if check started in void or return mode
FPS-12683
|
| KdsOrderDestination | This element will display which KDS Controller (the Primary or the Backup) the current Revenue Center is sending Order to. |
| KeyBeeperEnabled |
True if the keyboard beeper has been enabled for this workstation.
|
| KitchenThemeName |
The name of the current kitchen theme.
|
| LastAction |
Contains text indicating the last action performed by the system.
|
| LastEntryArea |
Displays the lastest action performed by the system or entered information such as keyboard entry.
|
| LastEntryAreaIsEntryArea |
True if the LastEntryArea is EntryArea, false otherwise.
|
| LaunchKDSDisplay | |
| LocalOrderPrinterNum | Local Order Printer Number |
| LocationFromLeft | |
| LocationFromTop | |
| LocationId |
Location id.
Returns the Location id associated with this workstation. If none is found due
to improper configuration then a -1 is returned.
|
| MainMenuLevel |
The main menu level.
|
| MainMenuLevelIndex |
The main menu level index.
|
| MaxDialogResolutionColumns |
The max number of screen resolution columns a dialog should be.
|
| MaxDialogResolutionRows |
The max number of screen resolution columns a dialog should be.
|
| MemoCheckPrinterNum | Memo Check Printer Number |
| MenuItemOrdererLog |
Menu Item Orderer Log
|
| MenuItemSummaryData |
A list of Menu Item Summary entries.
|
| MenuLevel |
A dictionary of active menu levels.
|
| Networking |
Networking access.
|
| NTEPCC |
National Turfgrass Evaluation Program Certificates of Conformance.
|
| ObjectPropertyBag |
Property bag containing objects for use in this context.
|
| OperatingSystem |
Operating System
|
| OperatorCurrentEventActualStartDateTime |
Actual start date/time of any operator assigned group event.
|
| OperatorCurrentEventEndDateTime |
Scheduled end date/time of any operator assigned group event.
|
| OperatorCurrentEventName |
Name of any operator assigned group event.
|
| OperatorCurrentEventShortCode |
Short code of any operator assigned group event.
|
| OpsTranslatedText |
Translated text for Ops in the current language on the workstation.
|
| OpsTranslatedTextWs |
Translated text for Ops in the default language as configured for the workstation.
|
| OrderMethodName |
The name of the order method assigned to the check.
|
| OrderStatusID |
The order status assigned to the check.
|
| OrderStatusName |
The name of the order status assigned to the check.
|
| OrderTypeName |
The name of the order type assigned to the check.
|
| OrderTypeNumber |
The order type assigned to the check.
|
| OrganizationId |
Organization id.
Returns the organization id associated with this workstation. If none is found due
to improper configuration then a -1 is returned.
|
| OtherDescriptor |
The text to be used as a label when displaying the check's Other total.
|
| PageID | Current page database ID |
| PageNumber | Current page database object number |
| PageTemplateID | Database ID of currrent page template displayed |
| PaymentDescriptor |
The text to be used as a label when displaying the check's Payments total.
|
| Platform |
Platform
|
| PlaybackInProgress |
Indicates if the OPS autotest playback is in progress
|
| PosCoreTranslatedText |
Translated text for PosCore in the current language on the workstation.
|
| PosCoreTranslatedTextWs |
Translated text for PosCore in the default language as configured for the workstation.
|
| PowerStatus |
Returns the battery status if present.
|
| PrimaryCheckIdentification |
Check name if not blank, tabletext/group if not blank, otherwise check number
|
| ProcessingDialog |
True if an Ops dialog is displaying or in process of being displayed.
|
| Product |
Product.
|
| PromptArea |
Displays text prompting the user to perform some action.
|
| PropertyBag |
Property bag containing string for use in this context.
|
| PropertyID |
The property id.
|
| PropertyName |
The name of the property where this workstation resides.
|
| PropertyNumber |
The unique number of the property where this workstation resides.
|
| PropHierStrucID |
The property hierarchy structure ID.
|
| ReceiptPrinterNum | Receipt Printer Number |
| ReceptacleBalancingItemID | |
| RemainingComboSideCount |
Remaining Combo Meal Side Count
|
| ReportPrinterNum | Report Printer Number |
| ResetDTODashboard | |
| ResolutionColumns |
The number of screen resolution columns configured for this workstation.
|
| ResolutionRows |
The number of screen resolution rows configured for this workstation.
|
| ReturnEnabled |
The currently active check is in the "return" state.
|
| ReturnText |
This field indicates the "return" state of the currently active check.
|
| RvcID |
The unique ID of the current revenue center.
|
| RvcName |
The name of the current revenue center.
|
| RvcNumber |
The unique number of the current revenue center.
|
| RvcNumberText |
The unique text of the current revenue center (blank if not set)
|
| ScreenLanguageFontFamily |
The font family of the current screen language. Default to Courier New.
|
| ScreenLanguageFontSize |
The font size of the current screen language. Default to 12.
|
| SeatPlating |
The "SeatPlating" state.
|
| SecondaryCheckIdentification |
Tabletext/group if check name not blank, otherwise check number
|
| ServingPeriod |
The current serving period.
|
| ServingPeriodId |
The current serving period.
|
| ServingPeriodNumber |
The current serving period number.
|
| ShowCALUrl | Set to false if TimsInfoKey is Pressed at SignIn. True by default for System Information Panel |
| ShowCheckSummaryArea |
True if Total tax that has been applied to the currently active check is not zero.
|
| ShowIPAddress | Set to false if TimsInfoKey is Pressed at SignIn. True by default for System Information Panel |
| SortedDetail |
The sorted check detail for the current check.
|
| StartTime |
Time that OPS was started.
|
| StartTimeText |
Time that OPS was started as a long date and time string.
|
| SubMenuLevel |
The sub menu level.
|
| SubMenuLevelIndex |
The sub menu level index.
|
| SubtotalDescriptor |
The text to be used as a label when displaying the check's Subtotal.
|
| TableNameHeader |
The title of the column showing the table name/group number when displaying a list of open check
|
| TableTextAndGroup |
The table name/group if non-blank, otherwise the table number. if table is 0 then blank is returned.
|
| TakeoutCheckActive |
True if there is a currently active takeout guest check.
|
| TaxDescriptor |
The text to be used as a label when displaying the check's Tax total.
|
| TaxExemptEnabled |
The check is exempt from taxes.
|
| TaxExemptText |
The reason the check is exempt from taxes.
|
| TertiaryCheckIdentification |
Check number if check name and table not blank.
|
| TillAssignedToWorkstation |
Will be set to true if a till is assigned to any of the workstations cash drawers.
|
| TimeCardPrinterNum | Time Card Printer Number |
| TimeChitPrinterNum | Time Chit Printer Number |
| TotalDueDescriptor |
The text to be used as a label when displaying the total due on the check.
|
| TotalMemory | Total memory in system |
| TrainingModeEnabled |
True if the current transaction is a "Training Mode" transaction.
|
| TrainingModeText |
Text to be used to indicate that the current transaction is a "Training Mode" transaction.
|
| TransactionOrderTypeName |
The name of the transaction order type assigned to the check.
|
| TransactionOrderTypeNumber |
The transaction order type assigned to the check.
|
| TransCashierName |
Check name of the cashier associated with the currently signed in employee
|
| TransCashierNumber |
Number of the cashier associated with the currently signed in employee
|
| TransEmployeeCheckName |
Check name of the currently signed in employee.
|
| TransEmployeeClassNumber |
Employee class of current employee.
|
| TransEmployeeFirstName |
First name of the currently signed in employee.
|
| TransEmployeeFullName |
Last name of the currently signed in employee.
|
| TransEmployeeID |
ID of the currently signed in employee.
|
| TransEmployeeIsInTraining |
boolean flag stating if the signed in employee is in training mode or not.
|
| TransEmployeeLastName |
Last name of the currently signed in employee.
|
| TransEmployeeNumber |
Number of the currently signed in employee.
|
| TransReturnEnabled |
The currently active check is in the "transaction return" state.
|
| TransReturnText |
This field indicates the "transaction return" state of the currently active check.
|
| TransVoidEnabled |
The currently active check is in the "transaction void" state.
|
| TransVoidReasonIdValue |
The reason id value for a transaction void that is being performed.
|
| TransVoidText |
The reason a transaction void is being performed.
|
| UnmaskedEntryArea |
Contains entered information such as keyboard entry.
|
| Uptime |
The period of time since OPS was last started.
|
| UptimeText |
The period of time since OPS was last started as a formatted string.
|
| UsedMemory | Used memory in system |
| ValidationPrinterNum | Validation Printer Number |
| Version |
Current version of OPS.
|
| ViewByCourse |
The currently active check is in the "ViewByCourse" state.
|
| ViewByFamilyGroup |
The currently active check is in the "ViewByFamilyGroup" state.
|
| ViewByItemEntry |
The currently active check is in the "ViewByItemEntry" state.
|
| ViewByMajorGroup |
The currently active check is in the "ViewByMajorGroup" state.
|
| ViewBySeat |
The currently active check is in the "ViewBySeat" state.
|
| ViewFireTimes |
The currently active check is in the "ViewFireTimes" state.
|
| VisualState |
The current visual state.
|
| VoidEnabled |
The currently active check is in the "void" state.
|
| VoidText |
This field indicates the "void" state of the currently active check.
|
| VoucherPrinterNum | Voucher Printer Number |
| WirelessQuality | |
| WorkstationClass |
The unique number of this workstation.
|
| WorkstationID |
The unique ID of this workstation.
|
| WorkstationLockStatus |
The Lock/Unlock status of the of the current workstation.
|
| WorkstationName |
The name of the of the current workstation.
|
| WorkstationNumber |
The unique number of this workstation.
|
See Also