Skyward OpenEdge 10.2B ODBC Launch Kit Services/Public...Open Database Connectivity (ODBC) provides...

Skyward OpenEdge 10.2B

ODBC Launch Kit

_________________________________________________________________________________________________________

_________________________________________________________________________________________________________

12.13.2016 www.skyward.com of 26

Table of Contents

WHAT IS ODBC? .............................................................................................................................................................................. 3

WHAT PRODUCTS USE ODBC TO ACCESS THE SKYWARD DATABASE? ...................................................................... 3

ODBC DRIVERS ............................................................................................................................................................................... 3

SKYWARD CUSTOM REPORTING OPTIONS........................................................................................................................... 3

ODBC DRIVER INSTALL METHODS .......................................................................................................................................... 4

INSTALLING AN ODBC OE 10.X DRIVER ................................................................................................................................. 5

WHERE DO I FIND THE IP ADDRESS OF A SKYWARD DATABASE SERVER?............................................................... 6

WHAT IS THE STANDARD SQL PORT NUMBER OF A SKYWARD DATABASE? ............................................................ 7

WHERE DO I FIND THE SQL PORT NUMBER OF A SKYWARD DATABASE?................................................................. 7

WHAT IS THE READ-ONLY USER THAT IS SETUP TO BE USED BY A SKYWARD DATABASE? .............................. 7

CREATING READ-ONLY SQL USER IN A SKYWARD DATABASE ..................................................................................... 8

INSTALLING ODBC DATA SOURCE CONNECTIVITY TO A SKYWARD DATABASE ................................................... 9

VIEWING THE CONTENTS OF AN ODBC DATA SOURCE ................................................................................................. 13

TESTING READ ONLY USER CONNECTIVITY OF AN ODBC DATA SOURCE .............................................................. 15

ODBC AND SKYWARD MAINTENANCE ................................................................................................................................. 17

DBTool Utility .......................................................................................................................................................................... 17 Updating Read-Only SQL User task via Monolith 2 ................................................................................................................ 17 Update Statistics process .......................................................................................................................................................... 17 How to create ODBC users with ODBC User Control Program ............................................................................................. 17 Software to Test Queries against the Skyward database .......................................................................................................... 17

INSTALLING OPENEDGE ODBC 11.1 DRIVER ...................................................................................................................... 18

CREATING AN ODBC DATA SOURCE ..................................................................................................................................... 23

http://www.skyward.com/

_________________________________________________________________________________________________________

_________________________________________________________________________________________________________


What is ODBC? Open Database Connectivity (ODBC) provides a standard software API method for using database

management systems (DBMS). The designers of ODBC aimed to make it independent of

programming languages, database systems, and operating systems. Skyward also supports JDBC

(Java Database Connectivity) which is the Java version of ODBC commonly used for Unix/Linux

based connections.

ODBC allows your district to read or write data to your Skyward Database(s) when SkyBuild does

not provide an export or import that meets your district’s needs. This connection gives IT personal

the ability to run SQL queries against the Skyward Database(s).

ODBC is available for both Cloud hosted and Self-hosted customers with on premise servers.

What products use ODBC to access the Skyward Database?

Crystal Reports /Report Viewer

Business Objects BI Platform 4.0 (formerly Crystal Enterprise)

Skyward PaC Reporting Options

Web Quick Pick reports using SkyRAS (Crystal for the Web)

SQL Management Studio

Microsoft Reporting Services

Cognos (IBM)

Squirrel SQL Client (Open Source)

Skyward ODBC Query Tool

Too many others to list…

ODBC Drivers The Skyward OpenEdge ODBC drivers will need to be loaded on any system that will be accessing

the Skyward Database. Skyward provides ODBC or JDBC drivers for all operating systems;

including 32 bit and 64 bit Windows. The drivers are available to all Skyward customers at no

additional cost.

Skyward Custom Reporting Options If you are interested in Skywards Custom reporting options please visit the following website.

https://support.skyward.com/Page.ashx/AdditionalServices/CustomReporting

(Customer Support Center login required)


https://support.skyward.com/Page.ashx/AdditionalServices/CustomReporting

_________________________________________________________________________________________________________

_________________________________________________________________________________________________________


ODBC Driver Install Methods You will need to install either the OpenEdge 32-bit or 64-bit driver on a server or workstation. The “bit”

version of the driver needs to match the “bit” version of the application that you are using to query the

database. An example of this scenario would be if you run a third party 32-bit product setup on a Skyward

server and it is configured to access the Skyward database using ODBC then you will need to install the 32 -

bit ODBC driver on the Skyward server.

ODBC

Driver

Operating System Installation Methods

32 Bit Windows Vista, 7, 8.x, 10

2008/2012 Terminal/Citrix Server

(32 or 64 Bit)

10.2B –Skyward PaC.msi1

