Adding a Connection to PCA Accounting

To add a connection to PCA Accounting:

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 PCA Accounting icon is not available, click the Add More icon to download and install the PCA Accounting 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 PCA Accounting

PCA Accounting provides embedded OAuth credentials that simplify connection from a Desktop application . To connect from a Web application, you must create a custom OAuth application.

To connect via OAuth from all authentication flows, you must set AuthScheme to OAuth.

The following subsections describe how to authenticate to PCA Accounting from the available oauth flows. For information about how to create a custom OAuth application, see Creating a Custom OAuth Application. For a complete list of connection string properties available in PCA Accounting, see Connection.

When the access token expires, the Sync App refreshes it automatically.

This section details a selection of advanced features of the PCA Accounting Sync App.

User Defined Views

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

SSL Configuration

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

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 PCA Accounting and then processes the rest of the query in memory (client-side).

See Query Processing for more information.

Logging

See Logging for an overview of configuration settings that can be used to refine CData logging. For basic logging, you only need to set two connection properties, but there are numerous features that support more refined logging, where you can select subsets of information to be logged using the LogModules connection property.

Customizing the SSL Configuration

By default, the Sync App attempts to negotiate SSL/TLS by checking the server's certificate against the system's trusted certificate store.

To specify another certificate, see the SSLServerCert property for the available formats to do so.

Connecting Through a Firewall or Proxy

HTTP Proxies

To connect through the Windows system proxy, you do not need to set any additional connection properties. To connect to other proxies, set ProxyAutoDetect to false.

In addition, to authenticate to an HTTP proxy, set ProxyAuthScheme, ProxyUser, and ProxyPassword, in addition to ProxyServer and ProxyPort.

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.

The CData Sync App models PCA Accounting objects as relational tables and views. A PCA Accounting object has relationships to other objects; in the tables, these relationships are expressed through foreign keys. The following sections show the available API objects and provide more information on executing SQL to PCA Accounting APIs.

Schemas for most database objects are defined in simple, text-based configuration files.

The Sync App models the data in PCA Accounting as a list of tables in a relational database that can be queried using standard SQL statements.

PCA Accounting Connector for CData Sync Tables

Name	Description
Bu	Usage information for the operation Bu.rsd.
Hojo	Usage information for the operation Hojo.rsd.
InputSlip	Usage information for the operation InputSlip.rsd.
InputSlipData	Usage information for the operation InputSlipData.rsd.
Kmk	Usage information for the operation Kmk.rsd.

Usage information for the operation Bu.rsd.

Columns

Name	Type	ReadOnly	Description
Id [KEY]	Int	False
Code	String	False
Name	String	False
Kana	String	False
Deletable	String	True
Reserve1	Int	False
Reserve2	String	False
Reserve3	String	False
UpdateTime	Datetime	True
BuLockType	String	True

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
BEVersion	String
IdList	String

Usage information for the operation Hojo.rsd.

Columns

Name	Type	ReadOnly	Description
BEVersion	String	True
Id [KEY]	Int	False
Code	String	False
KmkId	Int	False
HojoUnionId	Int	False
Kana	String	True
Name	String	False
FormalKana	String	True
FormalName	String	False
DrTaxClassId	Int	False
CrTaxClassId	String	False
TaxCalcMode	String	True
TaxRoundMode	String	True
BankTransferMode	String	True
ZipCode	String	True
Address1	String	True
Address2	String	True
Tel	String	True
Fax	String	True
CloseDay	Int	False
PayDay	Int	False
CorporateMyNumber	String	True
Reserve1	Int	True
Reserve2	String	True
Reserve3	String	True
UpdateTime	Datetime	True
KmkLockType	String	True
InvoiceIssuerType	String	False
RegistrationNumber	String	True
EInvoiceReceiveMode	String	False

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
IdList	String

Usage information for the operation InputSlip.rsd.

Columns

