Sage 300 Connection Details¶

Introduction¶

Connector Version

This documentation is based on version 23.0.8843 of the connector.

Get Started¶

Sage 300 Version Support

The connector leverages the Sage 300 API to enable bidirectional access to Sage 300. Supported Sage 300 modules include:

• AP (Account Payable)
• AR (Account Receivable)
• BK (Banks)
• CS (Common Services)
• GL (General Ledger)
• IC (Inventory Control)
• OE (Order Entry)
• PO (Purchase Orders)
• TX (Tax Tracking)

Establish a Connection¶

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.

Create 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

Set 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).

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

Connect 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¶

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.

Important Notes¶

Configuration Files and Their Paths¶

• All references to adding configuration files and their paths refer to files and locations on the 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.

Advanced Features¶

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.

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 (client-side).

See Query Processing for more information.

User Defined Views¶

The Sage 300 connector 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.

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

Define Views Using DDL Statements¶

The connector is also capable of creating and altering the schema via DDL Statements such as CREATE LOCAL VIEW, ALTER LOCAL VIEW, and DROP LOCAL VIEW.

Create a View¶

To create a new view using DDL statements, provide the view name and query as follows:

CREATE LOCAL VIEW [MyViewName] AS SELECT * FROM Customers LIMIT 20;

If no JSON file exists, the above code creates one. The view is then created in the JSON configuration file and is now discoverable. The JSON file location is specified by the UserDefinedViews connection property.

Alter a View¶

To alter an existing view, provide the name of an existing view alongside the new query you would like to use instead:

ALTER LOCAL VIEW [MyViewName] AS SELECT * FROM Customers WHERE TimeModified > '3/1/2020';

The view is then updated in the JSON configuration file.

Drop a View¶

To drop an existing view, provide the name of an existing schema alongside the new query you would like to use instead.

DROP LOCAL VIEW [MyViewName]

This removes the view from the JSON configuration file. It can no longer be queried.

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.

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

SSL Configuration¶

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

Data Model¶

Overview

The Sage 300 connector 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

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

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.

Stored Procedures¶

Stored procedures are function-like interfaces that extend the functionality of the connector beyond simple SELECT operations with Sage 300.

Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from Sage 300, along with an indication of whether the procedure succeeded or failed.

Sage 300 Connector Stored Procedures¶

APCreateGLBatch¶

Usage information for the operation APCreateGLBatch.rsb.

Input¶

Result Set Columns¶

APCreateRecurringPayableBatch¶

Usage information for the operation APCreateRecurringPayableBatch.rsb.

Input¶

Result Set Columns¶

APCreateRetainageDocumentBatch¶

Usage information for the operation APCreateRetainageDocumentBatch.rsb.

Input¶

Result Set Columns¶

APDeleteInactiveRecords¶

Usage information for the operation APDeleteInactiveRecords.rsb.

Input¶

Result Set Columns¶

APPostInvoices¶

Usage information for the operation APPostInvoices.rsb.

Input¶

Result Set Columns¶

APPostPaymentsAndAdjustments¶

Usage information for the operation APPostPaymentsAndAdjustments.rsb.

Input¶

Result Set Columns¶

ARCreateGLBatch¶

Usage information for the operation ARCreateGLBatch.rsb.

Input¶

Result Set Columns¶

ARCreateRecurringCharge¶

Usage information for the operation ARCreateRecurringCharge.rsb.

Input¶

Result Set Columns¶

ARCreateRetainageDocumentBatch¶

Usage information for the operation ARCreateRetainageDocumentBatch.rsb.

Input¶

Result Set Columns¶

ARPostInvoices¶

Usage information for the operation ARPostInvoices.rsb.

Input¶

Result Set Columns¶

ARPostReceiptsAndAdjustments¶

Usage information for the operation ARPostReceiptsAndAdjustments.rsb.

Input¶

Result Set Columns¶

ARPostRefunds¶

Usage information for the operation ARPostRefunds.rsb.

Input¶

Result Set Columns¶

CreateSchema¶

Creates a schema file for the specified table or view.

CreateSchema¶

Creates a local schema file (.rsd) from an existing table or view in the data model.

The schema file is created in the directory set in the Location connection property when this procedure is executed. You can edit the file to include or exclude columns, rename columns, or adjust column datatypes.

The connector checks the Location to determine if the names of any .rsd files match a table or view in the data model. If there is a duplicate, the schema file will take precedence over the default instance of this table in the data model. If a schema file is present in Location that does not match an existing table or view, a new table or view entry is added to the data model of the connector.

Input¶

Result Set Columns¶

GLPostJournal¶

Usage information for the operation GLPostJournal.rsb.

Input¶

Result Set Columns¶

ICCreateGLBatch¶

Usage information for the operation ICCreateGLBatch.rsb.

Input¶

Result Set Columns¶

ICDayEndProcessing¶

Usage information for the operation ICDayEndProcessing.rsb.

Input¶

Result Set Columns¶

POCreateBatch¶

Usage information for the operation POCreateBatch.rsb.

Input¶

Result Set Columns¶

PODayEndProcessing¶

Usage information for the operation PODayEndProcessing.rsb.

Input¶

Result Set Columns¶

System Tables¶

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.

sys_catalogs¶

Lists the available databases.

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

SELECT * FROM sys_catalogs

Columns¶

sys_schemas¶

Lists the available schemas.

The following query retrieves all available schemas:

SELECT * FROM sys_schemas

Columns¶

sys_tables¶

Lists the available tables.

The following query retrieves the available tables and views:

SELECT * FROM sys_tables

Columns¶

sys_tablecolumns¶

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¶

sys_procedures¶

Lists the available stored procedures.

The following query retrieves the available stored procedures:

SELECT * FROM sys_procedures

Columns¶

sys_procedureparameters¶

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¶

sys_keycolumns¶

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¶

sys_foreignkeys¶

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¶

sys_primarykeys¶

Describes the primary keys.

The following query retrieves the primary keys from all tables and views:

SELECT * FROM sys_primarykeys

Columns¶

sys_indexes¶

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¶

sys_connection_props¶

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¶

sys_sqlinfo¶

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

Discovering the Data Source's SELECT Capabilities¶

Below is an example data set of SQL capabilities. Some aspects of SELECT functionality are returned in a comma-separated list if supported; otherwise, the column contains NO.

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¶

sys_identity¶

Returns information about attempted modifications.

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

SELECT * FROM sys_identity

Columns¶

Advanced Configurations Properties¶

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

Connection

SSL

Schema

Miscellaneous

Authentication¶

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

URL¶

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

User¶

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.

Password¶

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.

Connection¶

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

Company¶

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.

Modules¶

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)

SSL¶

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

SSLServerCert¶

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:

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.

Schema¶

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

Location¶

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:

BrowsableSchemas¶

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.

Tables¶

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.

Views¶

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.

Miscellaneous¶

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

IncludeCustomFields¶

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.

MaxRows¶

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

Data Type¶

int

Default Value¶

-1

Remarks¶

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

Other¶

These hidden properties are used only in specific use cases.

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¶

PseudoColumns¶

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, "*=*".

RowScanDepth¶

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.

Timeout¶

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.

UserDefinedViews¶

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

Data Type¶

string

Default Value¶

""

Remarks¶

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

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