3 RTD Siebel ECommerce Inline Service Elements

This chapter describes the elements in the RTD Siebel ECommerce Inline Service. It contains the following topics:

Section 3.1, "Overview of Oracle RTD Integration with Siebel E-Commerce"
Section 3.2, "Data Sources"
Section 3.3, "Entities"
Section 3.4, "Informants"
Section 3.5, "Advisors"
Section 3.6, "Choice Groups and Choices"
Section 3.7, "Decisions"
Section 3.8, "Models"
Section 3.9, "Functions"

3.1 Overview of Oracle RTD Integration with Siebel E-Commerce

Figure 3-1 shows the high-level integration points between the Siebel E-Commerce application and Oracle RTD.

Figure 3-1 High-Level Siebel E-Commerce Integration Flow with Oracle RTD

Figure 3-2 shows a detailed integration flow between the Siebel E-Commerce application and the Inline Service RTD Siebel ECommerce.

Figure 3-2 Detailed Siebel E-Commerce Integration Flow with Oracle RTD Inline Service

The user logs in to the Siebel E-Commerce application.

The Siebel E-Commerce application initiates the context for an Oracle RTD session. It creates a session key (timestamp and random number combination), and sends the session key to the RTD Siebel ECommerce Inline Service through the Initial Context Informant.
Oracle RTD creates a session.
If the user is a registered customer, the Siebel E-Commerce application sends customer account and contact information to Oracle RTD through the Update Customer Profile Informant.
Oracle RTD extracts further customer information for the registered users from the Data Sources defined in the Inline Service.
The Siebel E-Commerce application sends the Advisor Get Promotions to Oracle RTD, specifying catalog and category id as parameters, if these were not already sent with a prior Informant.
1. Oracle RTD extracts the promotions from the Data Sources defined in the Inline Service.
2. The promotions choices are passed to the Oracle RTD Eligibility Engine.
3. The eligible promotion choices are scored in accordance with the performance goals associated to this decision and then ranked.
  
  The default scoring process for each choice is based on the likelihood score returned from the Promotions Acceptance model defined in the RTD Siebel ECommerce Inline Service for the performance goal, Maximize Acceptance Likelihood.
At the final stage of Get Promotions Advisor processing, Oracle RTD returns promotion choices to the Siebel E-Commerce application.
The Siebel E-Commerce application runs the returned promotions through Siebel's CheckQuoteEligibilityCompatibility web service before displaying the final set of eligible promotions as Hot Offers to the user.
The Siebel E-Commerce application sends Oracle RTD details of the promotions presented to the user through the Presented Offers Informant.
The Siebel E-Commerce application sends Oracle RTD details of the promotions that the user clicked through, if any, through the Offer Clicked Informant.
When the user logs out from the Siebel E-Commerce application, the Siebel E-Commerce application informs Oracle RTD through the Close Session Informant.

For anonymous users, the Oracle RTD session will timeout, closing the session automatically.
Oracle RTD applies the feedback from the web session to update the Promotions Acceptance Model, to refine and improve the model for future predictions.

3.2 Data Sources

As released, the RTD Siebel ECommerce Inline Service has been configured to extract various forms of customer data after a customer has been identified. Oracle RTD retrieves the data into Oracle RTD data sources using JDBC to the Siebel OLTP. These data sources can be categorized into the following areas:

Customer Profile - Information related to the customer on the E-Commerce site
Assets - Information related to a customer's current product holding
Past Web Interactions - Information related to past Oracle RTD web sessions that a given customer has had
Catalog Structure - Category/Catalog information directly related to the page that the customer is on in the E-Commerce site
Promotions - Source data that will be used with Oracle RTD's dynamic choices for presenting the best promotion to the E-Commerce customer

This section contains the following topics:

Section 3.2.1, "Accounts DS"
Section 3.2.2, "Address DS"
Section 3.2.3, "Assets DS (Multiple Rows)"
Section 3.2.4, "Catalog Category DS"
Section 3.2.5, "Catalog DS"
Section 3.2.6, "Contact Address DS"
Section 3.2.7, "Contact DS"
Section 3.2.8, "Image DS"
Section 3.2.9, "Industry DS"
Section 3.2.10, "List of Values DS"
Section 3.2.11, "Product Line DS"
Section 3.2.12, "Products DS"
Section 3.2.13, "Promo Category Catalog DS"
Section 3.2.14, "Promotions DS"
Section 3.2.15, "Web History DS"

3.2.1 Accounts DS

The Account data source extracts, from the Siebel data source S_ORG_EXT, account based information including the keys to additional account tables that store other profile information, for example, Address information.

Table 3-1 Account DS - SIEBEL_S_ORG_EXT

Parameter	Column Names	Comments
Output	PR_ADDR_ID CUST_STAT_CD OU_TYPE_CD PR_INDUST_ID	None
Input	ROW_ID	Populated by Customer Id passed through from front end, and set for the session.

Parameter

Column Names

Comments

Output

PR_ADDR_ID

CUST_STAT_CD

OU_TYPE_CD

PR_INDUST_ID

None

Input

ROW_ID

Populated by Customer Id passed through from front end, and set for the session.

3.2.2 Address DS

The Address data source extracts, from the Siebel data source S_ADDR_ORG, address information tied to the customer account.

Table 3-2 Address DS - SIEBEL.S_ADDR_ORG

Parameter	Column Names	Comments
Output	COUNTRY STATE ZIPCODE	None
Input	ROW_ID	Populated by PR_ADDR_ID from the S_ORG_EXT data source.

Parameter

Column Names

Comments

Output

COUNTRY

STATE

ZIPCODE

None

Input

ROW_ID

Populated by PR_ADDR_ID from the S_ORG_EXT data source.

3.2.3 Assets DS (Multiple Rows)

The Assets data source extracts, from the Siebel data source S_ASSETS, asset based information tied to the customer account.

Table 3-3 Assets DS - SIEBEL.S_ASSETS

Parameter	Column Names	Comments
Output	CREATED PROD_ID	None
Input	OWNER_ACCNT_ID	Populated by Customer Id passed through from front end, and set for the session.

