Purpose:
The purpose of the this document is to help the person to configure and deploy the POS payment plugin with respect to different types of payment devices.
...
Project Description
This project is related to POS Plug-in Management.
Scope/Requirement Statement
Earlier, the MoP (Mode of Payment) configuration was a challenge as configured data needed to be synchronized in each POS system, separately. Hence, more the number of POS greater was the challenge. This was a big headache.
The challenges described above has triggered the requirement to have a solution to centralized the The complexities of configuring the various MOPs in different POS, gave birth to POS Plugin Manager, which allows centralized the configuration and synchronization process with respect to MOP (Mode of Payment). The aim is to make life easy for the people responsible to perform the configuration.
...
Following are the steps to be followed in sequence to manage the entire process for configuring the POS Plugin:
Step #A: Configuring Plug-in Manager in Ginesys HO user interface
Step #B: MoP (Mode of Payment) configuration in Ginesys HO user interface
Step #C: Data Synchronization based on site from HO to POS
Step #D: Update the latest POS Plugin using the AutoUpdater
Step #E: Pulling/syncing down the required configuration from HO via Data Exchange in the POS system
Step #F: Logout and login into the POS application
Step #G: Test whether payment is being possible from POS using the configured MOP
| Info |
|---|
| All the above mentioned steps are described with the screenshots for easy reference, in this document. |
Assumption
System prerequisites are met
Ginesys HO version availability (minimum v12.5.1). Recommendation is to have the latest available version.
POS version availability (minimum v2.5.1). Recommendation is to have the latest available version.
Payment reference number would not be displayed in the POS Bill. In-case if it is needed, an official requirement has to come through the respective Account Manager.
Any URL that Ginesys will provide needs whitelisting
The port number that would listen to the HTTP request needs to be kept open
Auto POS Plugin would support the following Paytm (in case the payment partner is Paytm) devices:
Setup 1 : Dumb Terminals
|
|---|
| PAYTM DEVICE TYPE | SUPPPORTED / NOT SUPPORTED |
| DQR Wired Device | SUPPORTED |
| EDC Wired Device | SUPPORTED |
| EDC Wireless Device | SUPPORTED |
Setup 2 : POS application Installed in the Cashier Terminals |
|---|
PAYTM DEVICE TYPE | SUPPPORTED / NOT SUPPORTED |
| DQR Wired Device | SUPPORTED |
| EDC Wired Device | SUPPORTED |
| EDC Wireless Device | SUPPORTED |
Explanation of the entire process
This section will be of a great help to the users who are expected to perform the configuration and deployment. The user of this document needs to expand each of the following steps in the sequence given:
| Anchor |
|---|
| Configuring Plug-in Manager in Ginesys HO user interface |
|---|
| Configuring Plug-in Manager in Ginesys HO user interface |
|---|
|
| Expand |
|---|
| title | Step #A: Configuring Plug-in Manager in Ginesys HO user interface |
|---|
|
Under the Setup tab, click on the Plugin Manager under Configure section.
 Image Added Click on Add to start configuring a new Plugin Manager. Under the General tab enter the following for the required fields.
 Image Added The name of the Plugin Short Code is a sample name only. In real deployment, Plugin Short Code needs to be provided by Ginesys and the same needs to be set for the Plugin Short Code. Hence it would vary from payment partner to payment partner.
| Tip |
|---|
Important - Please check the respective partners page for the Plugin Short Code and Plugin Assembly Name.
Irrespective of brand, EaseMyRetail should be selected as Plugin Vendor . |
| Info |
|---|
Target Config File Name: This is the original configuration file name as required by the plugin dll. File name should be without extension. |
- Do the Hook Mapping.
 Image Removed Image Added
| Info |
|---|
Note: Copy-Paste the following values (to avoid typo) for the respective fields:
Hook Type : POS_PAY_PROCESS
Class Name : PaymentProcessor (Ginesys to provided this. Hence it will vary from partner to partner)
Method Name : ProcessPayment (Ginesys to provided this. Hence it will vary from partner to partner) |
| Tip |
|---|
Important - Please check the respective partners page for the Class Name and the Method Name. |
Move to the Config Files tab to specify the config file name. Click on the Add Row button to add a new row. Image Removed Image Added By clicking on the Add Row button, multiple configuration files can be added one after another. However any one can be marked as “Is Default”. Scroll to the right to find the Browse button for the newly added row.
Image Removed Image Added Enable the Is Default option.
Image Removed Image Added Click on the Browse button.
Image Removed Image Added Select the config file called app.config (this is a generic/sample configuration file).
Image Removed.
 Image Added | Info |