Name	Type	ReadOnly	Description
BEVersion	String	False
SlipState	String	True
InputSlipHeader	String	False
InputSlipDataList	String	False
TaxOrgMoneyCalcedByAs	String	True
MainDrCrMode	String	True
PermanentId	Int	True
InputSlipHeader_Id [KEY]	Int	False
InputSlipHeader_LockType	String	True
InputSlipHeader_Date_SerializeTarget	Date	False
InputSlipHeader_Number	Int	False
InputSlipHeader_JournalClass	String	False
InputSlipHeader_ManageClass	String	False
InputSlipHeader_State	String	True
InputSlipHeader_VanishState	String	True
InputSlipHeader_InputModuleName	String	False
InputSlipHeader_InputAreaUserId	Int	True
InputSlipHeader_ApprovalAreaUserId1	String	True
InputSlipHeader_ApprovalAreaUserId2	String	True
InputSlipHeader_ApprovalAreaUserId3	String	True
InputSlipHeader_ApprovalAreaUserId4	String	True
InputSlipHeader_OldId	Int	True
InputSlipHeader_OrgId	Int	True
InputSlipHeader_HsId	Int	True
InputSlipHeader_Reserve1	Int	False
InputSlipHeader_Reserve2	String	False
InputSlipHeader_Reserve3	String	False
InputSlipHeader_ReserveMoney1	Decimal	False
InputSlipHeader_ReserveMoney2	String	False
InputSlipHeader_ReserveMoney3	String	False
InputSlipHeader_ReserveString1	String	False
InputSlipHeader_ReserveString2	String	False
InputSlipHeader_ReserveString3	String	False
InputSlipHeader_UpdateTime	Datetime	True

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
JournalHeaderIdList	String
DateFrom_SerializeTarget	Int
DateTo_SerializeTarget	Int
NumberFrom	Int
NumberTo	Int
JournalClassList	String
ManageClassList	String
StateList	String
InputDateFrom_SerializeTarget	Int
InputDateTo_SerializeTarget	Int
InputModule	String
KmkId	Int
MoneyFrom	Int
MoneyTo	Int
MoneyCalcType	String

Usage information for the operation InputSlipData.rsd.

Columns

Name	Type	ReadOnly	Description
JournalHeaderId [KEY]	Int	False
LineNumber [KEY]	Int	False
DrId	Int	True
DrTaxCalcMode	String	False
DrBuId	Int	False
DrKmkId	Int	False
DrHojoId	Int	False
DrTaxClassId	Int	False
DrTaxKmkId	Int	True
DrMoney	Int	False
DrTaxMoney	Int	False
DrStamp	String	False
DrBankTransferState	String	True
DrReserve1	Int	False
DrReserve2	String	False
DrReserve3	String	False
CrId	String	True
CrTaxCalcMode	String	False
CrBuId	String	False
CrKmkId	String	False
CrHojoId	String	False
CrTaxClassId	String	False
CrTaxKmkId	String	True
CrMoney	String	False
CrTaxMoney	String	False
CrStamp	String	False
CrBankTransferState	String	True
CrReserve1	String	False
CrReserve2	String	False
CrReserve3	String	False
RemId	Int	True
Number1	String	False
Number2	String	False
Number3	String	False
Number4	String	False
Number5	String	False
Money1	Decimal	False
Money2	Decimal	False
Money3	Decimal	False
Money4	Decimal	False
Money5	Decimal	False
Text1	String	False
Text2	String	False
Text3	String	False
Text4	String	False
Text5	String	False
LabelId	Int	False
LabelString	String	False
Summary	String	False
InputModuleName	String	False

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
BEVersion	String
JournalHeaderIdList	String
DateFrom_SerializeTarget	Int
DateTo_SerializeTarget	Int
NumberFrom	Int
NumberTo	Int
JournalClassList	String
ManageClassList	String
StateList	String
InputDateFrom_SerializeTarget	Int
InputDateTo_SerializeTarget	Int
InputAreaUserId	Int
InputModule	String
KmkId	Int
MoneyFrom	Int
MoneyTo	Int
MoneyCalcType	String

Usage information for the operation Kmk.rsd.

Columns

