Oracle® Communications Marketing and Advertising System Administrator's Guide Release 5.1 Part Number E20558-01 |
|
|
View PDF |
Oracle Communications Marketing and Advertising delivers traffic to the network using three channels:
Short Messaging (SMS)
Multimedia Messaging (MMS)
WAP Push
Advertising Campaigns use the SMS and MMS channels. Marketing campaigns use SMS, MMS, and WAP Push.
Setting up these channels requires creating and configuring plug-ins, which are the parts of the Oracle Communications Services Gatekeeper Communication Services that interact with the underlying network elements. Those plug-in services that are used by Marketing and Advertising are included as part of the standard installation and are configured using the same system that is used in Services Gatekeeper.
Some plug-ins use special services designed to support their functionality (e.g. the Heartbeat Service and the Short Code Mapper Service).
In addition, because marketing campaigns send out bulk messages, a function that is not supported in Services Gatekeeper 5.0, new plug-ins were created to support the scheduling activities associated with this functionality.
This chapter provides an overview of the information needed to configure these plug-ins. Before configuring channels in Marketing and Advertising be sure that you have properly setup the OCSG Client tab in the WebLogic Administration Console. See "OCSG Client" for information on how to configure the OCSG Client.
For information about configuring Open Mobile Alliance (OMA) campaigns that use text, URL and simple HTML snippet ad content see the "Using Oracle Communications Marketing and Advertising as an Ad Server" chapter in Integration Guide, another document in this set.
Services Gatekeeper monitors the traffic it sends to the network to make sure the underlying network elements are not overloaded. It does this using an internal budget, which also accounts for other traffic that may be flowing through the system.
To handle scheduling, special bulk plug-ins interact with the budget to schedule time slots for sending its messages. These plug-ins divide the messages into chunks that are then sent on to the appropriate Services Gatekeeper plug-in to be delivered to the network
These special bulk management plug-ins are:
EWS Bulk SMS plug-in
EWS Bulk MMS plug-in
EWS Bulk WAP Push plug-in
The SMS channel is supported by three plug-ins, depending on the type of campaign being used.
SMS-based marketing campaigns use the EWS Bulk SMS plug-in to manage scheduling tasks. They use the Parlay X 2.1 Short Messaging/SMPP communication service to deliver messages to the network. The Parlay X 2.1 Short Messaging/SMPP plug-in supports the use of short codes, so short code mapping must be configured.
SMS-based advertising campaigns use the Native SMPP communication service to deliver messages to the network. Because of the nature of this communication service, a second component, the SMPP Server Service, must also be configured.
For information about configuring the SMS channel, see:
Set up a EWS Bulk SMS plug-in instance to manage scheduling the sending of bulk SMSs.
To create an EWS Bulk SMS plug-in instance:
In the Domain Structure panel of the Administration console, expand the OCSG item.
Click the name of the server on which you want to create the plug-in instance.
The Oracle Communications Services Gatekeeper panel appears.
Expand the Container Services item.
Under Container Services, click PluginManager.
The PluginManager panel appears.
Select the Operations tab if it is not already selected.
From the Select An Operation list, choose createPluginInstance.
In the PluginServiceId field, enter "Plugin_ews_bulk_sms".
If you do not know the exact name of the plug-in service for which you want to create an instance, use the listPluginServices operation from the Select An Operation list to display the available plug-in services.
In the PluginInstanceId field, enter a name of your choosing for the plug-in instance.
Click Invoke.
The plug-in instance is created.
For more information about the Plug-in Manager see "Managing and Configuring the Plug-in Manager" in Oracle Communications Services Gatekeeper System Administrator's Guide.
To configure the EWS Bulk SMS Plug-in instance:
In the Domain Structure panel of the Administration console, expand the OCSG item.
Click the name of the server on which you created the plug-in instance.
The Oracle Communications Services Gatekeeper panel appears.
In the Oracle Communications Services Gatekeeper panel, expand the Communication Services item.
Click the name of the EWS Bulk SMS plug-in instance that you created in Creating the EWS Bulk SMS Plug-in Instance.
The panel for the EWS Bulk SMS plug-in instance appears
Note:
If you are using an MBean browser instead of the console, navigate to the name of the plug-in instance you created. It will be of type com.bea.wlcp.wlng.plugin.bulk.sms.management.BulkSmsMBean.Click the Attributes tab if it is not already selected.
Configure the attributes using the information in Table 12-1.
Table 12-1 EWS Bulk SMS Attributes
Attribute Name | Attribute Description |
---|---|
MaxSubscriberNumOfChunkSms |
The maximum number of targeted addresses in one messaging chunk |
MaxSubscriberNumOfBulkSmsOrder |
The maximum number of subscribers for one bulk SMS Order |
ChunkSmsTaskHeartbeatInterval |
The interval (given in seconds) for updating the heartbeat timestamp of a chunk that is being processed. The completion status of the chunk is evaluated at this time. |
NodeBudgetDetctInverval |
The interval (given in seconds) at which the BulkOrderScheduler checks the budget available for sending messages |
AllowedBudgetUsagePercent |
How much of the overall budget can be shared by the bulk service, as a percent. If 0, the bulk service only sends out messages when there is no other pending traffic. |
To change an attribute value, click the check box beside the name and enter the new value. You can also keep the default values.
All of these attributes have a cluster-wide scope.
When you have finished making your changes, click the Update Attributes button.
The screen refreshes and the changes are saved.
The EWS Bulk SMS Plug-in generates the EDRs listed in Table 12-2.
Table 12-2 EWS Bulk SMS Plug-in EDRs
EdrID | Method Called |
---|---|
17001 |
submitBulkSmsOrder |
17002 |
getBulkSmsOrderStatus |
17003 |
cancelBulkSmsOrder |
These EDRs contain the same information as Services Gatekeeper's communication services with one additional piece of information, the bulk_order_id.
For information about the general structure of EDRs, see the "Event Handling in the Network Tier"section of "Events, Alarms, and Charging" in Oracle Communications Services Gatekeeper Communications Services Reference at:
http://download.oracle.com/docs/cd/E16625_01/doc.50/e16612/csv_edrcommon.htm#i1000079
To deliver messages to the network, SMS-based Marketing Campaigns rely on the Parlay X 2.1 Short Messaging/SMPP Plug-in.
To create the Parlay X 2.1 Short Messaging/SMPP plug-in instance, follow the instructions in Creating the EWS Bulk SMS Plug-in Instance except in step 7 where in the PluginServiceId field, you should enter "Plugin_px21_short_messaging_smpp".
To configure the plug-in instance, follow the instructions in "Managing and Configuring Short Messaging Communications Services" in Oracle Communication Services Gatekeeper System Administrator's Guide at:
http://download.oracle.com/docs/cd/E16625_01/doc.50/e16623/adm_tpshortmess.htm#i1119710
For information on the EDRs, CDRs, and statistics generated by this plug-in, see the "Configuration Specifics" section of "Parlay X 2.1 Short Messaging Communication Service" in Oracle Communications Services Gatekeeper Communications Services Reference at:
http://download.oracle.com/docs/cd/E16625_01/doc.50/e16612/csv_shortmsg.htm#i1081755
To set up short code mapping for the Parlay X 2.1 Short Messaging/SMPP plug-in instance, follow the instructions in "Managing and Configuring Shortcode Mappings" in Oracle Communication Services Gatekeeper System Administrator's Guide at:
http://download.oracle.com/docs/cd/E16625_01/doc.50/e16623/adm_shrtcodempr.htm#i1094941
Both the Native SMPP Communication Service and the Parlay X 2.1 Short Messaging/SMPP Communication Service rely on Services Gatekeeper's SMPP Server Service to establish and manage connections to the network.
To configure the SMPP Server Service, see the "Properties for SMPP Server Service", "System Properties for SMPP Server Service", and "Reference: Attributes and Operations for SMPP Server Service" sections in "Managing and Configuring Native SMPP Communication Services" in the Oracle Communication Services Gatekeeper System Administrator's Guide at:
http://download.oracle.com/docs/cd/E16625_01/doc.50/e16623/adm_tpnativesmpp.htm#CEGICEIH
To deliver messages to the network, SMS-based advertising campaigns rely on the Native SMPP Plug-in.
To create the Native SMPP plug-in instance, follow the instructions in Creating the EWS Bulk SMS Plug-in Instance except in step 7 where in the PluginServiceId field, you should enter "Plugin_sms_smpp".
To configure the plug-in instance, follow the instructions in "Managing and Configuring Native SMPP Communication Services" in Oracle Communication Services Gatekeeper System Administrator's Guide at:
http://download.oracle.com/docs/cd/E16625_01/doc.50/e16623/adm_tpnativesmpp.htm#CEGICEIH
For information on the EDRs, CDRs, and statistics generated by this plug-in, see the "Configuration Specifics" section of "Native SMPP Communication Service" in Oracle Communications Services Gatekeeper Communications Services Reference at:
http://download.oracle.com/docs/cd/E16625_01/doc.50/e16612/csv_nativesmpp.htm#i1003220
The MMS channel is supported by three plug-ins, depending on the type of campaign being used.
MMS-based marketing campaigns use the EWS Bulk MMS plug-in to manage scheduling tasks. They use the Parlay X 2.1 Multimedia Messaging/MM7 communication service to deliver messages to the network. The Parlay X 2.1 Multimedia Messaging/MM7 plug-in supports the use of short codes, so short code mapping must be configured.
The Parlay X 2.1 Multimedia Messaging to MM7 plug-in supports a heartbeat module to keep the plug-in aware of the status of the underlying network node, so the heartbeat module must be configured.
MMS-based advertising campaigns use the Native MM7 communication service to deliver messages to the network.
For information about configuring the SMS channel, see:
Set up a EWS Bulk MMS plug-in instance to manage scheduling the sending of bulk MMSs.
To create the EWS Bulk MMS Plug-in instance, follow the instructions in Creating the EWS Bulk SMS Plug-in Instance except in step 7 where in the PluginServiceId field, you should enter "Plugin_ews_bulk_mms".
To configure the plug-in instance, follow the instructions in Configuring the EWS Bulk SMS Plug-in instance with the following changes:
In step 4, click the name of the EWS Bulk MMS plug-in instance that you created in (UNKNOWN STEP NUMBER) Creating the EWS Bulk MMS Plug-in Instance.
In step 6, refer to Table 12-3 to complete the fields in the attributes tab.
Table 12-3 EWS Bulk MMS Attributes
Attributes | Attribute Description |
---|---|
NodeBudgetDetctInverval |
The interval (given in seconds) at which the BulkOrderScheduler checks the budget available for sending messages |
AllowedBudgetUsagePercent |
How much of the overall budget can be shared by the bulk service, as a percent. If 0, the bulk service only sends out messages when there is no other pending traffic |
MaxSubscriberNumOfChunkMms |
The maximum number of targeted addresses in one messaging chunk |
MaxSubscriberNumOfBulkMmsOrder |
The maximum number of subscribers for one bulk MMS Order |
ChunkMmsTaskHeartbeatInterval |
The interval (given in seconds) for updating the heartbeat timestamp of a chunk that is being processed. The completion status of the chunk is evaluated at this time. |
If you are using an MBean browser instead of the console, the plug-in instance you created will be of type com.bea.wlcp.wlng.plugin.bulk.mms.management.BulkMmsMBean.
The EWS Bulk MMS Plug-in generates the EDRs listed in Table 12-4.
Table 12-4 EWS Bulk MMS Plug-in EDRs
EdrID | Method Called |
---|---|
18001 |
submitBulkMmsOrder |
18002 |
getBulkMmsOrderStatus |
18003 |
cancelBulkMmsOrder |
These EDRs contain the same information as Services Gatekeeper's communication services with one additional piece of information, the bulk_order_id.
For information about the general structure of EDRs, see the "Event Handling in the Network Tier" section of "Events, Alarms, and Charging" in Oracle Communications Services Gatekeeper Communications Services Reference at:
http://download.oracle.com/docs/cd/E16625_01/doc.50/e16612/csv_edrcommon.htm#i1000079
To deliver messages to the network, MMS-based Marketing Campaigns rely on the Parlay X 2.1 Multimedia Messaging/MM7 Plug-in.
To create the Parlay X 2.1 Multimedia Messaging/MM7 plug-in instance, follow the instructions in Creating the EWS Bulk SMS Plug-in Instance, except in step 7 where in the PluginServiceId field, you should enter "Plugin_px21_multimedia_messaging_mm7".
To configure the plug-in instance, follow the instructions in "Managing and Configuring Multimedia Messaging Communications Services" in Oracle Communication Services Gatekeeper System Administrator's Guide at:
http://download.oracle.com/docs/cd/E16625_01/doc.50/e16623/adm_tpmmmess.htm
For information on the EDRs, CDRs, and statistics generated by this plug-in, see the "Configuration Specifics" section of "Parlay X 2.1 Multimedia Messaging Communication Service" in Oracle Communications Services Gatekeeper Communications Services Reference at:
http://download.oracle.com/docs/cd/E16625_01/doc.50/e16612/csv_multimediamsg.htm#i1088437
To set up short codes for use with the Parlay X 2.1Multimedia Messaging/MM7 Plug-in, follow the instructions in "Managing and Configuring Shortcode Mappings" in the Oracle Communication Services Gatekeeper System Administrator's Guide at:
http://download.oracle.com/docs/cd/E16625_01/doc.50/e16623/adm_shrtcodempr.htm#i1094941
To set up the heartbeat functionality for use with the Parlay X 2.1 Multimedia Messaging/MM7 Plug-in, follow the instructions in "Configuring Heartbeats" in the Oracle Communication Services Gatekeeper System Administrator's Guide at:
http://download.oracle.com/docs/cd/E16625_01/doc.50/e16623/adm_heartbeat.htm#i1095415
To deliver messages to the network, MMS-based advertising campaigns rely on the Native MM7 Plug-in.
To create the Native SMPP plug-in instance, follow the instructions in Creating the EWS Bulk SMS Plug-in Instance except in step 7 where in the PluginServiceId field, you should enter "Plugin_multimedia_messaging_mm7".
To configure the plug-in instance, follow the instructions in "Managing and Configuring Native MM7 Communication Services" in Oracle Communication Services Gatekeeper System Administrator's Guide at:
http://download.oracle.com/docs/cd/E16625_01/doc.50/e16623/adm_tplegacymm7.htm#sthref375
For information on the EDRs, CDRs, and statistics generated by this plug-in, see the "Configuration Specifics" section of "Native MM7 Communication Service" in Oracle Communications Services Gatekeeper Communications Services Reference at:
http://download.oracle.com/docs/cd/E16625_01/doc.50/e16612/csv_legacymm7.htm#i1001225
The WAP Push channel is supported by two plug-ins. WAP Push-based marketing campaigns use the EWS Bulk WAP Push plug-in to manage scheduling tasks. They use the EWS WAP Push communication service to deliver messages to the network.
The WAP Push plug-in supports the use a heartbeat module to keep the plug-in aware of the status of the underlying network node.
For information about configuring the WAP Push channel, see:
Set up a EWS Bulk WAP Push plug-in instance to manage scheduling the sending of bulk WAP Push messages.
To create the EWS Bulk WAP Push plug-in instance, follow the instructions in Creating the EWS Bulk SMS Plug-in Instance except in step 7 where in the PluginServiceId field, you should enter "Plugin_ews_bulk_pushmessage".
To configure the plug-in instance, follow the instructions in Configuring the EWS Bulk SMS Plug-in instance with the following changes:
In step 4, click the name of the EWS Bulk WAP Push plug-in instance that you created in (UNKNOWN STEP NUMBER) Creating the EWS Bulk WAP Push Plug-in Instance.
In step 6, refer to Table 12-5 to complete the fields in the attributes tab.
Table 12-5 EWS Bulk WAP Push Attributes
Attributes | Attribute Description |
---|---|
NodeBudgetDetctInverval |
The interval (given in seconds) at which the BulkOrderScheduler checks the budget available for sending messages |
AllowedBudgetUsagePercent |
How much of the overall budget can be shared by the bulk service, as a percent. If 0, the bulk service only sends out messages when there is no other pending traffic |
MaxSubscriberNumOfChunkPushMessage |
The maximum number of targeted addresses in one messaging chunk |
MaxSubscriberNumOfBulkPushMessageOrder |
The maximum number of subscribers for one bulk WAP Push Order |
MaxNumberOfBulkPushMessageOrders |
The maximum number of bulk WAP Push orders overall |
ChunkPushMessageTaskHeartbeatInterval |
The interval (given in seconds) for updating the heartbeat timestamp of a chunk that is being processed.The completion status of the chunk is evaluated at this time. |
If you are using an MBean browser instead of the console, the plug-in instance you created will be of type com.bea.wlcp.wlng.plugin.bulk.pushmessage.management.BulkPushMessageMBean.
The EWS Bulk WAP Push Plug-in generates the EDRs listed in Table 12-6.
Table 12-6 EWS Bulk WAP Push Plug-in EDRs
EdrID | Method Called |
---|---|
19001 |
submitPushMessageOrder |
19002 |
getBulkPushMessageStatus |
18003 |
cancelPushMessageOrder |
These EDRs contain the same information as Services Gatekeeper's communication services with one additional piece of information, the bulk_order_id.
For information about the general structure of EDRs, see the "Event Handling in the Network Tier"section of "Events, Alarms, and Charging" in Oracle Communications Services Gatekeeper Communications Services Reference at:
http://download.oracle.com/docs/cd/E16625_01/doc.50/e16612/csv_edrcommon.htm#i1000079
To deliver messages to the network, WAP Push-based marketing campaigns rely on the Extended Web Services WAP Push/PAP Plug-in.
To create the Extended Web Services WAP Push/PAP plug-in instance, follow the instructions in Creating the EWS Bulk SMS Plug-in Instance, except in step 7 where in the PluginServiceId field, you should enter "Plugin_ews_push_message_pap".
To configure the plug-in instance, follow the instructions in "Managing and Configuring WAP Push Communication Services" in Oracle Communication Services Gatekeeper System Administrator's Guide at:
http://download.oracle.com/docs/cd/E16625_01/doc.50/e16623/adm_tpwappush.htm#i1085395
For information on the EDRs, CDRs, and statistics generated by this plug-in, see the "Configuration Specifics" section of "Extended Web Services WAP Push Communication Service" in Oracle Communications Services Gatekeeper Communications Services Reference at:
http://download.oracle.com/docs/cd/E16625_01/doc.50/e16612/csv_wappush.htm#i999999
To set up the heartbeat functionality for use with the Extended Web Services WAP Push/PAP plug-in, follow the instructions in "Configuring Heartbeats" in the Oracle Communication Services Gatekeeper System Administrator's Guide at:
http://download.oracle.com/docs/cd/E16625_01/doc.50/e16623/adm_heartbeat.htm#i1095415