Difference: APPX61ODBCInstallationInstructions (55 vs. 56)
Revision 562021-06-08 - BrianRyan
| Line: 1 to 1 | |||||||||
|---|---|---|---|---|---|---|---|---|---|
APPX ODBC Installations Instructions_This page provides instructions for installing APPX ODBC 6.1 | |||||||||
| Changed: | |||||||||
| < < | |||||||||
| > > | |||||||||
OverviewAPPX 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 6.1 is accomplished by simply following the steps outlined below. APPX ODBC 6.1 is a Windows only product for now. | |||||||||
| Line: 13 to 13 | |||||||||
 | |||||||||
| Changed: | |||||||||
| < < | AppxODBC requires 3 components to work. The Appx FMS Server (APPX server configured to listen on TCP 8060 by default), The Appx ODBC Data Gateway (aka AppxODBC Server, configured to listen on TCP 1990), and the Appx ODBC Driver with ASQL tool. These components can all be installed on one computer or each component could be installed on separate computers. The Appx FMS server should already be installed and running. The APPX FMS Server is an APPX server configured to accept APPX client connections via TCP, by default TCP 8060. Install the Appx ODBC Data Gateway, then the Appx ODBC Driver + ASQL. Run ASQL to import Apppx dictionaries. On non-admin PCs you could choose to install the Appx ODBC Driver (minus ASQL). Here's what each installer does do...
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 the APPX ODBC server starts brokering requests from the ODBC client desktop's ODBC driver to the APPX FMS server. Your server's process list on the APPX ODBC server will have a new Data Gateway task for each ODBC client driver connection. Each Data Gateway task creates its own APPX 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 using Microsoft Windows Services applet. You might look at the appx.env file to see that it looks right.
| ||||||||
| > > | AppxODBC requires 3 components to work. The Appx FMS Server (APPX server configured to listen on TCP 8060 by default), The Appx ODBC Data Gateway (aka AppxODBC Server, configured to listen on TCP 1992), and the Appx ODBC Driver with ASQL tool. These components can all be installed on one computer or each component could be installed on separate computers. The Appx FMS server should already be installed and running. The APPX FMS Server is an APPX server configured to accept APPX client connections via TCP, by default TCP 8060. Install the Appx ODBC Data Gateway, then the Appx ODBC Driver + ASQL. Run ASQL to import Apppx dictionaries. On non-admin PCs you could choose to install the Appx ODBC Driver (minus ASQL). Here's what each installer does do...
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 the APPX ODBC server starts brokering requests from the ODBC client desktop's ODBC driver to the APPX FMS server. Your server's process list on the APPX ODBC server will have a new Data Gateway task for each ODBC client driver connection. Each Data Gateway task creates its own APPX 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 using Microsoft Windows Services applet. You might look at the appx.env file to see that it looks right.
| ||||||||
| 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. | |||||||||
| Changed: | |||||||||
| < < |
| ||||||||
| > > |
| ||||||||
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.
Disclaimer | |||||||||
| Changed: | |||||||||
| < < | APPX ODBC 6.1 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 6.1 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. | ||||||||
| > > | APPX ODBC 6.1.0 includes many new features and bug fixes. As always, before upgrading your APPX production system, you are strongly encouraged to install APPX ODBC 6.1.0 into a test environment where you can verify the compatibility of your applications. APPX ODBC 6.1.0 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:
| |||||||||
| Line: 39 to 39 | |||||||||
 | |||||||||
| Changed: | |||||||||
| < < | The image above demonstrates using the Windows OS commands netstat and findstr to search for TCP port 1990. As you can see nothing was returned, so we can be sure that the port is available. | ||||||||
| > > | The image above demonstrates using the Windows OS commands netstat and findstr to search for TCP port 1992. As you can see nothing was returned, so we can be sure that the port is available. | ||||||||
Download and run the APPX ODBC Server installation file.Let's download the APPX ODBC Server and start the installation. | |||||||||
| Changed: | |||||||||
| < < |  | ||||||||
| > > |  | ||||||||
| Changed: | |||||||||
| < < | Execute the AppxODBCserver _5_0_2_windows.exe installation file shown in the image above. | ||||||||
| > > | Execute the AppxODBCserver _windows-64.exe or AppxODBCserver _windows-32.exe installation file shown in the image above. Note: For this example we will use AppxODBCserver _windows-64.exe. | ||||||||
 | |||||||||
| Line: 54 to 54 | |||||||||
 | |||||||||
| Changed: | |||||||||
| < < | The APPX ODBC server is either a 32bit or 64bit application depending on which variant that you selected to install. It will install by default to either C:\Program Files\AppxODBC Server\ if you are installing the 64 bit version, or C:|Program Files (x86)\AppxODBC Server\ if you selected the 32 bit version. Note: If you are running a 32 bit version of Windows, you can only install the 32bit version of the APPX ODBC server. | ||||||||
| > > | The APPX ODBC server is either a 32bit or 64bit application depending on which variant that you selected to install. It will install by default to either C:\Program Files\AppxODBC Server\ if you are installing the 64 bit version, or C:\Program Files (x86)\AppxODBC Server\ if you selected the 32 bit version. Note: If you are running a 32 bit version of Windows, you can only install the 32bit version of the APPX ODBC server. | ||||||||
 | |||||||||
| Line: 80 to 80 | |||||||||
| 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. | |||||||||
| Changed: | |||||||||
| < < | 
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. | |||||||||
| Changed: | |||||||||
| < < | 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> | ||||||||
| > > | C:\Program Files\AppxODBC Server>more appx.dbs\appx.env APPX_DATA_SERVER=roxymusic.internal.appx.com:8063 C:\Program Files\AppxODBC Server> | ||||||||
The contents of the appx.env file is displayed above.
Download and run the AppxODBC driver and ASQL data importer. | |||||||||
| Changed: | |||||||||
| < < |  | ||||||||
| > > |  | ||||||||
| Changed: | |||||||||
| < < | 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. | ||||||||
| > > | With AppxODBC 6.1.0 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_windows-64.exe to begin the installation of the driver and ASQL importer. | ||||||||
 | |||||||||
| Line: 235 to 231 | |||||||||
| Read what other users have said about this page or add your own comments. | |||||||||
| Changed: | |||||||||
| < < | |||||||||
| > > | |||||||||
| -- BrianRyan - 2021-06-07 | |||||||||
| Line: 282 to 278 | |||||||||
| |||||||||
| Deleted: | |||||||||
| < < |
| ||||||||
| |||||||||
| Line: 291 to 286 | |||||||||
| |||||||||
| Added: | |||||||||
| > > |
| ||||||||
View topic | History: r60 < r59 < r58 < r57 | More topic actions...
Copyright © 2008-2024 by the contributing authors. All material on this collaboration platform is the property of the contributing authors. Ideas, requests, problems regarding TWiki? Send feedback