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 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 PCA Accounting 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.

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
AuthScheme	The type of authentication to use when connecting to PCA Accounting.
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	Specifies the client Id that was assigned the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server.
OAuthClientSecret	Specifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret ). This secret registers the custom application with the OAuth authorization server.
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	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.
UseLogout	Decide whether to logout of the PCA API when CData Driver connection is closed.
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	The type of authentication to use when connecting to PCA Accounting.
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.

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

Remarks

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

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	Specifies the client Id that was assigned the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server.
OAuthClientSecret	Specifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret ). This secret registers the custom application with the OAuth authorization server.
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.

Specifies the client Id that was assigned the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server.

Remarks

OAuthClientId is one of a handful of connection parameters that need to be set before users can authenticate via OAuth. For details, see Establishing a Connection.

Specifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret ). This secret registers the custom application with the OAuth authorization server.

Remarks

OAuthClientSecret is one of a handful of connection parameters that need to be set before users can authenticate via OAuth. For details, see Establishing a Connection.

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	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 PCA Accounting. Traffic flows back and forth via the proxy at this location.
SOCKS4	1080	The port where the Sync App opens a connection to PCA Accounting. 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 PCA Accounting. 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\\PCAAccounting 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.
UseLogout	Decide whether to logout of the PCA API when CData Driver connection is closed.
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.

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.

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