Sage 300 Version Support

The connector leverages the Sage 300 API to enable bidirectional access to Sage 300.

Before Authenticating

Sage 300 requires some initial setup in order to communicate over the Sage 300 Web API. The logged in user must have API access to one or all modules of the Sage300 instance. In Sage300 a user is assigned a security group. A security group is a set of permissions for each module. It is recommended that you use a different user other than the ADMIN user to access the API. The ADMIN user has a couple of extra steps in order to gain access to the API. Follow the steps below in order to obtain access to the API.

Creating a User

Skip this step if you have already created a new user or you would like to use an existing account.

• Open the Sage300 Desktop Application which is included in the installation of Sage300. Log in with the ADMIN account.
• Go to Administrative Services -> Users
• Fill in the required information and click Add

Setting up the Security Group

• Open the Sage300 Desktop Application which is included in the installation of Sage300. Log in with the ADMIN account.
• Go to Administrative Services -> Security Groups
• In the Application you will find all the modules of Sage300. The Group ID represents the security group you want to modify. Below you will find a list of permissions that you can check.
• (Optional)Create a new Security Group fill the Group ID, Group Description and check any of the permissions including the Sage 300 Web API permission. Lastly click Add(per each application required)
• Or select an existing Security Group you are going to assign to the User under Group ID and check the Sage 300 Web API permission in the end of permissions(per each application required).

Assigning a Security Group

• Open the Sage300 Desktop Application which is included in the installation of Sage300. Log in with the ADMIN account.
• Go to Administrative Services -> User Authorization
• Under User ID select your new/existing User
• Now for each Application assign the Group ID which you created/modified

• Once the user access is done, ensure that they have access to the web API. Construct an URL to test access for the Sage 300 Web API as follows: https://{server}/Sage300WebApi/, replacing {server} with your Sage300 instance URL.

Connecting to Sage 300

The Jitterbit Connector for Sage 300 communicates to Sage 300 over the OData API. You can authenticate to Sage 300 using Basic authentication.

Connect Using Basic Authentication

You must provide values for the following properties to successfully authenticate to Sage 300. Note that the provider will reuse the session opened by Sage 300 using cookies.

This means that your credentials will be used only on the first request to open the session. After that, cookies returned from Sage 300 will be used for authentication.

• URL: Set this to the URL of the server hosting Sage 300. Construct a URL for the Sage 300 Web API as follows: {protocol}://{host-application-path}/v{version}/{tenant}/
  For example: http://localhost/Sage300WebApi/v1.0/-/.
• User: Set this to the username of your account.
• Password: Set this to the password of your account.

Fine Tuning Data Access

You can use the following properties to gain more control over the data returned from Sage 300:

• Company: Specify the company you wish to get data from. If not specified, the first company found on the /Companies endpoint will be choosen.
• Modules: Use this connection property to limit metadata retrieval to only the desired modules. This will improve the performance of the metadata retrieved.
• IncludeCustomFields: Set to true to list custom fields as table columns.

Stored Procedures

• The stored procedures features described in this documentation are not currently supported.
• Because stored procedures are not currently supported, any feature dependent on stored procedures is also currently not supported.

Configuration Files and Their Paths

• All references to adding configuration files and their paths refer to files and locations on the Jitterbit Harmony Agent where the connector is installed. These paths are to be adjusted as appropriate depending on the agent and the operating system. If multiple agents are used in an agent group, identical files will be required on each agent.

This section details a selection of advanced features of the Sage 300 connector.

User Defined Views

The connector 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 connector handles TLS/SSL certificate negotiations. You can choose from various certificate formats; see the SSLServerCert property under "Connection String Options" for more information.

Proxy

To configure the connector using Private Agent proxy settings, select the Use Proxy Settings checkbox on the connection configuration screen.

The Jitterbit Connector for Sage 300 allows you to define a virtual table whose contents are decided by a pre-configured query. These are called User Defined Views, which are useful in situations where you cannot directly control the query being issued to the driver, e.g. when using the driver from Jitterbit. The User Defined Views can be used to define predicates that are always applied. If you specify additional predicates in the query to the view, they are combined with the query already defined as part of the view.

There are two ways to create user defined views:

• Create a JSON-formatted configuration file defining the views you want.
• DDL statements.

Defining Views Using a Configuration File

User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json. The connector 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 connector.

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 OEInvoices 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"

Schema for User Defined Views

User Defined Views are exposed in the UserViews schema by default. This is done to avoid the view's name clashing with an actual entity in the data model. You can change the name of the schema used for UserViews by setting the UserViewsSchemaName property.

Working with User Defined Views

For example, a SQL statement with a User Defined View called UserViews.RCustomers only lists customers in Raleigh:

SELECT * FROM Customers WHERE City = 'Raleigh';

An example of a query to the driver:

SELECT * FROM UserViews.RCustomers WHERE Status = 'Active';

Resulting in the effective query to the source:

SELECT * FROM Customers WHERE City = 'Raleigh' AND Status = 'Active';

That is a very simple example of a query to a User Defined View that is effectively a combination of the view query and the view definition. It is possible to compose these queries in much more complex patterns. All SQL operations are allowed in both queries and are combined when appropriate.

Customizing the SSL Configuration

By default, the connector 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.

Overview

The Jitterbit Connector for Sage 300 models Sage 300 objects as relational tables and views. A Sage 300 object has relationships to other objects; in the tables, these relationships are expressed through foreign keys.

Key Features

• The connector models Sage 300 entities as relational tables and views, allowing you to write SQL to query Sage 300 data.
• Stored procedures* allow you to execute operations to Sage 300.
• Live connectivity to these objects means any changes to your Sage 300 account are immediately reflected when using the connector.

