Install SQLSpec steps

SQLSpec by Elsasoft, is the database documentation tool used by Blackboard Analytics to document the database objects found in the iXXSA database and one SQLSpec license is included with your Blackboard Analytics purchase.

This documentation can be regenerated at any time from your installation to stay in sync with customizations made to the iXXSA database.

The following steps will configure SQLSpec for your environment.

  1. Locate the SQLSpec files in the BbAnalytics folder, C:\BbAnalytics\iXXSA Version 4.0.0\Install\7_sqlspec\.
  2. If there isn’t a SQLSpec.exe file there, download an evaluation copy from and copy it to this directory.


Execute SQLSpec.exe and click on the License Key button. If it not licensed, first look for a license.txt file in this directory and enter the license information at the prompt.

  1. After validating that SQLSpec is licensed, close SQLSpec. For Blackboard Analytics modules, a batch and configuration file is used to run SQLSpec and pass in all of the necessary parameters.
  2. Locate the htmlhelp.exe file in this directory and execute it.
  3. This will guide you through installing HTML Help Workshop 1.3, which includes an HTML Helpfile compiler – used to compile the HigherEd Analytics.CHM file discussed in the Data Model Review section of this Installation Guide.
  4. Click Next through the steps to complete the installation.
  5. If you receive an error message saying that the computer already contains a newer version of HTML Help, you can ignore it. It is the compiler, hhc.exe, that is needed for SQLSpec.
  6. Next, navigate into the iXXSA directory.
  7. Open the SQLSpec.bat batch file for editing in Notepad.
  8. Update the following six variables for your environment:


  1. SQLSpecHome: Path of the directory containing SQLSpec.exe
  2. SQLSpecModuleHome: Path of the directory containing this batch file
  3. SQLServer: SQL Server Instance name
  4. SQLDB: Name of the module SQL Server database, e.g. iXXSA
  5. OLAPServer: Analysis Services Instance name
  6. OLAPDB: Name of the module Analysis Services database, e.g. iXXSA

12. Save and close the batch file.

13. Next, in the same directory, locate the “SQLSpec File Generator.sql” file and open it in SQL Server Management Studio.

14. Change the database of execution to the iXXSA database and execute the file.

15. The query’s execution results should be cut and pasted into the SQLSpec.config file found in the same directory. Completely replace the original contents of the file with the new configuration. This configuration will provide SQLSpec with all of the information it needs to build the documentation (the CHM file and the HTML documentation) as originally delivered in the BbAnalytics folder, C:\BbAnalytics\iXXSA Version 4.0.0\Documentation\Data Model\.

16. To execute SQLSpec and regenerate the documentation, execute the SQLSpec.bat batch file. Depending on the size of the module, it can take several minutes to several hours to complete.



Leave a Reply

Fill in your details below or click an icon to log in: Logo

You are commenting using your account. Log Out /  Change )

Google+ photo

You are commenting using your Google+ account. Log Out /  Change )

Twitter picture

You are commenting using your Twitter account. Log Out /  Change )

Facebook photo

You are commenting using your Facebook account. Log Out /  Change )


Connecting to %s