|---|
It would be critical/important to select the proper app.config file and the basis would be which payment device is in use for taking the payment? Devices can be of two types - DQR and EDC. DQR is available in wired mode only. However, EDC devices are available in wired as well as wireless mode. Refer to the assumption section for detail.
Link to go to the application configuration page for Paytm
|
Click on the Upload button and then click on the OK button.
Image Removed Image Added Assign the site. The process is similar to how the site has been moved from the list of available site to the list of assigned site box.
Image Removed Image Added | Info |
|---|
In the “Site Allocation” tab and under the “Assigned Sites” list, the site against which the “Config File” column is blank for that the default configuration file (the one which has been selected for “Is Default”) will be considered. But if for an allocated site, the “Config File” column has a file name, that specific configuration file would be considered. |
Click on the save and close button at the top to save the Plugin Manager configuration.
Image Removed Image Added
Image Removed Image Added The configured Plugin Manager will now appear in the list of configured plugin managers.
Image Removed Image Added Plugin Manager configuration is now completed.
|
It would be critical/important to select the proper app.config file and the basis would be which payment device is in use for taking the payment? Devices can be of two types - DQR and EDC. DQR is available in wired mode only. However, EDC devices are available in wired as well as wireless mode.
Refer to the assumption section for detail.
Link to go to the application configuration page for Paytm
5.
11.
13.
Login to GinesysWeb HO from browser
| Anchor |
|---|
| MoP (Mode of Payment) configuration in Ginesys HO user interface |
|---|
| MoP (Mode of Payment) configuration in Ginesys HO user interface |
|---|
|
| Expand |
|---|
| title | Step #B: MoP (Mode of Payment) configuration in Ginesys HO user interface |
|---|
|
Login to Ginesys Web HO from browser.
 Image Added
| Info |
|---|
The user credential must have the required privileges. |
|
2.
Configure MoP (Method of Payment).
 Image Added
|
3. “RETAIL MANAGEMENT”- “Desktop POS Manager”.
 Image Added
Select “Setup” option.
Select “Mode of Payment” option under the “Configuration” section.
To add the new MoP, click on the “Add” button.
|
4. - Mode of Payment is the selected tab by default.
 Image Added
- Specify the name of the MoP and it’s short code (maximum length: 5)
|
5. - Select mode as Credit Card.
 Image Added
|
6.
Select “Paytm” as third party POS Plugin name.
 Image Added
| Tip |
|---|
This is the one we have configured earlier. |
|
7.
- Move to the “Site Allocation” tab.
 Image Added
|
8.
- Select a site from the list of Available Sites.
|
For this testing purpose, select GINNI RETAIL-GARIA. However, any other sites can be selected in the actual scenario.9. -
- Move the highlighted site from left to right by clicking the right (->) arrow.
 Image Added
The selected site would now appear in the Assigned sites list.
|
Please observe that GINNI RETAIL-GARIA site is no more there in the list of Available Sites.
 Image Added
Now, scroll to the right, double click under the Ledger and select Credit Card from the list.
 Image Added
| Info |
|---|
The ledger name should have been decided and configured in Ginesys HO by the brand. Here Credit Card has been selected as a sample value only. For the brand, in all probability, it would be different. If a Sub Ledger is associated with the Ledger, then the Sub Ledger should also be selected for successful configuration. |
|
10. A. Save - Save the MoP.
 Image Added
It will now try to save the configuration and displays the following while operation is in progress.
 Image Added Once the newly configured MoP is saved it would appear in the list of configured MoPs.
 Image Added