Tables

Tables are retrieved dynamically from the authenticated Sage 300 account.

Child Tables

Child tables are also retrieved, which contain child objects of their parents. For example, OEOrders has OEOrders_OrderCommentsInstructions and OEOrders_OrderDetails as its child tables. These tables are exposed as aggregate columns while querying their parent table. They also have references to the unique identifier of their parent.

Views

Read-only views are retrieved dynamically from the authenticated Sage 300 account.

Stored Procedures

NOTE: Stored procedures are not currently supported. See the above note for details.

Stored Procedures are function-like interfaces to Sage 300. Stored procedures* allow you to execute operations to Sage 300.

Collaborative Query Processing

The connector offloads as much of the SELECT statement processing as possible to Sage 300 and then processes the rest of the query in memory. API limitations and requirements are also documented in this section.

See SupportEnhancedSQL for more information on how the connector circumvents API limitations with in-memory client-side processing.

SELECT statements for the main tables are mostly supported server-side. For example:

SELECT * FROM APInvoiceBatches WHERE BatchDate='2019-01-09 01:00:00.0'

will be run server-side.

Note: When executing SELECT statements on child tables, everything is processed client side.

Stored procedures* are available to complement the data available from the Data Model. It may be necessary to update data available from a view using a stored procedure* because the data does not provide for direct, table-like, two-way updates. In these situations, the retrieval of the data is done using the appropriate view or table, while the update is done by calling a stored procedure. Stored procedures* take a list of parameters and return back a dataset that contains the collection of tuples that constitute the response.

Jitterbit Connector for Sage 300 Stored Procedures

Name	Description
APCreateGLBatch	Usage information for the operation APCreateGLBatch.rsb.
APCreateRecurringPayableBatch	Usage information for the operation APCreateRecurringPayableBatch.rsb.
APCreateRetainageDocumentBatch	Usage information for the operation APCreateRetainageDocumentBatch.rsb.
APDeleteInactiveRecords	Usage information for the operation APDeleteInactiveRecords.rsb.
APPostInvoices	Usage information for the operation APPostInvoices.rsb.
APPostPaymentsAndAdjustments	Usage information for the operation APPostPaymentsAndAdjustments.rsb.
ARCreateGLBatch	Usage information for the operation ARCreateGLBatch.rsb.
ARCreateRecurringCharge	Usage information for the operation ARCreateRecurringCharge.rsb.
ARCreateRetainageDocumentBatch	Usage information for the operation ARCreateRetainageDocumentBatch.rsb.
ARPostInvoices	Usage information for the operation ARPostInvoices.rsb.
ARPostReceiptsAndAdjustments	Usage information for the operation ARPostReceiptsAndAdjustments.rsb.
ARPostRefunds	Usage information for the operation ARPostRefunds.rsb.
CreateSchema	Creates a schema file for the specified table or view.
GLPostJournal	Usage information for the operation GLPostJournal.rsb.
ICCreateGLBatch	Usage information for the operation ICCreateGLBatch.rsb.
ICDayEndProcessing	Usage information for the operation ICDayEndProcessing.rsb.
POCreateBatch	Usage information for the operation POCreateBatch.rsb.
PODayEndProcessing	Usage information for the operation PODayEndProcessing.rsb.

Usage information for the operation APCreateGLBatch.rsb.

Input

Name	Type	Required	Description
ProcessPaymentBatch	String	False	Possible Values: DoNotPostPaymentBatches, PostPaymentBatches
ThruPaymentPostingSequenceNumber	String	False	Possible Values: Decimal Number
ProcessInvoiceBatch	String	False	Possible Values: DoNotPostInvoiceBatches, PostInvoiceBatches
ThruInvoicePostingSequenceNumber	String	False	Possible Values: Decimal Number
ProcessAdjustmentBatch	String	False	Possible Values: DoNotPostAdjustmentBatches, PostAdjustmentBatches
ThruAdjustmentPostingSequenceNumber	String	False	Possible Values: Decimal Number
ProcessRevalueBatch	String	False	Possible Values: DoNotPostRevaluationBatches, PostRevaluationBatches
ThruRevaluePostingSequenceNumber	String	False	Possible Values: Decimal Number
ActionSelector	String	False	Possible Values: String Text
UpdateOperation	String	False	Possible Values: Unspecified, Update, Insert, Delete

Result Set Columns

Name	Type	Description
Success	String	This value shows a boolean indication of whether the operation was successful or not.

Usage information for the operation APCreateRecurringPayableBatch.rsb.

Input

Name	Type	Required	Description
RunDate	String	False	Possible Values: DateTime
Mode	String	False	Possible Values: Integer Number
SelectRecordsBy	String	False	Possible Values: RecurringPayableCode, VendorNumber, VendorGroup, ScheduleLink, SpecificRecurringChargeCode
StartingRecurringPayableCode	String	False	Possible Values: String Text
EndingRecurringPayableCode	String	False	Possible Values: String Text
StartingVendorNumber	String	False	Possible Values: String Text
EndingVendorNumber	String	False	Possible Values: String Text
StartingVendorGroupCode	String	False	Possible Values: String Text
EndingVendorGroupCode	String	False	Possible Values: String Text
ScheduleKey	String	False	Possible Values: String Text
ScheduleLink	String	False	Possible Values: Decimal Number
Status	String	False	Possible Values: Integer Number
DateGenerationMethod	String	False	Possible Values: RunDate, NextScheduleDate, SpecificDate
BatchGenerationMethod	String	False	Possible Values: Default, CreateaNewBatch, AddToanExistingBatch
ForcedInvoiceDate	String	False	Possible Values: datetime
AppendToBatchNumber	String	False	Possible Values: Decimal Number
ActionSelector	String	False	Possible Values: String Text
UpdateOperation	String	False	Possible Values: Unspecified, Update, Insert, Delete

