Adding a Connection to e-Sales Manager Remix

To add a connection to e-Sales Manager Remix:

1. In the application console, navigate to the Connections page.
2. At the Add Connections panel, select the icon for the connection you want to add.
3. If the e-Sales Manager Remix icon is not available, click the Add More icon to download and install the e-Sales Manager Remix connector from the CData site.

For required properties, see the Settings tab.

For connection properties that are not typically required, see the Advanced tab.

Connecting to e-Sales Manager Remix

Set the following to connect:

• User: Set this to the username of the authenticating account.
• Password: Set this to password of the user of the authenticating account.
• URL: Set this to the URL of your e-Sales Manager Remix endpoint. For example: https://XXX.softbrain.co.jp.
• TenantId: Set this to tenant Id of the tenant the authenticating user is associated with.

This section details a selection of advanced features of the e-Sales Manager Remix Sync App.

User Defined Views

The Sync App supports the use of user defined views, virtual tables whose contents are decided by a pre-configured user defined query. These views are useful when you cannot directly control queries being issued to the drivers. For an overview of creating and configuring custom views, see User Defined Views .

SSL Configuration

Use SSL Configuration to adjust how Sync App handles TLS/SSL certificate negotiations. You can choose from various certificate formats;. For further information, see the SSLServerCert property under "Connection String Options" .

Firewall and Proxy

Configure the Sync App for compliance with Firewall and Proxy, including Windows proxies and HTTP proxies. You can also set up tunnel connections.

Query Processing

The Sync App offloads as much of the SELECT statement processing as possible to e-Sales Manager Remix and then processes the rest of the query in memory (client-side).

For further information, see Query Processing.

Logging

For an overview of configuration settings that can be used to refine CData logging, see Logging. Only two connection properties are required for basic logging, but there are numerous features that support more refined logging, which enables you to use the LogModules connection property to specify subsets of information to be logged.

Customizing the SSL Configuration

By default, the Sync App attempts to negotiate TLS with the server. The server certificate is validated against the default system trusted certificate store. You can override how the certificate gets validated using the SSLServerCert connection property.

To specify another certificate, see the SSLServerCert connection property.

Connecting Through a Firewall or Proxy

HTTP Proxies

To authenticate to an HTTP proxy, set the following:

• ProxyServer: the hostname or IP address of the proxy server that you want to route HTTP traffic through.
• ProxyPort: the TCP port that the proxy server is running on.
• ProxyAuthScheme: the authentication method the Sync App uses when authenticating to the proxy server.
• ProxyUser: the username of a user account registered with the proxy server.
• ProxyPassword: the password associated with the ProxyUser.

Other Proxies

Set the following properties:

• To use a proxy-based firewall, set FirewallType, FirewallServer, and FirewallPort.
• To tunnel the connection, set FirewallType to TUNNEL.
• To authenticate, specify FirewallUser and FirewallPassword.
• To authenticate to a SOCKS proxy, additionally set FirewallType to SOCKS5.

Overview

This section shows the available API objects and provides more information on executing SQL to e-Sales Manager Remix APIs.

Key Features

• The Sync App models e-Sales Manager Remix entities like documents, folders, and groups as relational views, allowing you to write SQL to query e-Sales Manager Remix data.
• Stored procedures allow you to execute operations to e-Sales Manager Remix
• Live connectivity to these objects means any changes to your e-Sales Manager Remix account are immediately reflected when using the Sync App.

The Sync App models the data in e-Sales Manager Remix as a list of tables in a relational database that can be queried using standard SQL statements.

e-Sales Manager Remix Connector for CData Sync Tables

Name	Description
Action	null
Agency	null
Business	null
BusinessDepart	null
BusinessEmpGroup	null
BusinessEmployee	null
BusinessProduct	null
BusinessType	null
Communication	null
CommunicationAction	null
CommunicationProduct	null
Customer	null
CustomerDepart	null
CustomerEmpGroup	null
CustomerEmployee	null
Depart	null
EmpGroup	null
EmpGroupMember	null
EmpLicense	null
Employee	null
EmpRole	null
Person	null
PlanType	null
Post	null
Product	null
Schedule	null
ScheduleType	null
Timeline	null
Todo	null

