SDGW web service configuration

In order to configure the Sponsored Data Web Service, you’ll need to setup a few things in order to get things moving. This topic guides you through this configuration.

Core configuration

  1. Enter the following in route.cfg:

<server>/sponsordata-ws/0 = 13900

  1. Add the following process to PM.cfg:

[Process {N}]
    Description         =  Sponsored Data WS
    Process Path        =  /tango/bin/launchSDWS.sh
    Program Name        =  sponsordata-ws
    Class Name          =  sponsordata-ws/0/pmClient/0
    Port                =  13900
    Argument            =  -c /tango/config/sponsorDataWs_properties
    Logical Host        =  SDWS Host
    Primary Host        =  localhost
    Initial Response    =  60
    Restart Attempts    =  3
    Polling Interval    =  2
    Outstanding Polls   =  10

  1. Add the following to the CDR.cfg:

filename<X> = active_ws.cdr,    /sdws/sponsordata_sd_cdr.%Y%m%d_%H%M%S,  sponsordata-ws/0


Set the API method to OCSG

In the sponsorDataWs.properties file:

sponsordata.ws.ocsg.api.http.method.get=true
sponsordata.ws.ocsg.api.http.check.response.status=true

Set API response timeout and HTTPs

In the sponsorDataWs.properties file:

sponsordata.ws.api.http.timeout=60000
sponsordata.ws.api.https.cert.verify=false

Configure the Heartbeat Discovery Service

When the Heartbeat Discovery Service is enabled, the service runs continually at a set interval. It checks the Oracle Server heartbeat endpoints (provided in a new column of the OCSG_ENDPOINT table) and in turn, creates a dynamic list of reliable endpoints.

This service runs within the Sponsor Data WS Application and can be enabled or disabled. When disabled, the static list of endpoints in the OCSG_ENDPOINT table are used.

To configure:

In the sponsorDataWs.properties file:

sponsordata.ws.heartbeat.enabled = true
sponsordata.ws.heartbeat.sleep = 10000
sponsordata.ws.heartbeat.timeout = 5000

Configure the Failover Service

If a campaign activation submission fails 3 times attempting to connect to an endpoint, it attempts to connect to the next endpoint on the list (whether the dynamic list from the Heartbeat Discovery Service or the static list).

If enabled, the number of failovers can be configured with the sponsordata.ws.failover.endpoints property where:

  • 0 = runs the entire list

  • <n> = specifies the number of endpoints to try after the first one fails

To configure:

In the sponsorDataWs.properties file:

sponsordata.ws.failover.enabled = true
sponsordata.ws.failover.endpoints = 0

Additional configuration

Check out the full Web Service Properties File file as of 2021-06-09.