Result Set Columns

Name	Type	Description
Success	String	This value shows a boolean indication of whether the operation was successful or not.

Usage information for the operation APCreateRetainageDocumentBatch.rsb.

Input

Name	Type	Required	Description
RunDate	String	False	Possible Values: datetime
Mode	String	False	Possible Values: Integer Number
SelectRecordsBy	String	False	Possible Values: VendorNumber, DocumentNumber, VendorGroup
StartingDocumentNumber	String	False	Possible Values: String Text
EndingDocumentNumber	String	False	Possible Values: String Text
StartingVendorNumber	String	False	Possible Values: String Text
EndingVendorNumber	String	False	Possible Values: String Text
StartingVendorGroupCode	String	False	Possible Values: String Text
EndingVendorGroupCode	String	False	Possible Values: String Text
IncludeInvoice	String	False	Possible Values: Yes, No
IncludeDebitNote	String	False	Possible Values: Yes, No
IncludeCreditNote	String	False	Possible Values: Yes, No
DaysBeforeRetainageDue	String	False	Possible Values: Integer Number
CommandCode	String	False	Possible Values: UserRun, ScheduledRun
Status	String	False	Possible Values: Integer Number
ActionSelector	String	False	Possible Values: String Text
UpdateOperation	String	False	Possible Values: Unspecified, Update, Insert, Delete

Result Set Columns

Name	Type	Description
Success	String	This value shows a boolean indication of whether the operation was successful or not.

Usage information for the operation APDeleteInactiveRecords.rsb.

Input

Name	Type	Required	Description
ClearFromVendorNumber	String	False	Possible Values: String Text
ClearThruVendorNumber	String	False	Possible Values: String Text
ClearFromGroupCode	String	False	Possible Values: String Text
ClearThruGroupCode	String	False	Possible Values: String Text
ClearRemitToFromVendorNumber	String	False	Possible Values: String Text
ClearRemitToThruVendorNumber	String	False	Possible Values: String Text
ClearFromDate	String	False	Possible Values: Datetime
ClearThruDate	String	False	Possible Values: Datetime
ClearInactiveVendors	String	False	Possible Values: Yes, No
ClearInactiveGroups	String	False	Possible Values: Yes, No
ClearInactiveRemitToLocation	String	False	Possible Values: Yes, No
ClearInactiveRecurringPayable	String	False	Possible Values: Yes, No
ClearFromRecurringPayable	String	False	Possible Values: String Text
ClearThruRecurringPayable	String	False	Possible Values: String Text
ActionSelector	String	False	Possible Values: String Text
UpdateOperation	String	False	Possible Values: Unspecified, Update, Insert, Delete

Result Set Columns

Name	Type	Description
Success	String	This value shows a boolean indication of whether the operation was successful or not.

Usage information for the operation APPostInvoices.rsb.

Input

Name	Type	Required	Description
ProcessAllBatches	String	False	Possible Values: Donotpostallbatches, Postallbatches
FromBatch	String	False	Possible Values: Decimal Number
ToBatch	String	False	Possible Values: Decimal Number
ActionSelector	String	False	Possible Values: String Text
UpdateOperation	String	False	Possible Values: Unspecified, Update, Insert, Delete

Result Set Columns

Name	Type	Description
Success	String	This value shows a boolean indication of whether the operation was successful or not.

Usage information for the operation APPostPaymentsAndAdjustments.rsb.

Input

Name	Type	Required	Description
BatchType	String	False	Possible Values: String Text
PostAllBatches	String	False	Possible Values: Donotpostallbatches, Postallbatches
PostBatchFrom	String	False	Possible Values: Decimal Number
PostBatchTo	String	False	Possible Values: Decimal Number
ActionSelector	String	False	Possible Values: String Text
UpdateOperation	String	False	Possible Values: Unspecified, Update, Insert, Delete

Result Set Columns

Name	Type	Description
Success	String	This value shows a boolean indication of whether the operation was successful or not.

Usage information for the operation ARCreateGLBatch.rsb.

Input

Name	Type	Required	Description
ProcessReceiptBatch	String	False	Possible Values: DonotpostCashbatches, PostCashbatches
ReceiptThroughPostingSequenceNumber	String	False	Possible Values: Decimal Number
ProcessInvoiceBatch	String	False	Possible Values: DonotpostInvoicebatches, PostInvoicebatches
InvoiceThroughPostingSequenceNumber	String	False	Possible Values: Decimal Number
ProcessAdjustmentBatch	String	False	Possible Values: DonotpostAdjustmentbatches, PostAdjustmentbatches
AdjustmentThroughPostingSequenceNumber	String	False	Possible Values: Decimal Number
ProcessRevaluationBatch	String	False	Possible Values: DonotpostRevaluebatches, PostRevaluebatches
RevaluationThroughPostingSequenceNumber	String	False	Possible Values: Decimal Number
ProcessRefundBatch	String	False	Possible Values: DonotpostRefundbatches, PostRefundbatches
RefundThroughPostingSequenceNumber	String	False	Possible Values: Decimal Number
ActionSelector	String	False	Possible Values: String Text
UpdateOperation	String	False	Possible Values: Unspecified, Update, Insert, Delete

Result Set Columns

Name	Type	Description
Success	String	This value shows a boolean indication of whether the operation was successful or not.

Usage information for the operation ARCreateRecurringCharge.rsb.

