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	Specifies the user ID of the authenticating e-Sales Manager Remix user account.
Password	Specifies the password of the authenticating user account.

SSL

---

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

Firewall

---

Property	Description
FirewallType	Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.
FirewallServer	Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.
FirewallPort	Specifies the TCP port to be used for a proxy-based firewall.
FirewallUser	Identifies the user ID of the account authenticating to a proxy-based firewall.
FirewallPassword	Specifies the password of the user account authenticating to a proxy-based firewall.

Proxy

---

Property	Description
ProxyAutoDetect	Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.
ProxyServer	The hostname or IP address of the proxy server that you want to route HTTP traffic through.
ProxyPort	The TCP port on your specified proxy server (set in the ProxyServer connection property) that has been reserved for routing HTTP traffic to and from the client.
ProxyAuthScheme	Specifies 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 connection property.
ProxyPassword	The password associated with the user specified in the ProxyUser connection property.
ProxySSLType	The SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.
ProxyExceptions	A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.

Logging

---

Property	Description
LogModules	Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.

Schema

---

Property	Description
Location	Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.
BrowsableSchemas	Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
Tables	Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .
Views	Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .

Miscellaneous

---

Property	Description
MaxRows	Specifies the maximum rows returned for queries without aggregation or GROUP BY.
Other	Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties.
PseudoColumns	Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.
Timeout	Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.
UserDefinedViews	Specifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file.

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	Specifies the user ID of the authenticating e-Sales Manager Remix user account.
Password	Specifies the password of the authenticating user account.

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.

Specifies the user ID of the authenticating e-Sales Manager Remix user account.

Remarks

The authenticating server requires both User and Password to validate the user's identity.

Specifies the password of the authenticating user account.

Remarks

The authenticating server requires both User and Password to validate the user's identity.

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

---

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

Specifies 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	Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.
FirewallServer	Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.
FirewallPort	Specifies the TCP port to be used for a proxy-based firewall.
FirewallUser	Identifies the user ID of the account authenticating to a proxy-based firewall.
FirewallPassword	Specifies the password of the user account authenticating to a proxy-based firewall.

Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

Note: 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.

The following table provides port number information for each of the supported protocols.

Protocol	Default Port	Description
TUNNEL	80	The port where the Sync App opens a connection to e-Sales Manager Remix. Traffic flows back and forth via the proxy at this location.
SOCKS4	1080	The port where the Sync App opens a connection to e-Sales Manager Remix. SOCKS 4 then passes theFirewallUser value to the proxy, which determines whether the connection request should be granted.
SOCKS5	1080	The port where the Sync App sends data to e-Sales Manager Remix. If the SOCKS 5 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.

Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

Specifies the TCP port to be used for a proxy-based firewall.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

Identifies the user ID of the account authenticating to a proxy-based firewall.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

Specifies the password of the user account authenticating to a proxy-based firewall.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

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

---

Property	Description
ProxyAutoDetect	Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.
ProxyServer	The hostname or IP address of the proxy server that you want to route HTTP traffic through.
ProxyPort	The TCP port on your specified proxy server (set in the ProxyServer connection property) that has been reserved for routing HTTP traffic to and from the client.
ProxyAuthScheme	Specifies 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 connection property.
ProxyPassword	The password associated with the user specified in the ProxyUser connection property.
ProxySSLType	The SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.
ProxyExceptions	A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.

Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.

Remarks

When this connection property is set to True, the Sync App checks your system proxy settings for existing proxy server configurations (no need to manually supply proxy server details).

This connection property takes precedence over other proxy settings. Set to False if you want to manually configure the Sync App to connect to a specific proxy server.

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 Sync App only routes HTTP traffic through the proxy server specified in this connection property when ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead routes HTTP traffic through the proxy server specified in your system proxy settings.

The TCP port on your specified proxy server (set in the ProxyServer connection property) that has been reserved for routing HTTP traffic to and from the client.

Remarks

The Sync App only routes HTTP traffic through the proxy server port specified in this connection property when ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead routes HTTP traffic through the proxy server port specified in your system proxy settings.

For other proxy types, see FirewallType.

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

Remarks

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.
• NTLM: The Sync App retrieves an NTLM token.
• NEGOTIATE: The Sync App retrieves an NTLM or Kerberos token based on the applicable protocol for authentication.
• NONE: Set this when the ProxyServer does not require authentication.

For all values other than "NONE", you must also set the ProxyUser and ProxyPassword connection properties.

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 connection property.

Remarks

The ProxyUser and ProxyPassword connection properties are used to connect and authenticate against the HTTP proxy specified in ProxyServer.

After selecting one of the available authentication types in ProxyAuthScheme, set this property as follows:

ProxyAuthScheme Value	Value to set for ProxyUser
BASIC	The user name of a user registered with the proxy server.
DIGEST	The user name of a user registered with the proxy server.
NEGOTIATE	The username of a Windows user who is a valid user in the domain or trusted domain that the proxy server is part of, in the format user@domain or domain\user.
NTLM	The username of a Windows user who is a valid user in the domain or trusted domain that the proxy server is part of, in the format user@domain or domain\user.
NONE	Do not set the ProxyPassword connection property.

The Sync App only uses this username if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead uses the username specified in your system proxy settings.

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

Remarks

The ProxyUser and ProxyPassword connection properties are used to connect and authenticate against the HTTP proxy specified in ProxyServer.

After selecting one of the available authentication types in ProxyAuthScheme, set this property as follows:

ProxyAuthScheme Value	Value to set for ProxyPassword
BASIC	The password associated with the proxy server user specified in ProxyUser.
DIGEST	The password associated with the proxy server user specified in ProxyUser.
NEGOTIATE	The password associated with the Windows user account specified in ProxyUser.
NTLM	The password associated with the Windows user account specified in ProxyUser.
NONE	Do not set the ProxyPassword connection property.

For SOCKS 5 authentication or tunneling, see FirewallType.

The Sync App only uses this password if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead uses the password specified in your system proxy settings.

The SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.

Remarks

This property determines when to use SSL for the connection to the HTTP proxy specified by ProxyServer. You can set this connection property to the following values :

AUTO	Default setting. If ProxyServer is set to an HTTPS URL, the Sync App uses the TUNNEL option. If ProxyServer is set to an HTTP URL, the component uses the NEVER option.
ALWAYS	The connection is always SSL enabled.
NEVER	The connection is not SSL enabled.
TUNNEL	The connection is made 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 proxy server set in the ProxyServer connection property.

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, set ProxyAutoDetect to False.

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

---

Property	Description
LogModules	Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.

Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.

Remarks

This property lets you customize the log file content by specifying the logging modules to include. Logging modules categorize logged information into distinct areas, such as query execution, metadata, or SSL communication. Each module is represented by a four-character code, with some requiring a trailing space for three-letter names.

For example, EXEC logs query execution, and INFO logs general provider messages. To include multiple modules, separate their names with semicolons as follows: INFO;EXEC;SSL.

The Verbosity connection property takes precedence over the module-based filtering specified by this property. Only log entries that meet the verbosity level and belong to the specified modules are logged. Leave this property blank to include all available modules in the log file.

For a complete list of available modules and detailed guidance on configuring logging, refer to the Advanced Logging section in Logging.

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

---

Property	Description
Location	Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.
BrowsableSchemas	Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
Tables	Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .
Views	Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .

Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.

Remarks

The Location property is only needed if you want to either customize definitions (for example, change a column name, ignore a column, etc.) 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, where %APPDATA% is set to the user's configuration directory:

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

Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .

Remarks

Listing all available database schemas can take extra time, thus degrading performance. Providing a list of schemas in the connection string saves time and improves performance.

Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .

Remarks

Listing all available tables from some databases can take extra time, thus degrading performance. Providing a list of tables in the connection string saves time and improves performance.

If there are lots of tables available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those tables. To do this, 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: If you are connecting to a data source with multiple schemas or catalogs, you must specify each table you want to view by its fully qualified name. This avoids ambiguity between tables that may exist in multiple catalogs or schemas.

Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .

Remarks

Listing all available views from some databases can take extra time, thus degrading performance. Providing a list of views in the connection string saves time and improves performance.

If there are lots of views available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those views. To do this, 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: If you are connecting to a data source with multiple schemas or catalogs, you must specify each view you want to examine by its fully qualified name. This avoids ambiguity between views that may 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	Specifies the maximum rows returned for queries without aggregation or GROUP BY.
Other	Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties.
PseudoColumns	Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.
Timeout	Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.
UserDefinedViews	Specifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file.

Specifies the maximum rows returned for queries without aggregation or GROUP BY.

Remarks

This property sets an upper limit on the number of rows the Sync App returns for queries that do not include aggregation or GROUP BY clauses. This limit ensures that queries do not return excessively large result sets by default.

When a query includes a LIMIT clause, the value specified in the query takes precedence over the MaxRows setting. If MaxRows is set to "-1", no row limit is enforced unless a LIMIT clause is explicitly included in the query.

This property is useful for optimizing performance and preventing excessive resource consumption when executing queries that could otherwise return very large datasets.

Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties.

Remarks

This property allows advanced users to configure hidden properties for specialized scenarios. These settings are not required for normal use cases but can address unique requirements or provide additional functionality. Multiple properties can be defined in a semicolon-separated list.

Note: It is strongly recommended to set these properties only when advised by the support team to address specific scenarios or issues.

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.

Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.

Remarks

This property allows you to define which pseudocolumns the Sync App exposes as table columns.

To specify individual pseudocolumns, use the following format: "Table1=Column1;Table1=Column2;Table2=Column3"

To include all pseudocolumns for all tables use: "*=*"

Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.

Remarks

This property controls the maximum time, in seconds, that the Sync App waits for an operation to complete before canceling it. If the timeout period expires before the operation finishes, the Sync App cancels the operation and throws an exception.

The timeout applies to each individual communication with the server rather than the entire query or operation. For example, a query could continue running beyond 60 seconds if each paging call completes within the timeout limit.

Setting this property to 0 disables the timeout, allowing operations to run indefinitely until they succeed or fail due to other conditions such as server-side timeouts, network interruptions, or resource limits on the server. Use this property cautiously to avoid long-running operations that could degrade performance or result in unresponsive behavior.

Specifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file.

Remarks

This property allows you to define and manage custom views through a JSON-formatted configuration file called UserDefinedViews.json. These views are automatically recognized by the Sync App and enable you to execute custom SQL queries as if they were standard database views. The JSON file defines each view as a root element with a child element called "query", which contains the 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)"
	}
}

You can define multiple views in a single file and specify the filepath using this property. For example: UserDefinedViews=C:\Path\To\UserDefinedViews.json. When you use this property, only the specified views are seen by the Sync App.

Refer to User Defined Views for more information.