10.2B – Skyward Workstation Installer.exe2

32 Bit 10.2B Windows 2008/2012

Skyward Database/Web/Report

Queue Servers (64 Bit Only)

10.2B - ODBC 32-bit Driver Installer.exe3

64 Bit Windows Vista, 7, 8.x, 10 (64 Bit

Only)

10.2B - ODBC 64-bit Driver installer.exe2

64 Bit 10.2B Windows 2008/2012

Skyward Database/Web/Report

Queue Server(s) (64 Bit Only)

10.2B - Role - Base Install.exe4

1 32-bit 10.2B ODBC driver is installed with the PaC Client 2 Requires access to the Skyward Server Install Directory 3 Installs 10.1B 32-bit driver as both 10.2B -.32-bit and 10.2B.- 64-bit driver cannot be installed on

same server 4 64-bit 10.2B ODBC driver is installed on all 64-bit Skyward Database/Web/Report Queue server(s)

Skyward Server Install Directory:

The ?:\skyward\install directory is created by the 10.2B - Skyward Software Distribution .exe and

10.2B – Skyward Software Distribution.2 files. The files are located on ftp.skyward.com in

Hardware\Public\OE102B-Customer-DVD folder. The files contains folders and files for OpenEdge

10.2B, Sun Java, Microsoft .NET, ODBC drivers and other files needed for installers. Some

Installer.exe files need to see this folder and some do not.


ftp://ftp.skyward.com/

_________________________________________________________________________________________________________

_________________________________________________________________________________________________________


Installing an ODBC OE 10.x Driver

Note: You either will be installing an ODBC driver for the first time on the computer or you will be

installing an ODBC driver of a different version as your need is to have two different bit-versions installed

on the same computer.

1. To install a different driver version on a computer with an existing install of Progress OpenEdge, or to

install the ODBC Driver on another computer, download the installer noted in the table above.

You can download the latest installers from:

https://support.skyward.com/Page.ashx/ITServices/TechnicalInformation/SkyInstallDocs

** DO NOT run the Skyward PaC.msi or Skyward Workstation Installer.exe file on a Skyward

db\web\report queue server. It will install without error but will overwrite the server settings for

db/web/report queue and will leave the Skyward database non-functional.

2. Double click the ‘ODBC Driver Installer’ > Next, at the information screen.

3. Enter the location of the existing Skyward Folder or a new install location > Next.

4. Click Next, to begin installing the ODBC Driver > Click Finish, when the install completes.


https://support.skyward.com/Page.ashx/ITServices/TechnicalInformation/SkyInstallDocs

_________________________________________________________________________________________________________

_________________________________________________________________________________________________________


Where do I find the IP address of a Skyward Database Server?

Cloud-hosted customers must contact Skyward to get the IP Address.

1. To find the IP address of your Business Management Database Server navigate to the ?:\skyward

or ?:\skyward\skyfin folder on the Skyward db server Locate the skyfin.pf file This file ‘tells’ the

Skyward PaC Business icon where the database is located Right click Edit Locate the –H ?.?.?.?

parameter The –H information is the ip address of the CAS/database server Make note of the ip

address Choose X to close window.

What is the IP address of the Business CAS/database server? _____________________

2. To find the IP address of your Student Management Database Server navigate to the ?:\skyward

folder on the Skyward db server Locate the skyward.pf file This file ‘tells’ the Skyward PaC Student

icon where the database is located Right click Edit Locate the –H ?.?.?.? parameter The –H

information is the ip address of the CAS/database server Make note of the IP address Choose X to

close window.

What is the IP address of the Student CAS/database server? ______________________


_________________________________________________________________________________________________________

_________________________________________________________________________________________________________


What is the standard SQL port number of a Skyward database?

Cloud-hosted customers must contact Skyward to get the SQL port numbers.

Self-hosted customers default ports are:

o Student: 12501

o Business 22501

Where do I find the SQL port number of a Skyward Database?

Cloud-hosted customers must contact Skyward to get the SQL port numbers.

1. Log into Web URL Navigate to PS\CA\DS\CF\SI On this screen, find the SQL Port Number:

Business:

What is the SQL/ODBC Port number of the Business database? ______________________________

Student:

What is the SQL/ODBC Port number of the Student database? ______________________________

What is the read-only user that is setup to be used by a Skyward database? Cloud-hosted customers must contact Skyward to get their ODBC User/Passwords.

1. Log into Web URL Navigate to PS\CA\DS\CF\SI On this screen, find the Username and

Password Click ‘’Display SQL User and Password’’ to view the account being used by the processes in

the Skyward database.

You could use this same account outside the Skyward software for Read-only SQL access. Skyward

recommends that you create a Read-Only SQL User for each 3rd party software. Each SQL process as it is

running will have the username created; ex. School Messenger vendor SQL Username could be SchMess or