Input

Name	Type	Required	Description
RangeType	String	False	Possible Values: RecurringChargeCode, CustomerNumber, CustomerGroup, NationalAccount, ScheduleLink, SpecificRecurringChargeCode
RangeFrom	String	False	Possible Values: String Text
RangeThrough	String	False	Possible Values: String Text
RunDate	String	False	Possible Values: Datetime
Mode	String	False	Possible Values: Integer Number
FiscalYear	String	False	Possible Values: String Text
FiscalPeriod	String	False	Possible Values: String Text
ScheduleKey	String	False	Possible Values: String Text
ScheduleLink	String	False	Possible Values: Decimal Number
Status	String	False	Possible Values: Integer Number
DateGenerationMethod	String	False	Possible Values: RunDate, NextScheduleDate, SpecificDate
BatchGenerationMethod	String	False	Possible Values: Default, CreatDecimaleaNewBatch, AddToanExistingBatch
ForcedInvoiceDate	String	False	Possible Values: Datetime
AppendToBatchNumber	String	False	Possible Values: Decimal Number
ActionSelector	String	False	Possible Values: String Text
UpdateOperation	String	False	Possible Values: Unspecified, Update, Insert, Delete

Result Set Columns

Name	Type	Description
Success	String	This value shows a boolean indication of whether the operation was successful or not.

Usage information for the operation ARCreateRetainageDocumentBatch.rsb.

Input

Name	Type	Required	Description
RunDate	Date	False	Possible Values: DateTime
Mode	String	False	Possible Values: Integer Number
SelectRecordsBy	String	False	Possible Values: VendorNumber, DocumentNumber, VendorGroup
StartingDocumentNumber	String	False	Possible Values: String Text
EndingDocumentNumber	String	False	Possible Values: String Text
StartingCustomerNumber	String	False	Possible Values: String Text
EndingCustomerNumber	String	False	Possible Values: String Text
StartingCustomerGroupCode	String	False	Possible Values: String Text
EndingCustomerGroupCode	String	False	Possible Values: String Text
StartingNationalAccount	String	False	Possible Values: String Text
EndingNationalAccount	String	False	Possible Values: String Text
IncludeInvoice	String	False	Possible Values: No, Yes
IncludeDebitNote	String	False	Possible Values: No, Yes
IncludeCreditNote	String	False	Possible Values: No, Yes
DaysBeforeRetainageDue	String	False	Possible Values: Integer Number
CommandCode	String	False	Possible Values: UserRun, ScheduledRun
Status	String	False	Possible Values: Integer Number
ActionSelector	String	False	Possible Values: String Text
UpdateOperation	String	False	Possible Values: Unspecified, Update, Insert, Delete

Result Set Columns

Name	Type	Description
Success	String	This value shows a boolean indication of whether the operation was successful or not.

Usage information for the operation ARPostInvoices.rsb.

Input

Name	Type	Required	Description
PostAllBatches	String	False	Possible Values: Donotpostallbatches, Postallbatches
PostBatchFrom	String	False	Possible Values: Decimal Number
PostBatchTo	String	False	Possible Values: Decimal Number
ActionSelector	String	False	Possible Values: String Text
UpdateOperation	String	False	Possible Values: Unspecified, Update, Insert, Delete

Result Set Columns

Name	Type	Description
Success	String	This value shows a boolean indication of whether the operation was successful or not.

Usage information for the operation ARPostReceiptsAndAdjustments.rsb.

Input

Name	Type	Required	Description
BatchType	String	False	Possible Values: String Text
PostAllBatches	String	False	Possible Values: Donotpostallbatches, Postallbatches
PostBatchFrom	String	False	Possible Values: Decimal Number
PostBatchTo	String	False	Possible Values: Decimal Number
ActionSelector	String	False	Possible Values: String Text
UpdateOperation	String	False	Possible Values: Unspecified, Update, Insert, Delete

Result Set Columns

Name	Type	Description
Success	String	This value shows a boolean indication of whether the operation was successful or not.

Usage information for the operation ARPostRefunds.rsb.

Input

Name	Type	Required	Description
PostAllBatches	String	False	Possible Values: Donotpostallbatches, Postallbatches
PostBatchFrom	String	False	Possible Values: Decimal Number
PostBatchTo	String	False	Possible Values: Decimal Number
ActionSelector	String	False	Possible Values: String Text
UpdateOperation	String	False	Possible Values: Unspecified, Update, Insert, Delete

Result Set Columns

Name	Type	Description
Success	String	This value shows a boolean indication of whether the operation was successful or not.

Creates a schema file for the specified table or view.

Input

Name	Type	Required	Description
TableName	String	True	The name of the table or view.
FileName	String	True	The full file path and name of the schema to generate. Ex : 'C:\Users\User\Desktop\SmartSheet\sheet.rsd'

Result Set Columns

Name	Type	Description
Result	String	Returns Success or Failure.

Usage information for the operation GLPostJournal.rsb.

Input

Name	Type	Required	Description
PostAllBatchesSwitch	String	False	Possible Values: PostbyBatchRange, PostallBatches
ProvisionalPostSwitch	String	False	Possible Values: ActualPost, ProvisionalPost
FromBatchNumber	String	False	Possible Values: String Text
ToBatchNumber	String	False	Possible Values: String Text
ErrorBatchCreatedSwitch	String	False	Possible Values: Errorbatchnotcreated, Errorbatchcreated
ActionSelector	String	False	Possible Values: String Text
UpdateOperation	String	False	Possible Values: Unspecified, Update, Insert, Delete

Result Set Columns

Name	Type	Description
Success	String	This value shows a boolean indication of whether the operation was successful or not.

