BI Documenter - The leading SQL Documentation Tool

FREQUENTLY ASKED QUESTIONS

•	What are the system requirements?
•	Is the .NET 2.0 framework included in the application download?
•	What versions of SQL Server does BI Documenter support?
•	Does BI Documenter support Analysis Services 2000?
•	When I run BI Documenter I get a “Missing Prerequisites” message. How do I install the prerequisites?
•	I am having a problem producing compiled HTML documents. What is the problem?
•	How do I make documentation using the command line application?
•	How do I schedule the command line application?
•	I see a "Page can not be displayed" error message when viewing CHM files stored on a network drive. What is the problem?
•	How do I make documentation from a previous snapshot?
•	How do I enter my license information?
•	How do I update the connection details of my database?
•	How can I check that I am running the latest version of BI Documenter?
•	How do I update BI Documenter with the latest version?
•	How can I change the number of snapshots that BI Documenter will save?
•	My evaluation period has ended. Will I lose the snapshots I have already created when I enter my license?
•	On Windows 2000 I get the message: BIDocumenter.exe - Ordinal Not Found. What is the problem?
•	Where can I ask questions about BI Documenter?

What are the system requirements? BI Documenter supports the following operating systems: Windows XP Service Pack 1 or higher Windows 2000 Server/Professional Service Pack 4 or higher Windows Server 2003 Service Pack 1 or higher Windows Server 2003 R2 Windows Vista Ultimate, Business, Home Premium, Home Basic Read More About Windows Vista Support. NOTE: BI Documenter DOES NOT support 64 bit clients. It DOES however document remote 64 bit servers. The software prerequisites to run BI Documenter are: Microsoft SQL Server 2005 Management Objects Collection (Link) Microsoft SQL Server 2005 Backward Compatibility Components (Link) Microsoft SQL Server Native Client (Link) Microsoft Core XML Services (MSXML) 6.0 (Link) Microsoft .NET Framework Version 2.0 If you have SQL Server 2005 Management Studio installed these prerequisites will already be fulfilled. Is .NET Framework 2.0 included in the application download? Yes, the .NET Framework 2.0 is downloaded by the setup if it is not already present on your computer. What versions of SQL Server does BI Documenter support? SQL Server 2000 Database Engine SQL Server 2005 Database Engine, Analysis Services and Integration Services Does BI Documenter support Analysis Services 2000? BI Documenter does not support Analysis Services 2000, but does support SQL Server 2000 databases. When I run BI Documenter I get a “Missing Prerequisites” message. How do I install the prerequisites? You need to either install SQL Server 2005 Management Studio or download and install the software prerequisites manually. I am having a problem producing compiled HTML documents. What is the problem? You most likely have an out of date version of the Microsoft HTML Help Compiler installed on your machine. Click here to download the latest version from Microsoft. If you are still experiencing problems contact BI Documenter support. How do I make documentation using the command line application? Run the application BIDOC.exe which is located in the BI Documenter application directory from a command window to as a sheduled task. Each time you run the command line application BIDOC.exe a new snapshot is created and given an automatically incremented name e.g. Solution Name 4. The documentation is then created from that new snapshot as either a CHM or HTML files depending on which argument you gave when running the application. Usage: BIDOC <solution name> <output type> <output location> Example 1: BIDOC "Adventure Works" chm c:\tmp\AdventWorks.chm Example 2: BIDOC "Adventure Works" html c:\tmp\htmlfolder How do I schedule the command line application? The easiest way to schedule regular snapshots is to use the Windows Scheduled Tasks application available from the control panel. 1. Open your control panel and choose Scheduled Tasks \| Add Scheduled Task. 2. Select BIDOC.exe as the application you want to run. 3. Choose how often you want the task to run and start time. 4. Enter the user name that the task will run as. Be careful if using windows authentication to connect to your SQL Server that this user has the required permission to connect to the SQL Server. 5. Check 'Open advanced properties when finished'. Specify in the Run textbox the required parameters such as C:\Program Files\BI Documenter>BIDOC.exe "solution name" chm c:\tmp\outputname.chm I see a "Page can not be displayed" error message when viewing CHM files stored on a network drive. What is the problem? Microsoft released a security patch that makes it impossible to view CHM files that are stored on a network drive (as opposed to CHM files stored on your own computer). The help file will appear, but instead of the topic text you will see an error message "this page cannot be displayed". There is a work-around to allow viewing across a network as discussed on the following links; http://www.helpscribble.com/chmnetwork.html http://west-wind.com/weblog/posts/2928.aspx How do I make documentation from a previous snapshot? When you are on the “Create a Snapshot” step click the “Use Existing Snapshot” link in the top right hand corner. This will allow you to choose an existing snapshot to create documents from. How do I enter my license information? After you purchase BI Documenter you will receive an email containing your license. Your license consists of text which begins with [BEGIN LICENSE] and ends with [END LICENSE]. To enter the license details click the “Enter License” when BI Documenter starts. Copy and paste your license beginning with the line [BEGIN LICENSE] up the and including the line [END LICENSE]. Click OK when ready. If you need to update your license later or wish to remove your license you can access the license manager by click the “Options” button and selecting the license tab. How do I update the connection details of my database? On the “Review your Solution” step select the database you want to update and click the “Change Connection Setting” link. Enter the connection details and Save. How can I check that I am running the latest version of BI Documenter? By default BI Documenter will automatically check if you are running the latest version each time you start. If you would like to change this behavior and manually check for updates you can access the updates configuration by clicking the “Options” button and choosing the Security tab. How do I update BI Documenter with the latest version? If after checking for updates you are prompted to update your version of BI Documenter download the latest version by clicking “Yes” when asked to click here to download. To install the update close BI Documenter if open and run downloaded file BIDocumenterSetup.exe. Follow the setup wizard to update your version. All your existing data will be preserved. Once the setup is complete you may use BI Documenter as usual. How can I change the number of snapshots that BI Documenter will save? BI Documenter will automatically delete old snapshots. To change the number of snapshots that BI Documenter will keep for each solution and the warning message access the updates configuration by clicking the “Options” button and choosing the Security tab. My evaluation period has ended. Will I lose the snapshots I have already created when I enter my license? All solutions and their snapshots created during your evaluation period will still be available after you enter your license. On Windows 2000 I get the message: BIDocumenter.exe - Ordinal Not Found. What is the problem? If using Windows 2000 you get the message: BIDocumenter.exe - Ordinal Not Found The ordinal 29 could not be found in dynamic link library odbcbcp.dll And the "Missing Prerequisities" screen prompts you to install SQLServer2005_BC.msi, even though it is already installed. This means that your ODBC components are out of date. Please install Microsoft Data Access Components 2.8 to fix this problem. Where can I ask further questions about BI Documenter? BI Documenter has a community website where you can participate in the forum discussions or even read the BI Documenter Team Blog. The forums are also a great first stop for getting support. Please direct all support enquires to support@bidocumenter.com and all sales enquires to sales@bidocumenter.com.

"I'd say you have a very impressive and extremely useful product here. I highly recommend it to anyone who wants to take snapshots of their SQL Server BI solution... Cool product."

Kirk Haselden

Development Manager,

SQL Server Integration Services,

Microsoft Corporation

BI Documenter 2.0 with increased snapshot performance and reliabilty.