Name	Type	ReadOnly	Description
Id [KEY]	Int	False
KmkAttributeLinkNumber	Int	False
Code	String	False
Deletable	String	True
Name	String	False
FormalName	String	False
Kana	String	True
DrCrMode	String	True
DrTaxClassId	Int	False
CrTaxClassId	String	False
ConnectionKmkId	Int	True
HojoCount	Int	True
DisplayMode	String	True
TaxCalcMode	String	True
TaxRoundMode	String	True
Reserve1	Int	True
Reserve2	String	True
Reserve3	String	True
UpdateTime	Datetime	True
KmkLockType	String	True

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
BEVersion	String
IdList	String
ExistHojo	String
UseMode	String

Views are similar to tables in the way that data is represented; however, views are read-only.

Queries can be executed against a view as if it were a normal table.

PCA Accounting Connector for CData Sync Views

Name	Description
AreaUser	Usage information for the operation AreaUser.rsd.
BudgetClass	Usage information for the operation BudgetClass.rsd.
BuGroup	Usage information for the operation BuGroup.rsd.
Comp	Usage information for the operation Comp.rsd.
DataAreas	Usage information for the operation DataAreas.rsd.
JournalExtensionItemSetting	Usage information for the operation JournalExtensionItemSetting.rsd.
KmkAttribute	Usage information for the operation KmkAttribute.rsd.
Label	Usage information for the operation Label.rsd.
ManageClassName	Usage information for the operation ManageClassName.rsd.
Rem	Usage information for the operation Rem.rsd.
RemEntry	Usage information for the operation RemEntry.rsd.
TaxClass	Usage information for the operation TaxClass.rsd.
TitleSet	Usage information for the operation TitleSet.rsd.
TrialBalanceHeader	Usage information for the operation TrialBalanceHeader.rsd.

Usage information for the operation AreaUser.rsd.

Columns

Name	Type	Description
Id [KEY]	Int
UserId	String
NameCache	String
UpdateTime	Datetime

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
BEVersion	String
IdList	String

Usage information for the operation BudgetClass.rsd.

Columns

Name	Type	Description
BEVersion	String
Id [KEY]	Int
BudgetType	String
Name	String
BudgetManagement	String
BudgetTaxAccountMode	String
UpdateTime	Datetime

Usage information for the operation BuGroup.rsd.

Columns

Name	Type	Description
Id [KEY]	Int
Code	String
Kana	String
Name	String
Reserve1	Int
Reserve2	String
Reserve3	String
UpdateTime	Datetime
BuLockType	String

Usage information for the operation Comp.rsd.

Columns

Name	Type	Description
BEVersion	String
Id [KEY]	Int
Code	String
Kana	String
Name	String
ZipCode	String
Address1	String
Address2	String
Address1Kana	String
Address2Kana	String
Tel	String
Fax	String
StartDate_SerializeTarget	Date
EndDate_SerializeTarget	Date
Number	Int
KoyomiMode	String
KmkCodeLength	Int
KmkCodeFillZero	String
HojoCodeLength	Int
HojoCodeFillZero	String
ProductionCostKmkMode	String
BuManageMode	String
BuCodeLength	Int
BuGroupCodeLength	Int
JournalNumberMode	String
JournalNumberCheckMode	String
JournalLockDate_SerializeTarget	Date
JournalLockJournalClass	String
JournalApprovalMode	String
JournalApprovalRank	String
ApprovalRank1Level	String
ApprovalRank2Level	String
ApprovalRank3Level	String
ApprovalRank4Level	String
ApprovalUserMode	String
TaxMode	String
TaxCalcMode	String
TaxRoundMode	String
CarryingOverMode	String
EBookSaveMode	String
NotDeleteHistoryDays	Int
CombinationMode	String
PreviousAreaName	String
DefaultKmkAttributePattern	Int
CorporateMyNumber	String
JournalExtensionItemMode	String
DataVersion	String
Reserve1	Int
Reserve2	String
Reserve3	String
RegistrationNumber	String
FromExemptAccountMode	String

Usage information for the operation DataAreas.rsd.

Columns

Name	Type	Description
Name [KEY]	String
DataVersion	String
CompanyCode	String
CompanyName	String
CompanyKana	String
CompanyTerm	Int
CompanyTermStart	Date
CompanyTermEnd	Date
CompanyType	Int
CompanyKoyomi	String
CompanyInt1	Int
CompanyInt2	Int
CompanyInt3	Int
CompanyInt4	Int
CompanyInt5	Int
CompanyString1	String
CompanyString2	String
CompanyString3	String
CompanyString4	String
CompanyString5	String
CompanyDescription	String
CompanyChainId	String
Status	String
StatusDescription	String
UpdateTime	Datetime

