Contents

Title and Copyright Information

Preface

• Audience
• Documentation Accessibility
• Related Documents
• Conventions

Part I Introduction

1 Introduction to Oracle Business Data Synchronization Server

• 1.1 What Is Oracle Business Data Synchronization Server?
• 1.2 Using BDSS
  • 1.2.1 Creating a Task
  • 1.2.2 Storing Contact Information
• 1.3 Configuring the Exchange 2007 Connector to Test Domain Synchronization

2 Understanding the BDSS Architecture

• 2.1 Overview of the Oracle Business Data Synchronization Server Architecture
  • 2.1.1 BDSS Components
    • 2.1.1.1 Hub
    • 2.1.1.2 Connectors
  • 2.1.2 How BDSS Synchronizes Users
    • 2.1.2.1 Synchronization Options
    • 2.1.2.2 Scheduler-Based Synchronization
    • 2.1.2.3 Tracking Record Changes Using Synchronization State
  • 2.1.3 Event-Based Synchronization
• 2.2 Overview of Connectors
  • 2.2.1 Hub Transport
  • 2.2.2 Transformer
  • 2.2.3 PIM Transport
  • 2.2.4 How the Connector Components Manage Domain Data During Synchronization
    • 2.2.4.1 Inbound Synchronization
    • 2.2.4.2 Outbound Synchronization
  • 2.2.5 Error Messages

3 Installing the BDSS Components

• 3.1 Overview of Installation
  • 3.1.1 Prerequisites
• 3.2 Deploying the Hub Components
  • 3.2.1 Prerequisites for Deploying the Hub Components
• 3.3 Overview of Installing and Configuring BDSS
• 3.4 Creating a Domain
  • 3.4.1 Installing Java Required Files
    • 3.4.1.1 Installing the JRF Extension
    • 3.4.1.2 Extending a Domain for JRF
• 3.5 Extending the Domain with the BDSS Templates
• 3.6 Adding Security Credentials
• 3.7 Setting SSL
• 3.8 Enabling Data Transformation and Filtering for Exchange 2007 Connector
• 3.9 Configuring the Exchange 2007 Connector
  • 3.9.1 Configuring the Exchange 2007 Connector for Record Transformation
  • 3.9.2 Configuring the Exchange 2007 Connector to the Active Directory Service
  • 3.9.3 Configuring Exchange 2007 Connector to Use the Auto Discovery Service
• 3.10 Configuring the BPEL Task Connector
• 3.11 Configuring the Hub
• 3.12 Configuring BDSS Server Instances
• 3.13 Configuring Connector Instances
• 3.14 Adding Users
• 3.15 Postinstallation Configuration
  • 3.15.1 Configuring the Dispatcher
  • 3.15.2 Configuring the Engine
  • 3.15.3 Configuring PIM Server Instances Using MBeans
    • 3.15.3.1 Creating PIM Server Instances and Connector Instances

Part II Basic Administration

4 Getting Started with Administering BDSS

• 4.1 Overview of Administration Tasks
  • 4.1.1 Managing BDSS Components Using MBeans
    • 4.1.1.1 Accessing MBeans through the Oracle Enterprise Manager Console
    • 4.1.1.2 Accessing MBeans through JConsole
  • 4.1.2 Specifying the Synchronization Direction
• 4.2 Managing Connectors
  • 4.2.1 Viewing the Connector Configuration
  • 4.2.2 Adding and Updating Connectors
    • 4.2.2.1 Configuring Connector-Level Synchronization and Event Notification
  • 4.2.3 Deleting a Connector
• 4.3 Managing BDSS Server Instances
  • 4.3.1 Adding and Updating BDSS Instances
  • 4.3.2 Deleting a PIM Server Instance
• 4.4 Managing Connector Instances
  • 4.4.1 Adding and Updating Connector Instances
  • 4.4.2 Deleting a Connector Instance
• 4.5 Managing Domains
  • 4.5.1 Creating a Domain for a Connector
    • 4.5.1.1 Configuring Domain-Level Synchronization
  • 4.5.2 Deleting a Domain from a Connector
• 4.6 Managing Domain Filters
  • 4.6.1 Creating a Filter for a Domain
  • 4.6.2 Deleting a Filter from a Domain
• 4.7 Managing Users
  • 4.7.1 Viewing User Status
  • 4.7.2 Creating Connector Users
    • 4.7.2.1 Deleting Hub Users
  • 4.7.3 Configuring User-Level Synchronization
    • 4.7.3.1 Enabling Synchronization for Hub Users
    • 4.7.3.2 Setting the Synchronization Levels for a User's Domains
