Unix SQL Connection Option

Transcription

1 Unix SQL Connection Option This document provides instructions for installing, setting up and using the Unix SQL Connection Option. 10/20/2008

2 Unix SQL Connection Option 2 Table of Contents Unix SQL Connection Option... 3 Overview... 3 Unix SQL Connection Requirements... 4 Demo Capabilities... 4 Additional Documentation...4 Installation... 5 Overview... 5 Server Installation... 5 Step 1 Install CounterPoint...5 Step 2 Register the SQL Connection Option...5 Step 3 Install the U/SQL Server software...5 Step 4 Install the U/SQL Server license...7 Step 5 Define a U/SQL Data Source...7 Client Installation... 8 Step 6 Install the Windows SQL Client...8 Step 7 Define an ODBC Connection...10 Accessing your CounterPoint data Using Crystal Reports...11 Using MS Query files...11 Using Win USQLi Using usqli... 14

3 Unix SQL Connection Option 3 Unix SQL Connection Option Overview The Unix SQL Connection Option allows you to use Transoft s U/SQL software to access CounterPoint data files on your Unix/Linux system from a Windows workstation. The SQL Connection Option includes a server component for the Unix/Linux server, a separate client component for each Windows workstation, data dictionaries that describe the CounterPoint data, and a number of additional components. The Unix SQL Connection Option includes: U/SQL Server Software Software that runs on the Unix/Linux server to provide access to the CounterPoint data files U/SQL Client Software Software that runs on the Windows workstation that allows access to CounterPoint data through an ODBC Data Source Complete dictionary files A complete dictionary (complete.udd) is provided that describes all CounterPoint data files and fields. English dictionary files A simplified and abbreviated English dictionary (english.udd) that lets you access CounterPoint data using the English-like descriptions you normally see on CounterPoint screens. For example, you can see and ask for an item's Vendor instead of the more technical ITEM-PRIME-VEND. The English dictionary only includes selected data files and fields that we believe would be most commonly used in reporting, and does not include all data fields. NOTE: These dictionaries are licensed for use only on systems with the SQL Connection Option. Sample Crystal reports Sample Crystal reports are provided to illustrate data mining of inventory and customer ticket history information. Crystal Reports Viewer Allows you to view Crystal reports on a Windows workstation. (The SQL Connection Option includes a Crystal Reports Viewer and a Crystal runtime. The Crystal Reports Designer, purchased separately, is required if you wish to create or customize reports.) Sample MS Query files A set of sample SQL queries (*.dqy files) is provided to illustrate retrieving data from the English tables. Excel workbooks (or worksheets) A set of workbooks (worksheets) is provided that shows columnar and graphical views of your inventory and other valuable information. Some of the workbooks use pivot tables for crosstab analysis, such as "on-hand by category" or "sales by location by category". Because the workbooks are linked directly to your CounterPoint data via an ODBC connection, you can click and immediately get an updated view of your business. You can use the workbooks provided as they are, or as models to create your own workbooks to see the exact information that you want the way you want to see it.

4 Unix SQL Connection Option 4 Unix SQL Connection Requirements Server Server running a Unix/Linux operating system supported by CounterPoint Clients Workstation(s) running Windows 2000/XP Connection via TCP/IP to the Unix/Linux server (Optional, if using Excel) Microsoft Query (Optional, if designing reports) Crystal Reports Designer Demo Capabilities A 30-day demo/evaluation capability is built into the system. This same capability is used for temporary activation prior to installing the permanent activation key. The demo can be activated only one time, for a maximum of 30 days. Additional Documentation Transoft provides additional configuration options and other information about using U/SQL in documentation that is installed with your U/SQL Server software and U/SQL Client software.

