1. iVend Retail Extensibility
Add-on Development

2. Agenda Overview Salient features Workflow & Event propagation
How to develop an add-on
UI customization
Custom validations
iVend UI and Business Logic events
Data management
Packaging and Deployment
Limitations
Artifacts: Developer Guide, Samples & KB Articles
Q & A

3. Confidential ©2016 CitiXsys. All Rights Reserved.
Overview
iVend Retail Add-on framework is used for writing Custom Business Logic and enhance application functionality.
The extended business logic is deployed as an add-on application centrally at the Enterprise (HO) which then gets automatically replicated to entire Retail Landscape.
Multiple add-on can be run in parallel and prioritized on specific iVend Retail stores.
iVend Retail Add-on allows to extend business logic in Management Console and Terminal POS only.
Confidential ©2016 CitiXsys. All Rights Reserved.

4. Confidential ©2016 CitiXsys. All Rights Reserved.
Salient Features
Add-on framework facilitates to extend UI (User Interface) Layer
Create your own custom screens to extend application feature functionality
Adding custom menus and controls in system screens
Globalization support on system and custom screen
Includes facility to extend Application Business Logics
Allows the events to be overridden for most of the activities application does
Publish Add-on per store level and prioritize execution
Version controlling of Add-on
Creation of User Defined Field(UDF) and User Defined Table(UDT)
iVend DB Context is accessible for SQL Queries execution
Hardware and Receipt Events are accessible
Generate custom reports using iVend reporting tool
Confidential ©2016 CitiXsys. All Rights Reserved.

5. iVend Retail Add-on Workflow & Event Propagation

6. iVend Retail Add-on Workflow
* Allows store level Add-on configuration to decide execution on specific stores
Confidential ©2016 CitiXsys. All Rights Reserved.

7. iVend Retail Event Propagation
Confidential ©2016 CitiXsys. All Rights Reserved.

8. How to Develop an Add-on

9. How to Develop an Add-on
Confidential ©2016 CitiXsys. All Rights Reserved.

10. How to Develop an Add-on
Confidential ©2016 CitiXsys. All Rights Reserved.

11. How to Develop an Add-on
Confidential ©2016 CitiXsys. All Rights Reserved.

12. iVend Retail UI Customization
Creating custom screens and custom menu using DevEx and Windows controls

13. iVend Retail UI Customization
Add-on framework enables UI controls on the system screens accessible to the custom code e.g. hide fields, marking them mandatory, and specify acceptable ranges and lengths, etc.
Add custom screens to the iVend Retail application similar to existing screens
Uses Microsoft Window form controls and Dev Express windows control for customization
Touch screen enabled custom screens
Data input via Floating Keyboard on custom screen
Extend globalization capability on custom screen
Extend support for hardware events on custom and system screen e.g. Signature capture devices, Printer, Barcode Scanner etc.
Confidential ©2016 CitiXsys. All Rights Reserved.

14. iVend Retail UI Customization
Add custom menu on Point of Sale (TPOS) and Management Console (MC) to open custom screen
Extend custom manager override functionality
Extend custom button panel on existing system screen
Allows to show line attributes on POS transaction grid
Extends the ability to add Custom Columns in vertical and horizontal grid of system screen
Allows to add button on existing button panel in system screen
Confidential ©2016 CitiXsys. All Rights Reserved.

15. Confidential ©2016 CitiXsys. All Rights Reserved.
iVend Retail UI Customization - Custom screens/menu using DevEx and Windows Controls
Add a user control and inherit it from BaseConsoleCustomView. We will have to add CXS.Retail.UIComponents namespace for using it.
Confidential ©2016 CitiXsys. All Rights Reserved.

16. Confidential ©2016 CitiXsys. All Rights Reserved.
iVend Retail UI Customization - Custom screens/menu using DevEx and Windows Controls
Screen Design View after being implemented from BaseConsoleCustomView
Confidential ©2016 CitiXsys. All Rights Reserved.

17. Confidential ©2016 CitiXsys. All Rights Reserved.
iVend Retail UI Customization - Custom screens/menu using DevEx and Windows Controls
SampleCategory and MenuItemCustomScreen Class to Add Custom Category and Menu in iVend Management Console
Confidential ©2016 CitiXsys. All Rights Reserved.

18. Confidential ©2016 CitiXsys. All Rights Reserved.
iVend Retail UI Customization - Custom screens/menu using DevExress and Windows Controls
Code snippet to add custom category and menu item in iVend Management console
Confidential ©2016 CitiXsys. All Rights Reserved.

19. Confidential ©2016 CitiXsys. All Rights Reserved.
iVend Retail UI Customization - Custom screens/menu using DevEx and Windows Controls
Basic DevExpress references to add in project for custom screen implementation
Confidential ©2016 CitiXsys. All Rights Reserved.

20. iVend Retail UI Customization - Customize Existing Screen
Customization with help of view object that exposes screen control to extensibility framework.
Confidential ©2016 CitiXsys. All Rights Reserved.

