Manuals

The Dharma Interface Manual explains how our ODBC interface works and details supported SQL statements and syntax.

• Entering a Database on the connection screen will cause connection problems. Leave the database blank.

• AppxODBCserver_5_0_2_windows.exe

This will install the "Appx ODBC Data Gateway Service" and supporting files. This service runs listening on TCP port 1990 for connections from the Appx ODBC Driver installed on someone's desktop. The Data Gateway contains one or more database directories each with it's own schemas imported via ASQL and each having its own appx.env file that tells it the host and port of the Appx FMS Server for that database. By default the installer creates a default database called "appx". This creates a directory tree in the server install directory called "appx.dbs". That directory contains all the schema files for database "appx" as well as its appx.env file. The bin subdirectory of the AppxODBC Server directory contains two important executables the gateway service tool AppxODBC.exe. This is the program that will listen for connection attempts on TCP port 1990 from desktop computers running the Appx ODBC driver. You'll also find in the bin sub directory the mdcreate.exe. I'll explain this in an example further in this documentation, but mdcreate is a command line tool used to optionally create connections to secondary APPX servers.

When a connection request is received from a desktop driver it takes the database from the request, "appx" by default, reads the appx.env file, and attempts to start up an FMS connection to that Appx host using the login and password received from the desktop driver. If authentication is successful then it starts brokering SQL requests from the driver to the FMS server. You have a new Data Gateway task for each driver connection. Each Data Gateway task creates its own FMS connection to the Appx server.

The installer should create everything needed in the way of the "appx" database, the appx.env file, and configure and start the service task. Upon completion of the installer the Appx ODBC Data Gateway should be ready for connections. This installer does not install an Appx ODBC driver or ASQL application. Nothing on this server is visibly runnable other than you can see that the service is running and you can look at the appx.env file to see that it looks right.

• AppxODBCdriver_5_0_2_windows.exe

This will install the desktop Appx ODBC Driver. This is what WinSQL and other desktop application will use to connect to the Appx ODBC Data Gateway, which in turn connect to APPX. During the install it will create a default System DSN using the driver and setting up the DSN to properly connect to the Appx ODBC Data Gateway. Once this installer is done the driver should be installed and there should be a functioning System DSN you can use to request data. That can't happen until ASQL has been run to import Appx data dictionaries into the Data Gateway database schemas. ASQL is not included in this installer for security reasons. When you use the driver to get data the user and password you use is your Appx user and password for the Appx server on the back end of the FMS connection between the Appx ODBC Data Gateway and the Appx FMS server.

• AppxODBCdriver+ASQL_5_0_2_windows.exe

This is the same as the other driver installer except that it does include ASQL. This must be installed on at least one desktop so that ASQL.exe can be used to import the APPX data dictionary of the desired APPX files.

WinSQL failure to connect to the APPX ODBC gateway server (aka appxODBC Server) on TCP port 1990.

Appx ODBC Gateway Service stopped or blocked by firewall.

ASQL.exe failure to connect to the APPX ODBC gateway server (aka appxODBC Server) on TCP port 1990.

If you receive the either of the two above errors, verify that the appxODBC Server's service named "Appx ODBC Data Gateway Service 05.02.0000" is started. Also make sure the TCP port 1990 is not blocked between the Appx ODBC client and Appx ODBC server.

Missing $APPXPATH\0SA\Struct\SYSDIR.dat

If you receive an error like below when you connect to a local instance of APPX via ASQL, you may be missing the 0SA\Struct\SYSDIR.dat file. You can create this file by selecting System Administration > System Setup > System Administration File Management > Create Files. Then restart ASQL and attempt to connect to APPX again.

The images above can occur when 0SA\Struct\SYSDIR.dat file is missing. This error will occur at the beginning of the connection attempt from ASQL to APPX.

Installing on Windows 64 bit

AppxODBC is a 32 bit product. The Windows ODBC System DSN it creates is 32 bit not 64 bit. To view and manage 32 bit DSNs on a 64 bit version of Windows, you must specify the 32 bit version of odbcad32.exe. For 64 bit Windows, to manage 32 bit DSNs like AppxODBC, use \Windows\SysWOW64\odbcad32.exe and not the 64 bit version with the same name found at \Windows\system32\odbcad32.exe.

If you are working on a 32 bit version, this does not apply to you, just run the odbcad32.exe found in your Administrative tools (which is mapped to \Windows\system32\odbcad32.exe.)

Known Issues

• APPX Server version and AppxODBC version should match. Mismatched version can cause failure to connect, or extreme loss of performance in AppxODBC data connection.

Linux and Unix

Troubleshooting AppxODBC Server

Troubleshooting AppxODBC Driver/ASQL

Troubleshooting

Manually creating a new AppxODBC data source on the AppxODBC Server

Importing APPX data structure via the AppxODBC ASQL tool.

The image above demonstrates the use of OS commands tasklist, findstr and netstat to verify that the AppxODBC server process is indeed running and listening on TCP port number 1990.

In the image above, you can see the service "Appx ODBC Data Gateway Service" in the OS Services panel. Notice that the Startup Type is set to Automatic, and the Status is Started.

As you can see in the image above, the tool placed an uninstall option in the just created AppxODBC menu group.

The directory listing above shows some of the files that are created in the AppxODBC Server directory structure. Notice the executable in the bin subdirectory, the appx.dbs subdirectory and the appx.env file inside appx.dbs. appx.dbs is the directory created for the default DSN database named appx. The configuration information for TCP port number of APPX and the APPX Server name is contained in the appx.env file.

C:\Program Files (x86)\AppxODBC Server>more appx.dbs\appx.env

