Custom Button Panels in the Management Console and the POS in iVend Retail

Introduction

This knowledge base article will assist developers on how to create a custom button panel in the iVend Management Console and at the POS.

Refer to. the CitiXsys Knowledge Portal for more details and code samples.

Purpose

The main purpose for allowing the creation of custom button panels in the iVend Management Console and in the iVend Retail Point of Sale (POS) is to provide developers with flexibility to customize the application’s button panels by adding new buttons using the iVend Retail Extensibility Framework, which may be important to ongoing development of their business operations.

Custom Button Panel on Management Console and POS

The iVend Retail Extensibility Framework allows developers to customize the Management Console and POS button panels by adding up to 12 buttons.

The following tables document the Custom Button Panels and screens that are available for customisation within the Management Console and the POS.

1. The following table represents the list of custom button screens supported in the Management Console:

Screen Name	Type
BankSearchView	Search Screen
BranchSearchView	Search Screen
UserDefinedValidValuesSearchView	Search Screen
CustomerDiscountGroupSearchView	Search Screen
CustomerPriceGroupSearchView	Search Screen
BatchLocationSearchView	Search Screen
ProductDiscountGroupSearchView	Search Screen
MerchandiseHierarchySearchView	Search Screen
UOMGroupSearchView	Search Screen
UOMSearchView	Search Screen
LoyaltyCardInformationSearchView	Search Screen
LoyaltyCustomerGroupSearchView	Search Screen
LoyaltySlabSearchView	Search Screen
ReportSearchView	Search Screen
ThermalLabelSearchView	Search Screen
BarCodeMaskSearchView	Search Screen
CultureInformationSearchView	Search Screen
EmailSMSTemplateSearchView	Search Screen
LocationSearchView	Search Screen
EmailTemplateSearchView	Search Screen
CommissionPlanSearchView	Search Screen
CountySearchView	Search Screen
MembershipSearchView	Search Screen
CurrencySearchView	Search Screen
PaymentTypeSearchView	Search Screen
PriceListSearchView	Search Screen
PackageSearchView	Search Screen
PackageGroupSearchView	Search Screen
ProductCategorySearchView	Search Screen
ProductClassSearchView	Search Screen
CountrySearchView	Search Screen
CustomerGroupSearchView	Search Screen
CustomerSearchView	Search Screen
GiftCerificateSearchView	Search Screen
InventoryCountSearchView	Search Screen
InventoryCycleSearchView	Search Screen
WarehouseListView	Search Screen
CustomTransactionInfoGridSearchView	Search Screen
EventSearchView	Search Screen
PoleDisplayMessageSearchView	Search Screen
ReasonCodeSearchView	Search Screen
RetailProfileSearchView	Search Screen
StoreListView	Search Screen
SubsidiarySearchView	Search Screen
PropertyCaptionSearchView	Search Screen
ValidationRulesSetupSearchView	Search Screen
SearchGridColumnSearchView	Search Screen
FulfillmentPlanSearchView	Search Screen
BatchSearchView	Search Screen
ManufacturerSearchView	Search Screen
SerialSearchView	Search Screen
EmployeePositionSearchView	Search Screen
JobCodeSearchView	Search Screen
LaborUserSearchView	Search Screen
TeamSearchView	Search Screen
ProductGroupSearchView	Search Screen
ProductSearchView	Search Screen
DepartmentSearchView	Search Screen
ShippingTypeSearchView	Search Screen
StateSearchView	Search Screen
SurchargeSearchView	Search Screen
TaxAuthoritySearchView	Search Screen
TaxAuthorityTypeSearchView	Search Screen
TaxCodeSearchView	Search Screen
WarehouseSearchView	Search Screen
VendorGroupSearchView	Search Screen
VendorSearchView	Search Screen
CustomerPrintingSearchView	Search Screen
FulfillmentSearchView	Search Screen
GCGoodsReceiptSTSearchView	Search Screen
GoodsReturnSearchView	Search Screen
LocationStockTransferSearchView	Search Screen
ProductGrossMarginSearchView	Search Screen
GoodsIssueSearchView	Search Screen
GoodsReceiptSearchView	Search Screen
InventoryRevaluationSearchView	Search Screen
ItemPrintingSearchView	Search Screen
InventoryAttributeSearchView	Search Screen
ForecastPlanningSearchView	Search Screen
PlanningScenarioSearchView	Search Screen
GoodsReceiptPOSearchView	Search Screen
PurchaseOrderSearchView	Search Screen
GoodsReceiptSTSearchView	Search Screen
StockTransferRequestDetailSearchView	Search Screen
StockTransferRequestReceivedSearchView	Search Screen
StockTransferRequestSearchView	Search Screen
StockTransferSearchView	Search Screen
LaborSessionSearchView	Search Screen
LoyaltyAdjustmentJournalSearchView	Search Screen
LoyaltyCardTransferSearchView	Search Screen
LoyaltyMembershipGroupSearchView	Search Screen
LoyaltyNotificationSearchView	Search Screen
LoyaltyPlanSearchView	Search Screen
LoyaltyPrePrintedCardSearchView	Search Screen
LoyaltyProductGroupSearchView	Search Screen
LoyaltyProductSearchView	Search Screen
LoyaltySpecialDaysSearchView	Search Screen
LoyaltyStoreSearchView	Search Screen
LoyaltyTransactionImportSearchView	Search Screen
LoyaltyDocumentNumberSeriesSearchView	Search Screen
LoyaltySecurityUserSearchView	Search Screen
TenderTypeSearchView	Search Screen
ConsignmentSearchView	Search Screen
LayawayPlanSearchView	Search Screen
ProductPriceManagerSearchView	Search Screen
SpecialPriceListMasterSearchView	Search Screen
PromotionBonusBuysSearchView	Search Screen
PromotionCouponSearchView	Search Screen
DashboardSearchView	Search Screen
AlertNotificationSearchView	Search Screen
EnterpriseDataPurgeSearchView	Search Screen
ExpenseSearchView	Search Screen
HardwareProfileSearchView	Search Screen
HardwareRegisterSearchView	Search Screen
LineAttributeSearchView	Search Screen
PaymentProcessorSearchView	Search Screen
POSDocumentNumberSeriesSearchView	Search Screen
POSSearchView	Search Screen
PrintProfileSearchView	Search Screen
QueryBuilderSearchView	Search Screen
RetailMessageSearchView	Search Screen
SaleAttributeSearchView	Search Screen
StageAuthorizationSearchView	Search Screen
DisplayProfileSearchView	Search Screen
StageSearchView	Search Screen
StoreGroupSearchView	Search Screen
StoreSearchView	Search Screen
TaxEventsSearchView	Search Screen
UserDefinedFieldsSearchView	Search Screen
ScheduleSearchView	Search Screen
SearchGridDefinitionSearchView	Search Screen
SecurityGroupSearchView	Search Screen
SecurityRoleSearchView	Search Screen
SecurityUserSearchView	Search Screen
MasterTillSearchView	Search Screen
TillSearchView	Search Screen
BankAddEditView	Add Edit View
BranchAddEditView	Add Edit View
InventoryAttributeAddEditView	Add Edit View
ItemMatrixInheritPropertiesView	Add Edit View
ProductMarginCalculationView	Add Edit View
ProductDefaultSettingAddEditView	Add Edit View
ProductGroupAddEditView	Add Edit View
UPCTranslationView	Add Edit View
LoyaltyCardActivationView	Add Edit View
ItemMatrixGlobalSettingView	Add Edit View
MerchandiseHierarchyAddEditView	Add Edit View
ProductCostAddEditView	Add Edit View
UOMAddEditView	Add Edit View
UOMGroupAddEditView	Add Edit View
LoyaltyCustomerGroupAddEditView	Add Edit View
LoyaltySlabAddEditView	Add Edit View
ReportAddEditView	Add Edit View
ThermalLabelAddEditView	Add Edit View
BarCodeMaskAddEditView	Add Edit View
CultureInformationAddEditView	Add Edit View
EmailSMSTemplateView	Add Edit View
LocationAddEditView	Add Edit View
EmailTemplateView	Add Edit View
AddressAddEditView	Add Edit View
CommissionPlanAddEditView	Add Edit View
ContactAddEditView	Add Edit View
CountyAddEditView	Add Edit View
ClubMembershipActivationView	Add Edit View
CurrencyAddEditView	Add Edit View
PaymentTypeAddEditView	Add Edit View
PaymentTypeAttributeAddEditView	Add Edit View
PriceListAddEditView	Add Edit View
PackageAddEditView	Add Edit View
PackageGroupAddEditView	Add Edit View
ProductCategoryAddEditView	Add Edit View
ProductClassAddEditView	Add Edit View
CountryAddEditView	Add Edit View
CreditCardAddEditView	Add Edit View
CustomerAccountsReceivableAddEditView	Add Edit View
CustomerAddEditView	Add Edit View
CustomerGroupAddEditView	Add Edit View
GiftCertificateAddEditView	Add Edit View
InventoryCycleAddEditView	Add Edit View
ReportEmailView	Add Edit View
CustomTransactionInfoGridAddEditView	Add Edit View
EventAddEditView	Add Edit View
PoleDisplayMessageAddEditView	Add Edit View
PropertyCaptionSetupAddEditView	Add Edit View
ReasonCodeAddEditView	Add Edit View
RetailProfileAddEditView	Add Edit View
SubsidiaryAddEditView	Add Edit View
ValidationRulesSetupAddEditView	Add Edit View
SearchGridColumnAddEditView	Add Edit View
FulfillmentPlanAddEditView	Add Edit View
BatchAddEditView	Add Edit View
ManufacturerAddEditView	Add Edit View
SerialAddEditView	Add Edit View
EmployeePositionAddEditView	Add Edit View
JobCodeAddEditView	Add Edit View
LaborUserAddEditView	Add Edit View
TeamAddEditView	Add Edit View
ProductAddEditView	Add Edit View
DepartmentAddEditView	Add Edit View
ShippingTypeAddEditView	Add Edit View
StateAddEditView	Add Edit View
SurchargeAddEditView	Add Edit View
TaxCodeByZipCodeView	Add Edit View
TaxAuthorityAddEditView	Add Edit View
TaxAuthorityTypeAddEditView	Add Edit View
TaxCodeAddEditView	Add Edit View
WarehouseAddEditView	Add Edit View
VendorGroupAddEditView	Add Edit View
VendorAddEditView	Add Edit View
VendorProductView	Add Edit View
CustomerCatalogView	Add Edit View
CustomerNotesAddEditView	Add Edit View
CustomerPrintingAddEditView	Add Edit View
DeliveryPackageView	Add Edit View
FulFillmentEditView	Add Edit View
MobilePOSDeliveryView	Add Edit View
AlternateProductView	Add Edit View
AssemblyDetailsView	Add Edit View
GCGoodsReceiptSTView	Add Edit View
GCGoodsReceiptView	Add Edit View
GCStockTransferView	Add Edit View
GoodsReturnView	Add Edit View
LocationStockTransferAddEditView	Add Edit View
ProductGrossMarginAddEditView	Add Edit View
GoodsIssueView	Add Edit View
GoodsReceiptView	Add Edit View
InventoryRevaluationAddEditView	Add Edit View
InventoryTransactionSurchargeAddEditView	Add Edit View
ItemPrintingAddEditView	Add Edit View
KitSetupView	Add Edit View
ForecastPlanningAddEditView	Add Edit View
MRPSettingsAddEditView	Add Edit View
PlanningScenarioAddEditView	Add Edit View
GoodsReceiptPOView	Add Edit View
PurchaseOrderView	Add Edit View
GoodsReceiptSTView	Add Edit View
StockTransferAddEditView	Add Edit View
StockTransferRequestAddEditView	Add Edit View
StockTransferRequestReceivedAddEditView	Add Edit View
UpsellProductView	Add Edit View
EditTimeClockAddEditView	Add Edit View
LoyaltyAdjustmentJournalAddEditView	Add Edit View
LoyaltyCardTransferAddEditView	Add Edit View
LoyaltyConfigAddEditView	Add Edit View
LoyaltyMembershipGroupAddEditView	Add Edit View
LoyaltyNotificationAddEditView	Add Edit View
LoyaltyPlanAddEditView	Add Edit View
LoyaltyPrePrintedCardAddEditView	Add Edit View
LoyaltyPrePrintedCardAutomaticGenerationView	Add Edit View
LoyaltyProductAddEditView	Add Edit View
LoyaltyProductGroupAddEditView	Add Edit View
LoyaltyReferralSetupAddEditView	Add Edit View
LoyaltySpecialDaysAddEditView	Add Edit View
LoyaltyStoreAddEditView	Add Edit View
LoyaltyDocumentNumberSeriesAddEditView	Add Edit View
LoyaltySecurityUserAddEditView	Add Edit View
TenderTypeAddEditView	Add Edit View
ExchangeRateView	Add Edit View
ConsignmentAddEditView	Add Edit View
LayawayPlanAddEditView	Add Edit View
ProductPriceManagerAddEditView	Add Edit View
SpecialPriceDiscountGroupView	Add Edit View
SpecialPriceListDateView	Add Edit View
SpecialPriceListMasterView	Add Edit View
SpecialPriceListQuantityView	Add Edit View
SpecialPriceListView	Add Edit View
PromotionBonusBuysAddEditView	Add Edit View
PromotionCouponAddEditView	Add Edit View
RentalPlanAddEditView	Add Edit View
DashboardAddEditView	Add Edit View
LabelPrintingView	Add Edit View
AlertNotificationAddEditView	Add Edit View
AlertNotificationView	Add Edit View
RetailConfig.AuditLogMasterAddEditView	Add Edit View
CloudServiceStatusAddEditView	Add Edit View
EnterpriseAddEditView	Add Edit View
EnterpriseDataPurgeView	Add Edit View
EnterpriseSettingsView	Add Edit View
ExpenseAddEditView	Add Edit View
DisplayProfileAddEditView	Add Edit View
HardwareProfileAddEditView	Add Edit View
HardwareRegisterAddEditView	Add Edit View
LineAttributeAddEditView	Add Edit View
LineAttributeAddEditViewOld	Add Edit View
PaymentProcessorAddEditView	Add Edit View
POSAddEditView	Add Edit View
POSDocumentNumberSeriesAddEditView	Add Edit View
PrintProfileAddEditView	Add Edit View
QueryBuilderAddEditView	Add Edit View
ReportEmailView	Add Edit View
RetailMessageAddEditView	Add Edit View
SaleAttributeAddEditView	Add Edit View
StageAddEditView	Add Edit View
StageAuthorizationAddEditView	Add Edit View
StoreAddEditView	Add Edit View
StoreGroupAddEditView	Add Edit View
TaxEventsAddEditView	Add Edit View
UserDefinedFieldsAddEditView	Add Edit View
ZipCodeAddEditView	Add Edit View
ScheduleAddEditView	Add Edit View
SearchGridDefinitionView	Add Edit View
PasswordPolicyAddEditView	Add Edit View
SecurityGroupAddEditView	Add Edit View
SecurityRoleAddEditView	Add Edit View
SecurityUserAddEditView	Add Edit View
ChequeCountView	Add Edit View
CreditCardCountView	Add Edit View
DebitCardCountView	Add Edit View
MasterTillAddEditView	Add Edit View
TillAddEditView	Add Edit View
VendorCatalogView	Add Edit View
LanguageTranslationView	Other Views
LogView	Other Views
CustomerWarehouseItemView	Other Views
PaymentTypeDiscountAddEditView	Other Views
PaymentTypeSurchargeAddEditView	Other Views
UOMInventoryCountingView	Other Views
ItemAttributeSelectionView	Other Views
ItemMatrixCodeSettingView	Other Views
ProductMerchandiseHierarchyView	Other Views
ProductChildInventoryView	Other Views
LoyaltyExipryOverrideView	Other Views
LoyaltyPointsDetailsView	Other Views
MultiLevelApprovalView	Other Views
DashboardView	Other Views
EulaInformationView	Other Views
RegisteredHandheldInfoSearchView	Other Views
AddressSearchView	Other Views
AddressSelectionView	Other Views
CommentSearchView	Other Views
ContactSearchView	Other Views
ClubMembershipSearchView	Other Views
ContactSelectionView	Other Views
PaymentTypeAttributeView	Other Views
AutomaticBatchSerialGenerationView	Other Views
BatchGenerationView	Other Views
BatchSelectionView	Other Views
ProductSalesPersonSelectionView	Other Views
SerialGenerationView	Other Views
SerialSelectionView	Other Views
CreditCardSearchView	Other Views
CustomSeriesView	Other Views
DiscountView	Other Views
InventoryCountingRangeSelectionView	Other Views
InventoryCountingView	Other Views
InventoryCountSelectionView	Other Views
KitBuildBreakView	Other Views
KitComponentView	Other Views
ConnectionManagerView	Other Views
RegisteredMANAGEMENT CONSOLEInfoSearchView	Other Views
SkinSelectionView	Other Views
StoreView	Other Views
DenominationCountView	Other Views
InventoryItemView	Other Views
ProductGroupAddEditViewNew	Other Views
SplashScreenView	Other Views
SurchargeView	Other Views
TenderDetailCountView	Other Views
TillAuditView	Other Views
TillCountView	Other Views
TillInventoryCountView	Other Views
VendorWarehouseItemView	Other Views
BaseDataTransferView	Other Views
MainExportView	Other Views
MainImportView	Other Views
DebugView	Other Views
EndOfDayView	Other Views
ExpiredGiftCertificateView	Other Views
ProductInventoryLocationView	Other Views
InventoryTransactionSurchargeView	Other Views
MatrixItemListView	Other Views
ProductAttributeSearchView	Other Views
TwoDimensionalMatrixItemView	Other Views
ForecastEditView	Other Views
ForecastPlanningView	Other Views
RecommendationView	Other Views
ProductListView	Other Views
LoginView	Other Views
LoyaltyPlanApplicabilityView	Other Views
LoyaltyPlanDetailsSetupView	Other Views
LoyaltyPointsExpirySetupView	Other Views
PurchasePriceView	Other Views
DiscountGroupView	Other Views
SalesPriceView	Other Views
SpecialPriceListEditView	Other Views
PromotionApplicabilityView	Other Views
PromotionBonusBuyAndGetView	Other Views
PromotionExclusionListView	Other Views
PromotionHierarchyView	Other Views
PromotionProductDetailView	Other Views
DashboardDesignerView	Other Views
DashboardTimerConfigureView	Other Views
iVendReportDesignerView	Other Views
ReportParameterView	Other Views
SmartLabelPrintingView	Other Views
AlertNotificationsView	Other Views
ApiHealthCheckView	Other Views
DatabaseBackupView	Other Views
DiscountGroupSetupView	Other Views
ECommerceInitializationView	Other Views
FiscalMaskAddEditView	Other Views
IntegrationFailureLogView	Other Views
IntegrationMonitorView	Other Views
iVendAddOnSetupView	Other Views
iVendAutoUpgradeTestView	Other Views
iVendProdImplementaionView	Other Views
LicenseInformationView	Other Views
MobileDatabaseBackupView	Other Views
MobileReplicationMonitorView	Other Views
PassbookSettingsView	Other Views
QRCodeGenerationView	Other Views
QueryBuilderParameterView	Other Views
ReplicationMonitorView	Other Views
UserDefinedValidValuesView	Other Views
BaseJobSetupView	Other Views
FingerScannerAddEditView	Other Views
SecurityFunctionView	Other Views
TaxConditionSetupView	Other Views
InventoryAllocationView	Other Views
TillMultiplCurrencyFloatAmountView	Other Views

