LobSystemInstance Class

Article
10/23/2013

Represents an instance of a business application registered in the Business Data Catalog.

Inheritance Hierarchy

System.Object
  Microsoft.Office.Server.ApplicationRegistry.Administration.MetadataObject
    Microsoft.Office.Server.ApplicationRegistry.Administration.AccessControlledMetadataObject
      Microsoft.Office.Server.ApplicationRegistry.Administration.LobSystemInstance

Namespace: Microsoft.Office.Server.ApplicationRegistry.Administration
Assembly: Microsoft.SharePoint.Portal (in Microsoft.SharePoint.Portal.dll)

Syntax

'Declaration
<SharePointPermissionAttribute(SecurityAction.Demand, ObjectModel := True)> _
<SharePointPermissionAttribute(SecurityAction.InheritanceDemand, ObjectModel := True)> _
Public Class LobSystemInstance _
    Inherits AccessControlledMetadataObject

'Usage
Dim instance As LobSystemInstance

[SharePointPermissionAttribute(SecurityAction.Demand, ObjectModel = true)]
[SharePointPermissionAttribute(SecurityAction.InheritanceDemand, ObjectModel = true)]
public class LobSystemInstance : AccessControlledMetadataObject

Remarks

The LobSystemInstance object allows you to associate multiple system instance-specific data such as connection parameters and authentication settings with a single system definition. The current release of Business Data Catalog allows supporting two LobSystemInstances for each LobSystem. One of them is used by web clients and the other by the Search crawler, since often these two Business Data Catalog applications require dissimilar authentication modes. Business Data Catalog disambiguates which one is used by the search crawler by tagging it with the UseForSearch property.

Client Impact

The Entity Picker in 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.

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 single sign-on (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. Any property name that is prefixed with RdbConnection will automatically be added to the connection string and sent over to the Database 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 credentials used in UsernameCredentialFilter and PasswordCredentialFilter.

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 files 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 credentials used for the Username filter and Password filter.
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.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Share via