5 Unix SQL Connection Option 5 Installation Overview The installation steps outlined below are detailed in the following sections: Server Installation Step 1 Install CounterPoint Step 2 Register the SQL Connection Option Step 3 Install the U/SQL Server software Step 4 Install the U/SQL Server license Step 5 Define a U/SQL Data Source Client Installation Step 6 Install the Windows SQL Client Step 7 Define an ODBC Connection Server Installation Step 1 Install CounterPoint If you have not already done so, install CounterPoint on your Unix system. Step 2 Register the SQL Connection Option For temporary activation, or for demo/evaluation purposes, you may skip this step. For permanent activation, use System / Registration to register the SQL Connection Option, entering the Permanent activation key shown on your Activation Form. At field number to change, press F5 to obtain the U/SQL license information. A screen will display showing your U/SQL Server license and your U/SQL Client license numbers. Write down these numbers for later use. You need a different client license for each machine that will install the client. NOTE: If you are installing the client on more than 20 workstations, contact Radiant Systems for additional client keys. Step 3 Install the U/SQL Server software In this step you will install the U/SQL Server software on your Unix/Linux server. 1. Set the environment variables COBDIR and LD_LIBRARY_PATH to the Micro Focus COBOL directory located below your top-level CounterPoint directory. For example, if CounterPoint was installed in /usr/syn, use the commands: COBDIR=/usr/syn/COBDIR;export COBDIR LD_LIBRARY_PATH=/usr/syn/COBDIR/coblib;export LD_LIBRARY_PATH

6 Unix SQL Connection Option 6 2. Create a directory named usqls below the CounterPoint top-level directory and set the permissions appropriately for your system. 3. Change directories to the usqls directory. For example: cd /usr/syn/usqls 4. Mount the CounterPoint CD. Typically, these commands are: Open Server mount /dev/cd0 /mnt cd /mnt Linux mount /dev/cdrom /mnt Cd /mnt 5. Transoft uses two character codes to identify Unix environments. They are lx (Linux) and so (Open Server). There are different U/SQL Server installation files for each environment. The files are named as follows: Open Server csmfso310.tar Linux csmflx310.tar Extract the appropriate installation file for your system from the CPUNIX directory on the CounterPoint CD using the command: tar xvf /mnt/cpunix/csmfxx310.tar (where xx is lx or so) For example, if you are running Linux, extract the files using the command: tar xvf /mnt/cpunix/csmfso310.tar 6. Install the server software by typing the command:. / install.sh 7. When prompted for a product password, enter: UNIX-MFLX-SUZUKI (Linux) UNIX-MFSO-UXBRIDGE (Open Server) During installation, you should see the message: The installation has detected a Micro Focus environment. Do you wish to run a test to confirm that U/SQL Server will operate in your environment (Y/N): Y Answer Y. You should see the message: Micro Focus environment satisfactory for U/SQL Server executable. 8. When prompted for the revision of Micro Focus COBOL ISAM, select the default: 2. MF-ISAM Rev 3 (the Micro Focus default) 9. The installation program then finds and displays the TCP/IP socket port number. Write down this number. You will need this value when you install the U/SQL Windows client software. 10. Choose whether to update your server s boot script to have the U/SQL Server start automatically at system boot time.

7 Unix SQL Connection Option 7 (Recommended) Answer y (Yes) to update your server s boot script to have the U/SQL Server start automatically at system boot time. For information on manually starting or stopping the server, and other functions, refer to Transoft's Configure and Use Manual installed with your U/SQL Server and U/SQL Client software. NOTE: If you encounter a net frame read error when trying to access the CounterPoint data, it may be necessary to modify the U/SQL startup script to add the environment variables COBDIR and LD_LIBRARY_PATH. On an Open Server system, the startup script is /etc/init.d/usqlcs. On a Linux system, the startup script is /etc/rc.d/init.d/usqlcs. Step 4 Install the U/SQL Server license In this step, you will license the U/SQL Server for temporary or permanent activation. A 30-day temporary registration license allows you to evaluate the software prior to permanent registration. You should use temporary registration if you have not received your Permanent activation information for your CounterPoint system, or for demo or evaluation purposes. Temporary registration can only be activated one time, for a maximum of 30 days. 1. From the usr/syn/usqls/bin directory, type: sh serv_setup.sh 2. Choose #6, CREATE, VIEW, AND REMOVE SERVER LICENSE. 3. For temporary activation, choose option 3 to create a temporary 2 user, 30 day evaluation license and follow the screen instructions. 4. For permanent activation, choose option 1 to create a full license. For Your Organization, do not enter your company name. You must enter Licensed CounterPoint User as shown below. Enter the following: Your Organization: Licensed CounterPoint User License Code: <Enter the U/SQL Server license from System / Registration> Answer Y to agree with the license terms, and press Enter to accept the displayed default for the license file path and name (SERVER.LIC). When finished, follow the instructions on the screen to exit the setup script. Step 5 Define a U/SQL Data Source U/SQL Data Sources are defined in the usqlsd.ini file. 1. From the usr/syn/usqls/bin directory, type: sh serv_setup.sh 2. Choose #1, DATA SOURCE CONFIGURATION, then choose #2, Add a new Data Source 3. When prompted for a UDD name, enter the name you want to assign to this data source. For example, if you want to use the sample reports and queries provided with CounterPoint, enter the name CPDATA. It is not necessary to use a.udd extension on the data source name (the samples would not work if you used an extension).

