Ready to get started?

Learn more about the CData ODBC Driver for Sage 300 or download a free trial:

Download Now

Access Sage 300 Data as a Remote Oracle Database

Use the Oracle ODBC Gateway and Heterogeneous Services technology to access Sage 300 data from your Oracle system.

The Oracle Database Gateway for ODBC and Heterogeneous Services technology enable you to connect to ODBC data sources as remote Oracle databases. This article shows how to use the CData ODBC Driver for Sage 300 to create a database link from Sage 300 to Oracle and to query Sage 300 data through the SQL*Plus tool. You can also create the database link and execute queries from SQL Developer.

Connect to Sage 300 as an ODBC Data Source

Information for connecting to Sage 300 follows, along with different instructions for configuring a DSN in Windows and Linux environments.

Sage 300 requires some initial setup in order to communicate over the Sage 300 Web API.

  • Set up the security groups for the Sage 300 user. Give the Sage 300 user access to the option under Security Groups (per each module required).
  • Edit both web.config files in the /Online/Web and /Online/WebApi folders; change the key AllowWebApiAccessForAdmin to true. Restart the webAPI app-pool for the settings to take.
  • Once the user access is configured, click https://server/Sage300WebApi/ to ensure access to the web API.

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 reuses the session opened by Sage 300 using cookies. This means that your credentials are used only on the first request to open the session. After that, cookies returned from Sage 300 are 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.

Windows

If you have not already, first specify connection properties in an ODBC DSN (data source name). This is the last step of the driver installation. You can use the Microsoft ODBC Data Source Administrator to create and configure ODBC DSNs.

Note: If you need to modify the DSN or create other Sage 300 DSNs, you must use a system DSN and the bitness of the DSN must match your Oracle system. You can access and create 32-bit DSNs on a 64-bit system by opening the 32-bit ODBC Data Source Administrator from C:\Windows\SysWOW64\odbcad32.exe.

Linux

If you are installing the CData ODBC Driver for Sage 300 in a Linux environment, the driver installation predefines a system DSN. You can modify the DSN by editing the system data sources file (/etc/odbc.ini) and defining the required connection properties.

/etc/odbc.ini

[CData Sage300 Source] Driver = CData ODBC Driver for Sage 300 Description = My Description User = SAMPLE Password = password URL = http://127.0.0.1/Sage300WebApi/v1/-/ Company = SAMINC

For specific information on using these configuration files, please refer to the help documentation (installed and found online).

Set Connection Properties for Compatibility with Oracle

The driver provides several connection properties that streamline accessing Sage 300 data just as you would an Oracle database. Set the following properties when working with Sage 300 data in SQL*Plus and SQL Developer. For compatibility with Oracle, you will need to set the following connection properties, in addition to authentication and other required connection properties.

  • MapToWVarchar=False

    Set this property to map string data types to SQL_VARCHAR instead of SQL_WVARCHAR. By default, the driver uses SQL_WVARCHAR to accommodate various international character sets. You can use this property to avoid the ORA-28528 Heterogeneous Services data type conversion error when the Unicode type is returned.

  • MaximumColumnSize=4000

    Set this property to restrict the maximum column size to 4000 characters.

  • IncludeDualTable=True

    Set this property to mock the Oracle DUAL table. SQL Developer uses this table to test the connection.

Linux Configuration

In Linux environments, Oracle uses UTF-8 to communicate with the unixODBC Driver manager, whereas the default driver encoding is UTF-16. To resolve this, open the file /opt/cdata/cdata-driver-for-sage300/lib/cdata.odbc.sage300.ini in a text editor and set the encoding.

cdata.odbc.sage300.ini

[Driver] DriverManagerEncoding = UTF-8

Configure the ODBC Gateway, Oracle Net, and Oracle Database

Follow the procedure below to set up an ODBC gateway to Sage 300 data that enables you to query live Sage 300 data as an Oracle database.

  1. Create the file initmysage300db.ora in the folder oracle-home-directory/hs/admin and add the following setting:

    initmysage300db.ora

    HS_FDS_CONNECT_INFO = "CData Sage300 Sys"
  2. Add an entry to the listener.ora file. This file is located in oracle-home-directory/NETWORK/admin.

    If you are using the Database Gateway for ODBC, your listener.ora needs to have a SID_LIST_LISTENER entry that resembles the following:

    listener.ora

    SID_LIST_LISTENER = (SID_LIST = (SID_DESC = (SID_NAME = mysage300db) (ORACLE_HOME = your-oracle-home) (PROGRAM = dg4odbc) ) )

    If you are using Heterogeneous Services, your listener.ora needs to have a SID_LIST_LISTENER entry that resembles the following:

    listener.ora

    SID_LIST_LISTENER = (SID_LIST = (SID_DESC = (SID_NAME = mysage300db) (ORACLE_HOME = your-oracle-home) (PROGRAM = hsodbc) ) )
  3. Add the connect descriptor below in tnsnames.ora, located in oracle-home-directory/NETWORK/admin:

    tnsnames.ora

    mysage300db = (DESCRIPTION= (ADDRESS=(PROTOCOL=tcp)(HOST=localhost)(PORT=1521)) (CONNECT_DATA=(SID=mysage300db)) (HS=OK) )
  4. Restart the listener.
  5. Test the configuration with the following command:

    tnsping mysage300db
  6. Open SQL*Plus and create the database link with the command below:

    CREATE DATABASE LINK mysage300db CONNECT TO "user" IDENTIFIED BY "password" USING 'mysage300db';

You can now execute queries in SQL*Plus like the one below (note the double quotation marks around the table name):

SELECT * from "OEInvoices"@mysage300db WHERE AllowPartialShipments = 'Yes';