• 4.8 Managing Profiles
  • 4.8.1 Viewing Profiles
    • 4.8.1.1 Viewing All Profiles for a Connector
    • 4.8.1.2 Viewing a Specific Profile
  • 4.8.2 Managing Profile Parameters
    • 4.8.2.1 Creating a Profile
    • 4.8.2.2 Updating a Profile
    • 4.8.2.3 Deleting a Parameter from a Profile

5 Configuring the BDSS Hub Services

• 5.1 Overview of Hub Configuration
• 5.2 Configuring the Dispatcher
• 5.3 Configuring the Engine
• 5.4 Creating Connector Configuration Profiles
• 5.5 Configuring the FtsKeyFields Profile

6 Configuring the BDSS Connector for Microsoft Exchange 2007

• 6.1 Overview of Exchange 2007 Connector Configuration
• 6.2 Configuring the Microsoft Exchange 2007 Connector for Data Exchange
• 6.3 Configuring Record Transformation for the Exchange 2007 Connector
• 6.4 Configuring the Microsoft Exchange 2007 Connector's PIM Transport Component
• 6.5 Configuring Domain Synchronization
  • 6.5.1 Configuring Contact Synchronization
  • 6.5.2 Configuring Task Synchronization
  • 6.5.3 Configuring Calendar Synchronization
• 6.6 Configuring Data Filtering
• 6.7 Configuring the Microsoft Exchange 2007 Connector to Use Active Directory
• 6.8 Configuring Event Receiving for the Exchange 2007 Connector
• 6.9 Configuring the Exchange 2007 Connector to Use the Microsoft Autodiscover Service
• 6.10 Testing Domain Synchronization using the Exchange 2007 Connector

7 Configuring Security for BDSS

• 7.1 Overview of Communication Security
• 7.2 Securing the Web Services Exposed by the Hub
• 7.3 Configuring BDSS for HTTPS

8 Mapping Connector Fields to Hub Fields

• 8.1 Overview of Data Transformation
• 8.2 About Domain Schemas
  • 8.2.1 Schema Data Types
    • 8.2.1.1 W3C Schema Data Types
    • 8.2.1.2 Hub Schema Data Types
    • 8.2.1.3 Connector Schema Data Types
  • 8.2.2 Hub Schema Documents
    • 8.2.2.1 Hub Schema Type Library
    • 8.2.2.2 Hub Task Schema
• 8.3 Data Side Effects Caused by Synchronization
  • 8.3.1 Data Model Incompatibility
  • 8.3.2 Differing Data Type Facets
    • 8.3.2.1 Length
    • 8.3.2.2 Pattern
    • 8.3.2.3 Enumeration
    • 8.3.2.4 White Space
  • 8.3.3 List Transformations
    • 8.3.3.1 Multivalue Field
    • 8.3.3.2 Field Group
  • 8.3.4 Record Collisions

9 Synchronizing the Calendar Domain

• 9.1 Overview of Calendar Synchronization Support
  • 9.1.1 Transforming Calendar Records
• 9.2 Transforming Custom Calendar Fields
  • 9.2.1 Transformations Through Secondary Translation
    • 9.2.1.1 Enabling Custom Fields for the Exchange 2007 Connector
  • 9.2.2 Translations Through Java-Based Connectors
• 9.3 Supporting Calendar Synchronization in Hub Schema
• 9.4 Creating Custom Calendar Fields
• 9.5 Data Side Effects Caused by Synchronizing ICAL Fields
  • 9.5.1 Failed Synchronization of Any ICAL Field
  • 9.5.2 Mapping a Custom ICAL Field to a Regular ICAL Field

Part III Appendixes

A BDSS Configuration Operations

• A.1 UserConfigMBean
• A.2 ServerDomainConfigMBean
• A.3 DispatcherSettings MBean
• A.4 EngineSettings MBean
• A.5 ProfileRuntimeInfo MBean
• A.6 Profile Parameters

B Configuring the BPEL Task Connector

• B.1 Overview of BPEL Task Connector Configuration
• B.2 Configuring the Tasks Profile

C Tables in the BDSS Data Stores

• C.1 Overview of BDSS Tables
• C.2 PIM_SERVER_INSTANCES
• C.3 CONNECTORS
• C.4 CONN_INSTANCES
• C.5 CONNS_TO_PIM_SERVERS
• C.6 HUB_DOMAINS
• C.7 CONN_DOMAINS
• C.8 CONN_DOMAIN_FILTERS
• C.9 DESC_FIELDS
• C.10 HUB_USERS
• C.11 CONN_USERS
• C.12 USER_CONTEXTS
• C.13 USER_CONTEXT_STATES
• C.14 STATE_DATA
• C.15 USER_HISTORY
• C.16 CONN_USER_RECORDS
• C.17 HUB_RECORDS
• C.18 CONN_RECORD_DESCS
• C.19 ASSOC_DATA
• C.20 LOVS
• C.21 PROFILES
• C.22 SEQUENCE