Renaissance Learning could be RenLearn.


_________________________________________________________________________________________________________

_________________________________________________________________________________________________________


Creating Read-Only SQL User in a Skyward database Cloud-hosted customers must contact Skyward to get their ODBC User/Passwords.

https://support.skyward.com/FAQ/View.aspx?ID=1200244

Notes:

The username is not case-sensitive whereas the password is case-sensitive.

After a SQL Read Only user has been added/edited in the database and assigned tables, the

Update Read Only User task needs to be setup/run in Monolith.




_________________________________________________________________________________________________________

_________________________________________________________________________________________________________


Installing ODBC Data Source Connectivity to a Skyward Database

Important! : On a 64 bit Windows computer there are separate 64 bit and 32 bit ODBC control panels.

The 32 bit ODBC control panel is launched by running C:\Windows\SysWOW64\odbcad32.exe

The 64 bit ODBC control panel is launched from the Windows Administrative Tools / Data Sources

(ODBC).

Notes:

Create an ODBC Data Source(s) on the workstation/Server using the pre-installed OE 10.x ODBC driver.

ODBC (SQL) Standard Port numbers are Student 12501 and Finance 22501

1. Download the ‘ODBC 32 Bit Data Source Configuration.exe’ or ‘ODBC 64 Bit Data Source

Configuration.exe’ from the Skyward Support Center\10.2B Windows Installers and save it to desktop of

the computer where the Data Source is being created.

https://support.skyward.com/page.ashx/ITServices/TechnicalInformation/SkyInstallDocs

2. A Welcome window will display indicating that you will need the IP address and port number for the

database Next.


https://support.skyward.com/page.ashx/ITServices/TechnicalInformation/SkyInstallDocs

_________________________________________________________________________________________________________

_________________________________________________________________________________________________________


3. Check either or both checkboxes to indicate the Data Source(s) to create. Next.


_________________________________________________________________________________________________________

_________________________________________________________________________________________________________


4. On the Student ODBC Information display, type in the IP address of the Student database server

Next On the Finance ODBC Information display, type in the IP address of the Business database server

Edit the ODBC port if different than standard port number Next.


_________________________________________________________________________________________________________

_________________________________________________________________________________________________________


5. Ready to Configure ODBC display Next.

6. The Skyward ODBC Configuration Installation Success window will display when complete

Finish.


_________________________________________________________________________________________________________

_________________________________________________________________________________________________________


Viewing the contents of an ODBC Data Source

1. To view the contents of the Data Source that is setup on the workstation,

Use 32-bit ODBC Data Source Administrator shortcut that was placed on the desktop

when ODBC 32 Bit Data Source Configuration.exe was run to create the 32-bit Data

Source.

The 32-bit ODBC Data Source Administrator is available in

C:\Windows\SysWOW64\odbcad32.exe.


C:\Windows\System32\odbcad32.exe or the Windows Control Panel.

2. Choose the System DSN tab Highlight a Skyward Data Source Choose Configure.


_________________________________________________________________________________________________________

_________________________________________________________________________________________________________


3. The General tab will show you the IP address of the database server The ODBC port number of

the database The SQL User ID being used to connect to the database.

4. Advanced tab Set READ UNCOMMITTED to prevent record locking issues in Skyward

Apply OK.


_________________________________________________________________________________________________________

_________________________________________________________________________________________________________


Testing Read Only User Connectivity of an ODBC Data Source

1. To test the connectivity, open the Data Source that is setup on the workstation,

Use 32-bit ODBC Data Source Administrator shortcut that was placed on the desktop

when ODBC 32 Bit Data Source Configuration.exe was run to create the 32-bit Data

Source.





2. Choose the System DSN tab Highlight a Skyward Data Source Choose Configure.


_________________________________________________________________________________________________________

_________________________________________________________________________________________________________


3. Choose Test Connect.

4. Enter the case-sensitive password for the User ID OK Connection established: Success or

Failure.


_________________________________________________________________________________________________________

_________________________________________________________________________________________________________


ODBC and Skyward Maintenance The following Database Tools are used to ensure that ODBC access to your database works effectively and

efficiently. The ODBC Skyward Database maintenance tasks are for you using your Monolith update

system. For hosted customers these maintenance tasks are scheduled and maintained by your hosting

provider.

DBTool SQL Width Padding utility

o Runs daily or weekly via Monolith Scheduled Task

o Adjusts the SQL fields length and pads by 100%

o Should be run prior to Update Statistics process

Update Read Only User process

o Runs daily via Monolith Scheduled Task

o Grants or revokes Read-Only user rights to the database for any SQL user created,

deleted or modified from Skyward software

Update Statistics process

o Runs weekly via Monolith Scheduled Task

o Speeds up Crystal Report processing

o Standard is to run the process each weekend

o When running it will impact the database performance.