| Tip |
|---|
This step (#B) is a one-time activity to be performed in majority of the cases. |
MoP configuration is now completed.
|
| Anchor |
|---|
| Data Synchronization based on site from HO to POS |
|---|
| Data Synchronization based on site from HO to POS |
|---|
|
| Expand |
|---|
| title | Step #C: Data Synchronization based on site from HO to POS |
|---|
|
- Click on the following shortcut to open the Ginesys Launchpad desktop application.
 Image Added
The following screen will appear:
 Image Added
|
2.
- Select the System Utilities option from the left panel.
|
3.
 Image Added
- Click on the Data Sync option from the right panel and then click on Yes in the User Account Control dialog.
 Image Added
|
4.
- Login to the Data synchronization application.
 Image Added
|
5.
- The Data Exchange Dashboard will appear in the Data Sync window. Click on the SYNC All button.
|
6.
 Image Added
- It will start syncing the configuration immediately.
|
7.
 Image Added
- Click on the Close button once you see the following lines:
| Info |
|---|
Make sure to run through this step (#C) every time you make changes in the app.config file. |
Data Synchronization based on site from HO to POS is completed.
|
| Anchor |
|---|
| Update the latest POS Plugin using the AutoUpdater |
|---|
| Update the latest POS Plugin using the AutoUpdater |
|---|
|
| Expand |
|---|
| title | Step #D: Update the latest POS Plugin using the AutoUpdater |
|---|
|
1.Login to the POS system using the valid user credential.
2. Open the AutoUpdate application.
 Image Added
3. The Auto Update screen will appear. Move to the Update Plugin tab.
 Image Added
4. Click on the Download button to download the latest updates in the POS system.
 Image Added
5. The latest POS Plugin is now downloaded successfully in the POS system and is visible in the list.
 Image Added
6. Click on the Close button to exit from the Auto Update application. |
| Anchor |
|---|
| Pulling/syncing down the required configuration from HO via Data Exchange in the POS system |
|---|
| Pulling/syncing down the required configuration from HO via Data Exchange in the POS system |
|---|
|
| Expand |
|---|
| title | Step #E: Pulling/syncing down the required configuration from HO via Data Exchange in the POS system |
|---|
|
- Log into the POS system as an admin (right click on the POS icon and select Run as administrator).
|
2.
 Image Added
- The User Account Control dialog will open. Click on Yes.
|
3.
 Image Added
- Ginesys POS login screen will appear. Enter the login credential (username and password) and click on the Login button.
|
4.
 Image Added
On successful login, the GINESYS POS screen will appear.
 Image Added
| Info |
|---|
The title bar is showing the same site name |
|
as GINNI RETAIL-GARIA. This is the site which has been assigned earlier while configuring the MoP and POS Plugin. |
|
5.
- From the left panel select Data Exchange in the tree.
Image Added
|
6.
- Click on the SYNC button in the lower right corner. The sync process will start immediately.
|
7.
 Image Added
- Close the window when you see the following two lines:
|
8.  Image Added
- Close the Synchronizing Data window.
| Info |
|---|
On successful syncing, the required configuration files would now be in the POS system. |
|
| Anchor |
|---|
| Logout and login into the POS application |
|---|
| Logout and login into the POS application |
|---|
|
| Expand |
|---|
| title | Step #F: Logout and login into the POS application |
|---|
|
Verify the following: Go to the folder where you have the POS application configuration file called NPOS.exe.config. Open the file in notepad and check if it has the following section -
<runtime>
<loadFromRemoteSources enabled="true"/>
</runtime>
|
...
If it is already there, close the file. If it is not there, copy and paste the above <runtime</runtime> section after the </Startup> tag.
|
...
Logout and re-login
| Tip |
|---|
The above step is important as the latest downloaded POS Plugin would come into effect only from next POS session. |
|
| Anchor |
|---|
| Test whether payment is being possible from POS using the configured MOP |
|---|
| Test whether payment is being possible from POS using the configured MOP |
|---|
|
| Expand |
|---|
| title | Step #G: Test whether payment is being possible from POS using the configured MOP |
|---|
|
All the required configuration, data syncing and data exchanges are done by now. So, it’s time to test and verify whether the newly configured MoP called CCMoP is appearing while taking the payment using credit card in the POS counter. - Open the POS application by double clicking on the following POS icon (no right click this time).
|
2. - Ginesys POS login screen will appear. Enter the login credential (username and password) and click on the Login button.
|
3. - On successful login, the GINESYS POS screen will appear. Click on the Application Control button.
4. The following options will appear: 5. Click on the POS button. 6. The following screen will appear: 7. Scan or Type the item-id. Enter GSL10001 (This is just a sample scan code) in the Scan field and press enter. The item detail will appear in the right panel. 8. It’s time to tag the customer now. Click on the Search Customer option under the POS Taskpad section in the left. 9. The Search Customer dialog will appear. In the above Search Customer dialog do the following: Disable the Search in Web check box. Default is enabled. For customer search enter membership number or mobile number or name. Click on the Search button.
10. The searched customer will appear in the panel below. Tag the customer by clicking the Tag button in the button panel at the bottom. 11. Hit the Payment button. The Account Payments section will appear. Under the Payment Mode, all the different mode of payment will appear. 12. Scroll down to check if the configured MoP called CCMoP is there in this list….. In this case it is CCMoP, The name may differ based on the configuration. If it is appearing then rest assured that the configuration has been done correctly and the syncing has also been done in a proper way. 13. For the testing purpose, make a Rs. 1/- payment through CCMoP and rest through Cash. Make sure that the payment device is connected with the system in the POS counter.
In case it is for Gift Voucher then the GV Partner’s system should be reachable. Press enter to proceed with the payment. The following message will appear. Click on the OK button to proceed further. 14. In the following screen, click on the Send Payment Request button to send the payment. Payment through Gift Voucher Redemption would display a different screen (and not the same as shown above) where either the GV number or the Barcode needs to be provided. For GV number, corresponding PIN would be needed. For Barcode, PIN code would not be required. 15. Payment Status can be checked by clicking the Check Payment Status button. If the payment is still under process, the following message will appear. 17. If the payment is processed, the following status message will com up:
With all the above steps done successfully, the configuration and testing can now be considered completed.
|