Usage information for the operation JournalExtensionItemSetting.rsd.

Columns

Name	Type	Description
BEVersion	String
Name	String
ItemType	String
OrderNumber	Int
Visible	String
UpdateTime	Datetime

Usage information for the operation KmkAttribute.rsd.

Columns

Name	Type	Description
BEVersion	String
KmkAttributeLinkNumber [KEY]	Int
GroupName	String
Name	String
FormalName	String
FormalKana	String
DrCrMode	String
DrTaxClassId	Int
CrTaxClassId	String
ActiveLawsMode	String
OrderNumber	Int

Usage information for the operation Label.rsd.

Columns

Name	Type	Description
Id [KEY]	Int
Color	Int
Name	String
UpdateTime	Datetime

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
BEVersion	String
IdList	String

Usage information for the operation ManageClassName.rsd.

Columns

Name	Type	Description
BEVersion	String
Id [KEY]	Int
ManageClass	String
Name	String
UpdateTime	Datetime

Usage information for the operation Rem.rsd.

Columns

Name	Type	Description
BEVersion	String
Id	Int
Code	String
Kana	String
Name	String
DisplayMode	String
RemEntryList	String
UpdateTime	Datetime

Usage information for the operation RemEntry.rsd.

Columns

Name	Type	Description
RemId	Int
LineNumber	Int
EntryDrKmkId	Int
EntryCrKmkId	Int

Usage information for the operation TaxClass.rsd.

Columns

Name	Type	Description
BEVersion	String
Id [KEY]	Int
Code	String
Name	String
Caption	String
Rate	Decimal
StartDate_SerializeTarget	Date
EndDate_SerializeTarget	Date
RevisedId	Int
DisplayMode	String
RefGroupType	String
ItemizedDisplayMode	String
PriorId	Int
InvoiceEligibleId	Int
InvoiceIneligibleTransitionalNotApplicableId	Int
InvoiceIneligibleTransitionalApplicableId	Int
InvoiceTransitionalApplicableStartDate	Date
InvoiceTransitionalApplicableDeductionRate	Decimal

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
IdList	String

Usage information for the operation TitleSet.rsd.

Columns

Name	Type	Description
Id [KEY]	Int
Name	String
BSTitle	String
PLTitle	String
CRTitle	String
UpdateTime	Datetime

Usage information for the operation TrialBalanceHeader.rsd.

Columns

Name	Type	Description
Id [KEY]	Int
Name	String
TitleSetId	Int
Pattern	Int
Version	Int
UpdateTime	Datetime

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
APIVersion	Specify the PCA API version.
DataCenter	PCA API Server DataCenter Name.
DefaultDataArea	First connected DataArea.
ProductCode	Product code of PCA to be connected.
InputModuleName	Specify the InputModuleName for InputSlip.

OAuth

---

Property	Description
OAuthClientId	The client Id assigned when you register your application with an OAuth authorization server.
OAuthClientSecret	The client secret assigned when you register your application with an OAuth authorization server.
AuthScheme	The type of authentication to use when connecting to PCA Accounting.
OAuthGrantType	The grant type for the OAuth flow.
User	The user name of the PCA Accounting account used to the Password Grant authenticate to the server.
Password	The password of the PCA Accounting account used to the Password Grant authenticate to the PCA Accounting server.
ServiceId	The ID of the service account to connect to.
ServicePassword	The password of the service account to connect to.

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	This indicates whether to use the system proxy settings or not.
ProxyServer	The hostname or IP address of a proxy to route HTTP traffic through.
ProxyPort	The TCP port the ProxyServer proxy is running on.
ProxyAuthScheme	The authentication type to use to authenticate to the ProxyServer proxy.
ProxyUser	A user name to be used to authenticate to the ProxyServer proxy.
ProxyPassword	A password to be used to authenticate to the ProxyServer proxy.
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. This takes precedence over LIMIT clauses.
Other	These hidden properties are used only in specific use cases.
PseudoColumns	This property indicates whether or not to include pseudo columns as columns to the table.
Timeout	The value in seconds until the timeout error is thrown, canceling the operation.
UseLogout	Decide whether to logout of the PCA API when CData Driver connection is closed.
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
APIVersion	Specify the PCA API version.
DataCenter	PCA API Server DataCenter Name.
DefaultDataArea	First connected DataArea.
ProductCode	Product code of PCA to be connected.
InputModuleName	Specify the InputModuleName for InputSlip.

