SMS 2.0 ODBC Launch Kit
______
Table of Contents WHAT IS ODBC? ...... 3 WHAT PRODUCTS USE ODBC TO ACCESS THE SKYWARD DATABASE? ...... 3 ODBC/JDBC DRIVERS ...... 3 SKYWARD CUSTOM REPORTING OPTIONS...... 3 ODBC DRIVER INSTALL METHODS ...... 4 INSTALLING AN ODBC DRIVER ON A NON-SKYWARD COMPUTER; WORKSTATION OR SERVER...... 6 WHERE DO I FIND THE IP ADDRESS OF A SKYWARD DATABASE SERVER?...... 10 WHAT IS THE STANDARD SQL PORT NUMBER OF A SKYWARD DATABASE? ...... 11 WHERE DO I FIND THE SQL PORT NUMBER OF A SKYWARD DATABASE?...... 11 WHAT ARE READ-ONLY ODBC USERS IN A SKYWARD DATABASE? ...... 12 CREATING READ-ONLY SQL USER IN A SKYWARD DATABASE ...... 12 INSTALLING ODBC DATA SOURCE CONNECTIVITY TO A SKYWARD DATABASE ...... 13 VIEWING THE CONTENTS OF AN ODBC DATA SOURCE ...... 17 ODBC AND SKYWARD MAINTENANCE ...... 19 DBTool Utility ...... 19 Updating Read-Only SQL User task via Monolith 2 ...... 19 Update Statistics task via Monolith 2 ...... 19 Testing Read Only User Connectivity of an ODBC Data Source ...... 20 How to create ODBC users with ODBC User Control Program ...... 22 Software to Test Queries against the Skyward database ...... 22 Manually Create an ODBC Data Source ...... 23 WHAT IS JDBC? ...... 26
______05.26.2021 www.skyward.com Page 2 of 26
______
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 data from or write data to your Skyward Database(s) when SkyBuild/Data Mining 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/JDBC Drivers The Skyward OpenEdge ODBC/JDBC drivers will need to be loaded on any system that will be accessing the Skyward Database. Skyward provides ODBC/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)
______05.26.2021 www.skyward.com Page 3 of 26
______
ODBC Driver Install Methods
You will need to install either the OpenEdge 32-bit or 64-bit driver on a non-Skyward 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 Installation Methods \Install folder Use Driver 32 Bit 11.7 – SMS 2.0 – PaC Not needed PaC Client includes Workstation Install.msi 32-bit driver 32 Bit 11.7 – SMS 2.0 – PaC Needed on Program PaC Client includes Workstation Install.exe server connected 32-bit driver from workstation. 32 Bit 11.7 – SMS 2.0 – Not needed 32-bit driver only ODBC 32-bit Driver Install.exe 64 Bit 11.7 – SMS 2.0 – Not needed 64-bit driver only ODBC 64-bit Driver Install.exe 32 Bit 11.7 - Role - Base Needed on Skyward Base server install 64 Bit Install.exe1 server. includes 32-bit and (This was run when 64-bit driver server was initially setup; only run when new server is set up.)
1 11.7 – Role – Base Install.exe is run when installing a new Skyward db/web/report server. If Skyward server is already set up, DO NOT run this installer.
FTP Connect Instructions for downloading files from Skyward FTP site https://support.skyward.com/DeptDocs/Corporate/IT%20Services/Public%20Website/Secure_FTP_Instructi ons.pdf
Skyward Server Install Directory: The ?:\skyward\install directory is created by the 11.7 - Skyward Software Distribution .exe and 11.7 – Skyward Software Distribution.2-5 files. The files are located on the Skyward FTP Site in the Hardware\Public\OE117-Customer-DVD\Windows folder. The software distribution files contain folders and files for OpenEdge 11.7, 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, or some will create the folder during the running of the install file.
______05.26.2021 www.skyward.com Page 4 of 26
______
Skyward Database/Web/Report Server Installs The 11.7 32-bit and the 11.7 64-bit ODBC drivers are installed on each server when the 11.7 – SMS 2.0 – Base Install.exe installer is run. This installer will be run on the SMS 2.0 Database/Web/Report Server(s).
______05.26.2021 www.skyward.com Page 5 of 26
______
Installing an ODBC driver on a non-Skyward Computer; workstation or server.
Note: This installer will be the most common one used for a non-Skyward computer; workstation or server.
1. Navigate to 11.7 – SMS 2.0 – ODBC 32-bit Driver Install.exe file from a Skyward server ?:\skyward\install folder → Double click 11.7 – SMS 2.0 – ODBC 32-bit Driver Install.exe.
2. The Important Information notice will display. → OK.
3. The screen will display stating the ‘bit’ level being installed → Next.
______05.26.2021 www.skyward.com Page 6 of 26
______
4. Choose the installation drive for the OpenEdge ODBC driver. C is listed by default. → Next.
5. Ready to Install → Next.
______05.26.2021 www.skyward.com Page 7 of 26
______
6. Preparing Setup is where the installer looks to see if there is an available \install folder.
7. If no \install folder is found the installer will extract files in a folder on the Installation drive so the ODBC drivers can be installed.
8. Once the \install folder extraction has completed, a display stating the “Installing OpenEdge….” is shown.
______05.26.2021 www.skyward.com Page 8 of 26
______
9. Once the ODBC driver has been installed, the Completion screen will display. You can review the log, if wanted and/or choose Finish to exit the installation.
______05.26.2021 www.skyward.com Page 9 of 26
______
Where do I find the IP address of a Skyward Database Server? • ISCorp cloud-hosted customers must contact ISCorp to get ODBC connectivity.
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? ______
______05.26.2021 www.skyward.com Page 10 of 26
______
What is the standard SQL port number of a Skyward database? • ISCorp cloud-hosted customers must contact ISCorp to get ODBC connectivity. • 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? ______
______05.26.2021 www.skyward.com Page 11 of 26
______
What are Read-Only ODBC Users in a Skyward database?
A Read-Only ODBC (aka SQL) user is granted read permission to tables to either all tables or selected tables in the Skyward Database. Skyward highly recommends that you create a Read-Only SQL User for each 3rd party software/end user. 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 ISCorp cloud-hosted customers must contact ISCorp to get ODBC connectivity, SQL User ID’s, and SQL User ID passwords. The instructions below are only for On-Premises customers.
1. Log into Web URL → Navigate to PS\CA\SE\RO → Add → On this screen, enter the Username and Password → Save
Notes: • The username is not case-sensitive whereas the password is case-sensitive.
2. Expand the newly created Read-Only SQL user → Next to Assigned Templates click Assign → Select the appropriate list of tables that the Read-Only SQL user will have Read Only access to → Save
3. 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 must run before the User Account can be used. The Update Read Only User task will create/modify/delete the Read-Only SQL User(s) and assign the permissions.
______05.26.2021 www.skyward.com Page 12 of 26
______
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 Data Source Administrator is available in C:\Windows\SysWOW64\odbcad32.exe or from the Windows Control Panel / Administrative Tools / Data Sources (ODBC). • The 64-bit ODBC Data Source Administrator is available in C:\Windows\System32\odbcad32.exe or from the Windows Control Panel / Administrative Tools / Data Sources (ODBC).
Notes: • Create an ODBC Data Source(s) on the workstation/Server using the pre-installed OE 11.7 ODBC driver. • ODBC (SQL) Standard Port numbers are Student 12501 and Business 22501
1. Download the 11.7 – SMS 2.0 - ODBC 32-Bit DSN Setup.exe and/or 11.7 – SMS 2.0 - ODBC 64- Bit DSN Setup.exe from the Skyward Support Center\11.7 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.
______05.26.2021 www.skyward.com Page 13 of 26
______
3. Check either or both checkboxes to indicate the Data Source(s) to create. → Next.
______05.26.2021 www.skyward.com Page 14 of 26
______
4. On the Student ODBC Information display, type in the IP address of the Student database server → Next →On the Business ODBC Information display, type in the IP address of the Business database server → Edit the ODBC port if different than standard port number → Next.
______05.26.2021 www.skyward.com Page 15 of 26
______
5. Ready to Configure ODBC display → Next.
6. The Skyward ODBC Configuration Installation Success window will display when complete → Finish.
______05.26.2021 www.skyward.com Page 16 of 26
______
Viewing the contents of an ODBC Data Source
1. To view the contents of the Data Source that is setup on the workstation, • The 32-bit ODBC Data Source Administrator is available in C:\Windows\SysWOW64\odbcad32.exe or from the Windows Control Panel / Administrative Tools / Data Sources (ODBC). • The 64-bit ODBC Data Source Administrator is available in C:\Windows\System32\odbcad32.exe or from the Windows Control Panel / Administrative Tools / Data Sources (ODBC).
2. Choose the System DSN tab → Highlight a Data Source → Choose Configure.
______05.26.2021 www.skyward.com Page 17 of 26
______
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.
To obtain your SQL User ID and Password contact Skyward at Support Center or by calling 1-800-236- 0001.
4. Advanced tab → Verify READ UNCOMMITTED was set to prevent record locking issues in SMS 2.0 → Apply → OK.
______05.26.2021 www.skyward.com Page 18 of 26
______
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. The three (3) tasks should be set up in Monolith Scheduled Tasks and run prior to testing ODBC connection to the database; this includes testing the DataSource connection.
DBTool Utility
• 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
• Run manually on Skyward database server http://support.skyward.com/FAQ/View.aspx?ID=381981
• 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
• Update Read Only User process o Runs daily via Monolith Scheduled Task o Grants or revokes Read-Only user permissions to the database for any SQL user created, deleted or modified from SMS 2.0 software o This Monolith task needs to be run after creating a new Read Only SQL User in the SMS 2.0 software.
https://support.skyward.com/FAQ/View.aspx?ID=1367341
Update Statistics task via Monolith 2
• 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.
https://support.skyward.com/FAQ/View.aspx?ID=1367345
______05.26.2021 www.skyward.com Page 19 of 26
______
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, • The 32-bit ODBC Data Source Administrator is available in C:\Windows\SysWOW64\odbcad32.exe or from the Windows Control Panel / Administrative Tools / Data Sources (ODBC). • The 64-bit ODBC Data Source Administrator is available in C:\Windows\System32\odbcad32.exe or from the Windows Control Panel / Administrative Tools / Data Sources (ODBC).
2. Choose the System DSN tab → Highlight a SMS 2.0 Data Source name → Choose Configure.
______05.26.2021 www.skyward.com Page 20 of 26
______
3. Choose Test Connect.
4. Enter the case-sensitive password for the User ID → OK → Connection established: Success or Failure.
______05.26.2021 www.skyward.com Page 21 of 26
______
How to create ODBC users with ODBC User Control Program
• Skyward IT Services will create a read/write ODBC user prior to you using this program. • As a district you will have to have a signed Acknowledgment of Skyward Policy for ODBC use by Customer form.
http://www.skyward.com/DeptDocs/Corporate/Documentation/Public%20Website/Tutorials/Soft ware/RW_1361690_100_T.pdf
Software to Test Queries against the Skyward database
• ODBC Query Tool
http://www.skyward.com/DeptDocs/Corporate/Documentation/Public%20Website/Tutorials/Soft ware/RW_SQ_1959090_100_T.pdf
• Other options are FlySpeed and QweryBuilder which are both freeware.
______05.26.2021 www.skyward.com Page 22 of 26
______
Manually Create an ODBC Data Source
Skyward does not recommend manually creating your ODBC sources. When you create an ODBC source using the Skyward Installers, 11.7 – SMS 2.0 - ODBC 32-Bit DSN Setup.exe and/or 11.7 – SMS 2.0 - ODBC 64-Bit DSN Setup.exe, we also implement several registry changes for known issues.
1. To create an ODBC Data Source on the workstation/server, • The 32-bit ODBC Data Source Administrator is available in C:\Windows\SysWOW64\odbcad32.exe. • The 64-bit ODBC Data Source Administrator is available in C:\Windows\System32\odbcad32.exe or the Windows Control Panel.
2. Choose the System DSN tab → Choose Add.
3. Scroll to locate the Progress OpenEdge 11.7 Driver → Choose Finish.
______05.26.2021 www.skyward.com Page 23 of 26
______
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 the Skyward database • Database Name: All Skyward databases are named ‘SKYWARD’; all upper case. • User ID: SQL user name in the Skyward database
______05.26.2021 www.skyward.com Page 24 of 26
______
5. The Data Source will show in the Source listing → Highlight the Data Source ‘Name’ → 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.
______05.26.2021 www.skyward.com Page 25 of 26
______
What is JDBC?
Skyward supports JDBC (Java Database Connectivity) which is the Java version of ODBC commonly used for Unix/Linux based connections. The JDBC Driver is a software component enabling a Java application to interact with a database. The JDBC driver is analogous to ODBC drivers, ADO.NET data providers and OLE DB providers. To connect with individual databases, JDBC requires drivers for each database. The JDBC driver gives out the connection to the database. JDBC implements the protocol for transferring the query and result between client and database. JDBC is java based so it is cross platform (Linux, Unix and Windows).
Third party vendors can connect to an OpenEdge database using the JDBC driver much like they use ODBC. One example is the third part AIMG, a Skyward business partner that integrates their workflow product into the Skyward Business System.
The OpenEdge JDBC driver can be found on any SMS 2.0 server in the \skyward\dlc\java folder. The “openedge.jar” file is the JDBC driver file. The JDBC driver can be installed using the Java or Windows Installer. You can review https://www.progress.com/jdbc/openedge for documentation references.
A JDBC connection string example would be: jdbc:datadirect:openedge://localhost:port;databaseName- SKYWARD where localhost would be replaced by the ip address/hostname of the SMS 2.0 database server, port would be replaced by 12501 for Student/Combined or 22501 for Business, if using the standard port numbers.
To obtain your SQL User ID and Password contact Skyward at Support Center or by calling 1-800-236- 0001.
______05.26.2021 www.skyward.com Page 26 of 26