Parameter

Column Names

Comments

Output

CREATED

PROD_ID

None

Input

OWNER_ACCNT_ID

Populated by Customer Id passed through from front end, and set for the session.

3.2.4 Catalog Category DS

The Catalog Category data source extracts, from the Siebel data source S_CTLG_CAT, information related to the category that the user has drilled down into from the web front end. The Category Id will be sent through the Oracle RTD integration with the web front end.

Table 3-4 Catalog Category DS - SIEBEL.S_CTLG_CAT

Parameter	Column Names	Comments
Output	CTLG_ID NAME PAR_CAT_ID	None
Input	ROW_ID	Populated by the Category Id passed in through the Informant Get Promotions.

Parameter

Column Names

Comments

Output

CTLG_ID

NAME

PAR_CAT_ID

None

Input

ROW_ID

Populated by the Category Id passed in through the Informant Get Promotions.

3.2.5 Catalog DS

The Catalog data source extracts, from the Siebel data source S_CTLG, information related to the Catalog that the user has drilled down into from the web front end. The Catalog Id will be sent through the Oracle RTD integration with the web front end.

Table 3-5 Catalog DS - SIEBEL.S_CTLG

Parameter	Column Names	Comments
Output	NAME	None
Input	ROW_ID	Populated by the Catalog Id passed in through the Informant Get Promotions.

3.2.6 Contact Address DS

The Contact Address data source extracts, from the Siebel data source S_ADDR_PER, address information tied to the customer contact.

Table 3-6 Contact Address DS - SIEBEL.S_ADDR_PER

Parameter	Column Names	Comments
Output	COUNTRY STATE ZIPCODE	None
Input	ROW_ID	Populated by PR_CON_ADDR_ID from the S_CONTACT data source.

Parameter

Column Names

Comments

Output

COUNTRY

STATE

ZIPCODE

None

Input

ROW_ID

Populated by PR_CON_ADDR_ID from the S_CONTACT data source.

3.2.7 Contact DS

The Contact data source extracts, from the Siebel data source S_CONTACT, contact based information tied to the person that is using the web front end.

Table 3-7 Contact DS - SIEBEL.S_CONTACT

Parameter	Column Names	Comments
Output	PR_ACT_ID PR_CON_ADDR_ID PR_OU_ADDR_ID	None
Input	ROW_ID	Populated by the Contact Id passed in through the Informant Update Customer.

Parameter

Column Names

Comments

Output

PR_ACT_ID

PR_CON_ADDR_ID

PR_OU_ADDR_ID

None

Input

ROW_ID

Populated by the Contact Id passed in through the Informant Update Customer.

3.2.8 Image DS

The Image data source extracts, from the Siebel data source S_LIT, image name related information based on the image id tied to a promotion record.

Table 3-8 Image DS - SIEBEL.S_LIT

Parameter	Column Names	Comments
Output	FILE_EXT FILE_NAME NAME ROW_ID	None
Input	ROW_ID	Populated by the Image Id value tied to each promotion record.

Parameter

Column Names

Comments

Output

FILE_EXT

FILE_NAME

NAME

ROW_ID

None

Input

ROW_ID

Populated by the Image Id value tied to each promotion record.

3.2.9 Industry DS

The Industry data source extracts, from the Siebel data source S_INDUST, primary industry information tied to the account associated to the person that is using the web front end.

Table 3-9 Industry DS - SIEBEL.S_INDUST

Parameter	Column Names	Comments
Output	NAME	None
Input	ROW_ID	Populated by the Industry Id tied to the Account record.

3.2.10 List of Values DS

The List of Values data source extracts, from the Siebel data source S_LST_OF_VAL, lists of values for any column linked to a list of values id. This can be applied to the Account table, Contact table, and so on.

Table 3-10 List of Values DS - SIEBEL.S_LST_OF_VAL

Parameter	Column Names	Comments
Output	NAME	None
Input	ROW_ID	Populated by various inputs that may map to this table.

3.2.11 Product Line DS

The Product Line data source extracts, from the Siebel data source S_PROD_LN, product line information tied to products extracted from S_PROD_INT.

Table 3-11 Product Line DS - SIEBEL.S_PROD_LN

Parameter	Column Names	Comments
Output	NAME	None
Input	ROW_ID	Populated by the Product Line id value tied to each product record.

3.2.12 Products DS

The Products data source extracts, from the Siebel data source S_PROD_INT, product based information tied to records extracted from the Assets data source.

Table 3-12 Products DS - SIEBEL.S_PROD_INT

Parameter	Column Names	Comments
Output	DESC_TEXT INCLSV_ELIG_RL_FLAG NAME PR_PROD_LN_ID	None
Input	ROW_ID	Populated by the Product Id tied to each Asset record.

Parameter

Column Names

Comments

Output

DESC_TEXT

INCLSV_ELIG_RL_FLAG

NAME

PR_PROD_LN_ID

None

Input

ROW_ID

Populated by the Product Id tied to each Asset record.

3.2.13 Promo Category Catalog DS

The Promo Category Catalog data source extracts, from the Siebel data source S_CTLG_CAT_PROD, information related to the categories and catalogs with which a promotion has been associated. This data can be used for future eligibility rules if necessary to show only promotions tied to a specific category or catalog. Category and Catalog information associated to promotions is calculated through the Set Category String and Set Catalog String functions.

Table 3-13 Promo Category Catalog DS - SIEBEL.S_CTLG_CAT_PROD

Parameter	Column Names	Comments
Output	CTLG_CAT_ID	None
Input	ROW_ID	Populated by each promotion Row Id.

3.2.14 Promotions DS

The Promotions data source extracts, from the Siebel data source S_PROD_INT, promotion data used to be populated in the Dynamic Choice Group, Siebel Promotions. As a result, these records are evaluated in decisioning and used by the Advisor Get Promotions.

Table 3-14 Promotions DS - SIEBEL.S_PROD_INT