Usage information for the operation ICCreateGLBatch.rsb.

Input

Name	Type	Required	Description
DayEndNumber	String	False	Possible Values: Integer Number
TransactionsCreated	String	False	Possible Values: true, false
ActionSelector	String	False	Possible Values: String Text
UpdateOperation	String	False	Possible Values: Unspecified, Update, Insert, Delete

Result Set Columns

Name	Type	Description
Success	String	This value shows a boolean indication of whether the operation was successful or not.

Usage information for the operation ICDayEndProcessing.rsb.

Input

Name	Type	Required	Description
ClearHistory	String	False	Possible Values: true, false
Application	String	False	Possible Values: String Text
ProcessingType	String	False	Possible Values: Integer Number
TransactionNumber	String	False	Possible Values: Decimal Number
PostSequenceNumber	String	False	Possible Values: Integer Number
ActionSelector	String	False	Possible Values: String Text
UpdateOperation	String	False	Possible Values: Unspecified, Update, Insert, Delete

Result Set Columns

Name	Type	Description
Success	String	This value shows a boolean indication of whether the operation was successful or not.

Usage information for the operation POCreateBatch.rsb.

Input

Name	Type	Required	Description
DayEndNumber	String	False	Possible Values: Decimal Number
TransactionsCreated	String	False	Possible Values: true, false
PostGLBatch	String	False	Possible Values: true, false
PostAPBatch	String	False	Possible Values: true, false
ActionSelector	String	False	Possible Values: String Text
UpdateOperation	String	False	Possible Values: Unspecified, Update, Insert, Delete

Result Set Columns

Name	Type	Description
Success	String	This value shows a boolean indication of whether the operation was successful or not.

Usage information for the operation PODayEndProcessing.rsb.

Input

Name	Type	Required	Description
ClearHistory	String	False	Possible Values: true, false
Application	String	False	Possible Values: String Text
ProcessingType	String	False	Possible Values: Integer Number
TransactionNumber	String	False	Possible Values: Decimal Number
PostSequenceNumber	String	False	Possible Values: Integer Number
ActionSelector	String	False	Possible Values: String Text
UpdateOperation	String	False	Possible Values: Unspecified, Update, Insert, Delete

Result Set Columns

Name	Type	Description
Success	String	This value shows a boolean indication of whether the operation was successful or not.

You can query the system tables described in this section to access schema information, information on data source functionality, and batch operation statistics.

Schema Tables

The following tables return database metadata for Sage 300:

• sys_catalogs: Lists the available databases.
• sys_schemas: Lists the available schemas.
• sys_tables: Lists the available tables and views.
• sys_tablecolumns: Describes the columns of the available tables and views.
• sys_procedures: Describes the available stored procedures.
• sys_procedureparameters: Describes stored procedure* parameters.
• sys_keycolumns: Describes the primary and foreign keys.
• sys_indexes: Describes the available indexes.

Data Source Tables

The following tables return information about how to connect to and query the data source:

• sys_connection_props: Returns information on the available connection properties.
• sys_sqlinfo: Describes the SELECT queries that the connector can offload to the data source.

Query Information Tables

The following table returns query statistics for data modification queries:

• sys_identity: Returns information about batch operations or single updates.

Lists the available databases.

The following query retrieves all databases determined by the connection string:

SELECT * FROM sys_catalogs

Columns

Name	Type	Description
CatalogName	String	The database name.

Lists the available schemas.

The following query retrieves all available schemas:

SELECT * FROM sys_schemas

Columns

Name	Type	Description
CatalogName	String	The database name.
SchemaName	String	The schema name.

Lists the available tables.

The following query retrieves the available tables and views:

SELECT * FROM sys_tables

Columns

Name	Type	Description
CatalogName	String	The database containing the table or view.
SchemaName	String	The schema containing the table or view.
TableName	String	The name of the table or view.
TableType	String	The table type (table or view).
Description	String	A description of the table or view.
IsUpdateable	Boolean	Whether the table can be updated.

Describes the columns of the available tables and views.

The following query returns the columns and data types for the OEInvoices table:

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='OEInvoices' 

Columns

Name	Type	Description
CatalogName	String	The name of the database containing the table or view.
SchemaName	String	The schema containing the table or view.
TableName	String	The name of the table or view containing the column.
ColumnName	String	The column name.
DataTypeName	String	The data type name.
DataType	Int32	An integer indicating the data type. This value is determined at run time based on the environment.
Length	Int32	The storage size of the column.
DisplaySize	Int32	The designated column's normal maximum width in characters.
NumericPrecision	Int32	The maximum number of digits in numeric data. The column length in characters for character and date-time data.
NumericScale	Int32	The column scale or number of digits to the right of the decimal point.
IsNullable	Boolean	Whether the column can contain null.
Description	String	A brief description of the column.
Ordinal	Int32	The sequence number of the column.
IsAutoIncrement	String	Whether the column value is assigned in fixed increments.
IsGeneratedColumn	String	Whether the column is generated.
IsHidden	Boolean	Whether the column is hidden.
IsArray	Boolean	Whether the column is an array.

Lists the available stored procedures.

The following query retrieves the available stored procedures:

SELECT * FROM sys_procedures

Columns

Name	Type	Description
CatalogName	String	The database containing the stored procedure.
SchemaName	String	The schema containing the stored procedure.
ProcedureName	String	The name of the stored procedure.
Description	String	A description of the stored procedure.
ProcedureType	String	The type of the procedure, such as PROCEDURE or FUNCTION.

Describes stored procedure* parameters.

The following query returns information about all of the input parameters for the APCreateGLBatch stored procedure:

SELECT * FROM sys_procedureparameters WHERE ProcedureName='APCreateGLBatch' AND Direction=1 OR Direction=2

Columns

Name	Type	Description
CatalogName	String	The name of the database containing the stored procedure.
SchemaName	String	The name of the schema containing the stored procedure.
ProcedureName	String	The name of the stored procedure* containing the parameter.
ColumnName	String	The name of the stored procedure* parameter.
Direction	Int32	An integer corresponding to the type of the parameter: input (1), input/output (2), or output(4). input/output type parameters can be both input and output parameters.
DataTypeName	String	The name of the data type.
DataType	Int32	An integer indicating the data type. This value is determined at run time based on the environment.
Length	Int32	The number of characters allowed for character data. The number of digits allowed for numeric data.
NumericPrecision	Int32	The maximum precision for numeric data. The column length in characters for character and date-time data.
NumericScale	Int32	The number of digits to the right of the decimal point in numeric data.
IsNullable	Boolean	Whether the parameter can contain null.
IsRequired	Boolean	Whether the parameter is required for execution of the procedure.
IsArray	Boolean	Whether the parameter is an array.
Description	String	The description of the parameter.
Ordinal	Int32	The index of the parameter.

Describes the primary and foreign keys. The following query retrieves the primary key for the OEInvoices table:

SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='OEInvoices' 

Columns

Name	Type	Description
CatalogName	String	The name of the database containing the key.
SchemaName	String	The name of the schema containing the key.
TableName	String	The name of the table containing the key.
ColumnName	String	The name of the key column.
IsKey	Boolean	Whether the column is a primary key in the table referenced in the TableName field.
IsForeignKey	Boolean	Whether the column is a foreign key referenced in the TableName field.
PrimaryKeyName	String	The name of the primary key.
ForeignKeyName	String	The name of the foreign key.
ReferencedCatalogName	String	The database containing the primary key.
ReferencedSchemaName	String	The schema containing the primary key.
ReferencedTableName	String	The table containing the primary key.
ReferencedColumnName	String	The column name of the primary key.

Describes the foreign keys. The following query retrieves all foreign keys which refer to other tables:

SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'

Columns

Name	Type	Description
CatalogName	String	The name of the database containing the key.
SchemaName	String	The name of the schema containing the key.
TableName	String	The name of the table containing the key.
ColumnName	String	The name of the key column.
PrimaryKeyName	String	The name of the primary key.
ForeignKeyName	String	The name of the foreign key.
ReferencedCatalogName	String	The database containing the primary key.
ReferencedSchemaName	String	The schema containing the primary key.
ReferencedTableName	String	The table containing the primary key.
ReferencedColumnName	String	The column name of the primary key.
ForeignKeyType	String	Designates whether the foreign key is an import (points to other tables) or export (referenced from other tables) key.

Describes the available indexes. By filtering on indexes, you can write more selective queries with faster query response times.

The following query retrieves all indexes that are not primary keys:

SELECT * FROM sys_indexes WHERE IsPrimary='false'

Columns

Name	Type	Description
CatalogName	String	The name of the database containing the index.
SchemaName	String	The name of the schema containing the index.
TableName	String	The name of the table containing the index.
IndexName	String	The index name.
ColumnName	String	The name of the column associated with the index.
IsUnique	Boolean	True if the index is unique. False otherwise.
IsPrimary	Boolean	True if the index is a primary key. False otherwise.
Type	Int16	An integer value corresponding to the index type: statistic (0), clustered (1), hashed (2), or other (3).
SortOrder	String	The sort order: A for ascending or D for descending.
OrdinalPosition	Int16	The sequence number of the column in the index.

Returns information on the available connection properties and those set in the connection string.

When querying this table, the config connection string should be used:

jdbc:cdata:sage300:config:

This connection string enables you to query this table without a valid connection.

The following query retrieves all connection properties that have been set in the connection string or set through a default value:

SELECT * FROM sys_connection_props WHERE Value <> ''

Columns

Name	Type	Description
Name	String	The name of the connection property.
ShortDescription	String	A brief description.
Type	String	The data type of the connection property.
Default	String	The default value if one is not explicitly set.
Values	String	A comma-separated list of possible values. A validation error is thrown if another value is specified.
Value	String	The value you set or a preconfigured default.
Required	Boolean	Whether the property is required to connect.
Category	String	The category of the connection property.
IsSessionProperty	String	Whether the property is a session property, used to save information about the current connection.
Sensitivity	String	The sensitivity level of the property. This informs whether the property is obfuscated in logging and authentication forms.
PropertyName	String	A camel-cased truncated form of the connection property name.
Ordinal	Int32	The index of the parameter.
CatOrdinal	Int32	The index of the parameter category.
Hierarchy	String	Shows dependent properties associated that need to be set alongside this one.
Visible	Boolean	Informs whether the property is visible in the connection UI.
ETC	String	Various miscellaneous information about the property.

Describes the SELECT query processing that the connector can offload to the data source.

Collaborative Query Processing

When working with data sources that do not support SQL-92, you can query the sys_sqlinfo view to determine the query capabilities of the underlying APIs, expressed in SQL syntax. The connector offloads as much of the SELECT statement processing as possible to the server and then processes the rest of the query in memory.

Discovering the Data Source's SELECT Capabilities

Below is an example data set of SQL capabilities. The following result set indicates the SELECT functionality that the connector can offload to the data source or process client side. Your data source may support additional SQL syntax. Some aspects of SELECT functionality are returned in a comma-separated list if supported; otherwise, the column contains NO.

