Skip Headers
Oracle® Fusion Middleware Administrator's Guide for Oracle Business Data Synchronization Server
11g Release 2 (11.1.2.2.0)

Part Number E24630-02
Go to Documentation Home
Home
Go to Table of Contents
Contents
Go to Feedback page
Contact Us

Go to previous page
Previous
Go to next page
Next
PDF · Mobi · ePub

A BDSS Configuration Operations

This appendix describes how Business Data Synchronization Server (BDSS) synchronizes Calendar domain records.

This appendix includes the following topics:

A.1 UserConfigMBean

Section A.1 lists the operations of the UserConfigMBean. For more information, see Section 4.7, "Managing Users."

Table A-1 Operations of the User Configuration MBean

Operation Description

showUserList

Returns a list of all users and their status

showFailinguserList

Returns a list of all users that are currently failing to synchronize

showUserStatus

Displays the status for a user, including record level status. There is an optional flag that forces the operation to only return failing items.

addConnectorUser

Adds a new connector user and associates the new user with a Hub user. This operation creates a Hub user if one does not exist. For a user who is configured to synchronize, this operation must be performed for each connector. The Hub user must then be enabled for synchronization using updateUserSyncEnablementFlag.

removeHubUser

Removes a Hub user from the database and also all of the connector users associated with that Hub user

updateHubUserSyncEnableFlag

Updates the synchronization-enabled flag for a user. T or True means that the user synchronizes in all of the subsequent synchronization sessions. F or False means the user does not synchronize.

updateUserDomainSyncLevel

Changes the synchronization level for a connector user on the given domain. The valid synchronization levels are currently Full, None, Inbound Only and Outbound Only.


A.2 ServerDomainConfigMBean

Table A-2 lists the operations of the ServerDomainConfigMBean. For more information see Section 4.2, "Managing Connectors" and Section 4.4, "Managing Connector Instances."

Table A-2 Operations of the ServerDomainConfigMBean

Operation Description

showConnectorDetails

Returns configuration for specified connectors. If the connector name is empty, then this operation returns configuration information for all configured connectors.

updateConnectorForPim

Adds or modifies a connector

deleteConnector

Removes the given connector

updatePimServerInstance

Updates an existing PIM server instance or creates a new PIM server instance

deletePimServerInstance

Deletes a PIM server instance

updateConnectorInstance

Creates or modifies a connector instance for a connector

deleteConnectorInstance

Deletes a connector instance from a connector

updateDomainForConnector

Creates or modifies a domain for a connector

deleteDomainForConnector

Deletes a domain from a connector

updateFilterForDomain

Creates or modifies a filter for a connector domain

deleteFilterForDomain

Deletes a filter from a domain


A.3 DispatcherSettings MBean

Table A-3 lists the attributes of the DispatcherSettings MBean. For more information, see Section 5.2, "Configuring the Dispatcher."

Table A-3 Attributes of the DispatcherSettings MBean

Attribute Description

ChunkSize

The number of users contained in the message sent to the Hub for synchronization. Use this attribute to balance the load to each instance of a running Engine. The default value is 20 users per message.

HubEndPointURL

The URL used by the Dispatcher to connect to the DispatcherHub Web service on the server hosting the Hub. For example, a typical Hub URL for the WebLogic Server is http://<HUB_SERVER_IP_ADDRESS>:7001/BDSSHubWebServices/DispatcherHubWebService?WSDL.


A.4 EngineSettings MBean

Table A-4 lists the attributes of the EngineSettings MBean. For more information, see Section 5.3, "Configuring the Engine."

Table A-4 Attributes of the EngineSettings MBean

Attributes Description

EngineEndPointURL

The URL used by the Engine to enable the connectors to extract requests and data update request responses to the Engine.