Parameter	Column Names	Comments
Output	DESC_TEXT INCLSV_ELIG_RL_FLG NAME PROD_IMAGE_ID ROW_ID	None
Input	ORDERABLE_FLG PROMO_TYPE_CD	Both inputs coded in the Promotions List entity.

Parameter

Column Names

Comments

Output

DESC_TEXT

INCLSV_ELIG_RL_FLG

NAME

PROD_IMAGE_ID

ROW_ID

None

Input

ORDERABLE_FLG

PROMO_TYPE_CD

Both inputs coded in the Promotions List entity.

3.2.15 Web History DS

This data source, a custom table for the E-Commerce solution, resides in the SDDS database and is used to capture web history data for customers that have provided their account id. The data in the table is then evaluated through the Web Interaction entity. Create Table scripts are provided with this Inline Service for this table and can be found in the etc folder of the Inline Service directory.

Table 3-15 Web History DS - SDDS.RTD_WEB_HISTORY

Parameter	Column Names	Comments
Output	CATALOGS_VISITED CATEGORIES_VISITED CREATED OFFER_CLICKED SESSION_ID	None
Input	ACCOUNT_ID	Populated by the Customer Id provided by the Informant Update Customer Profile.

Parameter

Column Names

Comments

Output

CATALOGS_VISITED

CATEGORIES_VISITED

CREATED

OFFER_CLICKED

SESSION_ID

None

Input

ACCOUNT_ID

Populated by the Customer Id provided by the Informant Update Customer Profile.

3.3 Entities

Oracle RTD entities can be broken down into the following categories:

Session

This special category contains the Session Entity only. Every Oracle RTD Inline Service has a Session entity, which defines the entities to be associated with the session.
Customer Profile

The Customer Profile entities build out what is known about the customer utilizing the web front end. This category contains the following entities:
- Account Entity, Assets Entity, Contact Entity, Industry Entity, Products Entity, Raw Assets Entity
Web Interaction

The Web Interaction entities are used to capture information related to the web interaction, such as which Catalog and Category the user is in on the web front. This category contains the following entities:
- Raw Web Interactions Entity, Web Interaction Entity
Product Catalog/Category

These entities are used to map product catalog and category information received from the front end UI. This category contains the following entities:
- Catalog Entity, Category Entity
Promotions

The Promotions entities are used for building out dynamic choice, which are utilized by the Advisor Get Promotions. These entities are not used for modeling. This category contains the following entities:
- Promo Category Catalog Entity, Promotions Entity, Promotions List Entity

The following diagram shows the overall logical entity model of the RTD Siebel ECommerce Inline Service.

Surrounding text describes ecom_log_ent_mod.gif.

The rest of this section contains the following topics:

Section 3.3.1, "Session Entity"
Section 3.3.2, "Account Entity"
Section 3.3.3, "Assets Entity"
Section 3.3.4, "Catalog Entity"
Section 3.3.5, "Category Entity"
Section 3.3.6, "Contact Entity"
Section 3.3.7, "Industry Entity"
Section 3.3.8, "Products Entity"
Section 3.3.9, "Promo Category Catalog Entity"
Section 3.3.10, "Promotions Entity"
Section 3.3.11, "Promotions List Entity"
Section 3.3.12, "Raw Assets Entity"
Section 3.3.13, "Raw Web Interactions Entity"
Section 3.3.14, "Web Interaction Entity"

3.3.1 Session Entity

The Session entity defines which entities should be included as part of the session. In addition to attributes configured directly in the session, entities included as session attributes are used as inputs to the Oracle RTD models.

The exceptions to this are entity attributes that have been specifically excluded for analysis but are used for other areas of the Inline Service. Examples of this are Id attributes that are used to join different data sources.

The Session entity has its session key set by the web front end to a unique value that represents a unique customer session.

Table 3-16 Session Entity

Attribute	Array	Type	Mapping	Show In DC	Use for Analysis	Comments
Web Session Id	No	String	None	No	No	NA
Account	No	Account	None	Yes	Yes	NA
Contact	No	Contact	None	Yes	Yes	NA
Promotions List	No	Promotions List	None	No	No	NA
Session Date	No	Date	None	Yes	Yes	Default Value = System Date (calculated from the Return System Date() function)
Web Interaction	No	Web Interaction	None	Yes	Yes	NA

3.3.1.1 Writing Output to RTD_WEB_HISTORY Table During Session Cleanup

Within the Cleanup Logic section of the Session Entity, the necessary code to write a record of the RTD Session to the RTD_WEB_HISTORY table has been included. This code, in conjunction with the LogWriter() and InsertMessageResult() functions, define how the columns in RTD_WEB_HISTORY are populated.

This code is only enabled, when the Application parameter Enable RTD Web History is set to True. Otherwise, no information will be populated to this table.

In the released version of the RTD Siebel ECommerce Inline Service, the Web Interaction attribute Past Web Interactions is populated through the records found in this table for a given Account Id.

3.3.2 Account Entity

Table 3-17 Account Entity

Attribute	Array	Type	Mapping	Show In DC	Use for Analysis	Comments
Assets	No	Assets	NA	Yes	Yes	Placed in the Account entity to group customer owned assets
Country	No	String	Address DS.COUNTRY	Yes	Yes	Value joined through Primary Address Id
Industry	No	String	Industry Lookup (PR_INDUST_ID)	Yes	Yes	Value populated through the Industry lookup function which returns the Name value of the record on S_INDUST for the corresponding PR_INDUST_ID
Primary Address Id	No	String	Account DS.PR_ADDR_ID	No	No	NA
State	No	String	Address DS.STATE	Yes	Yes	Value joined through Primary Address Id
Status	No	String	Account DS.CUST_STAT_CD	Yes	Yes	NA
Type	No	String	Account DS.OU_TYPE_CD	Yes	Yes	NA
Zipcode	No	String	Address DS.ZIPCODE	Yes	Yes	Value joined through Primary Address Id

Table 3-18 Data Source Input Values for Account Entity

Data Source	Input Column	Type	Input Value
Account DS	ROW_ID	String	Session.Web Interaction.Account Id
Address DS	ROW_ID	String	Primary Address Id