null

Columns

Name	Type	ReadOnly	Description
ActivityContentCode [KEY]	Int	False	Activity content code
ActivityContentName	String	False	Activity content name
DeleteFlag	Int	False
Order	Int	False

null

Columns

Name	Type	ReadOnly	Description
AgencyCode [KEY]	Int	False
BusinessCode	Int	False
CustomerCode	Int	False
PreviousAgencyCode	Int	False

null

Columns

Name	Type	ReadOnly	Description
BusinessCode [KEY]	Int	False	Business Code
CustomerCode	Int	False	Customer Code
CustomerActivityFlag	Int	False	Customer activity flag
BusinessType	Int	False	Business type
OperationType	Int	False	Type of Operation
OpenClose	Int	False	Open / Close
BusinessName	String	False	Business name
DepartmentName	String	False	Department name
ContactPersonName	String	False	Contact person name
ContactPersonName(KA)	String	False	Contact person name(KA
CustomerReceptionerPost	String	False	Customer receptioner post
ZIPCode	String	False	ZIP code
Address	String	False	Address
Phone	String	False	Phone
Phone2	String	False	Phone2
Extension	String	False	Extension
Fax	String	False	Fax
Email	String	False	email
Details	String	False	Details
ProgressReport	Int	False	Progress report
Probability	Int	False	Probability
EstCloseDate	Date	False	Est. close date
EstOrderAmount	Int	False	Est. order amount
EstPurchasingCost	Int	False	Est. purchasing cost
GrossMargin	Int	False	Gross margin
EmployeeGroup	Int	False	Employee group
EditGroup	Int	False	Edit group
CreatedAt	Datetime	False	Created at
CreatedBy	Int	False	Created by
LastUpdatedAt	Datetime	False	Last updated at
LastUpdatedBy	Int	False	Last updated by
BusinessIDForEmail	String	False	Business ID for e-mail
ReasonForWin	String	False	Reason for win
ReasonForLose	String	False	Reason for lose
BuildingName	String	False	Building name

null

Columns

Name	Type	ReadOnly	Description
BusinessCode [KEY]	Int	False
DepartmentCode	Int	False
AuthorityType	Int	False

null

Columns

Name	Type	ReadOnly	Description
BusinessCode [KEY]	Int	False
EmployeeGroupCode	Int	False
AuthorityType	Int	False

null

Columns

Name	Type	ReadOnly	Description
BussinessInformationCode [KEY]	Int	False
EmployeeCode	Int	False
AuthorityType	Int	False

null

Columns

Name	Type	ReadOnly	Description
ProductCode [KEY]	Int	False
MatterProductCode	Int	False
Quantity	Int	False
UnitPrice	Int	False
OrderAmount	Int	False
EstPurchasingCost	Int	False
ProgressStatus	Int	False
RegistrationDate	Datetime	False
RegisteredBy	Int	False
LastUpdatedAt	Datetime	False
LastUpdatedBy	Int	False
BusinessCode	Int	False

null

Columns

Name	Type	ReadOnly	Description
BusinessTypeCode [KEY]	Int	False
BusinessTypeName	String	False
ProgressManagementFlag	Int	False

null

Columns

Name	Type	ReadOnly	Description
ActivityReportCode [KEY]	Int	False
BusinessCode	Int	False
PersonInCharge	Int	False
Date	Datetime	False
MeetWith	String	False
ActivityTime	Int	False
Progress	Int	False
ProcessType	Int	False
StartTime	Datetime	False
FinishTime	Datetime	False
ReportType	Int	False
CampaignActivityReportCode	Int	False
AccountingInformation	Int	False
Status	Int	False
Recognizer	Int	False
OpenClose	Int	False
CreatedAt	Datetime	False
CreatedBy	Int	False
LastUpdatedAt	Datetime	False
LastUpdatedBy	Int	False
Probability	Int	False
EstCloseDate	Date	False
OrderValue	Int	False
EstPurchasingCost	Int	False
GrossMargin	Int	False
Details	String	False
ReasonForSales	String	False
ReasonForLose	String	False
NextSchedule	Date	False
NextToDo	Date	False

null

Columns

Name	Type	ReadOnly	Description
ActivityContent [KEY]	Int	False
ActivityTime	Int	False
OrderEmployee	Int	False

null

Columns

Name	Type	ReadOnly	Description
CommunicationSheetProductCode [KEY]	Int	False
Progress	Int	False
Quantity	Int	False
UnitPrice	Int	False
EstOrderAmount	Int	False
EstPurchasingCost	Int	False
ActivityReportCode	Int	False
ProductCode	Int	False

null

Columns

Name	Type	ReadOnly	Description
Id [KEY]	Int	False
Type	Int	False
Name	String	False
OtherName	String	False
PostalCode	String	False
Address	String	False
PhoneNumber	String	False
PhoneNumber2	String	False
FAX	String	False
URL	String	False
ListedFlag	Int	False
RepresentativeName	String	False
OtherRepresentativeName	String	False
CreatedDate	Date	False
Capital	Int	False
NumberOfEmployees	Int	False
Details	String	False
RegistrationDate	Datetime	False
RegisteredPerson	Int	False
UpdatedAt	Datetime	False
UpdatedBy	Int	False
ConfirmationFlag	Int	False
Agencyflag	Int	False
Rank	Int	False
Industry	Int	False
BuildingName	String	False

null

Columns

Name	Type	ReadOnly	Description
CustomerCode [KEY]	Int	False
DepartmentCode	Int	False
AuthorityType	Int	False

null

Columns

Name	Type	ReadOnly	Description
CustomerCode [KEY]	Int	False
EmployeeGroupCode	Int	False
AuthorityType	Int	False

null

Columns

Name	Type	ReadOnly	Description
CustomerCode [KEY]	Int	False
EmployeeCode	Int	False
AuthorityType	Int	False

null

Columns

Name	Type	ReadOnly	Description
DepartCode [KEY]	Int	False
Department	String	False
DepartmentBelongCode	Int	False
DepartmentDisplayOrder	Int	False
DepartNumber	String	False
DeleteFlag	Int	False

null

Columns

Name	Type	ReadOnly	Description
EmployeeGroupCode [KEY]	Int	False
GroupName	String	False
EmployeeGroupType	Int	False
SharedFlag	Int	False
CreatorEmployeeCode	Int	False
DisplayOrder	Int	False

null

Columns

Name	Type	ReadOnly	Description
EmployeeGroupMembersCode [KEY]	Int	False
EmployeeGroupCode	Int	False
EmployeeCode	Int	False
Express	Int	False

null

Columns

Name	Type	ReadOnly	Description
EmployeeCode [KEY]	Int	False
LicenseCode	Int	False

null

Columns

Name	Type	ReadOnly	Description
EmployeeCode [KEY]	Int	False
EmployeeNumber	String	False
EmployeeName	String	False
EmployeeAlias	String	False
JobTitle	Int	False
DepartmentName	Int	False
ZIPCode	String	False
Address	String	False
Phone	String	False
MobilePhone	String	False
Phone3	String	False
Email	String	False
Password	String	False
MainTask	Int	False
PortableTerminalID	String	False
TimeZone	String	False
DateFormat	Int	False
Language	String	False
HolidayTemplate	Int	False
BuildingName	String	False
RegistrationDate	Datetime	False
RegistrantEmployeeCode	Int	False
UpdatedAt	Datetime	False
UpdatedBy	Int	False

null

Columns

Name	Type	ReadOnly	Description
EmployeeCode [KEY]	Int	False
RollCode	Int	False

null

Columns

Name	Type	ReadOnly	Description
PersonCode [KEY]	Int	False	Person Code
CustomerCode	Int	False	Customer code
Person(Alias)	String	False	Person(Alias)
PersonName	String	False	Person name
DepartmentName	String	False	Department name
JobTitle	String	False	Job title
ZIPCode	String	False	ZIP code
Address	String	False	Address
Phone	String	False	Phone
Extension	String	False	Extension
Fax	String	False	Fax
MobilePhone	String	False	Mobile phone
CellerPhoneMailAddress	String	False	Celler phone mail address
Email	String	False	email
URL	String	False	URL
Descriptions	String	False	Descriptions
TenureStatus	Int	False	Tenure status
Confirmation	Int	False	Confirmation
Title	Int	False	Title
Deaprtments	Int	False	Deaprtments
Building Name	String	False	Building name
CreatedAt	Datetime	False	Created at
LastUpdatedAt	Datetime	False	Last updated at
Enrollee	Int	False	Enrollee
LastUpdatedBy	Int	False	Last updated by

null

Columns

Name	Type	ReadOnly	Description
Id [KEY]	Int	False
Type	String	False
CustomerSeatTypeCode	Int	False
DeleteFlag	Int	False
ParentMatterBusinessType	Int	False
BusinessSheetTypeDisplayorder	Int	False

null

Columns

Name	Type	ReadOnly	Description
Id [KEY]	Int	False
Title	String	False
PositionDisplayOrder	Int	False
SearchUnusedFlag	Int	False
PostForeignKey	String	False

null

Columns

Name	Type	ReadOnly	Description
ProductCode [KEY]	Int	False
DisplayedOrder	Int	False
CategoryFlag	Int	False
Category1	Int	False
Category2	Int	False
Category3	Int	False
Category4	Int	False
Category5	Int	False
Category6	Int	False
Category7	Int	False
Category8	Int	False
Category9	Int	False
Category10	Int	False
Depth	Int	False
BelongingCategory	Int	False
ProductName	String	False
Unit	Int	False
DisplayFlag	Int	False
CreatedAt	Datetime	False
CreatedBy	Int	False
UpdatedAt	Datetime	False
UpdatedBy	Int	False

null

Columns

Name	Type	ReadOnly	Description
ScheduleCode [KEY]	Int	False
EmployeeNumber	Int	False
ScheduleStartDatetime	Datetime	False
ScheduleEndDatetime	Datetime	False
ScheduleSubject	String	False
PlaceName	String	False
ScheduleContent	String	False
EnrolleeDepartmentCode	Int	False
PostalCode	String	False
Address	String	False
BuildingName	String	False
MeetWith	String	False
ScheduleType	Int	False
BussinessInformationCode	Int	False
LastingOrdinanceScheduleCode	Int	False
ScheduleOpenFlag	Int	False
RegistrationEmployeeCode	Int	False
Participationstatus	Int	False
ResponseMessage	String	False
LoginTime	Datetime	False
TeamScheduleCode	Int	False
Type	Int	False
ProcessType	Int	False
Modifier	Int	False
LastUpdatedAt	Datetime	False
ScheduleChangeFlag	Int	False

null

Columns

Name	Type	ReadOnly	Description
ScheduleTypeCode [KEY]	Int	False
ScheduleTypeName	String	False
DisplayFlag	Int	False
Express	Int	False

null

Columns

Name	Type	ReadOnly	Description
TimelineCode [KEY]	Int	False	Timeline code
TimelineClassification	Int	False	Timeline classification
OwnerCode	Int	False	Owner code
ParentTimelineCode	Int	False	Parent timeline code
RegistrationDate	Datetime	False	Date of registration
RegistrantEmployeeCode	Int	False	Registrant employee code
LastUpdatedAt	Datetime	False	Update Date
ModifierEmployeeCode	Int	False	Modifier employee code
Comment	String	False	Comment
TimelineGroupCode	Int	False	Timeline group code

null

Columns

Name	Type	ReadOnly	Description
Id [KEY]	Int	False
BusinessCode	Int	False
ZipPostalcode	String	False
Address	String	False
BuildingName	String	False
ContactPerson	String	False
ProcessType	Int	False
DueDate	Date	False
CompletionDate	Date	False
Priority	Int	False
AlertDate	Int	False
To-doDetails	String	False
HiddenFlag	Int	False
AssignedEmployee	Int	False
TeamToDoCode	Int	False
CreatedAt	Datetime	False
CreatedBy	Int	False
UpdatedAt	Datetime	False
UpdatedBy	Int	False

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider. Click the links for further details.

For more information on establishing a connection, see Establishing a Connection.

Authentication

---

Property	Description
AuthScheme	Whether to connect to ESalesmanager with Basic or APIToken Authentication.
URL	The URL to your ESales Manager endpoint.
TenantId	The tenant id.
APIToken	APIToken of the currently authenticated user.
User	The e-Sales Manager Remix user account used to authenticate.
Password	The password used to authenticate the user.

SSL

---

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

Firewall

---

Property	Description
FirewallType	The protocol used by a proxy-based firewall.
FirewallServer	The name or IP address of a proxy-based firewall.
FirewallPort	The TCP port for a proxy-based firewall.
FirewallUser	The user name to use to authenticate with a proxy-based firewall.
FirewallPassword	A password used to authenticate to a proxy-based firewall.

Proxy

---

Property	Description
ProxyAutoDetect	When this connection property is set to True, the provider checks your system proxy settings for existing proxy server configurations (no need to manually supply proxy server details). Set to False if you want to manually configure the provider to connect to a specific proxy server.
ProxyServer	The hostname or IP address of the proxy server that you want to route HTTP traffic through.
ProxyPort	The TCP port that the proxy server (specified in the ProxyServer connection property) is running on.
ProxyAuthScheme	The authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.
ProxyUser	The username of a user account registered with the proxy server specified in the ProxyServer connnection property.
ProxyPassword	The password associated with the user specified in the ProxyUser connection property.
ProxySSLType	The SSL type to use when connecting to the ProxyServer proxy.
ProxyExceptions	A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .

Logging

---

Property	Description
LogModules	Core modules to be included in the log file.

Schema

---

Property	Description
Location	A path to the directory that contains the schema files defining tables, views, and stored procedures.
BrowsableSchemas	This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
Tables	This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
Views	Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

Miscellaneous

---

Property	Description
MaxRows	Limits the number of rows returned when no aggregation or GROUP BY is used in the query. LIMIT clauses take precedence over the limit specified in MaxRows.
Other	These hidden properties are used only in specific use cases.
PseudoColumns	Specify a set of pseudocolumns to expose as columns.
Timeout	The value in seconds until the timeout error is thrown, canceling the operation.
UserDefinedViews	A filepath pointing to the JSON configuration file containing your custom views.

This section provides a complete list of the Authentication properties you can configure in the connection string for this provider.

---

Property	Description
AuthScheme	Whether to connect to ESalesmanager with Basic or APIToken Authentication.
URL	The URL to your ESales Manager endpoint.
TenantId	The tenant id.
APIToken	APIToken of the currently authenticated user.
User	The e-Sales Manager Remix user account used to authenticate.
Password	The password used to authenticate the user.

Whether to connect to ESalesmanager with Basic or APIToken Authentication.

Remarks

• Basic: Set this to perform Basic authentication with User and Password.
• APIToken: Set this to perform APIToken authentication with APIToken.

The URL to your ESales Manager endpoint.

Remarks

The URL to your ESales Manager endpoint.

The tenant id.

Remarks

Together with Password and User , this field is used to authenticate against the ESales Manager server.

APIToken of the currently authenticated user.

Remarks

APIToken of the currently authenticated user.

The e-Sales Manager Remix user account used to authenticate.

Remarks

Together with Password, this field is used to authenticate against the e-Sales Manager Remix server.

The password used to authenticate the user.

Remarks

The User and Password are together used to authenticate with the server.

This section provides a complete list of the SSL properties you can configure in the connection string for this provider.

---

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

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

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 is rejected.

This property can take the following 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 is accepted.

Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.

This section provides a complete list of the Firewall properties you can configure in the connection string for this provider.

---

Property	Description
FirewallType	The protocol used by a proxy-based firewall.
FirewallServer	The name or IP address of a proxy-based firewall.
FirewallPort	The TCP port for a proxy-based firewall.
FirewallUser	The user name to use to authenticate with a proxy-based firewall.
FirewallPassword	A password used to authenticate to a proxy-based firewall.

The protocol used by a proxy-based firewall.

Remarks

This property specifies the protocol that the Sync App will use to tunnel traffic through the FirewallServer proxy. Note that by default, the Sync App 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 Sync App opens a connection to e-Sales Manager Remix and traffic flows back and forth through the proxy.
SOCKS4	1080	When this is set, the Sync App 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 Sync App 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.

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

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 Sync App uses the system proxy by default. To use a different proxy, set ProxyAutoDetect to false.

The TCP port for a proxy-based firewall.

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.

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

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.

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

Remarks

This property is passed to the proxy specified by FirewallServer and FirewallPort, following the authentication method specified by FirewallType.

This section provides a complete list of the Proxy properties you can configure in the connection string for this provider.

---

Property	Description
ProxyAutoDetect	When this connection property is set to True, the provider checks your system proxy settings for existing proxy server configurations (no need to manually supply proxy server details). Set to False if you want to manually configure the provider to connect to a specific proxy server.
ProxyServer	The hostname or IP address of the proxy server that you want to route HTTP traffic through.
ProxyPort	The TCP port that the proxy server (specified in the ProxyServer connection property) is running on.
ProxyAuthScheme	The authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.
ProxyUser	The username of a user account registered with the proxy server specified in the ProxyServer connnection property.
ProxyPassword	The password associated with the user specified in the ProxyUser connection property.
ProxySSLType	The SSL type to use when connecting to the ProxyServer proxy.
ProxyExceptions	A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .

When this connection property is set to True, the provider checks your system proxy settings for existing proxy server configurations (no need to manually supply proxy server details). Set to False if you want to manually configure the provider to connect to a specific proxy server.

Remarks

This connection property takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to False in order to use custom proxy settings.

To connect to an HTTP proxy, see ProxyServer. For other proxies, such as SOCKS or tunneling, see FirewallType.

The hostname or IP address of the proxy server that you want to route HTTP traffic through.

Remarks

The hostname or IP address of a proxy to route HTTP traffic through. The Sync App 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 FirewallType.

By default, the Sync App uses the system proxy. If you need to use another proxy, set ProxyAutoDetect to false.

The TCP port that the proxy server (specified in the ProxyServer connection property) is running on.

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 FirewallType.

The authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.

Remarks

This value specifies the authentication type to use to authenticate to the HTTP proxy specified by ProxyServer and ProxyPort.

The authentication type can be one of the following:

• BASIC: The Sync App performs HTTP BASIC authentication.
• DIGEST: The Sync App performs HTTP DIGEST authentication.
• NEGOTIATE: The Sync App retrieves an NTLM or Kerberos token based on the applicable protocol for authentication.
• PROPRIETARY: The Sync App 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 FirewallType.

The username of a user account registered with the proxy server specified in the ProxyServer connnection property.

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 user name of a user recognized by the HTTP proxy. If you are using Windows or Kerberos authentication, set this property to a user name in one of the following formats:

user@domain
domain\user

The password associated with the user specified in the ProxyUser connection property.

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 FirewallType.

By default, the Sync App uses the system proxy. If you want to connect to another proxy, set ProxyAutoDetect to false.

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

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 Sync App 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.

A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .

Remarks

The ProxyServer is used for all addresses, except for addresses defined in this property. Use semicolons to separate entries.

Note that the Sync App uses the system proxy settings by default, without further configuration needed; if you want to explicitly configure proxy exceptions for this connection, you need to set ProxyAutoDetect = false, and configure ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.

This section provides a complete list of the Logging properties you can configure in the connection string for this provider.

---

Property	Description
LogModules	Core modules to be included in the log file.

Core modules to be included in the log file.

Remarks

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

See the Logging page for an overview.

This section provides a complete list of the Schema properties you can configure in the connection string for this provider.

---

Property	Description
Location	A path to the directory that contains the schema files defining tables, views, and stored procedures.
BrowsableSchemas	This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
Tables	This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
Views	Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

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

Remarks

The path to a directory which contains the schema files for the Sync App (.rsd files for tables and views, .rsb files for stored procedures). The folder location can be a relative path from the location of the executable. The Location property is only needed if you want to customize definitions (for example, change a column name, ignore a column, and so on) or extend the data model with new tables, views, or stored procedures.

If left unspecified, the default location is "%APPDATA%\\CData\\ESalesManager Data Provider\\Schema" with %APPDATA% being set to the user's configuration directory:

Platform	%APPDATA%
Windows	The value of the APPDATA environment variable
Linux	~/.config

This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.

Remarks

Listing the schemas from databases can be expensive. Providing a list of schemas in the connection string improves the performance.

This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.

Remarks

Listing the tables from some databases can be expensive. Providing a list of tables in the connection string improves the performance of the Sync App.

This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.

Specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.

Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.

Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

Remarks

Listing the views from some databases can be expensive. Providing a list of views in the connection string improves the performance of the Sync App.

This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.

Specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.

Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.

This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.

---

Property	Description
MaxRows	Limits the number of rows returned when no aggregation or GROUP BY is used in the query. LIMIT clauses take precedence over the limit specified in MaxRows.
Other	These hidden properties are used only in specific use cases.
PseudoColumns	Specify a set of pseudocolumns to expose as columns.
Timeout	The value in seconds until the timeout error is thrown, canceling the operation.
UserDefinedViews	A filepath pointing to the JSON configuration file containing your custom views.

Limits the number of rows returned when no aggregation or GROUP BY is used in the query. LIMIT clauses take precedence over the limit specified in MaxRows.

Remarks

Limits the number of rows returned when no aggregation or GROUP BY is used in the query. LIMIT clauses take precedence over the limit specified in MaxRows.

These hidden properties are used only in specific use cases.

Remarks

The properties listed below are available for specific use cases. Normal driver use cases and functionality should not require these properties.

Specify multiple properties in a semicolon-separated list.

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	Determines 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.

Specify a set of pseudocolumns to expose as columns.

Remarks

The value of this connection setting is of the format "Table1=Column1;Table1=Column2;Table2=Column3".

You can use the "*" character to include all tables and all columns; for example, "*=*".

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

Remarks

If Timeout = 0, operations do not time out. The operations run until they complete successfully or until they encounter an error condition.

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

A filepath pointing to the JSON configuration file containing your custom views.

Remarks

User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json. The Sync App automatically detects the views specified in this file.

You can also have multiple view definitions and control them using the UserDefinedViews connection property. When you use this property, only the specified views are seen by the Sync App.

This User Defined View configuration file is formatted as follows:

• Each root element defines the name of a view.
• Each root element contains a child element, called query, which contains the custom SQL query for the view.

For example:

{
	"MyView": {
		"query": "SELECT * FROM Customer WHERE MyColumn = 'value'"
	},
	"MyView2": {
		"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
	}
}

Use the UserDefinedViews connection property to specify the location of your JSON configuration file. For example:

"UserDefinedViews", C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json

Note that the specified path is not embedded in quotation marks.