The format aggregate or collection columns should return in.

string

"JSON"

The format aggregate or collection columns should return in.

The name or Id of a page to authenticate as when making requests to Facebook.

string

""

The Id of a page to retrieve data from. The page must be managed by the authenticated user; you can obtain the Ids for all such pages by querying the Pages view.

The OAuth callback URL to return to when authenticating. This value must match the callback URL you specify in your app settings.

string

""

During the authentication process, the OAuth authorization server redirects the user to this URL. This value must match the callback URL you specify in your app settings.

A password used to authenticate to a proxy-based firewall.

string

""

This property is passed to the proxy specified by Firewall Server and Firewall Port, following the authentication method specified by Firewall Port.

The TCP port for a proxy-based firewall.

string

""

This specifies the TCP port for a proxy allowing traversal of a firewall. Use Firewall Server to specify the name or IP address. Specify the protocol with Firewall Type.

The name or IP address of a proxy-based firewall.

string

""

This property specifies the IP address, DNS name, or host name of a proxy allowing traversal of a firewall. The protocol is specified by Firewall Type: Use Firewall Server with this property to connect through SOCKS or do tunneling. Use Proxy Server to connect to an HTTP proxy.

Note that the adapter uses the system proxy by default. To use a different proxy, set Proxy Auto Detect to false.

The protocol used by a proxy-based firewall.

string

"NONE"

This property specifies the protocol that the adapter will use to tunnel traffic through the Firewall Serverproxy. Note that by default the adapter connects to the system proxy; to disable this behavior and connect to one of the following proxy types, set Proxy Auto Detectto false..

 

To connect to HTTP proxies, use Proxy Serverand Proxy Port To authenticate to HTTP proxies, use Proxy Auth Scheme, Proxy User, and Proxy Password.

The user name to use to authenticate with a proxy-based firewall.

string

""

The Firewall User and Firewall Password properties are used to authenticate against the proxy specified in Firewall Server and Firewall Port, following the authentication method specified in Firewall Type.

Set this property to initiate the process to obtain or refresh the OAuth access token when you connect.

string

"OFF"

The following options are available:

OFF: Indicates that the OAuth flow will be handled entirely by the user. An OAuthAccessToken will be required to authenticate.

GETANDREFRESH: Indicates that the entire OAuth Flow will be handled by the adapter. If no token currently exists, it will be obtained by prompting the user via the browser. If a token exists, it will be refreshed when applicable.

REFRESH: Indicates that the adapter will only handle refreshing the OAuthAccessToken. The user will never be prompted by the adapter to authenticate via the browser. The user must handle obtaining the OAuthAccessToken and OAuthRefreshToken initially.

A path to the directory that contains the schema files defining tables, views, and stored procedures.

string

""

The path to a directory which contains the schema files for the adapter (.rsd files for tables and views, .rsb files for stored procedures). The Location property is only needed if you would like to customize definitions (e.g., change a column name, ignore a column, etc.) or extend the data model with new tables, views, or stored procedures.

The schema files are deployed alongside the adapter assemblies. You must also ensure that Location points to the folder that contains the schema files. The folder location can be a relative path from the location of the executable.

Core modules to be included in the log file.

string

""

Only the modules specified (separated by ';') will be included in the log file. By default all modules are included.

Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.

string

"-1"

Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.

The access token for connecting using OAuth.

string

""

The OAuthAccessToken property is used to connect using OAuth. The OAuthAccessToken is retrieved from the OAuth server as part of the authentication process. It has a server-dependent timeout and can be reused between requests.

The access token is used in place of your username and password. The access token protects your credentials by keeping them on the server.

The client Id assigned when you register your application with an OAuth authorization server.

string

""

As part of registering an OAuth application, you will receive the OAuthClientId value, sometimes also called a consumer key, and a client secret, the OAuth Client Secret.

The client secret assigned when you register your application with an OAuth authorization server.

string

""

As part of registering an OAuth application, you will receive the OAuth Client Id, also called a consumer key. You will also receive a client secret, also called a consumer secret. Set the client secret in the OAuth Client Secret property.

The lifetime in seconds of the OAuth AccessToken.

string

""

Pair with OAuthTokenTimestamp to determine when the AccessToken will expire.

The location of the settings file where OAuth values are saved when InitiateOAuth is set to GETANDREFRESH or REFRESH.

string

"%APPDATA%\\CData\\Facebook Data Provider\\OAuthSettings.txt"

When Initiate OAuth is set to GETANDREFRESH or REFRESH, the adapter saves OAuth values to a settings file to avoid requiring the user to manually enter OAuth connection properties. The default OAuthSettingsLocation is a settings file located in the %AppData%\CData folder.

The Unix epoch timestamp in milliseconds when the current Access Token was created.

string

""

Pair with OAuthExpiresIn to determine when the AccessToken will expire.

The verifier code returned from the OAuth authorization URL.

string

""

The verifier code returned from the OAuth authorization URL. This can be used on systems where a browser cannot be launched such as headless systems.

Set OAuth Settings Location along with OAuth Verifier. When you connect, the adapter exchanges the OAuth Verifier for the OAuth authentication tokens and saves them, encrypted, to the specified file. Set Initiate OAuth to GETANDREFRESH automate the exchange.

Once the OAuth settings file has been generated, you can remove OAuth Verifier from the connection properties and connect with OAuth Settings Location set.

To automatically refresh the OAuth token values, set OAuth Settings Location and additionally set Initiate OAuth to REFRESH.

The other parameters necessary to connect to a data source, such as username and password, when applicable.

string

""

The Other property is a semicolon-separated list of name-value pairs used in connection parameters specific to a data source.