3.3.3 Assets Entity

Table 3-19 Assets Entity

Attribute	Array	Type	Mapping	Show In DC	Use for Analysis	Comments
Days Since Last Asset	No	Integer	None	Yes	Yes	Derived attribute populated through the ProcessAssets() function that gives the days since the last asset was created
Last Created Product	No	String	None	Yes	Yes	Derived attribute populated through the ProcessAssets() function that gives the name of the last created product
Last Created Product Line	No	String	None	Yes	Yes	Derived attribute populated through the ProcessAssets() function that gives the product line of the last created product
Product Line	Yes	String	None	Yes	Yes	Derived array attribute populated through the ProcessAssets() function that provides a distinct list of product lines owned by the account
Product Name	Yes	String	None	Yes	Yes	Derived array attribute populated through the ProcessAssets() function that provides a distinct list of product names owned by the account
Assets	Yes	Raw Assets Entity	(See attributes below)	No	No	Array List of Assets extracted from the Raw Assets Entity (see Assets attributes below for breakdown)
Assets.Create Date	No	Date	Assets DS.CREATED	No	No	NA
Assets.Product Id	No	String	Assets DS.PROD_ID	No	No	NA
Assets.Product Line	No	String	None	No	No	Mapped on the Raw Asset Entity
Assets.Product Line Id	No	String	None	No	No	Mapped on the Raw Assets Entity
Assets.Product Name	No	String	Assets DS.PROD_ID	No	No	Actual name value for the asset product is extracted through a Product Lookup function which returns the Name of the product associated to the product id (The name value is on the table S_PROD_INT from the Products Entity)

Table 3-20 Data Source Input Values for Assets Entity

Data Source	Input Column	Type	Input Value
Assets DS	OWNER_ACCNT_ID	String	Session.Web Interaction.Account Id

3.3.4 Catalog Entity

Table 3-21 Catalog Entity

Attribute	Array	Type	Mapping	Show In DC	Use for Analysis	Comments
Row Id	No	String	None	No	No	NA
Catalog Name	No	String	Catalog DS.NAME	No	No	Used to extract the Catalog name value of any given Catalog Id (Catalog Lookup function)

Table 3-22 Data Source Input Values for Catalog Entity

Data Source	Input Column	Type	Input Value
Catalog DS	ROW_ID	String	Row Id

Note:

The Catalog Entity has caching enabled.

3.3.5 Category Entity

Table 3-23 Category Entity

Attribute	Array	Type	Mapping	Show In DC	Use for Analysis	Comments
Row Id	No	String	None	No	No	NA
Catalog Id	No	String	Catalog Category DS. CTLD_ID	No	No	Used to extract the Catalog Id value of any given Category Id (Catalog Id Lookup function)
Category Name	No	String	Catalog Category DS. NAME	No	No	Used to extract the Category Name value of any given Category Id (Catalog Lookup function)
Parent Category Id	No	String	Catalog Category DS. PAR_CAT_ID	No	No	Used to extract the Parent Category Id value of any given Category Id (Parent Category Lookup function)

Table 3-24 Data Source Input Values for Category Entity

Data Source	Input Column	Type	Input Value
Catalog DS	ROW_ID	String	Row Id

Note:

The Category Entity has caching enabled.

3.3.6 Contact Entity

Table 3-25 Contact Entity

Primary Address Id	Array	Type	Mapping	Show In DC	Use for Analysis	Comments
Country	No	String	Address DS.COUNTRY	Yes	Yes	Value joined through Primary Address Id
Primary Address Id	No	String	Contact DS.PR_OU_ADDR_ID	No	No	NA
State	No	String	Address DS.STATE	Yes	Yes	Value joined through Primary Address Id
Zipcode	No	String	Address DS.ZIPCODE	Yes	Yes	Value joined through Primary Address Id

Table 3-26 Data Source Input Values for Contact Entity

Data Source	Input Column	Type	Input Value
Address DS	ROW_ID	String	Primary Address Id
Contact DS	ROW_ID	String	Session.Web Interaction.Contact Id

3.3.7 Industry Entity

Table 3-27 Industry Entity

Attribute	Array	Type	Mapping	Show In DC	Use for Analysis	Comments
Row Id	No	String	None	No	No	NA
Name	No	String	Industry DS.NAME	No	No	Used to extract the Industry name value tied to the Primary Industry id of the account (Industry Lookup function)

Table 3-28 Data Source Input Values for Industry Entity

Data Source	Input Column	Type	Input Value
Industry DS	ROW_ID	String	Row Id

Note:

The Industry Entity has caching enabled.

3.3.8 Products Entity

Table 3-29 Products Entity

Attribute	Array	Type	Mapping	Show In DC	Use for Analysis	Comments
Row Id	No	String	None	No	No	NA
Name	No	String	Products DS. NAME	No	No	Used to extract the product name value of assets tied to customers (Product Lookup function)
Product Line	No	String	None	No	No	NA

Table 3-30 Data Source Input Values for Products Entity

Data Source	Input Column	Type	Input Value
Products DS	ROW_ID	String	Row Id

Note:

The Products Entity has caching enabled.

3.3.9 Promo Category Catalog Entity

Table 3-31 Promo Category Catalog Entity

Attribute	Array	Type	Mapping	Show In DC	Use for Analysis	Comments
Promotion Catalog Id	No	String	None	No	No	See Promotions Entity
Promotion Catalog Name	No	String	Catalog DS.NAME	No	No	Populated based on Id value of Promotion Catalog Id value
Promotion Category Name	No	String	None	No	No	See Promotions Entity

Table 3-32 Data Source Input Values for Promo Category Catalog Entity

Data Source	Input Column	Type	Input Value
Catalog DS	ROW_ID	String	Promotion Catalog Id

3.3.10 Promotions Entity

Table 3-33 Promotions Entity

