Skip Headers
Oracle® Communications Marketing and Advertising Integration Guide
Release 5.1

Part Number E20559-01
Go to Documentation Home
Home
Go to Book List
Book List
Go to Table of Contents
Contents
Go to Feedback page
Contact Us

Go to previous page
Previous
Go to next page
Next
View PDF

6 Integrating with Siebel Enterprise Marketing Suite

Oracle Communications Marketing and Advertising can be integrated with the Siebel Enterprise Marketing Suite in order to leverage the Siebel interface and datastore in creating marketing campaigns.

Overview

Coordinated campaigns can be initiated in Siebel as a new offer and then sent to Marketing and Advertising for execution via various delivery channels. Integration between the Siebel Marketing and the Marketing and Advertising applications takes place over productized web services. Marketing and Advertising campaigns are invoked from Siebel Marketing as part of the Campaign Launch workflow.

Integrated offer to campaign management allows organizations using both Siebel Enterprise Marketing Suite and Marketing and Advertising to create, execute, manage and monitor marketing initiatives from within Siebel.

To use this feature, you must complete the following steps:

  1. Preparing Siebel and Marketing and Advertising

  2. Configuring Siebel

  3. Configuring Oracle Communications Marketing and Advertising

  4. Creating a Test Campaign in Siebel Marketing

  5. Verifying the Integration

Note:

Marketing and Advertising integrates with Siebel Enterprise Marketing Suite by using the embedded Siebel Email Marketing Server. Use of a single Siebel Marketing instance for both native Siebel email and Marketing and Advertising campaigns is not supported. It is recommended that a dedicated Siebel Marketing instance is used with Marketing and Advertising.

Preparing Siebel and Marketing and Advertising

The first step in integrating Siebel Enterprise Marketing Suite with Marketing and Advertising is ensuring that the applications and modules have been properly installed. This section will cover the high level environment prerequisites needed to successfully launch offers from Siebel Marketing into Marketing and Advertising.

For detailed information on specific application installation procedures please consult the product documentation available at the referenced links.

Siebel Prerequisites

Marketing and Advertising works with Siebel Enterprise Marketing Suite version 8.1. The Siebel Enterprise Marketing Suite installation consists of a Siebel Server deployment and its required subcomponents (Siebel Gateway Name Server, Database and Web server Extensions).

To successfully integrate Siebel Marketing and Marketing and Advertising ensure that all the necessary Siebel components are installed and operational by accessing the Siebel Marketing web interface at the following URL:

http://Siebel Server Address:Port/marketing_enu

If Siebel Marketing is unavailable please consult Siebel Marketing Installation and Administration Guide for information on installation and troubleshooting at:

http://download.oracle.com/docs/cd/E14004_01/books/MKTG_InstallAdmin/MKTG_InstallAdminTOC.html

Consult your Siebel application administrator if assistance is required.

Oracle Communications Marketing and Advertising Prerequisites

Marketing and Advertising version 5.1 or later must be installed and functional.

You must have both Oracle WebLogic Administration Console Administrator rights for the domain on which Marketing and Advertising is running as well as valid credentials for a system owner user of the application.

Check the following URL to ensure that you can access and log into the Oracle WebLogic Administration Console as an Administrator:

http://Marketing Server Address:WebLogic Access Port/console

Ensure that the Marketing and Advertising Siebel Campaign Manager Enterprise and Web Applications are deployed and running in your domain. The Summary of Deployments should contain an entry for the ocma-siebel module.

Check the following URL to ensure that you can access and log into the Marketing and Advertising Server as a system owner:

http://Marketing Server Address:WebLogic Access Port/ocma

If the Oracle WebLogic and Marketing and Advertising servers are unavailable please consult Oracle Communications Marketing and Advertising Installation Guide for information on installing and starting the application.

Shared Filesystem

The Siebel file system is used to share ad content and subscriber address information from Siebel Marketing to Marketing and Advertising for use in campaigns. The Siebel fs directory must be shared from the Siebel server and mounted on the Marketing and Advertising server.