2. The following list represent the modules that support custom button panels in the POS:

ARPaymentModuleBase

· CouponItemModuleBase

· CustomerSearchModuleBase

· GiftCertificateItemModuleBase

· LayawayItemModuleBase

· LostSaleItemModuleBase

· POSUserMenuModuleBase

· ProductSearchModuleBase

· QuotationItemModuleBase

· QuotationToSaleItemModuleBase

· SaleEditModuleBase

· SaleExchangeItemModuleBase

· SaleItemModuleBase

· SpecialOrderFulfillmentItemModuleBase

· SpecialOrderItemModuleBase

· SurchargeItemModuleBase

· TransactionDetailModuleBase

· TransactionFulfillmentModuleBase

· TransactionPaymentModuleBase

· TransactionSearchModuleBase

· WeightedItemModuleBase

· CashInCashOutModules

· ManageExpenseModules

· ManageTillModules

· XReportModules

· ZReportModules

To Add Custom Button Panel

The following represents a code sample for adding a custom button panel in the iVend Management Console:

namespace SampleAddOn

{

class CustomButtonPanelOnVendorSearchScreen:VendorViewModuleBase

{

//Intialized event for VendorAddEdit screen

public override void OnViewIntialized(object sender, ViewInitializedEventArgs args)

{

//get VendorAddEdit screen

VendorAddEditView m_VendorView = sender as VendorAddEditView;

//Add custom button to VendorAddEdit screen.

//Note: we can add max 12 custom button.

CXSButton m_CXSButton1 = m_VendorView.AddCustomButton("Custom button 1 ");

CXSButton m_CXSButton2 = m_VendorView.AddCustomButton("Custom button 2 ");

m_CXSButton1.Click += m_CXSButton1_Click;

m_CXSButton2.Click += m_CXSButton2_Click;

}

//Click event for custom button m_CXSButton1

private void m_CXSButton1_Click(object sender, EventArgs e)

{

MessageBox.Show("Custom button 1 clicked!!");

}

//Click event for custom button m_CXSButton2

private void m_CXSButton2_Click(object sender, EventArgs e)

{

MessageBox.Show("Custom button 2 clicked!!");

}

Related Articles
Custom Button Panels in the Management Console and POS in iVend Retail
Introduction This knowledge base article will assist developers on how to create a custom button panel in the iVend Management Console and at the POS. Environment: iVend Version 6.5 Purpose The main purpose for allowing the creation of custom button ...
Custom Button Panels in the Management Console and the POS in iVend Retail
Introduction This knowledge base article will assist developers on how to create a custom button panel in the iVend Management Console and at the POS. Refer to. the CitiXsys Knowledge Portal for more details and code samples. Purpose The main purpose ...
Whats New in iVend Retail 6.6 API
What’s New in iVend Retail 6.6 API This knowledge base article provides an overview on the new features and enhancements introduced in the iVend Retail API, version 6.6. Purpose The core intent to bring new features and enhancements, is to make iVend ...
General Settings in SAP Business One
Introduction The iVend Add-on helps in setting up some configurations required for integrating iVend with SAP Business One. The following sections of this document capture the functionality of the new screens created and new fields added to the SAP ...
POS - Custom Button panel
Introduction iVend Add-on Framework is used for writing Custom Business Logic independently by a programmer. iVend Addon allows to extend business logic either in Management Console or at the Terminal POS.The addon framework allows deployment of ...

Custom Button Panels in the Management Console and the POS in iVend Retail

Custom Button Panels in the Management Console and the POS in iVend Retail

Introduction

Purpose

Custom Button Panel on Management Console and POS

To Add Custom Button Panel

Related Articles

Custom Button Panels in the Management Console and POS in iVend Retail

Custom Button Panels in the Management Console and the POS in iVend Retail

Whats New in iVend Retail 6.6 API

General Settings in SAP Business One

POS - Custom Button panel