Name	Description	Possible Values
AGGREGATE_FUNCTIONS	Supported aggregation functions.	AVG, COUNT, MAX, MIN, SUM, DISTINCT
COUNT	Whether COUNT function is supported.	YES, NO
IDENTIFIER_QUOTE_OPEN_CHAR	The opening character used to escape an identifier.	[
IDENTIFIER_QUOTE_CLOSE_CHAR	The closing character used to escape an identifier.	]
SUPPORTED_OPERATORS	A list of supported SQL operators.	=, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR
GROUP_BY	Whether GROUP BY is supported, and, if so, the degree of support.	NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE
STRING_FUNCTIONS	Supported string functions.	LENGTH, CHAR, LOCATE, REPLACE, SUBSTRING, RTRIM, LTRIM, RIGHT, LEFT, UCASE, SPACE, SOUNDEX, LCASE, CONCAT, ASCII, REPEAT, OCTET, BIT, POSITION, INSERT, TRIM, UPPER, REGEXP, LOWER, DIFFERENCE, CHARACTER, SUBSTR, STR, REVERSE, PLAN, UUIDTOSTR, TRANSLATE, TRAILING, TO, STUFF, STRTOUUID, STRING, SPLIT, SORTKEY, SIMILAR, REPLICATE, PATINDEX, LPAD, LEN, LEADING, KEY, INSTR, INSERTSTR, HTML, GRAPHICAL, CONVERT, COLLATION, CHARINDEX, BYTE
NUMERIC_FUNCTIONS	Supported numeric functions.	ABS, ACOS, ASIN, ATAN, ATAN2, CEILING, COS, COT, EXP, FLOOR, LOG, MOD, SIGN, SIN, SQRT, TAN, PI, RAND, DEGREES, LOG10, POWER, RADIANS, ROUND, TRUNCATE
TIMEDATE_FUNCTIONS	Supported date/time functions.	NOW, CURDATE, DAYOFMONTH, DAYOFWEEK, DAYOFYEAR, MONTH, QUARTER, WEEK, YEAR, CURTIME, HOUR, MINUTE, SECOND, TIMESTAMPADD, TIMESTAMPDIFF, DAYNAME, MONTHNAME, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, EXTRACT
REPLICATION_SKIP_TABLES	Indicates tables skipped during replication.
REPLICATION_TIMECHECK_COLUMNS	A string array containing a list of columns which will be used to check for (in the given order) to use as a modified column during replication.
IDENTIFIER_PATTERN	String value indicating what string is valid for an identifier.
SUPPORT_TRANSACTION	Indicates if the provider supports transactions such as commit and rollback.	YES, NO
DIALECT	Indicates the SQL dialect to use.
KEY_PROPERTIES	Indicates the properties which identify the uniform database.
SUPPORTS_MULTIPLE_SCHEMAS	Indicates if multiple schemas may exist for the provider.	YES, NO
SUPPORTS_MULTIPLE_CATALOGS	Indicates if multiple catalogs may exist for the provider.	YES, NO
DATASYNCVERSION	The Data Sync version needed to access this driver.	Standard, Starter, Professional, Enterprise
DATASYNCCATEGORY	The Data Sync category of this driver.	Source, Destination, Cloud Destination
SUPPORTSENHANCEDSQL	Whether enhanced SQL functionality beyond what is offered by the API is supported.	TRUE, FALSE
SUPPORTS_BATCH_OPERATIONS	Whether batch operations are supported.	YES, NO
SQL_CAP	All supported SQL capabilities for this driver.	SELECT, INSERT, DELETE, UPDATE, TRANSACTIONS, ORDERBY, OAUTH, ASSIGNEDID, LIMIT, LIKE, BULKINSERT, COUNT, BULKDELETE, BULKUPDATE, GROUPBY, HAVING, AGGS, OFFSET, REPLICATE, COUNTDISTINCT, JOINS, DROP, CREATE, DISTINCT, INNERJOINS, SUBQUERIES, ALTER, MULTIPLESCHEMAS, GROUPBYNORELATION, OUTERJOINS, UNIONALL, UNION, UPSERT, GETDELETED, CROSSJOINS, GROUPBYCOLLATE, MULTIPLECATS, FULLOUTERJOIN, MERGE, JSONEXTRACT, BULKUPSERT, SUM, SUBQUERIESFULL, MIN, MAX, JOINSFULL, XMLEXTRACT, AVG, MULTISTATEMENTS, FOREIGNKEYS, CASE, LEFTJOINS, COMMAJOINS, WITH, LITERALS, RENAME, NESTEDTABLES, EXECUTE, BATCH, BASIC, INDEX
PREFERRED_CACHE_OPTIONS	A string value specifies the preferred cacheOptions.
ENABLE_EF_ADVANCED_QUERY	Indicates if the driver directly supports advanced queries coming from Entity Framework. If not, queries will be handled client side.	YES, NO
PSEUDO_COLUMNS	A string array indicating the available pseudo columns.
MERGE_ALWAYS	If the value is true, The Merge Mode is forcibly executed in Data Sync.	TRUE, FALSE
REPLICATION_MIN_DATE_QUERY	A select query to return the replicate start datetime.
REPLICATION_MIN_FUNCTION	Allows a provider to specify the formula name to use for executing a server side min.
REPLICATION_START_DATE	Allows a provider to specify a replicate startdate.
REPLICATION_MAX_DATE_QUERY	A select query to return the replicate end datetime.
REPLICATION_MAX_FUNCTION	Allows a provider to specify the formula name to use for executing a server side max.
IGNORE_INTERVALS_ON_INITIAL_REPLICATE	A list of tables which will skip dividing the replicate into chunks on the initial replicate.
CHECKCACHE_USE_PARENTID	Indicates whether the CheckCache statement should be done against the parent key column.	TRUE, FALSE
CREATE_SCHEMA_PROCEDURES	Indicates stored procedures* that can be used for generating schema files.