Depending on the operating system(s) in use there will be different ways to configure the shared filesystem. The following example depicts configuring the file share on a Unix operating system using the Network File System (NFS) protocol:

  1. Login to the Siebel server as root or a user with administrative rights.

  2. Edit the /etc/exports file by adding an entry for the Siebel fs directory, Marketing and Advertising server IP address and necessary permissions on a single line:

    /u01/app/siebel/fs <Oracle Communications Marketing and Advertising server IP> (rw,sync,all_squash)

  3. Start the NFS services on the Siebel server:

    /etc/init.d nfs start

  4. Login to the Marketing and Advertising server as root or a user with administrative rights.

  5. Create a new directory in the $OCMA_HOME directory to mount the Siebel share:

    mkdir $OCMA_HOME/siebel

  6. Mount the remote Siebel fs directory locally on the Marketing and Advertising server:

    mount <Siebel Server IP Address>:/u01/app/siebel/fs $OCMA_HOME/siebel

Please consult the necessary operating system documentation and systems administrators for your environment if assistance is needed. Be sure to consider security requirements when making the Siebel fs directory available via file sharing.

Configuring Siebel

The Siebel Marketing application has a number of necessary setup activities needed for integrating with Marketing and Advertising. All of the following settings are configured from within the Siebel Marketing GUI.

  1. Configuring the Siebel Outbound Web Service

  2. Configuring the Siebel WebMarketing Inbound Web Service

  3. Configuring the Siebel Email Marketing Server

  4. Enabling the Siebel Component Groups

  5. Starting the Siebel Marketing Workflow Processes

To complete the necessary procedures login to the Siebel Marketing GUI at the following URL as a user with administrative rights:

http://Siebel Server Address:Port/marketing_enu

The following procedures assume familiarity with Siebel Marketing. If additional detail or assistance is required please contact your Siebel application administrator.

Configuring the Siebel Outbound Web Service

The Siebel Marketing SendMailingService Web Service must be altered with the Marketing and Advertising WSDL URL representing the target web service to invoke during campaign execution.

To make the necessary configuration changes in the Siebel Marketing web client:

  1. From the Navigate menu, select Site Map.

  2. Select Administration - WebServices.

  3. Select Outbound Web Services.

  4. Scroll down the list of Outbound Web Services and select the SendMailingService to bring up the Service Port configuration.

  5. Replace the Address value for SendMailing with the following URL containing values specific to your environment:

http://Marketing Server Address:WebLogic Access Port/SiebelCampaignManager/SendMailing?WSDL

Configuring the Siebel WebMarketing Inbound Web Service

Marketing and Advertising requires configuration of the Siebel WebMarketing Inbound Web Service.

To configure the Siebel WebMarketing Inbound Web Service:

  1. From the Navigate menu, select Site Map.

  2. Select Administration - WebServices.

  3. Select Inbound Web Services.

  4. Scroll down the list of Outbound Web Services and select the WebMarketing Inbound Web Service.

  5. In the Outbound Web Service Port field edit the Address column with the actual value:

    http://Siebel Server Address:Port/eai_enu/start.swe?SWEExtSource=WebService&SWEExtCmd=Execute&WSSOAP=1

This URL address is found in the WebMarketing WSDL file in the soap address element whose value is the inbound web service URL.

Configuring the Siebel Email Marketing Server

When an offer is created in Siebel one or more treatments or delivery channels need to be assigned for use in the marketing campaign. In order to use Marketing and Advertising as a delivery channel an Email Marketing Server must be configured to use the SendMailing Outbound Web Service Port previously configured.

To create the necessary Email Marketing Server in the Siebel Marketing Web Client:

  1. From the Navigate menu, select Site Map.

  2. Select Administration - Marketing.

  3. Select Servers.

  4. Click the New button.

  5. Under the Type value select Email Marketing Server.

After creating the new Email Marketing Server ensure that it is selected and proceed to the lower configuration area for the new server.

  1. Click the New button.

  2. Select the Parameter Type of Email sending daemon (ESD).

  3. In the Outbound Web Service Port field select the SendMailing port from the Pick Web Service Port popup window.

