SharePoint Integrator V4 - Online Help
SharePoint Integrator V4
Questions / Feedback?

SPSearch Configuration

The component accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.

SPSearch Configuration Settings

CapitalizeFirstLetters:   Whether or not to capitalize the first letter.

This specifies whether or not SharePoint should capitalize the first letter in the query suggestion that is returned. This configuration is false by default.

Note: This configuration is only available for the SharePointServer2010 SharePointVersion.

EnableSpellCheck:   Enables spell checking.

This configuration specifies how the component should apply spell correction to the query text in the search. Valid values for this configuration are:

0Off: No spell checking will occur in the search.
1Suggest: This tell SharePoint to return a list of suggestions along with the specified search results. Note that this will not alter the specified query when performing the search.
2On: This will make spelling corrections to the query before performing the search.

By default, EnableSpellCheck is Off (0).

Note: This configuration is only available for the SharePointServer2010 SharePointVersion.

HighlightQuerySuggestions:   Whether or not to highlight query suggestions.

This configuration tells SharePoint whether to highlight portions of the query suggestions. By default, this configuration is false.

Note: This configuration is only available for the SharePointServer2010 SharePointVersion.

IncludeHighConfidenceResults:   Includes high-confidence results.

When true, SharePoint will include high-confidence results in the result set of a search. By default, configuration is false.

Note: This configuration is only available for SharePointVersions MOSS2007 and SharePointServer2010.

IncludeImplicitAND:   Whether to include a default AND between search terms.

When set to true, SharePoint will include a default AND between search terms in the query string. The default for this configuration is false.

Note: This configuration is only available for SharePointVersions MOSS2007 and SharePointServer2010.

IncludePreQuerySuggestions:   Includes pre-query suggestions.

When set to true, this configuration will include pre-query suggestions in the search results. The default for this configuration is false.

Note: This configuration is only available for the SharePointServer2010 SharePointVersion.

IncludeRelevantResults:   Includes relevant results.

This tells SharePoint whether or not to include relevant results in the search query. The default for this configuration is true.

IncludeSpecialTermResults:   Includes special term results.

When true, SharePoint will include special term results from the search query. The default for this configuration is false.

Note: This configuration is only available for SharePointVersions MOSS2007 and SharePointServer2010.

ResubmitFlags:   Specifies how to handle resubmissions.

This configuration tells the component how to handle resubmissions when no results are retrieved from the search.

The following flags are defined (specified in hexadecimal notation). They can be or-ed together to include multiple conditions:

0x00000001 NoResubmit
0x00000002 EnableSpellcheckOnResubmit
0x00000004 EnableSpellcheckSuggestOnResubmit
0x00000008 EnableStemmingOnResubmit
0x00000010 AddSynonymsAutomatically

By default, the value is NoResubmit (1) which means no resubmission will occur.

Note: This configuration is only available for the SharePointServer2010 SharePointVersion.

ResultProvider:   The result provider to use.

This configuration specifies which result provider will be used for the query service within SharePoint. Valid values for this configuration are:

0Default: The default provider which is configured in the administrative interfaces.
1SharePointSearch: This is the SharePoint Server search provider.
2FASTSearch: This is the FAST Search Server 2010 for SharePoint provider.

Note: When performing People Search queries, use the SharePointSearch (1) ResultProvider, even if FAST Search Server 2010 is the back-end search provider.

Note: This configuration is only available for the SharePointServer2010 SharePointVersion.

ResultType:   The result type of the current search result.

Possible values are RelevantResults, SpecialTermResults and HighConfidenceResults.

ElapsedTime:   The total time (in milliseconds) used for the search.

After Search is called this setting will return the time in milliseconds that the search took.

IsTotalResultsExact:   Determines if the TotalResults is exact.

This setting returns true after a call to Search if TotalResults represents the exact number of results.

FormBasedCookies:   Holds the security cookies for Form-Based Authentication.

This setting is automatically populated when AuthScheme is set to form based and a method is called. If this setting is populated before calling a method, the component will use the specified cookies.

If the cookies specified in this setting become invalid, set this to an empty string to clear the cookies before re-attempting authentication.

SPOnlineSecurityCookies:   Holds the security cookies for SharePoint Online.

This setting is automatically populated when AuthScheme is set to SPOnline and a method is called. If this setting is populated before calling a method the component will use the specified cookies.

If the cookies specified in this setting become invalid, set this to empty string to clear the cookies before re-attempting authentication.

SPOnlineSSO:   Whether to use Single Sign On (SSO) with Active Directory Federation Services (ADFS).