To find this URL using Oracle WebLogic Administration Console:

  1. Select Deployments.

  2. Expand the tree structure of BDSSHub.

  3. Select the EngineCallBackInterface node. The Settings for EngineCallback page appears.

  4. Select the Testing tab.

  5. Expand the EngineCallbackInterface node.

  6. Select the ?WSDL test point.

ExtractResponseTimeOut

The number of milliseconds that the Engine waits to process an extract response from a connector. The default value is 60000 milliseconds.The timeout value must be sufficiently large to prevent a timeout from occurring under normal circumstances. This value depends on several factors that include:

  • The size of the largest record set that can be extracted.

  • The number of Hub domains that are to be extracted. This has bearing because Hub domains are processed serially by the Engine for a synchronization session. Therefore, Hub domain B must wait longer to retrieve its extract responses if Hub domain A were processed first.

  • Other factors, including system load and communication latency, that affect the ability of a Engine to retrieve and process extract response messages from connectors before the timeout occurs.

If a timeout occurs, then synchronization of the corresponding Hub domain is terminated for the affected user synchronization session.

MessageTimeToLive

The number of milliseconds that a message containing an extract response remains on the JMS queue before being removed. The default value is 60000 milliseconds. Calculate this timeout value using an analysis similar to the one performed for the ExtractResponseTimeOut attribute.

RuntimeLibraryURL

The URL that the Engine sends to the connectors to enable them to communicate with the Connector Run-Time Library.

To find this URL using Oracle WebLogic Server Console:

  1. Select Deployments.

  2. Expand the tree structure of BDSSHub.

  3. Select the ConnectorRuntimeInterface node. The Settings for ConnectorRuntimeInterface page appears.

  4. Select the Testing tab.

  5. Expand the ConnectorRuntimeInterface node.

  6. Select the ?WSDL test point.


A.5 ProfileRuntimeInfo MBean

The ProfileRuntimeInfo MBean provides operations for modifying and viewing profile parameters. For more information, see Section 4.8, "Managing Profiles."

Table A-5 Operations of the ProfileRuntimeInfo MBean

Operation Description

displayAllProfiles

Returns a list of all parameters grouped by their profiles and sections

displayProfile

Displays only the parameters for the given profile

removeProfileParameter

Removes a given parameter. You must provide a profile name and a section name to ensure that the correct parameter is removed.

setProfileParameter

Updates an existing parameter or creates a new parameter


A.6 Profile Parameters

A profile stores the configuration metadata for a connector. Each parameter has a single value. The operations of the ProfileRuntimeInfo MBean (listed in Table A-5) enable you to manage the profiles for a connector. BDSS ships with profiles seeded for the Exchange Connector and the FTSKeyFields Profile. The profiles are listed in Table A-6. For more information, see Chapter 6, "Configuring the BDSS Connector for Microsoft Exchange 2007," and Section 5.5, "Configuring the FtsKeyFields Profile."

Table A-6 The BDSS Profile Parameters

Profile Section Parameter Description

BdssKeyFields

Calendar

KeyField1

First field used for record matching

BdssKeyFields

Calendar

KeyField2

Second field used for record matching

BdssKeyFields

Contact

KeyField1

First field used for record matching

BdssKeyFields

Contact

KeyField2

Second field used for record matching

BdssKeyFields

Task

KeyField1

First field used for record matching

BdssKeyFields

Task

KeyField2

Second field used for record matching

FTSKeyFields

Tasks

KeyField1

The first field used for record matching

FTSKeyFields

Tasks

KeyField2

The second field used for record matching

Exchange2007

Hub Transport

Pim Transport Implementation Class

The Hub Transport generic component uses this value to initialize the Exchange PIM Transport.

Exchange2007

Hub Transport

Extract Response Batch Size

Set this value to a sufficiently large number so that no user synchronized byBDSS has records that exceeds this value.

Exchange2007

Task

Pim Xsd

The URI to the exchange2007task.xsd file.

Exchange2007

Task

PimToHubUrl

The URI to the Exchange2007TaskToHubTask.xsl

Exchange2007

Task