Attribute	Array	Type	Mapping	Show In DC	Use for Analysis	Comments
Catalog Array	Yes	String	None	No	No	NA
Catalog String	No	String	None	No	No	Populated through the Set Catalog String function which uses the Row Id as input
Category Array	Yes	String	None	No	No	NA
Category Catalog	Yes	Promo Category Catalog	None	No	No	NA
Category Catalog. Promotion Catalog Id	No	String	Catalog Category DS. CTLG_ID	No	No	Populated through the Catalog Lookup function
Category Catalog. Promotion Catalog Name	No	String	None	No	No	See Promo Category Catalog Entity for mapping
Category Catalog. Category Name	No	String	Catalog Category DS. NAME	No	No	Populated through the Category Lookup function
Category String	No	String	None	No	No	Populated through the Set Category String function which uses the Row Id as input
Description Text	No	String	None	No	No	See Promotions List Entity for mapping
Image Extension	No	String	Image DS.FILE_EXT	No	No	NA
Image File Name	No	String	Image DS.FILE_NAME	No	No	NA
Image Id	No	String	None	No	No	See Promotions List Entity for mapping
Image Name with Ext	No	String	None	No	No	Defaulted with the value returned from the GetImageName() function
Inclusive Eligibility Flag	No	String	Products DS. INCLSV_ELIG_RL_FLG	No	No	NA
Name	No	String	None	No	No	See Promotions List Entity for mapping
Row Id	No	String	None	No	No	See Promotions List Entity for mapping
Type	No	String	None	No	No	Default value is Promotion

Table 3-34 Data Source Input Values for Promotions Entity

Data Source	Input Column	Type	Input Value
Image DS	ROW_ID	String	Image Id
Products DS	ROW_ID	String	Row Id
Promo Category Catalog DS	ROW_ID	String	Row Id

3.3.11 Promotions List Entity

Table 3-35 Promotions List Entity

Attribute	Array	Type	Mapping	Show In DC	Use for Analysis	Comments
Promotions	Yes	Promotions	None	No	No	Promotions are extracted from the S_PROD_INT table via two static input values, ORDERABLE_FLG = "Y" and PROMO_TYPE_CD = "Bundled Promotions"
Promotions. Catalog String	No	String	None	No	No	Populated through the Set Catalog String function which uses the Row Id as input
Promotions. Category String	No	String	None	No	No	Populated through the Set Category String function which uses the Row Id as input
Promotions. Description Text	No	String	Promotions DS. DESC_TEXT	No	No	NA
Promotions. Image Extension	No	String	None	No	No	See Promotions Entity for mapping
Promotions. Image File Name	No	String	None	No	No	See Promotions Entity for mapping
Promotions. Image Id	No	String	Promotions DS. PROD_IMAGE_ID	No	No	NA
Promotions. Image Name With Ext	No	String	None	No	No	Defaulted with the value returned from the GetImageName() function
Promotions. Inclusive Eligibility Flag	No	String	None	No	No	NA
Promotions. Name	No	String	Promotions DS.NAME	No	No	NA
Promotions. Row Id	No	String	Promotions DS.ROW_ID	No	No	NA
Promotions. Type	No	String	None	No	No	Default value as Promotion
Promotions. Category Catalog	Yes	Promo Category Catalog Entity	None	No	No	See Promotions Entity for mapping

Table 3-36 Data Source Input Values for Promotions List Entity

Data Source	Input Column	Type	Input Value
Promotions DS	ORDERABLE_FLG	String	Y
Promotions DS	PROMO_TYPE_CD	String	Bundled Promotions

3.3.12 Raw Assets Entity

Table 3-37 Raw Assets Entity

Attribute	Array	Type	Mapping	Show In DC	Use for Analysis	Comments
Create Date	No	Date	None	No	No	Mapped on the Assets Entity
Product Id	No	String	None	No	No	Mapped on the Assets Entity
Product Line	No	String	Product Line DS. NAME	No	No	Name value on the S_PROD_LN table is found based on the value for the Product Line Id attribute tied to the row id on the product line table.
Product Line Id	No	String	Products DS. PR_PROD_LN_ID	No	No	NA
Product Name	No	String	Mapped on the Assets Entity	No	No	Actual name value for the asset product is extracted through a Product Lookup function which returns the Name of the product associated to the product id. (The name value is on the table S_PROD_INT from the Products Entity.)

Table 3-38 Data Source Input Values for Raw Assets Entity

Data Source	Input Column	Type	Input Value
Product Line DS	ROW_ID	String	Product Line Id
Products DS	ROW_ID	String	Product Id

3.3.13 Raw Web Interactions Entity

Table 3-39 Raw Web Interactions Entity

Attribute	Array	Type	Mapping	Show In DC	Use for Analysis	Comments
Catalogs Visited	No	String	None	No	No	Populated through the Web Interactions Entity
Categories Visited	No	String	None	No	No	Populated through the Web Interactions Entity
Create Date	No	Date	None	No	No	Populated through the Web Interactions Entity
Promotion Clicked	No	String	None	No	No	Populated through the Web Interactions Entity

3.3.14 Web Interaction Entity

Table 3-40 Web Interaction Entity

