LobSystemInstance

The main purpose of the LobSystemInstance object is to provide authentication and connection string information to the Infrastructure component of Business Data Catalog. The Infrastructure component provides run-time connection management for Business Data Catalog clients. The LobSystemInstance object must have a unique name.

Client Impact

The Entity Picker in Microsoft Office SharePoint Server 2007 lists the available LobSystemInstance objects in the Business Data Catalog for which you have permissions, and enables you to pick entities when adding Web Parts and Business Data columns.

Remarks

The LobSystemInstance object allows you to associate two sets of instance-specific data such as connection parameters and authentication settings with a single system definition - one for Web clients and one specifically for search. This is extremely useful when you have different sets of security credentials to access data using Web clients and to crawl search.

Examples

The following examples show the XML for the metadata for the LobSystemInstance object. This object takes different sets of properties for databases and Web services. The first two tables following the code examples list the properties that the LobSystemInstance object allows.

Database using PassThrough Authentication

  <LobSystemInstances>
    <!-- An LobSystem can have only one LobSystemInstance. The LobSystemInstance defines the connection and authentication parameters. -->
    <LobSystemInstance Name="AdventureWorksSample">
      <Properties>
        <Property Name="AuthenticationMode" Type="System.String">PassThrough</Property>
        <!--AuthenticationMode can be set to PassThrough, RevertToSelf, RdbCredentials, or WindowsCredentials. -->
        <Property Name="DatabaseAccessProvider" Type="System.String">SqlServer</Property>
        <!-- Can be SQL Server, OlEDB, Oracle, or ODBC for database systems. -->
        <Property Name="RdbConnection Data Source" Type="System.String">YourAdventureWorks2000ServerNameHere</Property>
        <!-- The name of your server hosting the database or the name of the SQL Server instance in the format SQLServer\Instance. -->
        <Property Name="RdbConnection Initial Catalog" Type="System.String">AdventureWorks2000</Property>
        <!-- The name of the database.> -->
        <Property Name="RdbConnection Integrated Security" Type="System.String">SSPI</Property>
        <Property Name="RdbConnection Pooling" Type="System.String">false</Property>
       </Properties>
    </LobSystemInstance>
  </LobSystemInstances>

Database Using Single Single-On

<LobSystemInstances>
    <LobSystemInstance Name="AdventureWorksSampleSSO">
      <Properties>
        <Property Name="AuthenticationMode" Type="System.String">WindowsCredentials</Property>
        <Property Name="DatabaseAccessProvider" Type="System.String">SqlServer</Property>
        <Property Name="RdbConnection Data Source" Type="System.String">YourAdventureWorks2000ServerNameHere</Property>
        <Property Name="RdbConnection Initial Catalog" Type="System.String">AdventureWorks2000</Property>
        <Property Name="RdbConnection Integrated Security" Type="System.String">SSPI</Property>
        <Property Name="RdbConnection Pooling" Type="System.String">false</Property>
        <Property Name="SsoApplicationId" Type="System.String">AdventureWorks</Property>
        <Property Name="SsoProviderImplementation" 
            Type="System.String">Microsoft.SharePoint.Portal.
            SingleSignon.SpsSsoProvider, 
            Microsoft.SharePoint.Portal.SingleSignon, 
            Version=12.0.0.0, Culture=neutral, 
            PublicKeyToken=71e9bce111e9429c</Property>
      </Properties>
    </LobSystemInstance>
  </LobSystemInstances>

Web Service

  <LobSystemInstances>
    <LobSystemInstance Name="AWSECommerceService">
      <Properties>
        <Property Name="WebServiceAuthenticationMode" Type="System.String">PassThrough</Property>
       </Properties>
    </LobSystemInstance>
  </LobSystemInstances>

Properties

Following are the properties that the LobSystemInstance object accepts for database systems.

Property	Type	Required	Default Value	Limits/Accepted Values	Comments
AuthenticationMode	Microsoft.Office.Server.ApplicationRegistry.SystemSpecific.Db.DbAuthenticationMode	No	RevertToSelf	PassThrough RevertToSelf Credentials WindowsCredentials
DatabaseAccessProvider	Microsoft.Office.Server.ApplicationRegistry.SystemSpecific.Db.DbAccessProvider	No	SqlServer	SqlServer OleDb Oracle Odbc
SsoProviderImplementation	System.String	Yes, if AuthenticationMode is Credentials or WindowsCredentials	None	Microsoft Single Sign-on provider	Fully qualified type name of the ISsoProvider implementation that stores credentials used to log in to the database.
SsoApplicationId	System.String	No	None		ID of the SSO enterprise application definition that stores credentials used to connect to the database.
RdbConnection Data Source RdbConnection Initial Catalog RdbConnection Integrated Security RdbConnection Pooling	System.String	No	None		Properties prefixed with RdbConnection become database connection properties. For example, the "RdbConnection Data Source" property becomes the "Data Source" property on the database connection.
NumberOfConnections	System.Int32	No	-1	-1 or a positive number	Maximum number of simultaneous connections to allow to the system. If the value is -1, there is no maximum.
SecondarySsoApplicationId	System.String	No	None		ID of the SSO enterprise application definition that stores credentials used by the filters: Username and Password.

Following are the properties that the LobSystemInstance object accepts for Web service systems.

Property	Type	Required	Default Value	Limits/Accepted Values	Comments
WebServiceAuthenticationMode	System.String	No	RevertToSelf	PassThrough RevertToSelf Credentials WindowsCredentials	Authentication mode used to invoke Web service methods.
SsoProviderImplementation	System.String	Yes, if WsdlFetchAuthenticationMode is Credentials or WindowsCredentials	None	Microsoft Single Sign-on provider	Fully qualified type name of the ISsoProvider implementation that stores credentials used to call the Web service.
WebServiceSsoApplicationId	System.String	Yes, if WsdlFetchAuthenticationMode is Credentials or WindowsCredentials	None		ID of the SSO enterprise application definition that stores credentials used to call the Web service.
WebProxyServerConfiguration	System.String	No	None		Proxy server URL. Requests to fetch WSDL or invoke Web service methods are routed through this proxy server.
NumberOfConnections	System.Int32	No	-1	-1 or a positive number	Maximum number of simultaneous connections to allow to the system. If the value is -1, there is no maximum.
SecondarySsoApplicationId	System.String	No	None		ID of the SSO enterprise application definition that stores the username and password for the Username and Password filters and HTTP and SOAP headers.
WebServiceUrlOverride	System.String	No	None		Overrides the URL used to access the Web service. The default behavior is to use the Web service URL defined in the WSDL file.

See Also

Tasks

AdventureWorks SQL Server 2000 Sample
How to: Get Started with Using the Runtime Object Model
How to: Get Started with Using the Administration Object Model

Concepts

Business Data Catalog Authentication
FAQ: Business Data Catalog
Business Data Catalog: Glossary