Enabling the Siebel Component Groups

The Siebel Marketing to Marketing and Advertising integration requires the following Siebel Component Groups to be enabled:

  • Workflow Management

  • Enterprise Application Integration

  • Marketing Server

  • Communication Management

  • Marketing Object Manager

Check that the listed Siebel Component Groups are enabled in the Siebel Marketing Web Client:

  1. From the Navigate menu, select Site Map.

  2. Select Administration - Server Configuration.

  3. Select Enterprises.

  4. Select Component Groups.

  5. Scroll through the list of Components and, if necessary, highlight the necessary Components and click the Enable button.

  6. Restart the Siebel Marketing instance to activate the configuration changes.

    After the Siebel instance has been restarted, navigate to the Component Groups screen and make sure the listed component groups remain enabled.

Starting the Siebel Marketing Workflow Processes

Prepare Siebel Marketing to launch marketing campaigns by activating the Marketing Workflows in the Siebel Marketing Web Client:

  1. From the Navigate menu, select Site Map.

  2. Select Administration - Business Process.

  3. Select Repository Workflow Processes under Workflow Deployment.

  4. In the Repository Workflow Processes pane click the Query button.

  5. In the Group field select Marketing.

  6. Click the Go button.

  7. Activate the required Marketing Workflows by highlighting the Workflow and clicking the Activate button.

Configuring Oracle Communications Marketing and Advertising

Marketing and Advertising must be configured for integration with Siebel Marketing. Two main activities are required before Siebel requests can be handled. These steps are described in the following sections:

  1. Configuring the Web Service in WebLogic

  2. Preparing Oracle Communications Marketing and Advertising for Siebel Marketing

Configuring the Web Service in WebLogic

Marketing and Advertising must be provided with Siebel integration parameters to allow communication between the applications. These parameters include Siebel Marketing application user credentials, the previously described Siebel fs share location on the Marketing and Advertising server and the Siebel Web Service Callback endpoint URL for communicating with Siebel.

All of the required parameters are configured in a single location within the Oracle WebLogic Administration Console for the domain on which Marketing and Advertising is running. The following steps indicate how to accomplish the necessary configuration:

  1. Access the Oracle WebLogic Administration Console for the domain on which Marketing and Advertising is running at:

    http://Marketing Server Address:WebLogic Access Port/console

  2. Login to the Administration Console with a user with administrative permissions.

  3. Under Domain Structure on the left side of the screen select OCMA.

  4. Click the Siebel tab.

    The Siebel parameter page appears.

    Description of mmitg_ocma_siebel_config.gif follows
    Description of the illustration mmitg_ocma_siebel_config.gif

  5. Enter the Siebel information into the fields as follows:

    • Leave the Access Siebel session type value of ServerDetermine.

    • In the Siebel user name field, enter the Siebel administrative user sadmin.

    • In the Siebel password field, enter the sadmin user password.

    • In the Siebel file system path field, enter the local path to where the Siebel fs share is mounted.

    • Leave the default entries for the CSV file separator, Token prefix, Token postfix, and the Merge field name of the phone number fields for now.

    • In the Callback endpoint field, enter the following URL customized for your environment:

      http://Siebel Server Address:Port/eai_enu/start.swe?SWEExtSource=WebService&SWEExtCmd=Execute&WSSOAP=1

  6. Click Save.

Preparing Oracle Communications Marketing and Advertising for Siebel Marketing

A number of Siebel-related entities must be created in the Marketing and Advertising application. Marketing and Advertising utilizes these entities in executing campaigns originating from Siebel Marketing. The entities provide the roles and functionality needed to translate a Siebel Marketing campaign launch into a running campaign in Marketing and Advertising.

The following Marketing and Advertising entities need to be created:

  • Organizations

  • Users

  • Connection Configuration

  • Campaign Space

  • Marketing Space

For information on how to create the required entities in Marketing and Advertising see Oracle Communications Marketing and Advertising System Owner Online Help.

Creating Oracle Communications Marketing and Advertising Organizations and Users