Attribute	Array	Type	Mapping	Show In DC	Use for Analysis	Comments
Account Id	No	String	None	No	No	Populated through Integration points and used as a reference to the S_ORG_EXT Table (Customer entity)
Catalog Id	No	String	None	No	No	Populated through Integration points and used as a reference to the S_CTLG Table (Catalog entity)
Catalogs Visited	Yes	String	None	Yes	Yes	Derived attribute populated through the function BuildCategory() thread that is called from the Get Promotions Advisor. This attribute will store in array every catalog visited by the customer during the RTD session.
Categories Visited	Yes	String	None	Yes	Yes	Derived attribute populated through the function BuildCategory() thread that is called from the Get Promotions Advisor. This attribute will store in array every category visited by the customer during the RTD session.
Category Id	No	String	None	No	No	Populated through Integration points and used as a reference to the S_CTLG_CAT Table (Category entity)
Contact Id	No	String	None	No	No	Populated through Integration points and used as a reference to the S_CONTACT Table (Contact entity)
Current Catalog Name	No	String	Catalog DS.NAME	Yes	Yes	Lookup to the S_CTLG table through the Catalog Lookup function
Current Category Hierarchy	Yes	String	None	Yes	Yes	Populated through the Build Category Thread function
Current Category Name	No	String	Catalog Category DS. NAME	Yes	Yes	Lookup to the S_CTLG_CAT table through the Category Lookup function
Current Category Thread	No	String	None	Yes	Yes	Populated through the Build Category Thread function
Days Since Last Web Visit	No	Integer	None	Yes	Yes	Derived attribute populated through the ProcessWebInteractions() function. Identifies the days since the last web visit recorded by the RTD_WEB_HISTORY Table.
Hot Offers Page Hits	No	Integer	None	Yes	Yes	Derived attribute populated through the logic associated with the Presented Offers informant. This attribute records a count of how many times the Hot offers page has been seen.
Last Promotion Clicked	No	String	None	Yes	Yes	Derived attribute populated through the ProcessWebInteractions() function. Identifies the value of the promotion clicked on the last web page visit.
Last Visited Catalogs	Yes	String	None	Yes	Yes	Derived attribute populated through the ProcessWebInteractions() function. Identifies the catalogs visited on the last web visit.
Last Visited Categories	Yes	String	None	Yes	Yes	Derived attribute populated through the ProcessWebInteractions() function. Identifies the categories visited on the last web visit.
Locale	No	String	None	Yes	Yes	Populated through Integration points
Login Id	No	String	None	No	No	Populated through Integration points and used as a reference
Number of Visits in Past 30 Days	No	Integer	None	Yes	Yes	Derived attribute populated through the ProcessWebInteractions() function. Identifies the number of web visits for a given customer over the past 30 days.
Number of Visits in past 7 Days	No	Integer	None	Yes	Yes	Derived attribute populated through the ProcessWebInteractions() function. Identifies the number of web visits for a given customer over the past 7 days.
Promotion Clicked	No	String	None	No	No	Populated through the logic contained in the Offer Clicked informant
Site	No	String	None	Yes	Yes	NA
Past Web Interactions	Yes	Raw Web Interactions	None	No	No	Array List of Web Interactions extracted from the Raw Assets Entity (see PastWeb attributes below for breakdown)
PastWeb. Catalogs Visited	No	String	RTD_WEB_HISTORY. CATALOGS_VISITED	No	No	Value used for processing in the ProcessWebInteractions() function
PastWeb. Categories Visited	No	String	RTD_WEB_HISTORY. CATEGORIES_VISITED	No	No	Value used for processing in the ProcessWebInteractions() function
PastWeb. Create Date	No	Date	RTD_WEB_HISTORY. CREATED	No	No	Value used for processing in the ProcessWebInteractions() function
PastWeb. Promotion Clicked	No	String	RTD_WEB_HISTORY. OFFER_CLICKED	No	No	Value used for processing in the ProcessWebInteractions() function

Table 3-41 Data Source Input Values for Web Interaction Entity

Data Source	Input Column	Type	Input Value
Web History DS	ACCOUNT_ID	String	Account Id

3.4 Informants

Informants are Integration Points used to pass information from an external application to Oracle RTD.

This section contains the following topics:

Section 3.4.1, "Initial Context"
Section 3.4.2, "Offer Clicked"
Section 3.4.3, "Presented Offers"
Section 3.4.4, "Update Customer Profile"
Section 3.4.5, "Close Session"

3.4.1 Initial Context

The Initial Context Informant is used to start the Oracle RTD session. Table 3-42 describes the parameters for the Informant Initial Context.

Table 3-42 Informant Initial Context

Parameter	Description
Informant Name	Initial Context
Session Keys	Session/Web Session ID
Request Data	Locale (String) - Mapped to Web Interaction Entity, Locale Attribute Site (String) - Mapped to Web Interaction Entity, Site Attribute
External System	Web Self Service
Order	0
Force session close	No
Logic	None
Pre-condition	None

3.4.2 Offer Clicked

The Offer Clicked Informant is to indicate which promotion was clicked through if any. Table 3-43 describes the parameters for the Informant Offer Clicked.

Table 3-43 Informant Offer Clicked

Parameter	Description
Informant Name	Offer Clicked
Session Keys	Session/Web Session ID
Request Data	Choice Type (String) Promotion Id (String)
External System	Web Self Service
Order	0
Force session close	No
Logic	Logic is included to update the Promotion Acceptance Model for the promotion that was clicked through (positive outcome event)
Pre-condition	None

3.4.3 Presented Offers

The Presented Offers Informant is used to indicate which promotions are presented in the Web UI after Siebel E-Commerce pushes the ranked offers through the Eligibility engine. Table 3-44 describes the parameters for the Informant Presented Offers.

Table 3-44 Informant Presented Offers

Parameter	Description
Informant Name	Presented Offers
Session Keys	Session/Web Session ID
Request Data	Choice Type (String) Promotion Id (String)
External System	Web Self Service
Order	0
Force session close	No
Logic	Logic is included to update the Promotion Acceptance Model for the promotions that were presented (base event)
Pre-condition	None

3.4.4 Update Customer Profile

The Update Customer Profile Informant is used to send information related to the customer (Account/Contact) that explicitly logs in to the Web site. Table 3-45 describes the parameters for the Informant Presented Offers.

Table 3-45 Informant Update Customer Profile

Parameter	Description
Informant Name	Update Customer Profile
Session Keys	Session/Web Session ID
Request Data	Account Id (String) - Mapped to Web Interaction Entity, Account Id Attribute Contact Id (String) - Mapped to Web Interaction Entity, Contact Id Attribute) Login Id (String) - Mapped to Web Interaction Entity, Login Id Attribute
External System	Web Self Service
Order	0
Force session close	No
Logic	Logic is included to fill customer profile entities after the customer id is known
Pre-condition	None

3.4.5 Close Session

The Close Session Informant is used to end the Oracle RTD session with that specific web session id. Table 3-46 describes the parameters for the Informant Close Session.

Table 3-46 Informant Close Session

