BI Documenter Frequently Asked Questions
What are the system requirements?
BI Documenter supports the following operating systems:
- Windows XP Service Pack 1 or higher
- Windows Vista Ultimate, Business, Home Premium, Home Basic
- Windows 7 Professional, Ultimate, Home Premium
- Windows Server 2008 X86 and X64
The software prerequisites to run BI Documenter are:
- Microsoft SQL Server 2005 Management Objects Collection
- Microsoft MSI Installer 4.5
- Microsoft SQL Server 2005 Backward Compatibility Components
- Microsoft SQL Server 2008 Management Objects
- Microsoft Analysis Management Objects
- Microsoft SQL Server System CLR Types
- Microsoft SQL Server Native Client
- Microsoft Core XML Services (MSXML) 6.0
- Microsoft .NET Framework Version 2.0
- SQL Server 2008 Express Edition or Higher
Even if you are only documenting SQL Server 2005, you are still required to install each of the above listed components.
The software prerequisites to document SSIS Packages are:
- SQL Server Integration Services - Must Match SSIS Package that you are trying to
update
- Business Intelligence Development Studio - Must Match SSIS Package that you are
trying to update
The software prerequisites to output documentation in Help 2 (HxS) are:
- Visual Studio 2008 or Higher
- Visual Studio 2008 SDK
What else is included in the application download?
Along with BI Documenter, the application download includes Microsoft SQL Server 2008 Analysis Objects, Microsoft SQL Server
2008 Management Objects, Microsoft SQL Server 2008 Native Client, SQL Server CLR Types, and the .NET Framework 2.0.
What versions of SQL Server does BI Documenter support?
- SQL Server 2005 Database Engine, Analysis Services and Integration Services
- SQL Server 2008 Database Engine (with SQL Server Instance Properties), Analysis Services, Integration Services, and Reporting Services.
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 requirements 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 scheduled 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.
- Open your control panel and choose Scheduled Tasks | Add Scheduled Task.
- Select BIDOC.exe as the application you want to run.
- Choose how often you want the task to run and start time.
- 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.
- 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 serial number.
To enter the serial number click “Register” when BI Documenter starts. Enter your name and your serial number in the provided form. Check the button next to "Activate automatically when I am online" and click "Register". If you need to update your license later or wish to remove your license you can access the license manager by clicking the “About” button and selecting "Deactivate Software".
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 visiting the
Pragmatic Works Client Center. 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.
What SQL Server Permissions are required for BI Documenter?
The following Server Permissions will need to be granted to BI Documenter users:
- db_datareader and db_datawriter access to the BI Documenter Metabase
- db_datareader access to any SQL Server Database you intend on documenting
- db_ssisoperator (in 2008/R2) or db_dtsoperator (in 2005) access to the msdb System Database for every SQL Server Instance that includes deployed SSIS Packages you intend on documenting
- System User Roles as well as the Browser Role to the Web Service Directory and Publisher Role to any report folder you intend on documenting inside of the Reporting Services Server
Where can I ask further questions about BI Documenter?
Please direct all support enquiries to
support@pragmaticworks.com and all sales enquiries to
sales@pragmaticworks.com.
If you have a great idea or suggestion for BI Documenter or any other products in the Pragmatic Works software family, just click the red "Feedback" tab at the far left of your screen. We appreciate all comments and/or questions!