DBTool Utility Run manually on Skyward database server

o Windows: http://support.skyward.com/FAQ/View.aspx?ID=381981

o Unix/Linux: http://support.skyward.com/FAQ/View.aspx?ID=789781

Setup as automated task in Monolith 2: http://support.skyward.com/FAQ/View.aspx?ID=2341116

Updating Read-Only SQL User task via Monolith 2 https://support.skyward.com/FAQ/View.aspx?ID=1367341

Update Statistics process https://support.skyward.com/FAQ/View.aspx?ID=1367345

How to create ODBC users with ODBC User Control Program You will need to have Skyward to create a read/write sql user prior to using this program.

http://www.skyward.com/DeptDocs/Corporate/Documentation/Public%20Website/Tutorials/Software/RW_1

361690_100_T.htm

Software to Test Queries against the Skyward database ODBC Query Tool

http://www.skyward.com/DeptDocs/Corporate/Documentation/Public%20Website/Tutorials/

Software/RW_SQ_1959090_100_T.htm

Other options are FlySpeed and QweryBuilder which are both freeware.


http://support.skyward.com/FAQ/View.aspx?ID=381981






http://www.skyward.com/DeptDocs/Corporate/Documentation/Public%20Website/Tutorials/Software/RW_1361690_100_T.htm

http://www.skyward.com/DeptDocs/Corporate/Documentation/Public%20Website/Tutorials/Software/RW_1361690_100_T.htm

http://www.skyward.com/DeptDocs/Corporate/Documentation/Public%20Website/Tutorials/Software/RW_SQ_1959090_100_T.htm

http://www.skyward.com/DeptDocs/Corporate/Documentation/Public%20Website/Tutorials/Software/RW_SQ_1959090_100_T.htm

_________________________________________________________________________________________________________

_________________________________________________________________________________________________________


Installing OpenEdge ODBC 11.1 driver

Notes:

Contact Skyward for recommendation to install this version of ODBC driver. This driver installer is

all-inclusive and does not need the Skyward Install folder. If installed on a Skyward server, the

install path must be different than the currently installed OpenEdge installation.

This driver version cannot be installed by running the installers reference earlier in this document.

You can download the 11.1 ODBC driver from

ftp://ftp.skyward.com/Hardware/Public/OE102B-Customer-DVD/Windows/ODBC%20Drivers/

1. Download the 32-bit or 64-bit version .exe of the 11.1 driver.> Download the Install Codes.txt file.

2. Double click “SQLClientAccess.exe” > Choose Run. This will extract the install folder for this

ODBC driver.


ftp://ftp.skyward.com/Hardware/Public/OE102B-Customer-DVD/Windows/ODBC Drivers/

_________________________________________________________________________________________________________

_________________________________________________________________________________________________________


3. Double click setup.exe. Choose Next.

4. Enter the Install codes for the bit version that is being installed > Choose Accept once entered.


_________________________________________________________________________________________________________

_________________________________________________________________________________________________________


5. The OE SQL Client product will list to be installed. Choose Next.

6. Enter folder path destination for installation. Next.>


_________________________________________________________________________________________________________

_________________________________________________________________________________________________________


7. Choose Next.

8. Choose Next.


_________________________________________________________________________________________________________

_________________________________________________________________________________________________________


9. Choose Next > Multiple status screens will display.

10. Choose Finish when setup is done.


_________________________________________________________________________________________________________

_________________________________________________________________________________________________________


Creating an ODBC Data Source

1. To create an ODBC Data Source on the workstation/server,





2. Choose the System DSN tab Choose Add.

3. Scroll to locate the Progress OpenEdge 11.1 Driver Choose Finish.


_________________________________________________________________________________________________________

_________________________________________________________________________________________________________


4. The General tab will display. Enter each field’s info to connect to the database via SQL

connectivity OK.

Data Source Name: To be used when identifying in scripts or third-party software.

Description: Description of the Data Source

Host Name: IP Address or server name of Skyward database location

Port Number: SQL port number of Skyward database

Database Name: All Skyward databases are named ‘SKYWARD’; all caps.

User ID: SQL user name in the Skyward database


_________________________________________________________________________________________________________

_________________________________________________________________________________________________________


5. The Data Source will now show in the Sources listing Choose Configure.

6. Advanced tab Set READ UNCOMMITTED to prevent record locking issues in Skyward

Apply OK.


_________________________________________________________________________________________________________

_________________________________________________________________________________________________________


7. Test the Data Source Connectivity to the Skyward database. Instructions were shown earlier in kit.


Skyward OpenEdge 10.2B ODBC Launch Kit Services/Public...Open Database Connectivity (ODBC) provides...

Documents

Transcript of Skyward OpenEdge 10.2B ODBC Launch Kit Services/Public...Open Database Connectivity (ODBC) provides...