This setting may be set to True to use Single Sign On with Active Directory Federation Services (ADFS) to authenticate to SharePoint Online. This is only applicable when AuthScheme is set to SPOnline. URL should be set to the SharePoint Online site URL. For instance:

list.URL = "https://mycrm.sharepoint.com";
list.User = "test@test.com";
list.AuthScheme = SplistAuthSchemes.authSPOnline;
list.Config("SPOnlineSSO=true");
list.Config("FollowRedirects=1");
list.List = "MyCustomList";
list.ListItems();
You may also generate and use SPOnlineSecurityCookies. For instance:
list.URL = "https://mycrm.sharepoint.com";
list.User = "test@test.com";
list.AuthScheme = SplistAuthSchemes.authSPOnline;
list.Config("SPOnlineSSO=true");
list.Config("FollowRedirects=1");
String cookie = list.Config("SPOnlineSecurityCookies");

...

list2.URL = "https://mycrm.sharepoint.com";
list2.Config("HttpCookies=" + cookie);
list2.AuthScheme = SplistAuthSchemes.authNone;
list2.Config("FollowRedirects=1");
list2.List = "MyCustomList";
list2.ListItems();

The default value is False.

SPOnlineSTS:   The URL of the online STS.

This setting specifies the URL of the online STS. The default value is "https://login.microsoftonline.com/rst2.srf".

SPOnlineADFSAuthScheme:   The HTTP authentication scheme used when working with SSO.

This setting controls the HTTP authentication scheme used when connecting to SharePoint online using SSO. This is only applicable if SPOnlineSSO is set to True. Possible values are:

  • 0 (Basic)
  • 1 (Digest)
  • 2 (Proprietary)
  • 3 (None)
  • 4 (NTLM - Default)
  • 5 (Negotiate/Kerberos)
  • 6 (OAuth)
SSODomain:   Specifies the federation domain configured in Office 365.

SSODomain should be set to "OneLogin" when authenticating SharePoint Online via Office 365 through OneLogin Single Sign-On.

Base Configuration Settings

CodePage:   The system code page used for Unicode to Multibyte translations.

The default code page is the Active Code Page (0).

The following is a list of valid code page identifiers:

IdentifierName
037IBM EBCDIC - U.S./Canada
437OEM - United States
500IBM EBCDIC - International
708Arabic - ASMO 708
709Arabic - ASMO 449+, BCON V4
710Arabic - Transparent Arabic
720Arabic - Transparent ASMO
737OEM - Greek (formerly 437G)
775OEM - Baltic
850OEM - Multilingual Latin I
852OEM - Latin II
855OEM - Cyrillic (primarily Russian)
857OEM - Turkish
858OEM - Multlingual Latin I + Euro symbol
860OEM - Portuguese
861OEM - Icelandic
862OEM - Hebrew
863OEM - Canadian-French
864OEM - Arabic
865OEM - Nordic
866OEM - Russian
869OEM - Modern Greek
870IBM EBCDIC - Multilingual/ROECE (Latin-2)
874ANSI/OEM - Thai (same as 28605, ISO 8859-15)
875IBM EBCDIC - Modern Greek
932ANSI/OEM - Japanese, Shift-JIS
936ANSI/OEM - Simplified Chinese (PRC, Singapore)
949ANSI/OEM - Korean (Unified Hangeul Code)
950ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC)
1026IBM EBCDIC - Turkish (Latin-5)
1047IBM EBCDIC - Latin 1/Open System
1140IBM EBCDIC - U.S./Canada (037 + Euro symbol)
1141IBM EBCDIC - Germany (20273 + Euro symbol)
1142IBM EBCDIC - Denmark/Norway (20277 + Euro symbol)
1143IBM EBCDIC - Finland/Sweden (20278 + Euro symbol)
1144IBM EBCDIC - Italy (20280 + Euro symbol)
1145IBM EBCDIC - Latin America/Spain (20284 + Euro symbol)
1146IBM EBCDIC - United Kingdom (20285 + Euro symbol)
1147IBM EBCDIC - France (20297 + Euro symbol)
1148IBM EBCDIC - International (500 + Euro symbol)
1149IBM EBCDIC - Icelandic (20871 + Euro symbol)
1200Unicode UCS-2 Little-Endian (BMP of ISO 10646)
1201Unicode UCS-2 Big-Endian
1250ANSI - Central European
1251ANSI - Cyrillic
1252ANSI - Latin I
1253ANSI - Greek
1254ANSI - Turkish
1255ANSI - Hebrew
1256ANSI - Arabic
1257ANSI - Baltic
1258ANSI/OEM - Vietnamese
1361Korean (Johab)
10000MAC - Roman
10001MAC - Japanese
10002MAC - Traditional Chinese (Big5)
10003MAC - Korean
10004MAC - Arabic
10005MAC - Hebrew
10006MAC - Greek I
10007MAC - Cyrillic
10008MAC - Simplified Chinese (GB 2312)
10010MAC - Romania
10017MAC - Ukraine
10021MAC - Thai
10029MAC - Latin II
10079MAC - Icelandic
10081MAC - Turkish
10082MAC - Croatia
12000Unicode UCS-4 Little-Endian
12001Unicode UCS-4 Big-Endian
20000CNS - Taiwan
20001TCA - Taiwan
20002Eten - Taiwan
20003IBM5550 - Taiwan
20004TeleText - Taiwan
20005Wang - Taiwan
20105IA5 IRV International Alphabet No. 5 (7-bit)
20106IA5 German (7-bit)
20107IA5 Swedish (7-bit)
20108IA5 Norwegian (7-bit)
20127US-ASCII (7-bit)
20261T.61
20269ISO 6937 Non-Spacing Accent
20273IBM EBCDIC - Germany
20277IBM EBCDIC - Denmark/Norway
20278IBM EBCDIC - Finland/Sweden
20280IBM EBCDIC - Italy
20284IBM EBCDIC - Latin America/Spain
20285IBM EBCDIC - United Kingdom
20290IBM EBCDIC - Japanese Katakana Extended
20297IBM EBCDIC - France
20420IBM EBCDIC - Arabic
20423IBM EBCDIC - Greek
20424IBM EBCDIC - Hebrew
20833IBM EBCDIC - Korean Extended
20838IBM EBCDIC - Thai
20866Russian - KOI8-R
20871IBM EBCDIC - Icelandic
20880IBM EBCDIC - Cyrillic (Russian)
20905IBM EBCDIC - Turkish
20924IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol)
20932JIS X 0208-1990 & 0121-1990
20936Simplified Chinese (GB2312)
21025IBM EBCDIC - Cyrillic (Serbian, Bulgarian)
21027Extended Alpha Lowercase
21866Ukrainian (KOI8-U)
28591ISO 8859-1 Latin I
28592ISO 8859-2 Central Europe
28593ISO 8859-3 Latin 3
28594ISO 8859-4 Baltic
28595ISO 8859-5 Cyrillic
28596ISO 8859-6 Arabic
28597ISO 8859-7 Greek
28598ISO 8859-8 Hebrew
28599ISO 8859-9 Latin 5
28605ISO 8859-15 Latin 9
29001Europa 3
38598ISO 8859-8 Hebrew
50220ISO 2022 Japanese with no halfwidth Katakana
50221ISO 2022 Japanese with halfwidth Katakana
50222ISO 2022 Japanese JIS X 0201-1989
50225ISO 2022 Korean
50227ISO 2022 Simplified Chinese
50229ISO 2022 Traditional Chinese
50930Japanese (Katakana) Extended
50931US/Canada and Japanese
50933Korean Extended and Korean
50935Simplified Chinese Extended and Simplified Chinese
50936Simplified Chinese
50937US/Canada and Traditional Chinese
50939Japanese (Latin) Extended and Japanese
51932EUC - Japanese
51936EUC - Simplified Chinese
51949EUC - Korean
51950EUC - Traditional Chinese
52936HZ-GB2312 Simplified Chinese
54936Windows XP: GB18030 Simplified Chinese (4 Byte)
57002ISCII Devanagari
57003ISCII Bengali
57004ISCII Tamil
57005ISCII Telugu
57006ISCII Assamese
57007ISCII Oriya
57008ISCII Kannada
57009ISCII Malayalam
57010ISCII Gujarati
57011ISCII Punjabi
65000Unicode UTF-7
65001Unicode UTF-8

The following is a list of valid code page identifiers for Mac OS only:

IdentifierName
1ASCII
2NEXTSTEP
3JapaneseEUC
4UTF8
5ISOLatin1
6Symbol
7NonLossyASCII
8ShiftJIS
9ISOLatin2
10Unicode
11WindowsCP1251
12WindowsCP1252
13WindowsCP1253
14WindowsCP1254
15WindowsCP1250
21ISO2022JP
30MacOSRoman
10UTF16String
0x90000100UTF16BigEndian
0x94000100UTF16LittleEndian
0x8c000100UTF32String
0x98000100UTF32BigEndian
0x9c000100UTF32LittleEndian
65536Proprietary

 
 
Copyright (c) 2017 /n software inc. - All rights reserved.
Build 4.0.6240.0