The maximum number of results to return per page from Facebook.

string

""

The Pagesize property affects the maximum number of results to return per page from Facebook. Sometimes you may get an error asking you to request less data. The frequency of such errors can be reduced by reducing the pagesize. The maximum pagesize tends to be about 100 per page.

The authentication type to use to authenticate to the ProxyServer proxy.

string

"BASIC"

This value specifies the authentication type to use to authenticate to the HTTP proxy specified by Proxy Server and Proxy Port.

Note that the adapter will use the system proxy settings by default, without further configuration needed; if you want to connect to another proxy, you will need to set Proxy Auto Detect to false, in addition to Proxy Server and Proxy Port. To authenticate, set Proxy Auth Scheme and set Proxy User and Proxy Password, if needed.

The authentication type can be one of the following:

BASIC: The adapter performs HTTP BASIC authentication.

DIGEST: The adapter performs HTTP DIGEST authentication.

NEGOTIATE: The adapter retrieves an NTLM or Kerberos token based on the applicable protocol for authentication.

PROPRIETARY: The adapter does not generate an NTLM or Kerberos token. You must supply this token in the Authorization header of the HTTP request.

If you need to use another authentication type, such as SOCKS 5 authentication, see Firewall Type.

This indicates whether to use the system proxy settings or not. Set ProxyAutoDetect to FALSE to use custom proxy settings. This takes precedence over other proxy settings.

bool

true

By default, the adapter uses the system HTTP proxy. Set this to false if you want to connect to another proxy.

To connect to an HTTP proxy, see Proxy Server.

For other proxies, such as SOCKS or tunneling, see Firewall Type.

A semicolon separated list of hosts or IPs that will be exempt from connecting through the ProxyServer .

string

""

The Proxy Server will be used for all addresses, except for addresses defined in this property. Use semicolons to separate entries.

Note that the adapter will use the system proxy settings by default, without further configuration needed; if you want to explicitly configure proxy exceptions for this connection, you will need to set Proxy Auto Detect to false, and configure Proxy Server and Proxy Port. To authenticate, set Proxy Auth Scheme and set Proxy User and Proxy Password, if needed.

A password to be used to authenticate to the ProxyServer proxy.

string

""

This property is used to authenticate to an HTTP proxy server that supports NTLM (Windows), Kerberos, or HTTP authentication. To specify the HTTP proxy, you can set Proxy Server and Proxy Port. To specify the authentication type, set Proxy Auth Scheme.

If you are using HTTP authentication, additionally set Proxy User and Proxy Password to HTTP proxy.

If you are using NTLM authentication, set Proxy User and Proxy Password to your Windows password. You may also need these to complete Kerberos authentication.

For SOCKS 5 authentication or tunneling, see Firewall Type.

By default, the adapter uses the system proxy. If you want to connect to another proxy, set Proxy Auto Detect to false.

The TCP port the Proxy Server proxy is running on.

string

"80"

The port the HTTP proxy is running on that you want to redirect HTTP traffic through. Specify the HTTP proxy in Proxy Server. For other proxy types, see Firewall Type.

The hostname or IP address of a proxy to route HTTP traffic through.

string

""

The hostname or IP address of a proxy to route HTTP traffic through. The adapter can use the HTTP, Windows (NTLM), or Kerberos authentication types to authenticate to an HTTP proxy.

If you need to connect through a SOCKS proxy or tunnel the connection, see Firewall Type.

By default, the adapter uses the system proxy. If you need to use another proxy, set Proxy Auto Detect to false.

The SSL type to use when connecting to the ProxyServer proxy.

string

"AUTO"

This property determines when to use SSL for the connection to an HTTP proxy specified by Proxy Server. This value can be AUTO, ALWAYS, NEVER, or TUNNEL. The applicable values are the following:

 

A user name to be used to authenticate to the ProxyServer proxy.

string

""

The Proxy User and Proxy Password options are used to connect and authenticate against the HTTP proxy specified in Proxy Server.

You can select one of the available authentication types in Proxy Auth Scheme. If you are using HTTP authentication, set this to the username of a user recognized by the HTTP proxy. If you are using Windows or Kerberos authentication, set this property to a username in one of the following formats:

You can use this property to enforce read-only access to Facebook from the provider.

bool

false

If this property is set to true, the adapter will allow only SELECT queries. INSERT, UPDATE, DELETE, and stored procedure queries will cause an error to be thrown.

The certificate to be accepted from the server when connecting using TLS/SSL.

string

""

If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine will be rejected.

This property can take the forms:

 

If not specified, any certificate trusted by the machine will be accepted. Use '*' to signify to accept all certificates (not recommended for security concerns).

A default target if none is specified. Used for some tables, such as Comments, where a target may be specified.

string

""

A default target if none is specified. Used for some tables, such as Comments, where a target may be specified.

The value in seconds until the timeout error is thrown, canceling the operation.

string

"60"

If the Timeout property is set to 0, operations do not time out: They run until they complete successfully or encounter an error condition.

If Timeout expires and the operation is not yet complete, the adapter throws an exception.

Upload linked photos or videos before inserting a new Post.

bool

false

The UploadLinkedMedia determines whether to upload media before inserting a Post. If set to True, when you attempt to insert a new Post with the Link column, the driver will first attempt to resolve the URL and determine if the URL is referencing a photo or a video. If so, the photo or video will be uploaded first, then a new Post containing the media will be created.If False, then the new Post will be created as a Link Post.

The Facebook Graph API version to use.

string

"2.12"

The Facebook Graph API version to use. Generally this property does not need to be set.