APPX_DATA_SERVER=hankwilliams.internal.appx.com:8060

C:\Program Files (x86)\AppxODBC Server>

See above the contents of the appx.env file.

Download and run the AppxODBC driver and ASQL data importer.

With AppxODBC 5.0.2 we've seperated the ODBC driver from the data importer. You may wish to put the APPX Server, AppxODBC server and AppxODBC driver and ASQL all on one machine. Then put just the AppxODBCdriver on each client's desktop that needs to access APPX from an application such as Microsoft Excel. If the AppxODBC user is an APPX developer, it might be desirable to have the AppxODBC driver and ASQL importer on the same desktop as the ODBC client client application (Excel, Crystal Reports, etc...). For this example I am keeping all AppxODBC components on a single machine, with the APPX Server on a separate machine. Your configuration could demand each component be installed on a separate machine.
I'm going to execute the AppxODBCdriver+ASQL_5_0_2_windows.exe to begin the installation of the driver and ASQL importer.

Click Next on the APPX ODBC installation welcome screen.

The APPX ODBC server is a 32bit application. It will install by default to either C:\Program Files\AppxODBC Server\ if you are installing it on a 32 bit version of Windows, or C:|Program Files (x86)\AppxODBC Server\ if you are installing onto a 64 bit version of Windows.

Verify TCP Port 1990 is open via Netstat Command

The port is available as you can see in the image above.

Download and run the APPX ODBC Server installation file.

Let's download the APPX ODBC Server and start the installation.

APPX ODBC Installations Instructions

This page provides instructions for installing APPX ODBC 5.

Overview

APPX ODBC is used by APPX customers to gain access to APPX data from external products, such as Crystal Reports or Excel. Installation of APPX ODBC 5 is accomplished by simply following the steps outlined below. APPX ODBC 5 is a Windows only product for now.

APPX ODBC 5 is a new product compared to earlier versions of APPX ODBC. There is no upgrade, just uninstall the older version prior to installing the new version.

Disclaimer

APPX ODBC 5 includes many new features and bug fixes. As always, before upgrading your APPX production system, you are strongly encouraged to install APPX ODBC 5 into a test environment where you can verify the compatibility of your applications. APPX ODBC 5 has been thoroughly tested but, because of the complexity of computer software, there will certainly be bugs and some ODBC clients that will not be able to connect to the ODBC server. Consequently, there is no guarantee that your applications will be completely compatible with this significant new release. It is your responsibility to test your applications to ensure that they are compatible with this new release of APPX ODBC and to make any changes that may be necessary to maintain compatibility. Finally, before upgrading your production system, make a backup of your applications and your data. Your computer software and your data are important assets of your organization. Please be prudent and take the steps needed to protect this important investment.

Known Issues:

• ?

APPX ODBC Server and Driver Installation Instructions

Windows Server/XP/Vista/Win 7

New Installation

Documentation

Overview:

AppxODBC requires 3 components to work now. The Appx FMS Server, The Appx ODBC Data Gateway, and the Appx ODBC Driver. The Appx FMS server should already be installed and running. Step 2 is to install the Appx ODBC Data Gateway, then the Appx ODBC Driver + ASQL. Run ASQL to import Apppx dictionaries. Then on non-admin PCs install the Appx ODBC Driver (minus ASQL). Here's what each installer does do...

AppxODBCserver_5_0_2_windows.exe

This will install the "Appx ODBC Data Gateway Service" and supporting files. This service runs listening on TCP port 1990 for connections from the Appx ODBC Driver installed on someone's desktop. The Data Gateway contains one or more database directories each with it's own schemas imported via ASQL and each having its own appx.env file that tells it the host and port of the Appx FMS Server for that database. By default the installer creates a default database called "appx". This creates a directory tree in the server install directory called "appx.dbs". That directory contains all the schema files for database "appx" as well as its appx.env file.

When a connection request is received from a desktop driver it takes the database from the request, "appx" by default, reads the appx.env file, and attempts to start up an FMS connection to that Appx host using the login and password received form the desktop driver. If authentication is successful then it starts brokering SQL requests from the driver to the FMS server. You have a new Data Gateway task for each driver connection. Each Data Gateway task creates its own FMS connection to the Appx server.

The installer should create everything needed in the way of the "appx" database, the appx.env file, and configure and start the service task. Upon completion of the installer the Appx ODBC Data Gateway should be ready for connections. This installer does not install an Appx ODBC driver or ASQL application. Nothing on this server is visibly runnable other than you can see that the service is running and you can look at the appx.env file to see that it looks right.

AppxODBCdriver_5_0_2_windows.exe

This will install the desktop Appx ODBC Driver. This is what WinSQL and other desktop application will use to connect to the Appx ODBC Data Gateway. During the install it will create a default System DSN using the driver and setting up the DSN to properly connect to the Appx ODBC Data Gateway. Once this installer is done the driver should be installed and there should be a functioning System DSN you can use to request data. That can't happen until ASQL has been run to import Appx data dictionaries into the Data Gateway database schemas. ASQL is not included in this installer for security reasons. When you use the driver to get data the user and password you use is your Appx user and password for the Appx server on the back end of the FMS connection between the Appx ODBC Data Gateway and the Appx FMS server.

AppxODBCdriver+ASQL_5_0_2_windows.exe

This is the same as the other driver installer except that it does include ASQL. This is what administrators will install when they will be manipulating the Data Gateway schemas and importing Appx dictionaries.

Comments:

Read what other users have said about this page or add your own comments.

<--/commentPlugin-->

-- JoeOrtagus - 2010-04-05