HubToPimUrl

The URI to the HubTaskToExchange2007Task.xsl.

Exchange2007

Task

Domain Class Type

The Exchange Web Service interface class that is used when synchronizing the domain

Exchange2007

Task

Exchange Domain Batch Size

The maximum number of records downloaded from Exchange when extract records from the domain target. Valid values are 1 through 512.

Exchange2007

Task

Folder Class

The folder class for the domain.

Exchange2007

Task

Body Type

How the Body field for the domain is synchronized. Valid values are Text or HTML.

Exchange2007

Task

Conflict Resolution Type

Determines how Exchange handles a conflict type. Valid values are AutoResolve, AlwaysOverwrite, and NeverOverwrite.

Exchange2007

Task

Disposal Type

Determines how Exchange handles deleted records. Valid values are HardDelete, SoftDelete, and MoveToDeletedItems.

Exchange2007

Task

Pim Domain id

The PIM domain identifier, used as the message class property for each synchronizing record

Exchange2007

Contact

Exchange Domain Batch Size

The maximum number of records downloaded from Exchange when extracting records from the domain target. Valid values are 1 to 512, inclusive

Exchange2007

Contact

Folder Class

The folder class for the domain

Exchange2007

Contact

Pim Domain Id

The PIM domain identifier, used as the message class property of each record synchronized

Exchange2007

Contact

Pim Xsd

The URI to the exchange2007contact.xsd file

Exchange2007

Contact

PimToHubUrl

The URI to the Exchange2007ContactToHubContact.xsl

Exchange2007

Contact

HubToPimUrl

The URI to the HubContactToExchange2007Contact.xsl

Exchange2007

Calendar

Time Zone Xsd

The URI to timezoneregistryschema.xsd

Exchange2007

Calendar

VEvent Xsd

The URI to veventasxml.xsd

Exchange2007

Calendar

PimToHubUrl

The URI to exchange2007calendartohubcalendar.xsl

Exchange2007

Calendar

Pim Xsd

The URI to pimicalbody.xsd

Exchange2007

Calendar

Calendar Item Type Xsd

The URI to calendaritemtype.xsd

Exchange2007

Calendar

Time Zone Xml

The URI to timezoneregistry.xml

Exchange2007

Calendar

HubToPimUrl

The URI to hubcalendartoexchange2007calendar.xsl

Exchange2007

Calendar

CalendarItemToVEvent Xsl

The URI to calendaritemtypetoveventasxml.xsl

Exchange2007

Calendar

VEventToCalendarItem Xsl

The URI to veventasxmltocalendaritemtype.xsl

Exchange2007

Calendar

Body Type

How the Body field for the domain is synchronized. Valid values are Text or HTML.

Exchange2007

Calendar

Conflict Resolution Type

Determines how Exchange handles a conflict type. Valid values are AutoResolve, AlwaysOverwrite, and NeverOverwrite.

Exchange2007

Calendar

Disposal Type

Determines how Exchange handles deleted records. Valid values are HardDelete, SoftDelete, and MoveToDeletedItems.

Exchange2007

Calendar

Domain Class Type

The Exchange Web Service interface class that is used when synchronizing a domain.

Exchange2007

Calendar

Exchange Domain Batch Size

The maximum number of records downloaded from Exchange when extracting records from the domain target. Valid values are 1 to 512, inclusive.

Exchange2007

Calendar

Fanning Limit

The number of records created when a recurring calendar record cannot be natively represented in Exchange. Valid values are 1 to 100, inclusive.

Exchange2007

Calendar

Folder Class

The folder class for the domain

Exchange2007

Calendar

Pim Domain id

The PIM domain identifier, used as the message class property of each record synchronized.

Exchange2007

Active Directory

ServerN

(where N is a ordinal >= 0)

The LDAP URL used by the connector to obtain Service Connection Point URLs from Active Directory when discovering a user's Exchange account information.

