svn commit: r1856624 - in /ofbiz/ofbiz-plugins/trunk/msg91: README.md data/Msg91SeedData.xml ofbiz-component.xml

[rishi]

Author: rishi
Date: Sat Mar 30 13:00:29 2019
New Revision: 1856624

URL: http://svn.apache.org/viewvc?rev=1856624&view=rev
Log:
[Implemented] Short Messaging Service(SMS) Gateway Integration. Added msg91 component to plugins. Added README.md file with steps to run and setup. Added seed data for the same.
(OFBIZ-10457)
Thanks to Pritam Kute for your contribution and Michael Brohi for review and feedback.

Added:
    ofbiz/ofbiz-plugins/trunk/msg91/README.md   (with props)
    ofbiz/ofbiz-plugins/trunk/msg91/data/Msg91SeedData.xml   (with props)
Modified:
    ofbiz/ofbiz-plugins/trunk/msg91/ofbiz-component.xml

Added: ofbiz/ofbiz-plugins/trunk/msg91/README.md
URL: http://svn.apache.org/viewvc/ofbiz/ofbiz-plugins/trunk/msg91/README.md?rev=1856624&view=auto
==============================================================================
--- ofbiz/ofbiz-plugins/trunk/msg91/README.md (added)
+++ ofbiz/ofbiz-plugins/trunk/msg91/README.md Sat Mar 30 13:00:29 2019
@@ -0,0 +1,30 @@
+# Steps to test the initial pass of the SMS gateway integration:
+
+    Build and start the server.
+    Reload the fresh data or you can load the data from following XML files.
+    - Msg91SeedData.xml
+    - Msg91SecurityPermissionSeedData.xml
+    - Msg91SecurityGroupDemoData.xml
+    - Msg91DemoData.xml
+
+    Sign up to the msg91 services to get the authkey and free SMS quota.
+    - http://control.msg91.com/signup/?source=developer-SMS
+    Find your authkey after completing the sign up process.
+
+    Alter the system property data to change "telecom.notifications.enabled" flag to "Y".
+
+    Go to "Msg91GatewayConfig" entity. Here you need to set following fields.
+    -- country: Set it to 91 if you want to send SMS in India, set it to 1 if you want to send SMS to USA, for rest of countries, it should be set to 0.
+    -- authkey: The authkey you got on your API dashboard once you complete registration process.
+
+    After doing all the above mentioned steps, go to webtools and click on run service menu.
+    Enter service name as "sendTelecomMessage".
+    Put following parameters:
+    -- productStoreId: 9000
+    -- telecomMsgTypeEnumId: ORDER_SMS
+    -- telecomMethodTypeId: Its optional so can be left blank.
+    -- numbers: comma seperated numbers. If you are sending SMS in India or USA, then the numbers should be excluding country code. Otherwise numbers should include country code too.
+    -- message: message you want to send to.
+    After entering the required parameters, run the service.
+
+    Wait for some time to receive message on your phone. If it is taking too much time, go to the delivery section of the msg91 console to see if message is submitted to the API provider or not.
\ No newline at end of file

Propchange: ofbiz/ofbiz-plugins/trunk/msg91/README.md
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: ofbiz/ofbiz-plugins/trunk/msg91/README.md
------------------------------------------------------------------------------
    svn:keywords = Date Rev Author URL Id

Propchange: ofbiz/ofbiz-plugins/trunk/msg91/README.md
------------------------------------------------------------------------------
    svn:mime-type = text/plain

Added: ofbiz/ofbiz-plugins/trunk/msg91/data/Msg91SeedData.xml
URL: http://svn.apache.org/viewvc/ofbiz/ofbiz-plugins/trunk/msg91/data/Msg91SeedData.xml?rev=1856624&view=auto
==============================================================================
--- ofbiz/ofbiz-plugins/trunk/msg91/data/Msg91SeedData.xml (added)
+++ ofbiz/ofbiz-plugins/trunk/msg91/data/Msg91SeedData.xml Sat Mar 30 13:00:29 2019
@@ -0,0 +1,30 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements.  See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership.  The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License.  You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied.  See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+
+<entity-engine-xml>
+
+    <SystemProperty systemResourceId="general" systemPropertyId="telecom.notifications.enabled" systemPropertyValue="N" description="Telecom notifications enabled (Y|N)"/>
+        <!-- Telecom Services Seed Data -->
+    <EnumerationType enumTypeId="TELECOM_MSG" description="Telcom Message Type Enum" hasTable="N"/>
+    <TelecomMethodType telecomMethodTypeId="SMS" description="Short Messaging Service Method"/>
+    <TelecomMethodType telecomMethodTypeId="WHATSAPP" description="WhatsApp Messaging Service Method"/>
+    <CustomMethodType customMethodTypeId="TELECOM_GATEWAY" description="Telecom Gateway Custom Method"/>
+
+</entity-engine-xml>
\ No newline at end of file

Propchange: ofbiz/ofbiz-plugins/trunk/msg91/data/Msg91SeedData.xml
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: ofbiz/ofbiz-plugins/trunk/msg91/data/Msg91SeedData.xml
------------------------------------------------------------------------------
    svn:keywords = Date Rev Author URL Id

Propchange: ofbiz/ofbiz-plugins/trunk/msg91/data/Msg91SeedData.xml
------------------------------------------------------------------------------
    svn:mime-type = text/xml

Modified: ofbiz/ofbiz-plugins/trunk/msg91/ofbiz-component.xml
URL: http://svn.apache.org/viewvc/ofbiz/ofbiz-plugins/trunk/msg91/ofbiz-component.xml?rev=1856624&r1=1856623&r2=1856624&view=diff
==============================================================================
--- ofbiz/ofbiz-plugins/trunk/msg91/ofbiz-component.xml (original)
+++ ofbiz/ofbiz-plugins/trunk/msg91/ofbiz-component.xml Sat Mar 30 13:00:29 2019
@@ -31,6 +31,7 @@ under the License.
     <!-- entity resources: model(s), eca(s), group, and data definitions -->
     <entity-resource type="model" reader-name="main" loader="main" location="entitydef/entitymodel.xml"/>
     <!-- <entity-resource type="eca" reader-name="main" loader="main" location="entitydef/eecas.xml"/> -->
+    <entity-resource type="data" reader-name="seed" loader="main" location="data/Msg91SeedData.xml"/>
     <entity-resource type="data" reader-name="seed" loader="main" location="data/Msg91SecurityPermissionSeedData.xml"/>
     <entity-resource type="data" reader-name="demo" loader="main" location="data/Msg91SecurityGroupDemoData.xml"/>
     <entity-resource type="data" reader-name="demo" loader="main" location="data/Msg91DemoData.xml"/>