External OBS - Business Messaging Services Manuals
Contents
1. Manage Users Aid new user 4 Search Results Web Site UPDATE DELETE ENABLE DISABLE B UserName Affiliate Name Role First Last Land Line Mobile Use Name Name Stat 2 _ acme A cme admin corporation Admin Jane Bloggs 0215556789 0823456789 Enal m acme acme afiliate corporation AffiliateAdmin John Brown 0213456789 0823456789 Enall acme acme joe corporation User joe acme 0213456789 0823456789 Dis Page 17 of 30 External OBS User Manual 5 Enter the details of the new user and New User Details then click Create User id All input fields are mandatory and the ad ih tnd ce aeae user name must be unique Affiliate Name acme corporation X User Name FirstName Last Name Password Confirm Password E mail Landline Mobile User Status Enabled X Create User Note To find a specific user click Manage Users on the Navigation bar select a search parameter from the drop down list enter a search term in the Search box and then click Find To list all users the Search box must be empty Find User Find What next You are now ready to link these users to services To do this select Manage OBS Services from the Navigation bar at the top of the page or from the links on the Home page 4 3 4 Manage OBS Services Use this function to give users permission to view OBS requests and revenue details for their company Who has access to this functio2. GRAPEVINE External OBS User Manual Version 1 1 Document location On Owl at Documents Projects OBS External_ OBS User _Manual_V1_1 docx Date July 2010 Support For assistance please contact Grapevine 27 21 702 3333 or email info vine co za Feedback Was this document useful What can we do to make this user guide more useful to you and informative Please email info vine co za with your comments and feedback www vine co za External OBS User Manual Contents 1 Referente senne en ara en a aAa aE aAA RAS EA aAa ERARE AAEREN 3 1 1 Terms and definitions orri rosor eisai r ekr AAAS E ANKESES SESENTA E ERASE 3 What is the External OBS ic sci cciccieeccacscteccsscseaccbcadaccetvastvcdscedencsedtevscessdenesedecevedssectesseaes 5 How do use the External OBS Web Service cccccssssscecsssssccccssssceccssssceesesseceseesseeees 6 3 1 What do I need to access the External OBS web ServiCe cccsscccceesteeeeeesteeeeeeaes 6 3 2 How do request funds from a NEtWOFK 0 ceccceseessssecececeseesssteseeeeecessessaeeeeeeeeeeee 6 3 2 1 Step 1 Submit a Debit REQUEST cc ccccccccessesssseceeeeecesseseaeaeeeeeeeseeseaaees 7 3 2 2 Step 2 Receive a Debit Request RESPONSE ceececceeeesteeeeeeneeeeeeneeeeeeaes 9 3 3 Web Service FAQS cecinere nan a EA cetadecccbudsaacevdadeascasdeaavcetadeaccaes 11 4 How dol use the External OBS Web Site ccccsssssscccsssssceccssssceccssssces
3. lt wsdl operation gt lt wsdl binding gt lt wsdl binding name ExternalObsWebServiceHttpPost type tns ExternalObsWebServiceHttpPost gt lt http binding verb POST gt lt wsdl operation name ObsDebitRequest_Extr gt lt http operation location ObsDebitRequest_Extr gt lt wsdl input gt lt mime content type application x www form urlencoded gt lt wsdl input gt lt wsdl output gt lt mime mimeXml part Body gt lt wsdl output gt lt wsdl operation gt lt wsdl binding gt lt wsdl service name ExternalObsWebService gt lt wsdl documentation gt lt b gt A External web service which performs Online Billing Services lt b gt lt wsdl documentation gt lt wsdl port name ExternalObsWebServiceSoap binding tns ExternalObsWebServiceSoap gt lt soap address location http 196 36 190 189 externalobswebservice ExternalObsWebService asmx gt lt wsdl port gt lt wsdl port name ExternalObsWebServiceSoap12 binding tns ExternalObsWebServiceSoap12 gt lt soap12 address location http 196 36 190 189 externalobswebservice ExternalObsWebService asmx gt lt wsdl port gt lt wsdl port name ExternalObsWebServiceHttpGet binding tns ExternalObsWebServiceHttpGet gt lt http address location hitp 196 36 190 189 externalobswebservice ExternalObsWebService asmx gt Page 29 of 30 External OBS User Manual lt wsdl port gt lt wsdl port name ExternalObsW
4. Ex_StatusDescription gt lt ExternalObsStatus gt Example 2 Debit Request Response Debit Request Status Codes Status Status Description What does it mean Code Page 9 of 30 Debit Request Status Codes Status Code 0 10 11 12 Status Description Authentication failed Funds authorised Funds request unsuccessful insufficient funds Amount requested exceeds maximum allowed for this service Funds request failed network problem Service is disabled Maximum daily attempts for this MSISDN has been reached Invalid MSISDN Minimum amount should be 0 50 Not an allowed amount for MTN Unknown error Timed out please try again later Delivery confirmation failed External OBS User Manual What does it mean Please check your Debit Request parameters It is possible your entered an invalid service name authentication code or service code Funds have been successfully taken from user s mobile phone account Cell phone user has insufficient funds for the Debit Request You may retry the request based on the rules specified in Appendix A Insufficient Funds and Re attempts on page 24 Each service has a maximum amount that may be requested Please try again later Contact Grapevine Support if this problem persists Our contact details are in the Support section of this manual on page 23 Contact Grapevine Support if a service has been disabled Our contact details
5. 51 Your report will include one of the following status descriptions OBS Web Site Requests Statuses Status Description What does it mean Page 14 of 30 OBS Web Site Requests Statuses Status Description Funds authorised Authentication failed Unsuccessful request Invalid MSISDN Minimum amount should be 0 50 Maximum amount exceeded Insufficient funds Service disabled Attempts exceeded for insufficient funds External OBS User Manual What does it mean The funds you requested have been authorised Authentication will fail if you enter an invalid service name authentication code or service code At least one input parameter was invalid You may have e entered an amount that is not allowed some networks specify the amounts you may request e used an MSISDN that doesn t exist You have entered an invalid MSISDN The number must be in international format where O is replaced by the South Africa code 27 Numbers greater than 11 digits will not be processed The networks all specify minimum and maximum request amounts No amounts less than 0 50 are allowed Each service has a maximum amount that may be requested based on your OBS application There are insufficient funds in the account of the mobile phone user Please refer to Appendix A Insufficient Funds and Re attempts on page 24 Please contact Grapevine Our contact details are in the Support section of this manual o
6. out funds to Affiliates once these have been received by Grapevine from the mobile networks It is fairly common for networks to delay payment and for revenue disputes to occur Grapevine will always push to get revenues paid by the networks as soon as possible but only once Grapevine received revenues will payments be made to the Affiliates Page 25 of 30 External OBS User Manual Appendix C Allowed Amounts The following are the minimum and maximum debit amounts in ZAR that you can ask for from network providers Network Minimum Debit Maximum Debit Provider Amount Amount MTN RO 50 R50 00 Cell C RO 50 R50 00 Vodacom RO 50 R50 00 MTN only allows the following amounts to be requested Any other amounts requested will not be allowed RO 50 R5 00 R5 24 R10 00 R10 25 R25 00 R28 00 R50 00 0 50 5 24 10 25 28 00 0 86 5 50 10 50 29 50 0 99 5 15 10 75 29 99 1 00 5 99 11 00 30 00 1 20 6 00 11 25 32 00 1 25 6 25 11 50 33 00 1 50 6 50 11 75 34 99 1 75 6 75 11 99 35 00 1 98 6 99 12 00 36 00 2 00 7 00 12 25 38 00 2 25 7 25 12 50 39 50 2 49 7 50 12 75 39 99 2 50 7 75 13 00 40 00 2 75 7 99 13 25 45 00 2 99 8 00 13 50 49 50 3 00 8 25 13 75 49 99 3 25 8 50 14 00 50 00 3 50 8 75 14 25 3 75 8 99 14 50 3 99 9 00 14 75 4 00 9 25 15 00 4 25 9 50 16 00 4 50 9 75 18 00 4 75 9 95 19 50 4 99 9 99 19 99 5 00 10 00 20 00 22 00 22 99 24 99 25 00 Page 26 of 30 External OBS User Manual Appendix D Web Service
7. Definition lt xml version 1 0 encoding utf 8 gt lt wsdl definitions xmlns soap http schemas xmlsoap org wsdl soap xmlns tm http microsoft com wsdl mime textMatching xmlns soapenc http schemas xmlsoap org soap encoding xmlins mime http schemas xmlsoap org wsdl mime xmlns tns http 196 36 190 168 xmlins s http www w3 org 2001 XMLSchema xmlns soap12 http schemas xmlsoap org wsdl soap12 xmlIns http http schemas xmlsoap org wsdl http lt wsdl definitions targetNamespace http 196 36 190 189 gt lt wsdl documentation gt lt b gt A External web service which performs Online Billing Services lt b gt lt wsdl documentation gt lt wsdl types gt lt s schema elementFormDefault qualified targetNamespace http 196 36 190 189 gt lt s element name ObsDebitRequest_Extr gt lt s complexType gt lt s sequence gt lt s element minOccurs 0 maxOccurs 1 name ServiceName type s string gt lt s element minOccurs 0 maxOccurs 1 name AuthenticationCode type s string gt lt s element minOccurs 0 maxOccurs 1 name AffiliateCode type s string gt lt s element minOccurs 0 maxOccurs 1 name Msisdn type s string gt lt s element minOccurs 1 maxOccurs 1 name Amount type s double gt lt s sequence gt lt s complexType gt lt s element gt lt s element name ObsDebitRequest_ExtrResponse gt lt s complexTyp
8. GVI tion code 2D60701D7 Affiliate Unique company code string Acme_001 GVI code MSISDN Mobile phone number in string 27767239116 Affiliate international format where the 0 prefix for a mobile phone number is replaced by the country code e g 27 for South Africa Page 7 of 30 Debit Request Method Method name ObsDebitRequest_Extr Field Vodacom Service ID Amount Daily Limit Amount Description This is a Vodacom requirement that enables the network to identify the service previously all services were tagged as Grapevine services Grapevine must apply for a Service ID for each new service it implements This is then tested and deployed by Vodacom The Service ID will help Grapevine to identify the funds associated with a service when Vodacom sends a billing report Amount to be taken from the mobile phone users account Allowed amounts that may be requested from the networks are provided in Appendix C Allowed Amounts on page 26 This figure limits the amount of funds that can be requested per day by an Affiliate The default is R100 In this example if a request costs R5 only 20 requests could be made per day The Daily Limit Amount can only be changed by a Grapevine administrator It has been implemented to prevent user error selecting a higher rate Format string 2 place decimal Any digits after the first two decimal places will be ignored Decima
9. Text file where each field is distinguished from the next by a comma The commas indicate to a spreadsheet program for instance MS Excel where each field starts and ends so it can divide the data into columns e g Text file saved in csv format Surname First Name Area Code Telephone Bloggs Joe 021 5553456 Spreadsheet application Area Code 021 First Name Joe Surname Bloggs Telephone 5553456 A new line in the text file represents a new row in the spreadsheet Reports from the External OBS can be exported to a CSV file where the data can be custom sorted and filtered Method used to request funds from mobile phone users accounts in payment for content they have bought MTN s preferred name for the Online Billing System OBS Mobile Subscriber International Station Directory Number Mobile Subscriber Integrated Services Digital Network Number www vine co za OBS Online Billing System External OBS User Manual Number format used to uniquely identify a mobile phone number internationally It is created by replacing the 0 of the mobile phone number with the country code e g 27735555555 where 27 is the country code for South Africa A mechanism used to take money from mobile phone users accounts in payment for content The External OBS lets companies outside Grapevine use the OBS to take money from mobile phone users accounts dir
10. age Page 21 of 30 External OBS User Manual View OBS Revenue Affiliate Name The Outdoor Store conte Select the date parameters v Generate Generate BilingReports To Accounts 4 for which you d like to run your report View a summary of revenue Network Revenue Authorised for The Outdoor Store YT for all the networks Network Amount lick a S rviceNname to Go o the View OBS Requests View a breakdown of revenue for each of the networks v calls of the wild R0 00 R0 00 R0 00 R0 00 outdoor logos wild screensavers Report 2 OBS Revenue Report Page 22 of 30 5 External OBS User Manual Support For Grapevine assistance please call 27 21 702 3333 or email support vine co za Notes In order to be able to submit support requests you need to ask Grapevine support to add you to our White List This is a list of e mail addresses and domain names from which our e mail blocking program will allow messages The External OBS URL and your login details will have been sent to you by email from Grapevine when you signed up for this service Please contact us if you have access problems When submitting a request please ensure you have all your details at hand including details of the error or problem you are experiencing This includes any status codes you may have received and a description of what you were doing on the system at the time Page 23 of 30 Extern
11. al OBS User Manual Appendix A Insufficient Funds and Re attempts The following describes what happens when Affiliates repeatedly request funds from mobile phone users who have insufficient funds in their accounts It is essential for users of the External OBS to understand and accept the process described below as it is a specific commercial condition of using the External OBS When you request funds request from a mobile phone that does not have enough airtime you will receive a Debit Request response that the mobile phone user has Insufficient Funds status code 2 see the Debit Request Response Codes table on page 9 The mobile phone networks charge for funds requests that are unsuccessful In fact some of the networks charge a sliding scale for unsuccessful funds requests where the more unsuccessful attempts there are the more they charge They have implemented this because when they get an Insufficient Funds status some OBS users will repeatedly keep requesting funds from a mobile phone in the hope that the phone user will top up their airtime at some point This practice has put a huge load on the mobile networks OBS infrastructure and so they are actively discouraging this practice by charging more for higher volumes of unsuccessful funds requests Under the terms of use for the Grapevine External OBS an Affiliate may only attempt 3 times in any one day to request funds from a mobile phone where there are insufficient
12. are in the Support section of this manual on page 23 If you receive a response with status code 2 insufficient funds you may only resubmit the request twice on a given day Please see Appendix A Insufficient Funds and Re attempts on page 24 Please check your MSISDN parameters No amounts less than 0 50 are allowed Allowed amounts that may be requested from the networks are provided in Appendix C Allowed Amounts on page 26 Please try again later Contact Grapevine Support if the problem persists so that they can investigate the problem Our contact details are in the Support section of this manual on page 23 Please try again later Contact Grapevine Support if this problem persists Our contact details are in the Support section of this manual on page 23 Grapevine has made more than one attempt to reach the network to confirm delivery of your content and been unsuccessful Please contact Grapevine Support Our contact details are in the Support section of this manual on page 23 Page 10 of 30 External OBS User Manual Table 3 Debit Request Status Codes Notes e A funds request may not exceed R50 00 or be less than RO 50 for most networks Allowed amounts that may be requested from the networks are provided in Appendix C Allowed Amounts on page 26 An Affiliate can make a maximum of three requests a day two retries to an MSISDN which does not have sufficient funds Please see Appendix A Insuffic
13. ceseeseseeseeeeecesseseasseeeeecessesaaaeseeseseesseseaaeeeeess 9 Table 2 Debit Request RESPONSE ccccccesssececeesnececessneeeceeaeeeceeseeeceeaaeeeesesueeeceeaueeeseeqeeeeeeeneeeeees 9 Table 3 Debit Request Status COd S c cccccccccccsssssseceeececsesesnsaeeeeeceeeeseseaeeeeecesseseaaeaeeeeeeeseesesaeas 11 Table 4 Overview of Web Site FUNCtIONS ccescccessesecesseeeececseeeececseeseceeeeeaeceeeeeaeceeeeeaeeeeeeatees 13 Table 5 OBS Web Site Requests Statuses ccccessccccececsesssssaeeececeseeseceeseeeeecesseseaeaeeeesesseeeesaeas 15 Page 2 of 30 1 Reference 1 1 Term Affiliate Affiliate Administrator Content Content Owner CSV Comma Separated Values file Debit Request EBB Billing Event Based MSISDN External OBS User Manual Terms and definitions Definition Company that is allowed to use Grapevine s External OBS to request funds from mobile phone users accounts in payment for content When companies register with Grapevine we say that they are provisioned to use the External OBS Affiliate employee who has a user profile allowing them to manage services create user profiles and view reports on their company s use of the system Products and services that are sold to mobile phone users e g ringtones screensavers games daily weather reports and stock market notifications etc Owner of content that is sold to mobile phone users
14. e gt lt s sequence gt lt s element minOccurs 0 maxOccurs 1 name ObsDebitRequest_ExtrResult type tns ExternalObsStatus gt lt s sequence gt lt s complexType gt lt s element gt lt s complexType name ExternalObsStatus gt lt s sequence gt lt s element minOccurs 1 maxOccurs 1 name Ex_StatusCode type s int gt lt s element minOccurs 0 maxOccurs 1 name Ex_StatusDescription type s string gt lt s sequence gt lt s complexType gt lt s element name ExternalObsStatus nillable true type tns ExternalObsStatus gt lt s schema gt lt wsdl types gt lt wsdl message name ObsDebitRequest_ExtrSoapIn gt lt wsdl part name parameters element tns ObsDebitRequest_Extr gt lt wsdl message gt lt wsdl message name ObsDebitRequest_ExtrSoapOut gt Page 27 of 30 External OBS User Manual lt wsdl part name parameters element tns ObsDebitRequest_ExtrResponse gt lt wsdl message gt lt wsdl message name ObsDebitRequest_ExtrHttpGetIn gt lt wsdl part name ServiceName type s string gt lt wsdl part name AuthenticationCode type s string gt lt wsdl part name AffiliateCode type s string gt lt wsdl part name Msisdn type s string gt lt wsdl part name Amount type s string gt lt wsdl message gt lt wsdl message name ObsDebitRequest_ExtrHttpGetOut gt lt wsdl part name Body eleme
15. ebServiceHttpPost binding tns ExternalObsWebServiceHttpPost gt lt http address location http 196 36 190 189 externalobswebservice ExternalObsWebService asmx gt lt wsdl port gt lt wsdl service gt lt wsdl definitions gt Page 30 of 30
16. ectly These companies need to first register with Grapevine as Affiliates of the system OBS is a term used by Cell C and Vodacom EBB is the term preferred by MTN Page 4 of 30 External OBS User Manual 2 What is the External OBS Grapevine s External OBS Online Billing System allows you registered as an Affiliate to use Grapevine s web service to request funds from networks in payment for content that mobile phone users have purchased The web service can be accessed using a SOAP call the ObsDebitRequest_Extr service method You can view the full WSDL for this method in Appendix D on page 27 You can monitor your requests and view reports and revenue details for your requests via the External OBS web site Note All the information you need to access and use the External OBS can be found in the email you receive from Grapevine when you register Below is a graphical overview of the External OBS and how the web service and web site work together Content Owner SOAP Ext OBS Web Service Networks Funds Request Company name Sells content e g e Authentication code ringtones to customer e Service name e Validates request e MSISDN e Requests money from e Amount requested network e Stores request details e Request successful e 6 in DB e Request failed Funds Response e Status code e Status description Ext OBS Web Site Create users profile
17. funds If more than 3 attempts in one day are made to request funds for a particular mobile phone then you will receive a response of Maximum Daily Attempts Limit Reached status code 6 see the Debit Request Response Codes table on page 9 Please note that you will be charged for all unsuccessful funds requests whether you receive status code 2 or status code 6 In order to ensure that you do not pay excessively for unsuccessful attempts please ensure that you write your application to limit the number of daily retries From a consumer friendly point of view if a consumer repeatedly does not have sufficient funds it would probably be better to remove that person from your customer list than it would be to hound their mobile phone account for funds If an Affiliate is seen to be over requesting for funds which are unsuccessful Grapevine has the right to suspend the Affiliate s OBS services www vine co za External OBS User Manual Appendix B OBS Revenue Calculations The following is a description of how the Grapevine calculates the revenue owing to Affiliates after the funds they requested from mobile phone users are authorised It is essential for users of the External OBS to understand and accept the calculations described below as it is a specific commercial condition of using the External OBS The main use of the External OBS is to allow Affiliates to get payment for their content While the External OBS rep
18. ick Generate Month August Year 2009 v Generate 4 3 3 Manage Users Use this function to view and update user details From the Manage Users page you can also send notification to a user of their login details Who has access to this function e Affiliate administrators can view and update their company s users details e Users do not have access to this function Affiliate administrators can change the following fields e firstname e last name e land line e mobile e password e user status Page 16 of 30 Affiliate administrators can delete disable and enable users To Manage Users External OBS User Manual 1 Select Manage Users from the Navigation bar at the top of the page or from the links on the home page The system lists all users linked to the services that you may view If you are an Affiliate administration you will only be able to view the profiles of users at your company 2 Select the check box next to the user whose details you wish to update 3 Click Update 4 To add a new user click Add New User A To send an email to a user with their login details select the check box next to the name of the user you wish to email and click Web Site B Click on a column heading to sort the users C To delete disable or enable a user select the check box next to the name of a user and then click on the appropriate icon
19. ient Funds and Re attempts on page 24 What next e You can view reports detailing your Debit Requests on the web site e If there was a network failure or unexpected error please contact Grapevine Our contact details are in the Support section of this manual on page 23 3 3 Webservice FAQs How many times may resubmit an OBS request Because the networks charge for OBS requests if the mobile phone user has insufficient money in their account status code 2 you may only resubmit a request twice This means that you may request funds for content from a specific MSISDN a maximum number of 3 times a day You will be charged for every unsuccessful request as per the commercial agreement with Grapevine How can I see how much money I have made You can see how much money you have requested via the View OBS Revenue function on the External OBS web site Your company s share of the OBS revenue will be determined based on the reported OBS revenue the commercially agreed revenue share with Grapevine and the actual payout by the mobile networks Read more rN OBS Revenue Calculations It is essential for users of the External OBS to understand how revenue owing to them is calculated Understanding these requirements is a specific commercial condition of using the External OBS Please familiarise yourself with Appendix B OBS Revenue Calculations on page 25 Page 11 of 30 External OBS User Manual 4 How do I u
20. inks on the Home page Page 20 of 30 External OBS User Manual View OBS Requests Search for OBS Requests SS Filter your data by Date From 2009 10 02 Hour 0 v Minutes 00 v e date andtime Ss el service DateTo 2009 10 02 Hour 23 Minutes 59 a asbak MSISDN OBS Service 4x4 backup X MSISDN seacn Export your results to a CSV file which you can view in a spreadsheet like Excel Total requests Summary information gives you a bird s eye view go Total failed p adoi ri Total success unsuccessful requetss Total amount successfully authorised Click on the column headings to sort your results Date MSISDN Amount Status Affiliate Code Service Name 2009 10 02 10 46 32 AM 27739771576 50 00 Attempts exceeded forinsufficientfunds outdoor 4x4 backup 2009 10 02 09 49 51 AM 27739771576 50 00 Insufficient funds outdoor 4x4 backup 2009 10 02 09 49 35 AM 27739771576 50 00 Insufficient funds outdoor 4x4 backup 2009 10 02 09 49 19 AM 27739771576 50 00 Insufficient funds outdoor 4x4 backup 4 A detailed report includes a description of the request Status Date and Time the request was made MSISDN Amount Affiliate Code Service Name You are viewing page 1 of 1 4 Results out of 4 Report 1 OBS Requests Report 4 4 2 OBS Revenue report To view the OBS Revenue report select View OBS Revenue from the Navigation bar at the top of the page or from the links on the Home p
21. l in rands External OBS User Manual Examples SA Redemptorists 0 50 10 00 100 Supplied by GVI Affiliate Affiliate Page 8 of 30 External OBS User Manual Table 1 Debit Request Method ObsDebitRequest_Extr ringtones D63A3F991C96830112D60701D7 Acme_001 27767239116 5 00 Example 1 Debit Request 3 2 2 Step 2 Receive a Debit Request Response Each Debit Request generates a Debit Request response Below is a sample Debit Request response After you receive a response please check the status code to see if your request was successful Debit Request response status codes are tabled at the end of this section with explanations about what they mean Debit Request Response Header lt xml version 1 0 encoding utf 8 gt lt ExternalObsStatus xmIns xsi http www w3 org 2001 XMLSchema instance xmlIns xsd http www w3 org 2001 XMLSchema xmIns http 196 36 190 168 gt Parameter Example Description Status 0 Please see Debit Request code Status Codes on page 9 Status Authorisation failure Please see Debit Request description Status Codes on page 9 Table 2 Debit Request Response lt xml version 1 0 encoding utf 8 gt lt ExternalObsStatus xmIns xsi http www w3 org 2001 XMLSchema instance xmlIns xsd http www w3 org 2001 XMLSchema xmlIns http 196 36 190 168 gt lt Ex_StatusCode gt 0 lt Ex_StatusCode gt lt Ex_StatusDescription gt Authorisation failure lt
22. n e Affiliate administrators can view details of their company s services and change the users associated with them e Users do not have access to this function Affiliate administrators can change the following e service descriptions Affiliate administrators cannot disable enable or delete services Please contact Grapevine for assistance with this Our contact details are in the Support section of this manual on page 23 Page 18 of 30 Notes External OBS User Manual You may only assign users to services provided by your company Apart from service descriptions only Grapevine can change service details To Manage OBS Services Select Manage OBS Services from the Navigation bar at the top of the page or from the links on the home page Welcome back jane The system lists the services you may view Select the check box next to the service to which you wish to add a user or from which you wish to remove a user Click Update Note Only Grapevine administrators may add new OBS services Click on a column heading to sort the services Only Grapevine administrators can enable or disable services Our contact details are in the Support section of this manual on page 23 Manage OBS Services Add New OBS Service Find OBS Services Search Results EXPORT UPDATE 4x4 backup 4x4 backup clubs clubs wild screensavers hippos outdoor logos mad cow
23. n page 23 You have exceeded the daily number of times you can request funds from a mobile phone user with insufficient funds in their account Please refer to Appendix A Insufficient Funds and Re attempts on page 24 Table 5 OBS Web Site Requests Statuses 4 3 2 View OBS Revenue This report shows the total amount of money taken from mobile phone users accounts over a selected time period Read more calculated OBS Revenue Calculations It is essential for users of the External OBS to understand how revenue owing to them is Page 15 of 30 External OBS User Manual Understanding these requirements is a specific commercial condition of using the External OBS Please familiarise yourself with Appendix B OBS Revenue Calculations on page 25 Who has access to this function e Affiliate administrators can view revenue details for their company s services e Users can view revenue details for services they have been given permission to view To View OBS Revenue 1 Select View OBS Revenue from the Navigation bar at the top of the page or RAPEVINE from the links on the home page wilde Welcome back jane In the View OBS Revenue section you can narrow your search to a specific time period View OBS Revenue Affiliate Name acme corporation 2 Select a Month from the drop down list 3 Select a Year from the drop down list 4 Cl
24. ng name ExternalObsWebServiceSoap type tns ExternalObsWebServiceSoap gt lt soap binding transport http schemas xmlsoap org soap http gt lt wsdl operation name ObsDebitRequest_Extr gt lt soap operation soapAction http 196 36 190 189 ObsDebitRequest_Extr style document gt lt wsdl input gt lt soap body use literal gt lt wsdl input gt lt wsdl output gt lt soap body use literal gt lt wsdl output gt lt wsdl operation gt lt wsdl binding gt Page 28 of 30 External OBS User Manual lt wsdl binding name ExternalObsWebServiceSoap12 type tns ExternalObsWebServiceSoap gt lt soap12 binding transport http schemas xmlsoap org soap http gt lt wsdl operation name ObsDebitRequest_Extr gt lt soap12 operation soapAction http 196 36 190 189 ObsDebitRequest_Extr style document gt lt wsdl input gt lt soap12 body use literal gt lt wsdl input gt lt wsdl output gt lt soap12 body use literal gt lt wsdl output gt lt wsdl operation gt lt wsdl binding gt lt wsdl binding name ExternalObsWebServiceHttpGet type tns ExternalObsWebServiceHttpGet gt lt http binding verb GET gt lt wsdl operation name ObsDebitRequest_Extr gt lt http operation location ObsDebitRequest_Extr gt lt wsdl input gt lt http urlEncoded gt lt wsdl input gt lt wsdl output gt lt mime mimeXml part Body gt lt wsdl output gt
25. nt tns ExternalObsStatus gt lt wsdl message gt lt wsdl message name ObsDebitRequest_ExtrHttpPostIn gt lt wsdl part name ServiceName type s string gt lt wsdl part name AuthenticationCode type s string gt lt wsdl part name AffiliateCode type s string gt lt wsdl part name Msisdn type s string gt lt wsdl part name Amount type s string gt lt wsdl message gt lt wsdl message name ObsDebitRequest_ExtrHttpPostOut gt lt wsdl part name Body element tns ExternalObsStatus gt lt wsdl message gt lt wsdl portType name ExternalObsWebServiceSoap gt lt wsdl operation name ObsDebitRequest_Extr gt lt wsdl input message tns ObsDebitRequest_ExtrSoapIn gt lt wsdl output message tns ObsDebitRequest_ExtrSoapOut gt lt wsdl operation gt lt wsdl portType gt lt wsdl portType name ExternalObsWebServiceHttpGet gt lt wsdl operation name ObsDebitRequest_Extr gt lt wsdl input message tns ObsDebitRequest_ExtrHttpGetIn gt lt wsdl output message tns ObsDebitRequest_ExtrHttpGetOut gt lt wsdl operation gt lt wsdl portType gt lt wsdl portType name ExternalObsWebServiceHttpPost gt lt wsdl operation name ObsDebitRequest_Extr gt lt wsdl input message tns ObsDebitRequest_ExtrHttpPostin gt lt wsdl output message tns ObsDebitRequest_ExtrHttpPostOut gt lt wsdl operation gt lt wsdl portType gt lt wsdl bindi
26. orting interface will indicate clearly what amounts have been requested the amounts shown are the total funds taken from the mobile phone user s account and not an indication of the split of revenue between the Affiliate the network and Grapevine The mobile networks have different methods of splitting OBS revenues with Grapevine these calculations can vary considerably Grapevine is committed to making the most accurate revenue reports available to Affiliates who are using the External OBS However the result is not always perfect For example under the current OBS from Vodacom Vodacom first deducts VAT from the total amount and then a so called bearer fee of RO 30 Thereafter they deduct either 15 in the case of a contract mobile phone or 24 5 in the case of a pre paid mobile phone The problem is that Grapevine has no way to know which mobile numbers are on contract and which numbers are on pre paid This means that a completely accurate calculation of exact revenue from each request to Vodacom is not possible As a result Grapevine will make best effort assessments of the revenue from Vodacom and report these to the Affiliates monthly While this is far from ideal it is the reality that all OBS service providers are faced with It also means that Affiliates are required to agree that this is the case and that Grapevine s revenue reports will be as accurate as we are able to make them Please note that Grapevine will only pay
27. ount taken from mobile phone users accounts during a selected time period Assign users to services and view service details View and update user details External OBS User Manual Who has access to this function Affiliate administrators can view OBS requests for their company s services Users can view the OBS requests for services they have been given permission to view Affiliate administrators can view revenue details for their company s services Users can view revenue details for services they have been given permission to view Affiliate administrators can view details of their company s services and change the users associated with them Users do not have access to this function Affiliate administrators can view and update their company s users details and add new users to their company s services Users do not have access to this function Table 4 Overview of Web Site Functions e Your home page and the functions to which you have access will vary according to your user status The following screenshots display all functions that an Affiliate administrator can view but may not necessarily be viewable by all users Only Affiliate administrators have access to the Manage Users and Manage OBS Services functions e Service and Affiliate details are initially set up by Grapevine administrators 4 3 1 View OBS Requests Use this function to report on all the debit requests that you
28. r company has made to the networks Who has access to this function Page 13 of 30 External OBS User Manual e Affiliate administrators can view OBS requests for their company s services e Users can view the OBS requests for services they have been given permission to view To View OBS Requests 1 Select View OBS Requests from the 6 Navigation bar at the top of the page RA IN or from the links on the home page Te I a OBS WEB SERVICE sts om Welcome back jane In the Search for OBS Requests section View OBS Requests you can narrow your search to a specific k i Search for OBS Requests time period service and or mobile phone number Date From 2009 08 21 EE Hour O Minutes 00 2 1 Use the date picker to select a DateTo 2009 08 21 Hour 23 Minutes 59 start date and time OBS Serice All TO 2 Use the date picker to select an usison 5 Sense end date and time 3 Select an OBS Service from the drop down list 4 If you wish enter an MSISDN international mobile phone number 5 Click Search Figure 3 View OBS Request parameters 7 Click Export to send a detailed report of the data to a CSV file where you can filter and sort the results in a spreadsheet application like Excel EXPORT Summary Information Total requests Total failed Total success Total amount successfully authorised R4
29. s 2 Service Name Q9 Service Code Authentication Code Status 4x4 backup Enabled clubs Enabled hippos Disabled mad cows Enabled Page 19 of 30 External OBS User Manual 4 To add users to a service in the cassenceDeaisisencename Available Users list box highlight the user s that you wish to add and click asd lin ae 7 Ad d Service Name classic screenshots 5 To remove users from a service In EA E the Associated Users list box pasiaina ateoa highlight the user s that you wish to Ahentcaton Code 98712301 remove and click Remove Status Enabled Maxvalue 0 50 X Note Associated Users Available Users To select more than one user press 7 PEET and hold ctrl and click on multiple a eea user names individually BSA p aad 5 se Bown 5 Click Update Service Remove gt gt 6 2 O Cancel Note To find a specific service select a search parameter from the drop down list enter a search term in the Search box and then click Find To list all services the Search box must be empty Find OBS Services Find service_name Se_authenticationcode 4 4 External OBS Reports You can view two kinds of reports on the External OBS web site e OBS Requests reports e OBS Revenue reports 4 4 1 OBS Requests reports To view the External OBS Requests report select View OBS Requests from the Navigation bar at the top of the page or from the l
30. s so that they can view requests View detailed Revenue and Requests reports Figure 1 System Overview Now let s take a detailed look at how you will use this service Page 5 of 30 External OBS User Manual 3 How do I use the External OBS Web Service You will use the External OBS web service to request funds from mobile phone users accounts in payment for content that they have bought from you 3 1 What do I need to access the External OBS web service To access the web service you need e to be registered as affiliate an External OBS Company that is allowed to use Grapevine s External OBS to Affiliate with request funds from mobile phone users accounts in payment for Grapevine content e authentication These will be sent to you by email from Grapevine when you sign details for up for the External OBS service submitting requests to the web service e the WSDL for these The full web service definition is available in WSDL format in services Appendix D Web Service Definition on page 27 e thewebservice URL This will be sent to you by email from Grapevine when you sign up for the External OBS service Note If you ve mislaid your login information or authentication details please contact Grapevine Support Our contact details are in the Support section of this manual on page 23 3 2 How do I request funds from a network The process of requesting funds is quick and easy Step 1 you
31. se the External OBS Web Site The External OBS web site is a reporting mechanism You can use it to view all the requests for funds made by your company and whether they were successful or not You can also see the total amount of money you have requested from different networks 4 1 What do I need to access the External OBS web site To access the web site you need e an External OBS username These will be sent to you from Grapevine by email when and password you sign up for the External OBS service e the URL of the web site This will be sent to you from Grapevine by email when you sign up for the External OBS service Note If you ve mislaid your login information or the URL for this service is not working please contact Grapevine Support Our contact details are in the Support section of this manual on page 23 4 2 The External OBS Home Page R IN iNpIgizRZOLOn Tane OBS WEB SERVICE Home View OBS Requests Manage OBS Services Manage Users lt 4 Navigation bar Welcome back frikkie lt 4 Menu functions CONTACT US Grapevine Interactive Tel 2721 702 3333 Email support vine co za Figure 2 Home Page Page 12 of 30 4 3 Overview of web site functions Function View OBS Requests View OBS Revenue Manage OBS Services Manage Users Notes Description Lists all the requests for funds that your company has made to the networks Lists the total am
32. sssseceesesseeesees 12 4 1 What do I need to access the External OBS web site eeeecesssceeeeesteeeeeesteeeeees 12 4 2 The External OBS HOME Page cccccccsessesseceeececesseseeaeeeeeceseeseseeaeeeeeeeseeseseaeesesensees 12 4 3 Overview of web Site FUNCTIONS 00 0 ccecccecsteeececsteeeeeenueeeceeaaeeeeeeaueeeceeaaeeeeeeaaeeeeeeaas 13 4 3 1 View OBS REQUGStS 280 8 aati ete eich Gea eases oes 13 4 3 2 MIEW OBS REVEMUG reeeo reiia naana sa anatas AAE AES eases svaiseenceetoasescane ncsblanstcsnas 15 4 3 3 Manage Users a scat as Ai aia ack Se ees EEES SAKA ENEA ERE ae eee Ga 16 4 3 4 Manage OBS Services siccas ccc snd ockeks he chesceeecekkek bec sh acyeelwetnabacciaeececaseenbencian 18 4 4 External OBS RED OMtS nesnenin a Eea 20 AAT MOBS REQUCStS FE OES a a a a a Ee DAETA 20 44 2 OBS REVENUE report rerni a a e aae aa a aaa anaia 21 SE T e 1o E TA AEA TA TA AE A E T 23 Appendix A Insufficient Funds and Re attempts ssssesssssssssoossseosssssossessosseseossessessessossese 24 Appendix B OBS Revenue CalculationS sesseesesssssssosesssssessoosessosssssoosessosseseossessesssssossese 25 Appendix C Allowed Amounts seesessesssssssseoossssosssssoossssooesessoossseossessossessosseseosssseessessossese 26 Appendix D Web Service Definition cccssssscccsssssceccsssscecessssccccesssceccesssceesessecesssseeeeees 27 Tables Table 1 Debit Request Method cccccccccccecsssesenecece
33. will make a Debit Request call for funds see Step 1 Submit a Debit Request on page 7 Step 2 the web service will return a response see Step 2 Receive a Debit Request Response on page 9 Please take careful note of the status code in the Debit Request response see Debit Request Status Codes on page 9 If your request is unsuccessful you will need to decide whether you want to retry the request Costs for funds requests will be based on your commercial agreement with Grapevine Page 6 of 30 External OBS User Manual Read more pe Insufficient Funds and Re attempts to Request Funds It is essential for users of the External OBS to understand the process for handling re attempts to request funds from mobile phone users who have insufficient funds in their accounts Please familiarise yourself with Appendix A Insufficient Funds and Re attempts on page 24 3 2 1 Step 1 Submit a Debit Request To request funds you must call the Debit Request method Below the parameters you need to submit are tabled followed by an example of a Debit Request Input parameters are usually case sensitive e g Affiliate code Debit Request Method Method name ObsDebitRequest_Extr Field Description Format Examples Supplied by Service Unique name of the content string e ringtones GVI name offered by your company e classic screenshots e Card Division Authentica Unique security code string D63A3F991C9683011
Download Pdf Manuals
Related Search