BDC Custom Properties
Applies to: SharePoint Server 2010
Table 1 contains the Business Data Connectivity (BDC) service custom properties and their descriptions.
BDC Custom Properties Descriptions
Table 1. BDC custom property descriptions
Element |
Property Name |
Type Name |
Description |
Required/Optional |
Default Value |
Limits / Accepted Values |
ActionParameter |
IdOrdinal |
System.Int32 |
Specifies that the action parameter represents an identifier instead of a field. |
Optional |
None |
An integer greater than or equal to zero. |
Association |
HideOnProfilePage |
System.Boolean |
Specifies whether a particular associated entity should be added to the profile page of the master entity. |
Optional |
false |
true, false |
Entity |
DefaultAction |
System.String |
Specifies the name of the default action defined for the entity. |
Optional |
None |
One of the action names. |
Entity |
Title |
System.String |
Specifies the name of a field defined on the entity as a title. |
Optional |
None |
A field name. |
Entity |
DisplaySearchResultRightsMask |
System.Int64 |
Defines the response from the CheckAccess stereotype that shows that an item can be displayed in the search results page for the currently logged in user. For more information about this property, see the note later in this topic. |
Optional |
1 |
A long integer that represents a bitmask. |
Entity |
MaxAccessChecksPerSession |
System.Int32 |
This is a parameter to the Search Windows PowerShell commandlet that registers a custom security trimmer. It specifies the number of Document IDs that are sent to the external system in one call, to check whether the current user has access to those documents. |
Optional |
100 |
An integer value. |
Entity |
__BdcLastModifiedTimestamp |
System.String |
Specifies the name of the field that contains the time stamp of the entity instance. The value of this field is used for timestamp- based incremental crawling and also to display in the search results page. |
Optional |
None |
Should be the name of a field whose type is System.DateTime. If the name of a non-existent field is specified, or if the name of a field whose type is not System.DateTime is specified, an InvalidOperationException is thrown. |
Entity |
ExcludeFromOfflineClientForList |
System.String |
Specifies whether the entity can be taken offline in Microsoft Groove or Microsoft Outlook applications. |
Optional |
false |
true, false |
Entity |
Discovery |
System.String |
Indicates whether the metadata object is used for data source discovery purposes inside SharePoint Designer, instead of for end-user consumption. |
Optional. |
None |
The values of this property are ignored. |
Entity |
OfficeItemType |
System.String |
Identifies the item type that the entity can map to. |
Optional |
None |
Appointment, Task, Post, Contact |
FilterDescriptor |
CaseSensitive |
System.Boolean |
Specifies a UI hint that indicates whether a filter string is evaluated in a case-sensitive manner or in a case-insensitive manner. |
Optional |
false |
true, false |
FilterDescriptor |
IsDefault |
System.Boolean |
Specifies a UI hint that indicates whether to use this filter by default. This property is used by an external item picker control. |
Optional |
false |
true, false |
FilterDescriptor |
Comparator |
String or ComparisonFilter.Comparator enum |
Specifies the comparison operator for a comparison filter. |
Optional |
= |
Equals, NotEquals, GreaterThan, LessThan, GreaterThanEquals, LessThanEquals, =, ==, !=, <>, <, >, >=, <= |
FilterDescriptor |
MaximumValue |
System.Int32 |
Specifies a UI hint that can be used for validation in forms. |
Optional |
None |
|
FilterDescriptor |
UsedForDisambiguation |
System.Boolean |
Specifies whether the picker should use this filter to populate the match list. |
Optional |
false |
true, false |
FilterDescriptor |
UseValueAsDontCare |
System.Boolean |
Indicates whether the DontCareValue property should be used or ignored for this filter. This is used only in the SharePoint Designer filter editor for Microsoft SQL Server tables and views. |
Optional |
false |
true, false |
FilterDescriptor |
DontCareValue |
System.String |
Specifies the value to be ignored at run time when this filter is executed. This property is used only inside the filter editor in SharePoint Designer for tables and views. |
Optional |
Null if not specified. |
Any string |
FilterDescriptor |
PageSize |
System.Int32 |
Specifies the page size for the page filter. This property is used only inside the filter editor for SQL Server tables and views in SharePoint Designer. |
Optional |
0 |
A 32-bit integer value. |
FilterDescriptor |
SortType |
System.String |
Specifies how to order the results for a BDC method. This property applies to Limit filters and Page filters. This property is used only inside the filter editor for SQL Server tables and views in SharePoint Designer. |
Optional |
Ascending |
Ascending, Descending |
LobSystem |
WildcardCharacter |
System.String |
Specifies the wildcard character used in Wildcard Filters defined for methods on Entities under this LobSystem. |
Optional |
"*" |
Any string except the empty string. |
LobSystem |
WildcardCharacterEscapeFormat |
System.String |
Specifies the escape string for wildcard characters for cases where the wildcard character is part of the actual search string. For example, "\{0}". |
Optional |
"\{0}" |
Any string with exactly one parameter. |
LobSystem |
DbAuthenticationMode |
System.String |
Specifies the authentication mode to access a database. If authentication mode is not specified in the BDC model, then by default, PassThrough authentication mode is used. For more information about the authentication modes that BDC supports, see Business Data Connectivity Service Authentication. |
Required |
RevertToSelf, PassThrough, WindowsCredentials, RdbCredentials |
|
LobSystem |
WebServiceAuthenticationMode |
System.String |
Specifies the authentication mode to access a Web service. If authentication mode is not specified in the BDC model, then by default, PassThrough authentication mode is used. For more information about the authentication modes that BDC supports, see Business Data Connectivity Service Authentication. |
Required |
RevertToSelf, PassThrough, WindowsCredentials, Credentials |
|
LobSystem |
WsdlFetchUrl |
System.String |
Specifies the location of the WSDL file for a Web service connection. |
Required |
A URL. |
|
LobSystem |
WsdlFetchAuthenticationMode |
System.String |
Specifies the authentication mode used to retrieve the WSDL file from the WsdlFetchUrl. If authentication mode is not specified in the BDC model, then by default, PassThrough authentication mode is used. For more information about the authentication modes that BDC supports, see Business Data Connectivity Service Authentication. |
Required |
RevertToSelf, PassThrough, WindowsCredentials, Credentials |
|
LobSystem |
WsdlFetchSsoProviderImplementation |
System.String |
Specifies the assembly-qualified name for the implementation of the custom secure store provider that is used for authenticating WSDL retrieval. |
Required only if the SSO application ID exists. |
An assembly-qualified name. |
|
LobSystem |
WsdlFetchSsoApplicationId |
System.String |
Specifies the SSO application ID for retrieving the WSDL file. |
Optional |
None |
SSO application ID. |
LobSystem |
WebServiceProxyNamespace |
System.String |
Specifies the namespace in which the Web service proxy is to be generated. |
Required |
None |
A string that contains the namespace. |
LobSystem |
WebServiceProxyProtocol |
System.String |
SOAP protocol version. |
SOAP11, SOAP12 |
||
LobSystem |
SystemUtilityType |
System.String |
Specifies the assembly information for the custom connector. |
Required only if the type is a custom type. |
None |
An assembly-qualified name. |
LobSystem |
Discovery |
System.String |
Indicates whether the metadata object is used for data source discovery purposes inside SharePoint Designer, instead of for end-user consumption. |
Optional |
None |
The values of this property are ignored. |
LobSystem |
DiscoveryVersion |
System.Int32 |
Indicates the discovery version of the discovery LobSystem in SharePoint Designer. |
Optional |
None |
Acceptable value range is from 0 to Int32. MaxValue. |
LobSystem |
DotNetAssemblyLobSystemName |
System.String |
Specifies the name of the lob system that this discovery LobSystem requires the .NET assembly from in SharePoint Designer. |
Optional |
None |
Any string less than or equal to 255 characters. |
LobSystem |
DotNetAssemblyTypeName |
System.String |
Specifies the assembly-qualified name of the class that this discovery LobSystem stands for in SharePoint Designer. |
Optional |
None |
An assembly-qualified name. |
LobSystemInstance |
WebProxyServerConfiguration |
System.String |
Specifies the proxy server name, if not using the default proxy server. |
Optional |
None |
A string. |
LobSystemInstance |
NumberOfConnections |
System.Int32 |
Specifies the number of concurrent connections allowed to one endpoint. |
Optional |
||
LobSystemInstance |
DatabaseAccessProvider |
System.String |
Specifies the type of database access. |
Required |
None |
SqlServer, OleDB, Oracle, Odbc |
LobSystemInstance |
AuthenticationMode |
System.String |
Specifies the authentication mode used to access a database. For more information about the authentication modes that BDC supports, see Business Data Connectivity Service Authentication. |
Required |
None |
RevertToSelf, PassThrough, WindowsCredentials, RdbCredentials |
LobSystemInstance |
WebServiceAuthenticationMode |
System.String |
Specifies the authentication mode to access a Web service. For more information about the authentication modes that BDC supports, see Business Data Connectivity Service Authentication. |
Required |
None |
RevertToSelf, PassThrough, WindowsCredentials, Credentials |
LobSystemInstance |
WebServiceUrlOverride |
System.String |
Specifies the location of the Web service, if different from WSDLFetchUrl. |
Optional |
HNone |
A URL. |
LobSystemInstance |
SsoProviderImplementation |
System.String |
Specifies the assembly-qualified name for the implementation of the secure store provider that is used to access the external system. |
Required only if the SSP application ID exists. |
None |
An assembly-qualified name. |
LobSystemInstance |
WebServiceSsoApplicationId |
System.String |
Specifies the Secure Store Application ID for accessing a Web service. |
Optional |
None |
An SSO application ID. |
LobSystemInstance |
SsoApplicationId |
System.String |
Specifies the Secure Store Application ID. |
Optional |
None |
An SSO application ID. |
LobSystemInstance |
SecondarySsoApplicationId |
System.String |
Specifies the secondary Secure Store Application ID. |
Optional |
None |
An SSO application ID. |
LobSystemInstance |
Discovery |
System.String |
Indicates whether the metadata object is used for data source discovery purposes inside SharePoint Designer, instead of for end-user consumption. |
Optional |
None |
The values of this property are ignored. |
LobSystemInstance |
WebServiceProxyTimeOut |
System.Int32 |
Specifies the timeout for Web service methods in milliseconds. |
Optional |
||
LobSystemInstance |
__Upgraded |
System.Boolean |
Specifies whether this LobSystem instance was upgraded from Microsoft Office 2007. |
Optional |
false |
true, false |
LobSystemInstance |
RdbConnection Data Source RdbConnection Initial Catalog RdbConnection Integrated Security RdbConnection Pooling |
System.String |
Properties prefixed with RdbConnection become database connection properties. For example, the RdbConnection Data Source property becomes the Data Source property on the database connection. If using PassThrough, RevertToSelf, or WindowsCredentials authentication modes, you must set the RdbConnection Integrated Security property to SSPI, yes, or true. We recommend that you set this value to SSPI for SQL Server databases. For more information about the authentication modes that BDC supports, see Business Data Connectivity Service Authentication. |
Optional |
None |
|
Method |
RdbCommandType |
System.Data.CommandType |
Specifies how the command string is executed. |
Required only for a database. |
None |
Text, StoredProcedure, TableDirect |
Method |
RdbCommandText |
System.String |
Specifies the command string to be executed on a database. |
Required only for a database. |
None |
A string that contains the command text. |
Method |
Schema |
System.String |
Specifies the SQL Server schema of the SQL Server object that the method is created from in SharePoint Designer. |
Optional. Required to edit a method in SharePoint Designer. |
None |
A SQL Server schema. |
Method |
BackEndObject |
System.String |
Specifies the SQL Server object that the method is created from in SharePoint Designer. |
Optional. Required to edit a method in SharePoint Designer. |
None |
|
MethodInstance |
DisableReadBeforeUpdate |
System.Boolean |
Indicates whether the Specific Finder call should be disabled before calling updater and deleter. Used only in offline synchronization. |
true, false |
||
MethodInstance |
IsLongRunningTransaction |
System.Boolean |
Indicates whether this operation is long-running. If this is set to true, the ID can be populated in a two-step process rather than retrieved in a single synchronous call. |
true, false |
||
MethodInstance |
FileNameField |
System.String |
Specifies the field in the entity that contains the name of the "file" that should be shown to the user in the SharePoint Server user interface. (The user clicks the file name, if available, to access the stream content.) |
Optional |
None |
A field name. |
MethodInstance |
FileName |
System.String |
Specifies the hard-coded file name that should be used for all StreamAccessor methods on this entity and shown in the SharePoint Server user interface. (The user clicks the file name, if available, to access the stream content.) |
Optional |
None |
A field name. |
MethodInstance |
MIMETypeField |
System.String |
Specifies the name of the field that returns the dynamic MIME type of the stream per entity instance. For example, the MIME type for the resume for candidate1 is "docx" and "pdf" for candidate2. |
Optional |
None |
A field name. |
MethodInstance |
MIMEType |
System.String |
Specifies the static and hard-coded MIME type for the stream. |
Optional |
None |
A field name. |
MethodInstance |
LastDesignedOfficeItemType |
System.String |
Specifies the office item type that the method instance was last designed with inside SharePoint Designer. |
Optional |
None |
None, Appointment, Task, Post, Contact. |
Model |
Discovery |
System.String |
Indicates whether the metadata object is used for data source discovery purposes inside SharePoint Designer, instead of for end-user consumption. |
Optional |
None |
The values of this property are ignored. |
TypeDescriptor |
ComplexFormatting |
System.Boolean |
Indicates whether the complex structure must be converted to a single string based on FormatString. |
Optional |
false |
true, false |
TypeDescriptor |
FormatString |
System.String |
Specifies the .NET format string where individual format specifiers, for example, {0} {1}, correspond to type descriptors in the order that they appear. |
Optional |
None |
A .NET format string with enough parameters for the type descriptor leaves; that is, for the type descriptors that have no child type descriptors. |
TypeDescriptor |
RendererDefinition |
System.String |
Specifies the assembly-qualified name of the class that implements the formatting logic. |
Optional |
None |
An assembly-qualified name. |
TypeDescriptor |
SuppressCrawl |
existential |
Specifies that the value of the TypeDescriptor and any nested fields will not be indexed. |
Optional |
None |
The value of this property is ignored. If this property is present, the value of the TypeDescriptor is not indexed. |
TypeDescriptor |
ShowInPicker |
System.Boolean |
Specifies whether this TypeDescriptor must be included as a column in the picker control. |
Optional |
false |
true, false |
TypeDescriptor |
HideInListWebPartByDefault |
System.Boolean |
Indicates whether the field is hidden by default in the list Web part, in the initial configuration of the list Web part. |
Optional |
false |
true, false |
TypeDescriptor |
HideInItemWebPartByDefault |
System.Boolean |
Indicates whether the field is hidden by default in the item Web part, in the initial configuration of the item Web part. |
Optional |
false |
true, false |
TypeDescriptor |
DisplayByDefault |
System.Boolean |
true, false |
|||
TypeDescriptor |
LogicalOperatorWithPrevious |
System.String |
Specifies the logical operator between this and the previous type descriptor inside the filter editor for SQL Server tables and views, inside SharePoint Designer. |
Optional |
Or |
And, Or |
TypeDescriptor |
Order |
System.Int32 |
Indicates the order of the type descriptor among all type descriptors with logically relatable filters on. This property is used only inside the filter editor for SQL Server tables and views in SharePoint Designer. |
Optional |
-1 |
A 32-bit integer value. |
TypeDescriptor |
Size |
System.Int32 |
Specifies the maximum size of the string used as a hint. The cache creates columns with this length, if possible. |
Optional |
None |
An integer greater or equal to 1. |
TypeDescriptor |
NullEquivalentValueInForms |
Object |
Specifies a value used to convert null values to null. Values in the cache are converted to the value specified by this property before being propagated to the MAPI store. Conversely, the converted null-equivalent values in the MAPI store are converted back to null before being propagated back to the cache. |
Optional |
||
TypeDescriptor |
DecimalDigits |
System.Int32 |
Specifies the number of digits after the decimal point. If this property is not specified for a decimal field in the BDC model, the cache by default assumes the value 4. If there are more than four digits after the decimal point, BDC rounds up the values in the cache, which can lead to potential data loss. Set this property in the BDC model if your model contains decimal fields. |
Optional |
4 |
An integer between the values of 1 and 28. |
TypeDescriptor |
RequiredInForms |
System.Boolean |
Specifies a UI hint that indicates whether the form submission should be prevented if a value is not provided. |
Optional |
true |
true, false |
TypeDescriptor |
SPCustomFieldType |
System.String |
Specifies the name of a SharePoint custom field type to be used for this TypeDescriptor in an external list. Add this property to a TypeDescriptor in the return parameter of a SpecificFinder method when using a custom field type. This property has no effect on methods other than the SpecificFinder. For more information about custom field types, see Custom Field Types. |
Optional |
None |
The name of any installed SharePoint custom field type. |
Note
The CheckAccess stereotype returns an array of type long integer, and each of those values are bitwise ANDed with the value specified in the DisplaySearchResultRightsMask property. If the result of the bitwise AND operation is the same as the value of the DisplaySearchResultRightsMask property, that item can be displayed. The idea is that any of the bits in the vector that are returned by CheckAccess could signal a ‘yes, it’s safe to show,’ and thus which bit we use should be configurable.