In Siebel Marketing (7.7.x, 7.8.x, 8.x), the campaign load and list generation processes pass a variety of parameters to the web services available on Analytics ( OBI ) server.
Out of the Box there are some pre-defined report parameters (e.g. campaignName, campaignCode) which can be used in the list format to control column expressions, list format filters and contents of the list header / footer. These parameters are Name Value pairs, which get passed from Siebel Server to Siebel Analytics Web (OBI Presentation services ) along with WriteListFiles SOAP call.
The process can be extended to pass additional Parameters during the WriteListFiles call (the web services API to generate the campaign load or list export file) .
This document describes the process to add custom fields and make them available as 'system data' :
SOLUTION
This document describes how to add custom fields to Campaign Load Format.
1. Create custom field ( in case it does not exist ) :
If the data that needs to be passed to Analytics (OBI) Server is coming for S_SRC extension column, then expose that column in Campaign BusComp. If it is coming for other objects (eg. Program, Segment), then expose that column in the Campaign BusComp using appropriate joins. (If column already exists in the Campaign BC, then ignore this step). Make sure you compile the SRF after these changes.
2. Modify Workflow
In Siebel Tools > Object explorer, select Workflow Process steps and query for “Marketing Campaign Load” workflow process. Revise the latest version using “Revise” button. Note that new record with status = ‘In Progress’ is created, and you will be making changes to this workflow process record
Right click and select Edit Workflow Process menu item. It will bring up workflow process designer. Select “Get List Format System Data” step, and then click “Show Input Arguments” from the right click menu. Note that bottom applet now displays Input arguments for the step :
Create a new record in the bottom applet, and set following properties:
Repeat above step for additional fields that you want to pass over to Marketing Server, and then deploy the workflow.
Once the workflow changes are deployed, you will have to “Activate” the new version using Siebel Client > Administration – Business Processes > Workflow Deployment view
Once you finish above step, next time you run the WriteListFile job (eg. campaign load), You will see these new parameters values in the NameValuePair section of the Marketing Job detail log. The log can be found under site map > Administration – Marketing > Marketing Server Administration > Manage Marketing Jobs.
3. Add the new expression to the List Format Designer expression list.
In the List Format Designer user interface, there is a list of available web expressions provided in the standard product. The list of available expressions is controlled by a set of web message files in the Siebel Analytics Web file system.
There are 2 file types that control the list of web expressions - one for the language independent expression and a translated file for each language. To add a new expression, you need to add a new entry to both the language independent file as well as any languages that you use in production.
The file of language independent expressions is located in:
\install root\SiebelAnalyticsData\Web\Config\marketingwebexpressions.xml (10g)
<OBI Install Root>\instances\instance1\config\OracleBIPresentationServicesComponent\coreapplication_obips1\marketingwebexpressions.xml (11g)
The translated display name for each expression is indicated in the web expression message file for the selected language. The location is dependent on the installed language(s). For English the file can be found in:
\installroot\D:\SiebelAnalytics\Web\App\Res\l_en\messages\marketingwebexpressionmessages.xml (10g)
<OBI Install Root>\Oracle_BI1\bifoundation\web\msgdb\l_en\messages\marketingwebexpressionmessages.xml (11g)
Note that sub-folder l_en is for English strings only. Other language sub-folders can be found under \installroot\SiebelAnalytics\Web\App\Res (10g) or <OBI Install Root>\Oracle_BI1\bifoundation\web\msgdb
To add the new expression:
- Open \install root\SiebelAnalyticsData\Web\Config\marketingwebexpressions.xml (10g) or <OBI Install Root>\instances\instance1\config\OracleBIPresentationServicesComponent\coreapplication_obips1\marketingwebexpressions.xml (11g)
- Add your new expression to the end of the file using the same XML formatting as the existing entries. Make sure the string you use for the expression name matches what you added to the Business Service.
For example:
<WebExpression name="batchNumber" usequotes="false">
<messageKey>kmsgMktgWebExprBatchNumber</messageKey>
<default>1</default>
</WebExpression>
<WebExpression name="DNISNumber" usequotes="false">
<messageKey>kmsgMktgWebExprDNISNumber</messageKey>
<default></default>
</WebExpression>
<WebExpression name="fileCounter" usequotes="false">
<messageKey>kmsgMktgWebExprFileCounter</messageKey>
<default></default>
</WebExpression>
<WebExpression name="CampaignCreatedBy" usequotes="false">
<messageKey>kmsgMktgWebExprCampaignCreatedBy </messageKey>
<default></default>
</WebExpression> </WebExpressions>
Save the XML file.
Open the translation file for the language(s) you are using.
The English file is located in:
\installroot\SiebelAnalytics\Web\App\Res\l_en\messages\marketingwebexpressionmessages.xml (10g) or <OBI Install Root>\Oracle_BI1\bifoundation\web\msgdb\l_en\messages\marketingwebexpressionmessages.xml (11g)
Add the display caption that you want to appear to the user with the English user interface. Add the expression at the end of the file using the same XML syntax. Be sure to reference the ‘messageKey’ you entered in step 2 in the other XML file.
For example:
<WebMessage name="kmsgMktgWebExprSplitDetails">
<TEXT>Split Details</TEXT>
</WebMessage>
<WebMessage name="kmsgMktgWebExprTokenNumber">
<TEXT>Token Number</TEXT>
</WebMessage>
<WebMessage name="kmsgMktgWebExprWaveID">
<TEXT>Wave Id</TEXT>
</WebMessage>
<WebMessage name="kmsgMktgWebExprCampaignCreatedBy">
<TEXT>Campaign Created By Name</TEXT>
</WebMessage> </WebMessageTable>
</WebMessageTables>
Save the XML file.
4. Test the new configuration
To test list generation with new parameters do the following:
Create a list format or modify an existing format to use the new expression.
To test if the new expression appears in the pick list in the user interface, go the Column Formula dialog for a column or the List Format Headers/Footers tab and select the System Data link. The new value should appear in the list.
Add the expression to the list format header or column formula. Save the list format.
Associate the list format to a test campaign in the Marketing application in the List Distribution view tab. Generate the list using the button.
Go to Manage Marketing Jobs and locate your recent WriteListFiles job. Click the Details link to view the XML. The new parameter should appear in the NameValuePair section of the XML.