Login to the Marketing and Advertising Web Client as a system owner user and create the following entities:

  • A Siebel Network Provider Organization, e.g. siebelNPO

  • A Siebel Network Provider User, e.g. siebelNPuser

  • A Siebel Ad Service Provider Organization, e.g. siebelASPO

  • A Siebel Ad Service Provider User, e.g. siebelASPuser

  • A Siebel Ad Space Owner Organization, e.g. siebelASO

  • A Siebel Ad Space Owner User, e.g. siebelASOuser

  • A Siebel Advertiser User, e.g. siebelADuser

Creating a Usable Campaign Space

To execute a marketing campaign launched from Siebel Marketing there must be a valid Marketing Space for Siebel. Configuring a Marketing Space in Marketing and Advertising requires a Marketing Connection configuration to be setup first.

Configure the necessary entities as follows:

  1. Create a Siebel Marketing Connection Configuration, e.g. SiebelCC, using the previously created Siebel Ad Space Owner.

  2. Create a Siebel Marketing Space, e.g. SiebelMS, using the Connection Configuration created in the previous step also populating the remaining required fields.

Setting the Oracle Communications Services Gatekeeper Network Provider Name

To identify the Marketing and Advertising instance servicing Siebel Marketing set the Ocsg Network Provider in the Oracle WebLogic Administration Console for the domain in which Marketing and Advertising is running.

  1. Access the Oracle WebLogic Administration Console for the domain on which Marketing and Advertising is running at:

    http://Marketing Server Address:WebLogic Access Port/console

  2. Login to the Administration Console with a user with administrative permissions.

  3. Under Domain Structure on the left side of the screen select OCMA.

  4. In the General tab replace the entry in the Ocsg Network Provider with the name of the Siebel Network Provider created above (e.g. SiebelNPO).

Creating a Test Campaign in Siebel Marketing

Once all of the previous steps have been completed the integration between Siebel Marketing and Marketing and Advertising is functional.

The following section provides a high level demonstration on how to test and operate the integration between the two applications. Detailed procedures for creating Siebel Marketing campaigns/offers, including more information on treatments and treatment templates, can be found in Siebel Marketing User Guide.

http://download.oracle.com/docs/cd/E14004_01/books/MKTG_User/MKTG_UserTOC.html

Consult your Siebel application administrator if assistance is required.

Create Siebel Marketing Offer

A Siebel Marketing sourced campaign running in Marketing and Advertising is based on a Siebel Marketing offer. To initiate a new integrated campaign begin by creating a new Siebel Marketing offer.

  1. Access the Siebel Marketing interface and login with a user with the necessary permissions to create a new offer at:

    http://Siebel Server Address:Port/marketing_enu

  2. Select the Offers tab.

  3. Create a new offer by clicking on the New button.

  4. In the Name field enter a value for the new offer (e.g. TestOffer).

  5. In the Type field select one of the values from the pulldown.

  6. Save the record by clicking on the Menu button and selecting Save Record.

Create Siebel Marketing List

A Siebel Marketing list has various functions. Marketing and Advertising uses a marketing list of contacts contained in Siebel Marketing as the selected recipients of an offer/campaign. To test the integration between Siebel Marketing and Marketing and Advertising there must either be an existing list of contacts which contain the needed information for a campaign (e.g. mobile phone numbers for a SMS campaign) or a new list must be generated from within the Siebel Marketing interface.

To generate a new list:

  1. Access the Siebel Marketing interface and login with a user with the necessary permissions to manage lists at:

    http://Siebel Server Address:Port/marketing_enu

  2. Click the Navigate pull down menu and select Site Map.

  3. Click the List Management link

  4. Under List Management click the All Lists link.

    If a list suitable for testing the integration already exists proceed to Creating Siebel Treatments Using Sample Template Files.

  5. Click the New button to create a new list.

  6. Save the newly created list by clicking another field or clicking the Menu button.

    The List Name becomes a clickable hyperlink.

  7. Click the list hyperlink to edit the contacts.

  8. In the List Contacts and Prospects tab click the New button to add contacts to the list.

    Ensure that the contacts you add to the list possess a value in the Mobile Phone # field so that Marketing and Advertising can deliver a targeted campaign message to the contact. You may add any number of contacts to the list for testing purposes. For production campaigns and lists you will likely have a large number of contacts in the lists used for offers/campaigns.

