Connection String Options
The following is the full list of the options you can configure in the connection string for this provider.
| The scheme used for authentication. Accepted entries are NTLM, BASIC, DIGEST, NONE, and NEGOTIATE. |
| The unique identifier of the company to access as a data source. |
| A password used to authenticate to a proxy-based firewall. |
| The TCP port for a proxy-based firewall. |
| The name or IP address of a proxy-based firewall. |
| The protocol used by a proxy-based firewall. |
| The user name to use to authenticate with a proxy-based firewall. |
| A boolean indicating if errors on Ids that are looked up should be ignored. |
| A path to the directory that contains the schema files defining tables, views, and stored procedures. |
| Core modules to be included in the log file. |
| A boolean indicating if ids should be looked up. |
| 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 other parameters necessary to connect to a data source, such as username and password, when applicable. |
| The password for the user connecting to Dynamics GP. |
| The authentication type to use to authenticate to the ProxyServer proxy. |
| 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. |
| A semicolon separated list of hosts or IPs that will be exempt from connecting through the ProxyServer . |
| A password to be used to authenticate to the ProxyServer proxy. |
| The TCP port the ProxyServer proxy is running on. |
| The hostname or IP address of a proxy to route HTTP traffic through. |
| The SSL type to use when connecting to the ProxyServer proxy. |
| A user name to be used to authenticate to the ProxyServer proxy. |
| The certificate to be accepted from the server when connecting using TLS/SSL. |
| The value in seconds until the timeout error is thrown, canceling the operation. |
| The URL of the Dynamics GP server. |
| The user that is authenticating to the Dynamics GP Web Services. |
Auth Scheme
The scheme used for authentication. Accepted entries are NTLM, BASIC, DIGEST, NONE, and NEGOTIATE.
Data Type
string
Default Value
"WSS"
Remarks
Together with Password and User, this field is used to authenticate against the server. WSS is the default option. Use the following options to select your authentication scheme:
• WSS: Set this to use WS-SECURITY encryption for SOAP messages.
• NTLM: Set this to use your Windows credentials to authenticate.
• BASIC: Set this to use HTTP Basic authentication.
• NEGOTIATE: If
• AuthScheme is set to NEGOTIATE, the adapter will negotiate an authentication mechanism with the server. Set AuthScheme to NEGOTIATE to use Kerberos authentication.
• DIGEST: Set this to use HTTP Digest authentication.
Company Id
The unique identifier of the company to access as a data source.
Data Type
string
Default Value
""
Remarks
This property is required to connect. You can obtain this value in the company setup window: Click Tools -> Setup -> Company.
Firewall Password
A password used to authenticate to a proxy-based firewall.
Data Type
string
Default Value
""
Remarks
This property is passed to the proxy specified by FirewallServer and FirewallPort, following the authentication method specified by FirewallType.
Firewall Port
The TCP port for a proxy-based firewall.
Data Type
string
Default Value
""
Remarks
This specifies the TCP port for a proxy allowing traversal of a firewall. Use FirewallServer to specify the name or IP address. Specify the protocol with FirewallType.
Firewall Server
The name or IP address of a proxy-based firewall.
Data Type
string
Default Value
""
Remarks
This property specifies the IP address, DNS name, or host name of a proxy allowing traversal of a firewall. The protocol is specified by FirewallType: Use FirewallServer with this property to connect through SOCKS or do tunneling. Use ProxyServer to connect to an HTTP proxy.
Note that the adapter uses the system proxy by default. To use a different proxy, set ProxyAutoDetect to false.
Firewall Type
The protocol used by a proxy-based firewall.
Data Type
string
Default Value
"NONE"
Remarks
This property specifies the protocol that the adapter will use to tunnel traffic through the FirewallServer proxy. 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 ProxyAutoDetect to false.
Type | Default Port | Description |
TUNNEL | 80 | When this is set, the adapter opens a connection to Microsoft Dynamics GP and traffic flows back and forth through the proxy. |
SOCKS4 | 1080 | When this is set, the adapter sends data through the SOCKS 4 proxy specified by FirewallServer and FirewallPort and passes the FirewallUser value to the proxy, which determines if the connection request should be granted. |
SOCKS5 | 1080 | When this is set, the adapter sends data through the SOCKS 5 proxy specified by FirewallServer and FirewallPort. If your proxy requires authentication, set FirewallUser and FirewallPassword to credentials the proxy recognizes. |
To connect to HTTP proxies, use ProxyServer and ProxyPort. To authenticate to HTTP proxies, use ProxyAuthScheme, ProxyUser, and ProxyPassword.
Firewall User
The user name to use to authenticate with a proxy-based firewall.
Data Type
string
Default Value
""
Remarks
The FirewallUser and FirewallPassword properties are used to authenticate against the proxy specified in FirewallServer and FirewallPort, following the authentication method specified in FirewallType.
Ignore Lookup Id Errors
A boolean indicating if errors on Ids that are looked up should be ignored.
Data Type
bool
Default Value
true
Remarks
Sometimes Microsoft Dynamics GP will throw exceptions when looking up a specific Id. This can indicate that there is an internal problem with the record, even though it is listed just fine along with all of the rest when it is not looked up by Id. To allow the Microsoft Dynamics GP Adapter to work without interruption, these errors are ignored by default and simply logged. Set this property to false to force the Microsoft Dynamics GP Adapter to throw an error when there is a problem.
This property is also used when retrieving data from a child table. Child tables must always be retrieved by id as they do not come back in the summary responses that list all parent items.
Location
A path to the directory that contains the schema files defining tables, views, and stored procedures.
Data Type
string
Default Value
""
Remarks
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.
Log Modules
Core modules to be included in the log file.
Data Type
string
Default Value
""
Remarks
Only the modules specified (separated by ';') will be included in the log file. By default all modules are included.
Lookup Ids
A boolean indicating if ids should be looked up.
Data Type
bool
Default Value
false
Remarks
Most entities are retrieved via a summary from DynamicsGP. However, these summaries are incomplete. To get back more details such as line items, entities must be retrieved one at a time by Id. Setting this value to true will cause the tool to perform this lookup automatically, although it will harm performance.
Max Rows
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.
Data Type
int
Default Value
-1
Remarks
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.
Other
The other parameters necessary to connect to a data source, such as username and password, when applicable.
Data Type
string
Default Value
""
Remarks
The Other property is a semicolon-separated list of name-value pairs used in connection parameters specific to a data source.
Integration and Formatting
DefaultColumnSize | Sets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000. |
ConvertDateTimeToGMT | Whether to convert date-time values to GMT, instead of the local time of the machine. |
RecordToFile=filename | Records the underlying socket data transfer to the specified file. |
Password
The password for the user connecting to Dynamics GP.
Data Type
string
Default Value
""
Remarks
This property is required to connect.
Proxy Auth Scheme
The authentication type to use to authenticate to the ProxyServer proxy.
Data Type
string
Default Value
"BASIC"
Remarks
This value specifies the authentication type to use to authenticate to the HTTP proxy specified by ProxyServer and ProxyPort.
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 ProxyAutoDetect to false, in addition to ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, 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.
Proxy Auto Detect
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.
Data Type
bool
Default Value
true
Remarks
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.
Proxy Exceptions
A semicolon separated list of hosts or IPs that will be exempt from connecting through the ProxyServer .
Data Type
string
Default Value
""
Remarks
The ProxyServer 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 ProxyAutoDetect to false, and configure ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.
Proxy Password
A password to be used to authenticate to the ProxyServer proxy.
Data Type
string
Default Value
""
Remarks
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 ProxyServer and ProxyPort. To specify the authentication type, set ProxyAuthScheme.
If you are using HTTP authentication, additionally set ProxyUser and ProxyPassword to HTTP proxy.
If you are using NTLM authentication, set ProxyUser and ProxyPassword 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 ProxyAutoDetect to false.
Proxy Port
The TCP port the ProxyServer proxy is running on.
Data Type
string
Default Value
"80"
Remarks
The port the HTTP proxy is running on that you want to redirect HTTP traffic through. Specify the HTTP proxy in
ProxyServer. For other proxy types, see
Firewall Type.
Proxy Server
The hostname or IP address of a proxy to route HTTP traffic through.
Data Type
string
Default Value
""
Remarks
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 ProxyAutoDetect to false.
Proxy SSL Type
The SSL type to use when connecting to the ProxyServer proxy.
Data Type
string
Default Value
"AUTO"
Remarks
This property determines when to use SSL for the connection to an HTTP proxy specified by ProxyServer. This value can be AUTO, ALWAYS, NEVER, or TUNNEL. The applicable values are the following:
AUTO | Default setting. If the URL is an HTTPS URL, the adapter will use the TUNNEL option. If the URL is an HTTP URL, the component will use the NEVER option. |
ALWAYS | The connection is always SSL enabled. |
NEVER | The connection is not SSL enabled. |
TUNNEL | The connection is through a tunneling proxy: The proxy server opens a connection to the remote host and traffic flows back and forth through the proxy. |
Proxy User
A user name to be used to authenticate to the ProxyServer proxy.
Data Type
string
Default Value
""
Remarks
The ProxyUser and ProxyPassword options are used to connect and authenticate against the HTTP proxy specified in ProxyServer.
You can select one of the available authentication types in ProxyAuthScheme. 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:
user@domain
domain\user
SSL Server Cert
The certificate to be accepted from the server when connecting using TLS/SSL.
Data Type
string
Default Value
""
Remarks
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:
Description | Example |
A full PEM Certificate (example shortened for brevity) | -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE----- |
A path to a local file containing the certificate | C:\cert.cer |
The public key (example shortened for brevity) | -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY----- |
The MD5 Thumbprint (hex values can also be either space or colon separated) | ecadbdda5a1529c58a1e9e09828d70e4 |
The SHA1 Thumbprint (hex values can also be either space or colon separated) | 34a929226ae0819f2ec14b4a3d904f801cbb150d |
If not specified, any certificate trusted by the machine will be accepted. Use '*' to signify to accept all certificates (not recommended for security concerns).
Timeout
The value in seconds until the timeout error is thrown, canceling the operation.
Data Type
string
Default Value
"60"
Remarks
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.
Url
The URL of the Dynamics GP server.
Data Type
string
Default Value
""
Remarks
This property is required to connect. The full path must be specified. For example, http://{servername}:{port}/Dynamics/GPService.
User
The user that is authenticating to the Dynamics GP Web Services.
Data Type
string
Default Value
""
Remarks
This property is required to connect.