8 Unix SQL Connection Option 8 4. Enter the full path to the dictionary. For example, if you are defining a data source to the English dictionary delivered with CounterPoint, and CounterPoint is installed in the directory usr/syn, you would enter: /usr/syn/sqlconn/english/english.udd 5. Next, you are prompted to enter the directory where the data is located. This is your company directory. You should enter the complete path to your data. For example, if you using the company DEMO1 and CounterPoint is installed in /usr/syn, you would enter: /usr/syn/demo1 This completes the minimal requirements for defining a data source. You can press enter to skip all of the remaining questions. Note: The next question asks if you want to open the files in read-only mode. If you do not want anyone to have the ability to modify the actual CounterPoint data, answer Y to this question. You can also define Data Sources by using vi or a similar editor. Create the Data Source CPDATA and the Data Source COMPLETE by using a text editor to add the following lines to the usqlsd.ini (typically in the /usr/syn/usqls/bin directory): [CPDATA] Dictionary=/usr/syn/SQLCONN/ENGLISH/english.udd Directory=/usr/syn/DEMO1 [COMPLETE] Dictionary=/usr/syn/SQLCONN/COMPLETE/complete.udd Directory=/usr/syn/DEMO1 For a live installation, specify your company instead of DEMO1. Client Installation Step 6 Install the Windows SQL Client The U/SQL client must be installed on each workstation you will use to access the CounterPoint data. When installing on a Windows 2000/XP workstation, make sure you are logged on as an administrator. The U/SQL client is installed from the CounterPoint CD. 1. Insert the CounterPoint 7.5 CD. When the CounterPoint launch menu appears, click Browse and navigate to the CPUNIX\USQLWIN directory. 2. Double click on the file USQLCONN.EXE and follow the screen instructions. Choose any installation directory for the SQL Connection files (the default is C:\SYN). 3. Choose any installation folder for the client, typically the default (the default is C:\Program Files\USQLC). 4. Choose a Typical installation. If you have purchased the Dictionary Toolkit (the U/SQL Manager), you must select a custom install and check the U/SQL Manager box. 5. When prompted for a password, enter: DRV1-MT-HARVEY

9 Unix SQL Connection Option 9 6. When prompted for the default server properties, enter the name (or IP address) of your server and the default port you wrote down when setting up the Unix server. If you forget the port number, you can find it by going to the U/SQL server directory (typically /usr/syn/usqls) and typing: cat install.data 7. When prompted for the license form, you can skip this step to use the 30-day temporary registration by clicking the Close button. You should use temporary registration if you have not received your Permanent activation information for your CounterPoint system, or for demo or evaluation purposes. For permanent activation, when the license screen appears, choose License Form. Enter the following (organization must be entered as Licensed CounterPoint User): Your Name: <Enter your name here> Your Organization: Licensed CounterPoint User License Code: <Enter the U/SQL Client license from System / Registration> NOTE: Each Windows workstation must have a unique client license. The U/SQL Client software may be operated as a Temporary Unlicensed Copy for 30 days, in unrestricted mode, without installing a license. NOTE: If you do not license the U/SQL Client and an ODBCenabled product (Crystal, Excel, etc.) is invoked, then this message is displayed. If you click the Yes button to create a Temporary Unlicensed Copy, then each time an ODBC-enabled product is invoked this message will appear. 8. Click Finish to complete the installation.