Consult Siebel Bookshelf v8.1 and your Siebel application administrator if more assistance is required configuring lists.

Creating Siebel Treatments Using Sample Template Files

A channel-specific (e.g. SMS) instance of a Siebel Marketing offer requires a specific treatment.

Sample treatment xsd files for use with Marketing and Advertising are provided in the ocma-siebel-jar-5.0-SNAPSHOT.jar jar file contained in the ocma-siebel-ear.ear application.

Uncompress the sample template xsd files so that they can be used to create valid treatment templates for use with Siebel Marketing.

  1. Login to the server where the Oracle WebLogic domain hosting Marketing and Advertising is running.

  2. Uncompress the ocma-siebel-ear.ear file located in the $ORACLE_MIDDLEWARE_HOME/ocma_5.1/applications directory (e.g. C:\Oracle\Middleware\ocma5.1\applications on Windows operating systems).

  3. In the lib folder uncompress the ocma-siebel-jar-5.0-SNAPSHOT.jar file.

  4. Extract and save the following xsd template files to a location where they can be edited with a text editor and then uploaded from within the Siebel Marketing Web client:

    • mms_template.xsd

    • sms_template.xsd

    • wap_template.xsd

    Each sample template xsd file should be used as a basis for creation of channel-specific treatment templates in Siebel Marketing.

Creating Treatment Templates

The sample template xsd files must be edited for your specific environment and offer/campaign requirements. A number of elements within the templates specify Marketing and Advertising entities to be used by offers/campaigns. Replace the entity fields with the values specific to your environment.

The text element is used for personalization of offers using contact information stored in Siebel Marketing lists and shared with Marketing and Advertising. Any number and combination of the following Siebel contact fields can be included for use in the text field of a treatment template:

  • First Name

  • Middle Name

  • Last Name

  • Work Phone #

  • Home Phone #

  • Fax Phone #

  • Cellular Phone #

  • Email Address

  • Job Title

  • Account

  • Account Location

  • Current Date

  • Source Code

  • Contact Id

  • Prospect Id

  • Camp Con Id

  • Segment/List Name

  • Forwarder Message

  • Subscription List

Note:

The Cellular Phone # value corresponds to the Mobile Phone # field for a Siebel contact.

A simple example of a valid SMS treatment template file is provided here based on Marketing and Advertising entity names used in this chapter.

The treatment template indicates that the recipient of an offer based on this template is identified by the Cellular Phone # field. The offer treatment is customized in this example to include the recipient's first and last names as well as a short text string.