Parameter	Description
Informant Name	Close Session
Session Keys	Session/Web Session ID
Request Data	None
External System	Web Self Service
Order	0
Force session close	Yes
Logic	None
Pre-condition	None

3.5 Advisors

Advisors are Integration Points by which an external application sends information to, and receives information back from, Oracle RTD.

This section contains the following topics:

Section 3.5.1, "Get Promotions"

3.5.1 Get Promotions

The Get Promotions Advisor is used to send promotions (choices) to the web client. Table 3-47 describes the parameters for the Advisor Get Promotions.

Table 3-47 Advisor Get Promotions

Parameter	Description
Advisor Name	Get Promotions
Session Keys	Session/Web Session ID
Request Data	Catalog Id (String) - Mapped to Web Interaction Entity, Catalog Id Attribute Category Id (String) - Mapped to Web Interaction Entity, Category Id Attribute
Decision	Return Promotions (Both Control Group and Decision Group)
External System	Web Self Service
Order	0
Force session close	No
Logic	None
Pre-condition	Logic is included to build out the "category thread" for the given category input from the Advisor call. The Category thread outlines the category path the user would have had to go down in order to get to the category where the Advisor call was made.

3.6 Choice Groups and Choices

The RTD Siebel ECommerce Inline Service contains one choice group, Promotions, which has two sub-choice groups:

Siebel Promotions, for dynamic choices
RTD Promotions, for static choices

Each of these choice groups has the same choice attributes.

This section contains the following topics:

Section 3.6.1, "Promotions Choice Group"
Section 3.6.2, "Siebel Promotions Choice Group (Dynamic Choices)"
Section 3.6.3, "RTD Promotions Choice Group (Static Choices)"

3.6.1 Promotions Choice Group

Table 3-48 shows the component elements of the top-level choice group, Promotions.

Table 3-48 Promotions Choice Group

Tab	Parameter	Description
Choice Attributes	Image Name	String place holder used in the sub-choice groups Siebel Promotions and RTD Promotions.
Choice Attributes	Inclusive Eligibility Flag	String place holder used in the sub-choice groups Siebel Promotions and RTD Promotions.
Choice Attributes	Promotion Description	String place holder used in the sub-choice groups Siebel Promotions and RTD Promotions.
Choice Attributes	Promotion Id	String place holder used in the sub-choice groups Siebel Promotions and RTD Promotions.
Choice Attributes	Promotion Name	String place holder used in the sub-choice groups Siebel Promotions and RTD Promotions.
Choice Attributes	Promotion Type	String place holder used in the sub-choice groups Siebel Promotions and RTD Promotions.
Scores	Predicted by Likelihood of Acceptance for Promotions Acceptance Model	Utilizes the Performance Goal Maximize Acceptance Likelihood.
Choice Events	Clicked Through	NA
Choice Events	Presented	NA
Choice Eligibility	None	NA
Group Attributes	None	NA
Group Eligibility	None	NA
Dynamic Choices	None	NA

3.6.2 Siebel Promotions Choice Group (Dynamic Choices)

The Siebel Promotions choice group uses dynamic choices. The Siebel Promotions choice attributes are populated through the Promotions Entity, which in turn gets its values from the table S_PROD_INT.

Table 3-49 shows the component elements of the Siebel Promotions choice group.

Table 3-49 Siebel Promotions Choice Group (Dynamic Choices)

Tab	Parameter	Description
Choice Attributes	Catalog String	Populated through the Promotions Entity, Catalog String attribute
Choice Attributes	Category String	Populated through the Promotions Entity, Category String attribute
Choice Attributes	Choice Type	Value=Dynamic
Choice Attributes	Image Extension	Populated through the Promotions Entity, Image Extension attribute
Choice Attributes	Image Name	Populated through the Promotions Entity, Image Name with Ext attribute
Choice Attributes	Inclusive Eligibility Flag	Populated through the Promotions Entity, Inclusive Eligibility Flag attribute
Choice Attributes	Promotion Description	Populated through the Promotions Entity, Description Text attribute
Choice Attributes	Promotion Id	Populated through the Promotions Entity, Row Id attribute
Choice Attributes	Promotion Name	Populated through the Promotions Entity, Name attribute
Choice Attributes	Promotion Type	Populated through the Promotions Entity, Type attribute
Choice Attributes	Promotions Entity	Declaration of the Promotions entity used in order to map promotions entity attributes to their corresponding choice attribute
Scores	Predicted by Likelihood of Acceptance for Promotions Acceptance Model	Utilizes the Performance Goal Maximize Acceptance Likelihood
Choice Events	Clicked Through	NA
Choice Events	Presented	NA
Choice Eligibility	(As released, both current catalog and current category rules are set. See Description.)	To select one of the rules, follow the instructions in Section 4.1, "Utilizing the Category/Catalog Eligibility Rules."
Group Attributes	Promotions Array Entity	NA
Group Eligibility	None	NA
Dynamic Choices	Use Dynamic Choices for this Choice Group	Yes
Dynamic Choices	Group attribute containing the List of entities for Choice	Promotions Array
Dynamic Choices	Choice attribute to assign the entity data	Promotions Entity
Dynamic Choices	Entity attribute that contains the choices id	Row Id
Dynamic Choices	Distribution mode for choices over choice group folders	Spill
Dynamic Choices	Maximum number of choices within one choice group folder on decision center	100

3.6.3 RTD Promotions Choice Group (Static Choices)

Static choices are choices that are defined in Oracle RTD. For the static choice group RTD Promotions, the choice attributes have been set up, but no values are assigned to any static choice. This static choice group serves as a template for future customer use.

Table 3-50 shows the component elements of the RTD Promotions choice group.

Table 3-50 RTD Promotions Choice Group (Static Choices)

Tab	Parameter	Description
Choice Attributes	Choice Type	Value=Static
Choice Attributes	Image Name	Not populated
Choice Attributes	Inclusive Eligibility Flag	Not populated
Choice Attributes	Promotion Description	Not populated
Choice Attributes	Promotion Id	Not populated
Choice Attributes	Promotion Name	Not populated
Choice Attributes	Promotion Type	Not populated
Scores	Predicted by Likelihood of Acceptance for Promotions Acceptance Model	Utilizes the Performance Goal Maximize Acceptance Likelihood
Choice Events	Clicked Through	NA
Choice Events	Presented	NA
Choice Eligibility	None	NA
Group Attributes	None	NA
Group Eligibility	None	NA
Dynamic Choices	None	NA