Specify the PCA API version.

Remarks

API V1 is currently being offered.

PCA API Server DataCenter Name.

Remarks

Enter the DataCenter name of the PCA API Server. Example east02

First connected DataArea.

Remarks

Enter the DataArea to connect first. Example P20V01C081KON0001

Product code of PCA to be connected.

Remarks

Enter the product code of PCA to be connected. Currently supported product codes are "Kon20", "SAcc20" and "Acc20".

Specify the InputModuleName for InputSlip.

Remarks

This value is used in InputSlip.

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

---

Property	Description
OAuthClientId	The client Id assigned when you register your application with an OAuth authorization server.
OAuthClientSecret	The client secret assigned when you register your application with an OAuth authorization server.
AuthScheme	The type of authentication to use when connecting to PCA Accounting.
OAuthGrantType	The grant type for the OAuth flow.
User	The user name of the PCA Accounting account used to the Password Grant authenticate to the server.
Password	The password of the PCA Accounting account used to the Password Grant authenticate to the PCA Accounting server.
ServiceId	The ID of the service account to connect to.
ServicePassword	The password of the service account to connect to.

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

Remarks

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

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

Remarks

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

The type of authentication to use when connecting to PCA Accounting.

Remarks

• Auto: Lets the driver decide automatically based on the other connection properties you have set.
• OAuth: Set to this to perform OAuth authentication with the code grant type.
• OAuthPassword: Set to this to perform OAuth authentication with the password grant type.

The grant type for the OAuth flow.

Remarks

The grant type for the OAuth flow. The following options are available: CODE, PASSWORD

The user name of the PCA Accounting account used to the Password Grant authenticate to the server.

Remarks

Together with Password and ServiceId and ServicePassword, this field is used to the Password Grant authenticate against the PCA Accounting server.

The password of the PCA Accounting account used to the Password Grant authenticate to the PCA Accounting server.

Remarks

Together with User and ServiceId and ServicePassword, this field is used to the Password Grant authenticate against the PCA Accounting server.

The ID of the service account to connect to.

Remarks

The password of the service account to connect to.

Remarks

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 PCA Accounting 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	This indicates whether to use the system proxy settings or not.
ProxyServer	The hostname or IP address of a proxy to route HTTP traffic through.
ProxyPort	The TCP port the ProxyServer proxy is running on.
ProxyAuthScheme	The authentication type to use to authenticate to the ProxyServer proxy.
ProxyUser	A user name to be used to authenticate to the ProxyServer proxy.
ProxyPassword	A password to be used to authenticate to the ProxyServer proxy.
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 .

This indicates whether to use the system proxy settings or not.

Remarks

This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order 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 a proxy 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 the ProxyServer proxy 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 type to use to authenticate to the ProxyServer proxy.

Remarks

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

Note that the Sync App 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 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.

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

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

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

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\\PCAAccounting 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. This takes precedence over LIMIT clauses.
Other	These hidden properties are used only in specific use cases.
PseudoColumns	This property indicates whether or not to include pseudo columns as columns to the table.
Timeout	The value in seconds until the timeout error is thrown, canceling the operation.
UseLogout	Decide whether to logout of the PCA API when CData Driver connection is closed.
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. This takes precedence over LIMIT clauses.

Remarks

Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.

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.

This property indicates whether or not to include pseudo columns as columns to the table.

Remarks

This setting is particularly helpful in Entity Framework, which does not allow you to set a value for a pseudo column unless it is a table column. 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.

Decide whether to logout of the PCA API when CData Driver connection is closed.

Remarks

It is recommended that the PCA API perform logout processing after API request completion. However, it may not be desirable when making parallel requests via CData Driver. In that case, please set this property to False.

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