SMS Integration
Introduction
SMS Integration in iVend Retail provides Retailers, the flexibility of receiving iVend Reports or results of a SQL Query via email, by simply sending a SMS from a registered mobile number. Using this feature, Retailers will just need to SMS a keyword on a pre-shared number. Once sent, a report will be e-mailed on the Email address recorded in the database. Furthermore, they can also receive results of a SQL Query from iVend over their mobile phone. Retailers can obtain these reports and/or query results from both the Enterprise and the individual Store databases. Let us see how this functionality can be configured in iVend Retail.
Note: In this article, for the purposes of presenting an example, the SMS Integration functionality is configured on the Enterprise server. This functionality can also be configured for individual stores. Please follow the same steps shown below if you wish to enable SMS Integration functionality at the store level.
Installing and Configuring the iVend API
1. Depending upon the source database for the queries/reports, install the iVend API on the Enterprise and/or Store server. As a rule of thumb, the iVend API needs to be installed on the source server for iVend queries and reports.
Note: Ensure that a Public Static IP is assigned to the iVend API host server.
Figure 1 – Custom Installation Screen
2. Upon successful installation of the iVend API, select the iVend Configuration Manager from Windows Start menu. The iVend Configuration Manager icon will appear in the Windows System Tray.
Figure 2 – Configuration Manager Icon
3. Right click on the iVend Configuration Manager icon and select iVend API.
Figure 3 – Right Click Pop Up Menu Screen
4. The iVend API window appears.
Figure 4 – iVend API Window Screen
Enter the required details in following fields:
Server Name: Enter the IP address of the iVend API host server.
Database Name: Enter the source database name on the iVend API host server.
User Id: Enter the SQL DB User ID.
Password: Enter the SQL DB password.
5. Choose [Update] to save the changes.
6. Choose the [Start] icon to start the API services.
7. Log into the Management Console on the API host server and go to Administration > IT Administration > API Health Check - the API Health Check window appears.
8. Enter the API host server IP in the Server IP Address field and choose [Check] to initiate the API Health Check.
Figure 5 – API Health Check Screen
Note: When all checks are marked green, the iVend API is configured successfully.
Configuring Scheduler Service
Depending upon the source database for the queries/reports, configure the Scheduler Service on the Enterprise/Store server. As a rule of thumb, the Scheduler Service needs to be configured and running on the source server for iVend queries and reports.
Note: For further details related to configuring the Scheduler Service, please refer the separate iVend Knowledge article for the Scheduler Service.
SMS Gateway Configuration on Enterprise
Prior to the SMS Gateway configuration on iVend, Retailers needs to register with a SMS Gateway. The following SMS Gateways are supported with iVend:
· ClickaTell
· ClickSend
· MessageMedia
· Nexmo
· SMSCountry
· SMSGlobal
Retailers are also required to share the iVend SMS reply API with the SMS Gateway; by default, the path for the iVend SMS Reply API is : http:// [Public Static IP of iVend API host server] /iVendAPI/SMSReply.aspx
Retailers are also required to acquire a Phone Number and register this number with the SMS Gateway. This number will be shared with the retailer’s employees. Employees will send SMS codes to this number to obtain reports and query results from iVend.
Follow the steps below on the Enterprise Server for SMS gateway configuration in iVend. These steps will be executed whether SMS Integration is configured for the Enterprise or for individual store databases.
1. Log into the Management Console and go to: Administration > System Initialization > Communication Settings. The Communication Settings window appears.
2. Enter the required values in the fields as shown in the table below, in the Messaging Settings section:
Figure 6 – Communication Settings Screen
3. On selecting the Enable SMS Notification field and selecting a SMS Gateway, the [SMS Configuration] button is enabled.
Figure 7 – Communication Settings Screen
4.Click on the [SMS Configuration] button. Depending on the SMS gateway selected in the SMS Gateway field, the corresponding SMS setup window appears and the fields on this screen may differ depending upon the SMS Gateway selected.
Figure 8 – Communication Settings Screen
5. Enter the required values in these fields.
Note: The details required for these fields will be provided by the SMS Gateway Company.
6. Choose [Ok] to save the changes. The Communication Settings window reappears.
7. Choose [Ok]to save the changes made. The SMS Gateway configuration will then be saved in iVend.
Configuring Scheduler Job
Now, let us schedule an SMS job in iVend. Here we will define what reports and/or queries will be accessible to employees and assign a keyword that will be required to access this data.
1. Log into the Management Console and go to: Administration > Application Setup > Schedule Manger. The Schedule Job Search window appears.
2. Press [F3 New] to setup a new schedule. The Schedule Setup window appears.
Figure 9 – Schedule Setup Screen
3. Enter the required data in the fields explained in the table below, in the General sub-section:
4.The Schedule sub-section is not relevant for SMS Integration; you may leave it blank.
5.The Report sub-section is relevant for SMS Integration if Report was selected in the Type field. Enter the required data in the fields as explained in the following table:
Figure 10 – Schedule Setup Screen
6. Choose [Ok] to save the changes made.
Employee Email and Phone Registration
To ensure that access to data is available to authentic employees only, it is mandatory to register the employee’s Email Id and mobile number in the Employee master record in iVend. The employee will be required to send a SMS keyword from their registered mobile number to access the SMS Integration functionality.
For Query type Scheduler jobs, the employee will receive the query results via a SMS to their registered number. In the event of Report type Schedule jobs, a report will be Emailed to their registered Email Id.
Now, let us register these details in iVend:
1. Log into the Management Console and go to: Administration > Human Resources > Employee - the Employee Search window appears.
2. Select the Employee record and press the [F4 Edit] button to open an Employee’s master record in edit mode.
Figure 11 – Employee Setup Screen
3.Enter their Email Id in the Email field and their mobile phone number in the Mobile Phone field.
Note: For SMS integration, the mobile number is mandatory. The Email Id is required for Emailing reports.
4. Choose [Ok] to save the changes made. The configuration for SMS Integration is now complete.
The Employee can now send the keyword to a pre-shared number from their registered mobile number. Depending upon the Scheduler job type, they will either receive a query result on their registered mobile number or a report will be sent to their registered Email ID.
Related Articles
Test SMS Failure.
*********** ** Internal to CitiXsys Support******************* Problem Statement: - Getting an error message "Unable to connect to the remote server" while doing Test SMS (SMS Integration). Resolution: - 1. One can check the following points: - 2. ...Multiple SMS for single Loyalty Transactions
Environment : iVend Version 6.6 with SAPB1 9.2 Problem Statement: Multiple SMS for single Loyalty Transactions Symptoms : Multiple SMS for single Loyalty Transactions Resolution/Work Around : Due to SMS gateway ,not returning the success message, the ...Integration Error "System.Data.Odbc.OdbcException (0x80131937): ERROR [HY000] [SAP AG][LIBODBCHDB"
Environment: iVend 6.6 integrated with SAPB1 HANA Problem Statement: Integration was not working and its showing below message on Event Viewer Log “System.Data.Odbc.OdbcException (0x80131937): ERROR [HY000] [SAP AG][LIBODBCHDB DLL][HDBODBC] General ...SAP Business One - iVend Retail Integration Points
Introduction SAP Business One software is created specifically for small and midsized businesses. It is a powerful application and iVend Retail seamlessly integrates with it to help retailers better manage every aspect of their daily retail ...Error in Integration Monitor (SAP to iVend) in version 6.6 for event type "Customer"
*****************For Internal purpose********************* Product Version: iVend 6.6 Issue: Error in Integration Monitor (SAP to iVend) in version 6.6 for event type "Customer": Integration Error: System.Data.SqlClient.SqlException (0x80131904): ...