D Connector API

• D.1 Overview of the Connector API
  • D.1.1 Associated Data
  • D.1.2 Connector Name
  • D.1.3 Create/Create Conflict
  • D.1.4 Field Class
  • D.1.5 PIM Domain Target
  • D.1.6 PIM Record Description
  • D.1.7 PIM Record ID
  • D.1.8 PIM Record Version ID
  • D.1.9 Synchronization Session
  • D.1.10 Synchronization State
  • D.1.11 Update/Update Conflict
• D.2 Connector Interface
  • D.2.1 InitializeUserSyncSession API
    • D.2.1.1 Engine Contract
    • D.2.1.2 Connector Contract
  • D.2.2 ExtractDomains API
    • D.2.2.1 Engine Contract
    • D.2.2.2 Connector Contract
    • D.2.2.3 Best Practices for ExtractDomains
  • D.2.3 EndDomainSynchronization API
    • D.2.3.1 Engine Contract
    • D.2.3.2 Connector Contract
  • D.2.4 EndUserSyncSession API
    • D.2.4.1 Engine Contract
    • D.2.4.2 Connector Contract
  • D.2.5 CreateRecord API
    • D.2.5.1 Engine Contract
    • D.2.5.2 Connector Contract
  • D.2.6 UpdateRecord API
    • D.2.6.1 Engine Contract
    • D.2.6.2 Connector Contract
  • D.2.7 DeleteRecord API
    • D.2.7.1 Engine Contract
    • D.2.7.2 Connector Contract
  • D.2.8 GetPimServerEndPoint API
    • D.2.8.1 Engine Contract
    • D.2.8.2 Connector Contract
• D.3 Engine Callback Interface API
  • D.3.1 ExtractDomainResultsCallback API
  • D.3.2 Engine Contract
  • D.3.3 Connector Contract
• D.4 Connector Run-Time Interface API
  • D.4.1 GetPimRecordVersions API
  • D.4.2 CacheTempSyncState API
  • D.4.3 CommitCachedSyncState Method API
  • D.4.4 GetConfigurationMetaData API
  • D.4.5 GetDeletesByPendingCreateEchoes API
  • D.4.6 GetDeletesBylds API
  • D.4.7 GetRecordAssociatedData API
  • D.4.8 GetSyncState API
  • D.4.9 GetUserAssociatedData API
  • D.4.10 SaveSyncState API
  • D.4.11 SetRecordAssociatedData
  • D.4.12 SetUserAssociatedData API
• D.5 Data Representation Structures
  • D.5.1 Common Structures
    • D.5.1.1 KeyValuePair
  • D.5.2 Connector Interface-Related Structures for the BDSS Engine
    • D.5.2.1 DomainInfo
    • D.5.2.2 ExtractRequest
    • D.5.2.3 ExtractResponse
    • D.5.2.4 ExtractResponseData
    • D.5.2.5 ExtractResponseMetaData
    • D.5.2.6 HubContext
    • D.5.2.7 PimRecordDescription
    • D.5.2.8 AssociatedData
    • D.5.2.9 AssocDataElement
    • D.5.2.10 RecordMetaData
    • D.5.2.11 UpsertRecord
    • D.5.2.12 Enum ExtractResultCode
  • D.5.3 Configuration-Related Structures
    • D.5.3.1 ConfigurationSection
    • D.5.3.2 ConfigurationProfile
• D.6 Best Practices for Building Connectors
• D.7 The Exchange 2007 Connector API
• D.8 Generic Component Support for Calendar Synchronization
  • D.8.1 Calendar Support Methods
    • D.8.1.1 Hub Contract
    • D.8.1.2 Connector Contract
    • D.8.1.3 Fanning
  • D.8.2 Exchange 2007 PIM Transport Calendar Support
    • D.8.2.1 Organizer and Attendees
    • D.8.2.2 Record Associated Data and Exchange Metadata
    • D.8.2.3 Supported Recurrence Patterns
    • D.8.2.4 Time Zones
    • D.8.2.5 Date Time Values
    • D.8.2.6 PIM Record IDs
    • D.8.2.7 ExtractDomain
    • D.8.2.8 CreatePIMRecord
    • D.8.2.9 UpdatePIMRecord
    • D.8.2.10 DeletePIMRecord

E Custom Field XSLTs and XSDs

• E.1 Overview of Custom Field Transformations
  • E.1.1 Defining Custom Fields
• E.2 Defining the ICAL Field Definitions
• E.3 Transforming the Exchange Connector's Custom Fields into ICAL
• E.4 Transforming the ICAL fields into Exchange Connector Fields
• E.5 Mapping Windows Time Zones to Java-Standard Time Zones

F Troubleshooting BDSS

• F.1 Exchange 2007 Connector Fails First-Time Synchronization

Glossary

Index