3.7 Decisions

There is one decision in the RTD Siebel ECommerce Inline Service, namely Return Promotions.

Table 3-51 shows the component elements of the RTD Promotions choice group.

Table 3-51 Return Promotions Decision

Parameter	Description
Select Choices From:	Siebel Promotions
Number of Choice to Select:	1000
Select at Random:	No
Segment Segments:	None
Priority for Default Segment:	Maximize Acceptance Likelihood: 100%
Pre-Decision Logic	None
Post Decision Logic	None

3.8 Models

There is one Choice Event model in the RTD Siebel ECommerce Inline Service, namely Promotions Acceptance Model. This models the "click through" likelihood of promotions presented through the Siebel E-Commerce site.

Table 3-52 shows the component elements of the Promotions Acceptance Model.

Table 3-52 Promotions Acceptance Model

Component/Parameter	Value
Use for prediction	Yes (Check)
Randomize Likelihood	Yes (Check)
Time Window	Month
Choice Group	Promotions
Base Event	Presented
Positive Outcome Events:	Clicked Through
Learn Location	End of Session

3.9 Functions

Table 3-53 describes the functions in the RTD Siebel ECommerce Inline Service.

Table 3-53 Functions to Support RTD Siebel ECommerce Inline Service

Function	Inputs	Outputs	Area Utilized In	Comments
Build Category Thread	None	None	Used in the Get Promotions Advisor login	This function takes the category id that has been sent in from the informant and builds the "category hierarchy" for it based on what has been setup in the Siebel Categories view.
Catalog/Category Eligibility	Catalog/Category Name (String), Promotion String (String)	(Boolean)	Can be used an optional eligibility function in Choice Eligibility	This function compares either the catalog or category string tied to a promotion with a inputted catalog or category name and return TRUE if the case holds.
Catalog Id Lookup	Row Id (String)	Catalog Id (String)	Utilized within the Promotions Entity	This function extracts back from the cached Category Entity, the catalog Id associated with the inputted category id.
Catalog Lookup	Row Id (String)	Catalog Name (String)	Utilized within the Web Interaction Entity	This function extracts back from the cached Catalog Entity, the catalog name associated with the inputted catalog id.
Category Array Eligibility	Category Array (String Array), Promotion String (String)	(Boolean)	Can be used an optional eligibility function in Choice Eligibility	This function compares a given category string tied to a promotion with a inputted category array and return TRUE if one of the array values holds.
Category Lookup	Row Id (String)	Category Name (String)	Utilized in the Promotions and Web Interaction Entity as well as the BuildCategoryThread() function.	This function extracts back from the cached Category Entity, the category Name associated with the inputted category id.
Days Since	InputDate (Date)	DaysSince (Integer)	Utilized in the ProcessAssets() and ProcessWebInteractions() functions	This function calculates the delta between the current system date with any given input date.
Fill Entities	None	None	Used in the Update Customer Profile Informant logic section	The Fill Entities function is used as a container function which calls all of the logic/additional functions used to populate the session entities for this Inline Service.
Get Image Name	File Name (String), File Ext (String)	File Name (String)	Used in the Promotions Entity	This function concatenates the file name and extension of if a given image record.
Get Siebel Promotions	Type (String)	Promotions (Promotions Entity)	Using the Siebel Promotions Choice Group (Group attributes tab)	This function populated the Promotions List Entity with an array of Promotions extracted back from Siebel.
Industry Lookup	Row Id (String)	Industry Name (String)	Used in the Customer Entity	This function returns back the name of an industry for a given industry id.
Insert Message Result	Session Id (String), Account Id (String), Offer Clicked (String), Categories Visited (String), Catalogs Visited (String)	None	Used in the Close Session informant logic	This function inserts rows into the RTD_WEB _HISTORY table - see Log Writer function.
Log Write	None	TableInserter	Used as the default value for the Application attribute, Log Writer)	This function instantiates a tableInserter and returns handle for the table RTD_WEB_HISTORY.
Multiply	A (double), B (Double)	A * B (Double)	Optional function	This function is used to multiply two inputted values.
Number Is Null	Number (Integer)	(Boolean)	Optional function used to check if any integer attributes are null	This function returns True if number value provided is Null, otherwise False.
Parent Category Lookup	Row Id (String)	Parent Category Id (String)	Used in the BuildCategoryThread() function	This function extracts back from the cached Category Entity, the Parent Category Id associated with the inputted category id. This is in turn used in the Build category thread function.
Process Assets	None	None	Utilized in the Fill Entities() function	This function loops through the asset records associated with an account to determine and set which products/product lines an Account owns.
Process Web Interactions	None	None	Utilized in the Fill Entities() function	This function processes the web interaction records Source tied to a given account id and populates the appropriate Web Interaction entity attributes.
Product Lookup	Row Id (String)	Name (String)	Utilized in the Assets Entity	This function returns the product name for a given product record.
Return SDOId	Choice (choice)	(String)	Optional function which can be used for choices	This function is used to return the SDOId (Internal Name) of the choice inputted in.
Return System Date	None	Current Time (Date)	Used in the Session Entity	This function is used to return the current system date/time.
Set Catalog String	Promo Id (String)	Catalog String (String)	Used in the Promotions Entity	This function populates the Promotions Entity attribute, Catalog String based on the category records that are associated to the promotion in Siebel.
Set Category String	Promo Id (String)	Category String (String)	Used in the Promotions Entity	This function populates the Promotions Entity attribute, Category String based on the category records that are associated to the promotion in Siebel.
To Integer	String (String)	(integer)	Optional Transformation function	This function converts a string value into an integer.
To String	Integer (integer)	(String)	Optional Transformation function	This functions converts an integer value into a string.