Contents

Title and Copyright Information

Send Us Your Comments

Preface

Intended Audience

Documentation Accessibility

Structure

Where to Find More Information

Conventions

1 OracleAS Personalization Programming

1.1 OracleAS Personalization API Structure

1.2 Executing OracleAS Personalization Programs

1.3 Javadoc for the OracleAS Personalization APIs

Part I Recommendation Engine API

2 REAPI Overview

2.1 REAPI Prerequisites

2.2 REAPI Definitions and Concepts

2.2.1 REAPI End Users (Customers and Visitors)

2.2.2 Web Applications and Sessions

2.2.3 REAPI Sessionful Web Applications

2.2.4 REAPI Sessionless Web Applications

2.2.5 REAPI Data Collection

2.2.6 REAPI Recommendations

2.2.7 REAPI Hot Picks

2.3 Before Using REAPI

2.3.1 REAPI Demo Program

2.3.2 Creating REProxyRT Objects

2.3.3 Starting an REAPI Session

2.3.4 Creating Instances of REAPI Supporting Classes

2.3.5 Collecting Data for REAPI Recommendations

2.3.6 Getting REAPI Recommendations

2.3.7 Making REAPI Recommendations

2.3.8 Closing an REAPI Session

2.3.9 Removing REProxyRT Objects

3 REAPI Supporting Classes

3.1 Ratings in OracleAS Personalization

3.2 Location of REAPI Classes

3.3 REAPI EnumType Interfaces

3.3.1 REAPI CategoryMembership Interface

3.3.2 REAPI DataSource Interface

3.3.3 REAPI Filtering Interface

3.3.4 REAPI InterestDimension Interface

3.3.5 REAPI PersonalizationIndex Interface

3.3.6 REAPI ProfileDataBalance Interface

3.3.7 REAPI ProfileUsage Interface

3.3.8 REAPI RecommendationAttribute Interface

3.3.9 REAPI Sorting Interface

3.3.10 REAPI User Interface

3.4 Other Supporting REAPI Classes

3.4.1 ContentItem Class

3.4.2 DataItem Class

3.4.3 FilteringSettings Class

3.4.4 IdentificationData Class

3.4.5 Item Class

3.4.6 ItemDetailData Class

3.4.7 Recommendation Class

3.4.8 RecommendationContent Class

3.4.9 RecommendationList Class

3.4.10 TuningSettings Class

4 Using REAPI

4.1 Recommendation Proxy Classes

4.2 Location of RE Proxy Classes

4.2.1 RE Proxy Creation and Management

4.2.1.1 RE Data Collection

4.2.1.2 REProxyManager Class

4.2.2 Proxy Methods

4.2.3 RE Proxy Session Management

4.2.4 RE Proxy Data Collection and Management

4.2.5 Re Proxy Customer Registration

4.2.6 RE Proxy Recommendations

4.2.6.1 Ratings in OracleAS Personalization

4.2.6.2 Meaning of Returned Value for Recommendations

4.3 Rules and Recommendations

4.4 RE Proxy Method Usage Notes

4.4.1 Session Creation

4.4.2 Data Collection

4.4.2.1 Add Items

4.4.2.2 Remove Items

4.4.3 Proxy Creation

4.4.3.1 Cache Size

4.4.3.2 Interval

4.4.4 Cross Sell Methods

4.4.5 Proxy Destruction

5 REAPI Examples and Usage

5.1 REAPI Demo

5.2 REAPI Basic Usage

5.2.1 Create an REProxy Object

5.2.2 Use the Proxy

5.2.3 Destroy the Proxy

5.3 Sessionful Web Application Outline

5.4 Sessionless Web Application Outline

5.5 REProxyManager Interaction with JVM

5.5.1 Standalone Java Applications

5.5.2 Java Server-Side Modules

5.6 Using Multiple Instances of REProxy

5.6.1 Initialization Fail Safe

5.6.2 Uninterrupted REAPI Service

5.6.3 Load Balancing

5.7 Extracting Individual Recommendations

5.8 Handling Multiple Currencies

5.9 Recommendation Engine Usage

5.10 Using Demographic Data

5.11 Handling Time-Based Items

Part II Recommendation Engine Batch API

6 RE Batch API Overview

6.1 RE Batch API Prerequisites

6.2 RE Batch API Definitions and Concepts

6.2.1 RE Batch API End Users (Customers)

6.2.2 RE Batch API Recommendations

6.3 Using RE Batch API

6.3.1 Setting Up the RE Batch API Environment

6.3.1.1 Customer Profile Data

6.3.1.2 Deploy a Package to an RE

6.3.2 Sample RE Batch API Usage

6.3.3 Creating an REBatchProxy Object

6.3.4 Creating Instances of RE Batch API Objects

6.3.5 Converting Data for RE Batch API

6.3.6 Managing Customer Profiles for RE Batch API

6.3.7 Getting RE API Batch Recommendations

6.3.7.1 Ratings in OracleAS Personalization

6.3.7.2 Creating Recommendations

6.3.8 Making RE Batch Recommendations

6.3.9 Removing the REBatchProxy Object

7 RE Batch API Supporting Classes

7.1 Ratings in OracleAS Personalization

7.2 Location of RE Batch API Classes

7.3 EnumType Interfaces for RE Batch API

7.3.1 CategoryMembership Interface

7.3.2 DataSource Interface

7.3.3 InterestDimension Interface

7.3.4 PersonalizationIndex Interface

7.3.5 ProfileDataBalance Interface

7.3.6 ProfileUsage Interface

7.3.7 Sorting Interface

7.4 Other RE Batch API Supporting Classes

7.4.1 DataItem Class

7.4.2 FilteringSettings Class

7.4.3 Item Class

7.4.4 Location Class

7.4.5 TuningSettings Class

8 Using the Recommendation Engine Batch Proxy

8.1 REProxy Batch Overview

8.2 Location of REProxyBatch Classes

8.2.1 REProxyBatch Creation and Management

8.2.1.1 Customer Profile Management

8.2.2 REProxyBatch Recommendations

8.2.2.1 Ratings in OracleAS Personalization

8.2.2.2 Meaning of Returned Value for Recommendations

8.2.2.3 Cross Sell Method Usage Notes

8.2.2.4 Recommendation Method Usage Notes

8.3 REProxyBatch Rules and Recommendations

9 REProxyBatch API Examples and Usage

9.1 REProxyBatch API Basic Usage

9.1.1 Code Sample: Recommend Top

9.1.2 Code Sample: Recommend Cross Sell

9.2 Recommendation Engine Usage

9.3 Handling Multiple Currencies

9.4 Using Demographic Data

9.5 Handling Time-Based Items

A REAPI Sample Program

B REProxyBatch Sample Program

B.1 RE Batch Sample Program Overview

B.1.1 RE Batch Sample Program Output

B.2 Executing the RE Batch Sample Program

B.3 RE Batch Sample Program Code

B.3.1 batchtest.txt

B.3.2 REBatchTest.java

Index