You can add multiple entries. The ordinal specifies a preference order (that is, Server0 is tried before Server1, and so on).

The connector tries each URL until the user is discovered or each entry has been tried.

Exchange2007

Active Directory

Referral

Specifies how the LDAP provider handles referrals. Values are follow, throw or defer. The default value is follow.

Exchange2007

Active Directory

Max Query Result Size

Max number of results to return per Active Directory query. The default value is 20.

Exchange2007

Active Directory

Max Query Time

The time (in milliseconds) to wait for an Active Directory query to return. The default value is 30 seconds (30000 milliseconds).

Exchange2007

Active Directory

Read Timeout

The time (in milliseconds) to wait for a response before timing out. The default value is 5000.

Exchange2007

Active Directory

Connect Timeout

The time (in milliseconds) to establish a connection to Active Directory before timing out. The default value is 5000.

Exchange2007

Active Directory

Use SSL

Whether secure LDAP is used. The default is true. However, in the development environment, set the value to false because the Domain Controller is not enabled for secure LDAP

Exchange2007

Active Directory

Using Client Certificates

Indicates if the client provider uses LDAP certificates

Exchange2007

Active Directory

Client Certificate Path

Set to true if Use SSL is set to true and the Domain Controller requires a client certificate. The default value is false.

Exchange2007

Auto Discovery

SCPN

where N is an ordinal >= 0

The URL to a Service Connection Point (SCP) that the connector should use when discovering a user.

The ordinal specifies a preference order (the connector tries SCP0 is tried before SCP1, and so on). The connector tries each URL until the user is discovered or each entry has been tried.

Exchange2007

Auto Discovery

Remove Domain From Urls

Directs the connector to remove the domain information from a discovered SCP URLs obtained from Active Directory.

For the development environment, set the value to true because DNS prevents the URL from being resolved when the URL contains a domain (that is, http://server1.us.oracle.com/autodiscover/autodiscover.xml does not work.) When the option set to true, the URL becomes http://server1/autodiscover/autodiscover.xml.

Exchange2007

Auto Discovery

Read Timeout

The time (in milliseconds) to wait for a response before timing out. The default value is 5000.

Exchange2007

Auto Discovery

Connect Timeout

The time (in milliseconds) to establish a connection to Auto Discover server before timing out. The default is 5000.

Exchange2007

Auto Discovery

Use SSL

Whether secure HTTP (HTTPS) is used. The default is true. HTTPS may be required for the Auto Discover service if attempts to configure the server to allow HTTP fail.

Exchange2007

Auto Discovery

Client Certificate Path

Set this value to the location of the PEM (Privacy Enhance Mail security certificate) file containing the client certificate that is used if Auto Discover requires client certificates

Exchange2007

Auto Discovery

Client Certificate Key Path

Set this value to the location of the PEM (Privacy Enhance Mail security certificate) file containing the client certificate private key

Exchange2007

Auto Discovery

Port

Defaults to 443, the typical HTTPS secure port. Set the value to the HTTPS port if Use SSL is set to true. If false, this value should be the HTTP port. The value is only used when attempting default SCP URLs (which are attempted when all SCP URLS have been tried (those in the SCPN configuration and those obtained from AD per the Servern configuration).

Exchange2007

Event Receiver

CHANGE_ME

The name of an Exchange 2007 connector as it appears in the NAME Column of the CONNECTORS table.

Exchange2007

Event Receiver

Status Frequency

The frequency, in minutes, that Exchange provides a notification for each subscription

Exchange2007

Event Receiver

Subscription Status Factor

The event receiver performs a check on all subscriptions to verify that the Exchange server has not terminated any subscriptions. This parameter sets frequency in which this check occurs. The frequency in which this check occurs is the value set for this parameter multiplied by the value set for the Status Frequency parameter. For example, if you set the Status Frequency parameter to 1 minute, and then set the Subscription Status Factory to 3, then the event receiver performs the subscription check every 3 minutes.