<smsContent>
        subscriberNumberField>[Field:Cellular Phone#]</subscriberNumberField>
        <advertiser>siebelADuser
        <text> Hello [Field:First Name] [Field:Last Name]</text>
        <textWithoutToken> Please visit www.oracle.com</textWithoutToken>
        <marketingSpace>siebelMS</marketingSpace>
        <channelType>SMS</channelType>
        <serviceProviderName>siebelASPuser</serviceProviderName>
</smsContent>

MMS and WAP treatment templates can be created in the same manner using the sample xsd files. Template contents will vary depending on marketing requirements. Offer/campaign strategy will dictate the reusability and specificity of template contents.

Uploading Treatment Templates

Once a valid treatment template has been created it needs to be uploaded into Siebel Marketing so that it can be used to launch an integrated campaign in Marketing and Advertising.

To upload the treatment template into Siebel Marketing:

  1. Access the Siebel Marketing interface and login with a user with the necessary permissions to manage treatment templates at:

    http://Siebel Server Address:Port/marketing_enu

  2. Select the Offers tab.

  3. Click the Treatment Templates link.

  4. Click the New File button and navigate to the location where the treatment template is saved.

  5. Select the template file and click the Open button to upload the template into Siebel Marketing.

  6. Edit the description field if desired.

Create Treatment

A Siebel Marketing treatment based on a Marketing and Advertising compliant template can now be generated. The treatment will include the offer. This treatment will be used by a Siebel campaign.

To create a new Siebel treatment:

  1. Access the Siebel Marketing interface and login with a user with the necessary permissions to manage treatment templates at:

    http://Siebel Server Address:Port/marketing_enu

  2. Select the Offers tab.

  3. Click the Email Treatments link.

  4. Click the New button and enter a name for the new treatment.

  5. In the Treatment Details tab select the name of the offer previously created in Create Siebel Marketing Offer (e.g. TestOffer).

  6. Select the Edit Email tab.

  7. Click the New button.

  8. In the Template Name field search for and select the Marketing and Advertising template previously uploaded.

    The Template Contents field should display the properly formatted template.

    Note:

    MMS treatments require an image file attachment. If a MMS template is being used to create a MMS channel treatment you must select the attachments tab and add an image file.
  9. Save the treatment.

Creating a Siebel Campaign

When the campaign is launched as a new offer in Siebel, Marketing and Advertising will be notified to execute the campaign based on the contents of the treatment and the marketing list specified in the campaign and stored on the shared file system.

Note:

The following Siebel Campaign procedure may not be indicative of your organization's Siebel Marketing implementation. The steps described here are high-level in nature and do not account for possible workflows in your campaign processes (e.g. approvals). Consult your Siebel administrator for implementation specific details of your campaign creation process.

To create a new Siebel Campaign:

  1. Access the Siebel Marketing interface and login with a user with the necessary permissions to manage campaigns at:

    http://Siebel Server Address:Port/marketing_enu

  2. Select the Campaigns tab.

  3. Click the New button.

  4. In the Name field enter a value for the new campaign.

  5. Save the newly created campaign by clicking another field or the Menu button

    The campaign Name becomes a clickable hyperlink.

  6. Click the name hyperlink to edit the Campaign Details.

  7. Select the Design tab.

  8. In the Offers sub-tab Click the New button.

  9. Select the previously created Offer (e.g. TestOffer).

  10. In the lower Treatments section click the New button.

  11. Select the previously created treatment based on the uploaded template.

  12. Select the Segments/List sub-tab.

  13. Click the Add List button.

  14. Select the previously created list.

  15. Select the Allocation sub-tab.

  16. Click the Update Count button and verify that the Net Count corresponds to the number of members in the selected contact list.

Launching the Siebel Campaign

Once the campaign has been created in Siebel Marketing it must be launched.

To launch the newly created Siebel Marketing campaign:

  1. Access the Siebel Marketing interface and login with a user with the necessary permissions to manage campaigns at:

    http://Siebel Server Address:Port/marketing_enu

  2. Select the Campaigns tab.

  3. Select the campaign name hyperlink containing the Marketing and Advertising treatment.

  4. Select the Execute tab.

  5. Click the Launch Wave button.

  6. Confirm the Scheduled Start date and time and click OK.

Verifying the Integration

Once the Siebel Campaign wave has been launched verify that the treatment has been successfully initiated in Siebel Marketing and that the campaign has been created in Marketing and Advertising.

Confirming Siebel Campaign Status

In the Siebel Marketing verify the successfully launch of the campaign wave by:

  1. Confirming that the Status field in the Execution Status sub-tab for the wave has changed to launched.

  2. Confirming that the Status field in the System Tasks sub-tab for Campaign Launch process has changed to Completed.

  3. Confirming that the mime content and contacts list files have been generated in the respective shared directories on the Siebel server host:

    $SIEBEL_HOME/fs/Marketing/EmailOfferContent/<name>.mime

    $SIEBEL_HOME/fs/Marketing/Lists/<name>.txt

Confirming Oracle Communications Marketing and Advertising Campaign Creation

In the Marketing and Advertising Web Client, verify the successful launch of the marketing campaign by confirming that a campaign has been created for the Siebel Advertiser user.