Access Sage US Data as a Remote Oracle Database

Use the Oracle ODBC Gateway and Heterogeneous Services technology to access Sage US 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 US to create a database link from Sage US to Oracle and to query Sage US data through the SQL*Plus tool. You can also create the database link and execute queries from SQL Developer.

Connect to Sage US as an ODBC Data Source

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

The Application Id and Company Name connection string options are required to connect to Sage as a data source. You can obtain an Application Id by contacting Sage directly to request access to the Sage 50 SDK.

Sage must be installed on the machine. The Sage.Peachtree.API.dll and Sage.Peachtree.API.Resolver.dll assemblies are required. These assemblies are installed with Sage in C:\Program Files\Sage\Peachtree\API\. Additionally, the Sage SDK requires .NET Framework 4.0 and is only compatible with 32-bit applications. To use the Sage SDK in Visual Studio, set the Platform Target property to "x86" in Project -> Properties -> Build.

You must authorize the application to access company data: To authorize your application to access Sage, restart the Sage application, open the company you want to access, and connect with your application. You will then be prompted to set access permissions for the application in the resulting dialog.

While the compiled executable will require authorization only once, during development you may need to follow this process to reauthorize a new build. To avoid restarting the Sage application when developing with Visual Studio, click Build -> Configuration Manager and uncheck "Build" for your project.

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 US 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 US 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 Sage50US Source] Driver = CData ODBC Driver for Sage US Description = My Description ApplicationId = 8dfafu4V4ODmh1fM0xx CompanyName = Bellwether Garden Supply - Premium

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 US data just as you would an Oracle database. Set the following properties when working with Sage US 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-sage50us/lib/cdata.odbc.sage50us.ini in a text editor and set the encoding.

cdata.odbc.sage50us.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 US data that enables you to query live Sage US data as an Oracle database.

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

    initmysagedb.ora

    HS_FDS_CONNECT_INFO = "CData Sage50US 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 = mysagedb) (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 = mysagedb) (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

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

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

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

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

SELECT * from "Customer"@mysagedb WHERE Name = 'ALDRED';