10 Unix SQL Connection Option 10 Step 7 Define an ODBC Connection Define an ODBC Data Source Name (DSN) for the Windows workstation. Select Start / Programs / USQL Client / USQL Administrator. On the User DSN tab, click the Add button. Enter CPDATA for the Data Source Name. This is the data source you defined at the server in Step 5. Enter a description of this data source. Enter the Unix server name (or IP address) and the TCP/IP socket port number you wrote down when installing the U/SQL Server (typically 7000). Enter the Timeout (seconds the system will try to access data before timing out). Click OK to add this DSN. Click to highlight the data source (e.g., CPDATA), then click the Test Connect button to test the new connection. The Test Completed Connection succeeded message appears if your connection is successful. Repeat the above steps to define a DSN for the COMPLETE dictionary.

11 Unix SQL Connection Option 11 Accessing your CounterPoint data The Unix SQL Connection Option allows you to retrieve data from your CounterPoint system using Windows data access tools. You may use Crystal Reports, Excel (with MS Query), or any number of other Windows data access tools. You may also use Win USQLi, a data access tool provided with the SQL Connection Option. (Transoft also provides a Unix server-based data access tool named usqli that allows you to access the data directly at the Unix server). During installation, you defined two Data Source Names (DSN s), CPDATA (using the English dictionary) and COMPLETE (using the Complete dictionary). The CounterPoint data files appear as tables through the English or Complete Data Dictionaries provided with the SQL Connection Option. Using Crystal Reports Sample Crystal reports and a runtime are provided with the SQL Connection Option. These reports are installed under the CounterPoint top-level directory, typically in SYN/SQLCONN. To display a report, navigate to the SYN/SQLCONN directory and double-click crview.exe to run the Crystal Reports Viewer. Select any Crystal report file (*.rpt) in the SYN/SQLCONN directory to open a report in the Crystal Reports Viewer. For more detailed information on the sample Crystal reports and reporting options, refer to the SQL Connection Option documentation for Windows. Using MS Query files MS Query (*.dqy) files are provided with the SQL Connection Option to obtain data from the CPDATA tables (through the English dictionary). These query files are installed under the CounterPoint top-level directory, typically in SYN/SQLCONN/QUERY. The data returned by the query can be displayed in an Excel spreadsheet. MS Query and Excel must be installed on your Windows workstation to use the MS Query files provided with the SQL Connection Option.

12 Unix SQL Connection Option 12 To use MS Query files, open the SYN/SQLCONN/QUERY directory: Double-click any query in that directory (e.g, ITEMS.dqy) MS Query executes the selected query (e.g., ITEMS.dqy) to obtain the data from your U/SQL Server (e.g., ITEMS)

13 Unix SQL Connection Option 13 Using Win USQLi WARNING: Be very careful when you use Win USQLi! This is a powerful data access tool that can be used not only to view data, but also to delete or modify data by entering a few simple SQL commands. Win USQLi is a data access tool that can obtain data from your Unix/Linux CounterPoint system. To run, select Win USQLi from your Windows Start menu: Start / Programs / USQL Client / Win USQLi Click File and select Open UDD from the drop-down menu. The Connect to Data Source form displays the available User Data Sources (User DSN tab). Click to select (highlight) the data source you want to use to access your CounterPoint database (e.g., CPDATA). Click the Open button to use the selected data source to access your CounterPoint database. Enter a SQL query in the Query frame. Click the icon to execute your query. For example, Select * from ITEMS. Executing this SQL query selects and lists all of the records in the ITEMS table of your Unix/Linux CounterPoint database in the Results frame.

14 Unix SQL Connection Option 14 Using usqli WARNING: Be very careful when you use usqli! This is a powerful data access tool that can be used not only to view data, but also to delete or modify data by entering a few simple SQL commands. The Unix server based utility usqli allows you to access and manipulate your data files at the Unix server without requiring an ODBC-enabled client product. You must start usqli from the directory that contains the usqlsd.ini file. 1. From the usr/syn/usqls/bin directory, type: usqli 2. When prompted for a UDD Name, enter the name of the data source you want to access. For example, CPDATA. 3. When connecting, usqli obtains the server name and port number from usqlsd.ini. If you are prompted for the server name, then you probably started the utility from the wrong directory. 4. When the connection is complete, the prompt appears. U/SQL> You can now enter SQL commands. All commands must end with a semicolon (;). For example, to view the contents of the customer file in CPDATA, enter select * from accounts; When finished using usqli, type quit (with no semicolon) and press enter.