21. iVend Retail UI Customization - Custom Validation
There are two methods for validation through add-on code.
MessageBox Validation
Using args event parameter to handle custom validation.
Confidential ©2016 CitiXsys. All Rights Reserved.

22. iVend Retail UI and Business Logic Events

23. iVend Retail UI and Business Logic Events
Add-on framework provides the ability to subscribe iVend UI and BL events on system screens
Provide “OnViewIntialized” event on existing (MC and POS ) screen when system screen initializes to enable/disable button on system button panel and adding custom button panel, etc
Extend the ability to override “Ok/Cancel events” on existing system screen (MC and POS)
Provide “Before events” and “After events” for button click event on system screen.
Extend the UI events( e.g. button click, dropdown click, etc) of controls ( e.g. vertical and horizontal grid, button, etc) on system screen for customization
Provide OnGlobalize event for implementing globalization on system as well as custom screen
Provide Hardware events( e.g. print , barcode scan) on custom screen
Provide business logic events ( e.g. “After Events and Before Events” for adding transaction item , “After Events and Before Events” of transaction commit ,etc.)
Confidential ©2016 CitiXsys. All Rights Reserved.

24. Confidential ©2016 CitiXsys. All Rights Reserved.
iVend Retail UI Events
[Business Object] View Module Base Events
Confidential ©2016 CitiXsys. All Rights Reserved.

25. Confidential ©2016 CitiXsys. All Rights Reserved.
iVend Retail UI Events
Subscribe particular view controls events
Confidential ©2016 CitiXsys. All Rights Reserved.

26. iVend Retail Business Logic events
Confidential ©2016 CitiXsys. All Rights Reserved.

27. Data Management
Allows adding User Defined Tables and User Defined Fields on business object through Add-on Framework
iVend DB context is accessible for direct communication with iVend Extensibility Framework

28. Confidential ©2016 CitiXsys. All Rights Reserved.
Data Management - UDT
User Defined Tables
Confidential ©2016 CitiXsys. All Rights Reserved.

29. Confidential ©2016 CitiXsys. All Rights Reserved.
Data Management - UDF
User Defined Fields and their valid values (Multiple Option Field)
Confidential ©2016 CitiXsys. All Rights Reserved.

30. Data Management – DB context
Confidential ©2016 CitiXsys. All Rights Reserved.

31. Packaging and Deployment

32. Packaging and Deployment
Confidential ©2016 CitiXsys. All Rights Reserved.

33. Packaging and Deployment
Confidential ©2016 CitiXsys. All Rights Reserved.

34. Packaging and Deployment
Confidential ©2016 CitiXsys. All Rights Reserved.

35. Packaging and Deployment
Confidential ©2016 CitiXsys. All Rights Reserved.

36. Debugging iVend Retail Add-on

37. Confidential ©2016 CitiXsys. All Rights Reserved.
Debugging Add-on
First Run Management Console and before login, Click on Debug-> Attach to Process in Add-on project
Confidential ©2016 CitiXsys. All Rights Reserved.

38. Debugging iVend Retail Add-on
Select iVend – Management Console from available process list and click attach
Confidential ©2016 CitiXsys. All Rights Reserved.

39. Debugging iVend Retail Add-on
Complete login to Management Console. Here, break point has been added on add-on start event so debugger will be activated right after login.
Confidential ©2016 CitiXsys. All Rights Reserved.

40. Limitations

41. Confidential ©2016 CitiXsys. All Rights Reserved.
Limitations
iVend Retail Add-on application can only customize Management console(MC) and Terminal POS (POS) and does not customize iVend Mobile POS (mPOS), iVend eCommerce, integration, replication, handheld and other services and components of iVend Retail Suit.
iVend Retail Add-on execution cannot be configured to run per user or user group
Restructuring of POS screen cannot be possible using iVend Retail Add-on
Custom button panel on POS screen is not possible
Search criteria and result in all search screen cannot be control
Transaction mode cannot be changed using iVend Retail Add-on
Customization on POS customer display is not possible
No customization for till management
While installing/configuring Offline POS, it creates a table containing specific table structure and syncs only those tables which are synchronized with store database when connection establishes. Executing any SQL queries for tables which are not synched may show outdated or irrelevant record.
Confidential ©2016 CitiXsys. All Rights Reserved.

42. Artifacts

43. Confidential ©2016 CitiXsys. All Rights Reserved.
Artifacts
Citixsys Knowledge Portal
CKP -> iVend Extensibility Landing page
iVend Retail Add-on developer guide:
CKP -> Document Store -> Product Documentation -> iVend Retail -> iVend Retail 6.5 -> iVend_Retail_6.5_Extensibility_Guide.rar
Sample Projects:
CKP -> Extensibility -> Add On Development -> Sample project for 6.5
Web based guide:
iVend Retail Add-on developer guide(Web)
Confidential ©2016 CitiXsys. All Rights Reserved.

44. Questions & Answers