The following query retrieves the operators that can be used in the WHERE clause:

SELECT * FROM sys_sqlinfo WHERE Name='SUPPORTED_OPERATORS'

Note that individual tables may have different limitations or requirements on the WHERE clause; refer to the Data Model section for more information.

Columns

Name	Type	Description
NAME	String	A component of SQL syntax, or a capability that can be processed on the server.
VALUE	String	Detail on the supported SQL or SQL syntax.

Returns information about attempted modifications.

The following query retrieves the Ids of the modified rows in a batch operation:

SELECT * FROM sys_identity

Columns

Name	Type	Description
Id	String	The database-generated ID returned from a data modification operation.
Batch	String	An identifier for the batch. 1 for a single operation.
Operation	String	The result of the operation in the batch: INSERTED, UPDATED, or DELETED.
Message	String	SUCCESS or an error message if the update in the batch failed.

The advanced configurations 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. Click the links for further details.

Authentication

---

Property	Description
URL	Set the URL to the HTTP or HTTPS endpoint of your Sage 300 system. For example, http://localhost/Sage300WebApi/v1.0/-/.
User	The Sage 300 user account used to authenticate.
Password	The password used to authenticate the user.

Connection

---

Property	Description
Company	Determines the company.
Modules	Comma separated list of modules.

SSL

---

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

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
IncludeCustomFields	Determines if Custom Fields should be included as table columns or not.
MaxRows	Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.
Other	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.
RowScanDepth	The maximum number of rows to scan to look for the columns available in a table.
Timeout	The value in seconds until the timeout error is thrown, canceling the operation.

This section provides a complete list of authentication properties you can configure.

---

Property	Description
URL	Set the URL to the HTTP or HTTPS endpoint of your Sage 300 system. For example, http://localhost/Sage300WebApi/v1.0/-/.
User	The Sage 300 user account used to authenticate.
Password	The password used to authenticate the user.

Set the URL to the HTTP or HTTPS endpoint of your Sage 300 system. For example, http://localhost/Sage300WebApi/v1.0/-/.

Data Type

string

Default Value

""

Remarks

Set the URL to the HTTP or HTTPS endpoint of your Sage 300 system.Construct a URL for the Sage 300 Web API as follows: {protocol}://{host-application-path}/v{version}/{tenant}/ For example, http://localhost/Sage300WebApi/v1.0/-/.

The Sage 300 user account used to authenticate.

Data Type

string

Default Value

""

Remarks

Together with Password, this field is used to authenticate against the Sage 300 server.

The password used to authenticate the user.

Data Type

string

Default Value

""

Remarks

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

This section provides a complete list of connection properties you can configure.

---

Property	Description
Company	Determines the company.
Modules	Comma separated list of modules.

Determines the company.

Data Type

string

Default Value

""

Remarks

Specify the company you wish to get data from. If not specified, the first company found on /Companies endpoint will be choosen.

Comma separated list of modules.

Data Type

string

Default Value

"*"

Remarks

Comma separated list of modules. (Use this connection property to have access only on the desired modules. This will improve performance of the metadata retrieved.) Options: AP(Account Payable), AR(Account Receivable), BK(Banks), CS(Common Services), GL(General Ledger), IC(Inventory Control), OE(Order Entry), PO(Purchase Orders), TX(TaxTracking)

This section provides a complete list of SSL properties you can configure.

---

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.

Data Type

string

Default Value

""

Remarks

If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine 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.

Certificates are validated as trusted by the machine based on the System's trust store. The trust store used is the 'javax.net.ssl.trustStore' value specified for the system. If no value is specified for this property, Java's default trust store is used (for example, JAVA_HOME\lib\security\cacerts).

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

This section provides a complete list of schema properties you can configure.

---

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.

Data Type

string

Default Value

"%APPDATA%\\Sage300 Data Provider\Schema"

Remarks

The path to a directory which contains the schema files for the connector (.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%\\Sage300 Data Provider\Schema" with %APPDATA% being set to the user's configuration directory:

Platform	%APPDATA%
Windows	The value of the APPDATA environment variable
Mac	~/Library/Application Support
Linux	~/.config

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

Data Type

string

Default Value

""

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.

Data Type

string

Default Value

""

Remarks

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

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.

Data Type

string

Default Value

""

Remarks

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

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 miscellaneous properties you can configure.

---

Property	Description
IncludeCustomFields	Determines if Custom Fields should be included as table columns or not.
MaxRows	Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.
Other	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.
RowScanDepth	The maximum number of rows to scan to look for the columns available in a table.
Timeout	The value in seconds until the timeout error is thrown, canceling the operation.

Determines if Custom Fields should be included as table columns or not.

Data Type

bool

Default Value

false

Remarks

To retrieve their values you can set IncludeCustomFields=true as a connection property. Doing so will list the custom fields created as table columns.

Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.

Data Type

int

Default Value

-1

Remarks

Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.

These hidden properties are used only in specific use cases.

Data Type

string

Default Value

""

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.

Data Type

string

Default Value

""

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 maximum number of rows to scan to look for the columns available in a table.

Data Type

int

Default Value

100

Remarks

The columns in a table must be determined by scanning table rows. This value determines the maximum number of rows that will be scanned.

Setting a high value may decrease performance. Setting a low value may prevent the data type from being determined properly, especially when there is null data.

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

Data Type

int

Default Value

60

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 connector throws an exception.