Using the Command Line Application

Using the Command Line Application

Top  Previous  Next 

 

lightbulb_on

BI Documenter has a command line application that gives you the ability to update or create documentation on a schedule.

 

Executing the Command Line Application

 

BI Documenter provides a console application, BIDOC.exe that can be used to automate the production of documentation on a schedule by using a existing BIDocumenter Solution (Stored in SQL CE or SQL Server Metabase) and optionally outputs documentation after snapshot to CHM or HTML format.  In order to do this you need to run BIDOC.exe (which is located in the BI Documenter application directory) as a Windows scheduled task. BI Documenter also in includes a screen to assist you in creating the command line information.

 

 

 

Command Line Syntax
 

Profesional Edition(SQL Server Metabase)

Syntax: BIDOC.EXE /SOLUTION "<solutionname>" /SERVER "<servername>" /METABASE "<metabase name>" [/USER "<username>"] [/PWD "<username>"] [/NOOUT] [/CHM [/OVERWRITE] | /HTML] [/OUT "<output file/folder path>" [/FILESUFFIX "<pattern>"]] [/WAIT] [/LOG "<log file path>" [/LOGSUFFIX "<pattern>"]] [/HELP]

 

Database or Standard Edition

Syntax: BIDOC.EXE /SOLUTION "<solutionname>" [/NOOUT] [/CHM [/OVERWRITE] | /HTML] [/OUT "<output file/folder path>" [/FILESUFFIX "<pattern>"]] [/WAIT] [/LOG "<log file path>" [/LOGSUFFIX "<pattern>"]] [/HELP]


 

IMPORTANT NOTES

- All switches can be used in one of the following ways. e.g. -HELP , /HELP , HELP
- All switches are case-insensetive
- Value must be placed in double quotes if you have space in the value otherwise double quotes are optional. e.g. VALID => /OUT "C:\My Doc"  INVALID => /OUT C:\My Doc

SWITCHES

Command line Switch Description
/SOLUTION < solution name > Solution name which you want to process
/SERVER < server name > Server name where BIDoc Metabase is stored (ignored when using Database or Standard Edition)
/USER < userid > User name to connect SQL Server. If user name is blank them Windows Authentication is used (ignored when using Database or Standard Edition)
/PWD < password > Password for specified userid to connect SQL Server. If user name is blank them Windows Authentication is used (ignored when using Database or Standard Edition)
/METABASE < database name > BIDoc repository name (i.e Database Name) where Documentation is stored (ignored when using Database or Standard Edition)
/OUT < output path > Output file name or folder. If output format is CHM then has to be existing or non-existing file name (use /OVERWRITE to overwrite existing file). If output format is HTML then it has be an existing folder name.
/FILESUFFIX < pattern > Appends current timestamp with a specified datetime pattern to the output file. E.g. if FILESUFFIX is MMddyyyy then output file name may look like AdventureWorks_12312009.chm
/LOG < pattern > Log file path where process information is stored .
/LOGSUFFIX < pattern > Appends current timestamp with a specified datetime pattern to the log file. E.g. if LOGSUFFIX is MMddyyyy then log file name may look like LOG_AdventureWorks_12312009.txt
/HELP or /? Displays usage help
/CHM Output format as Compiled Help File (CHM)
/HTML Output format as html
/NOOUT Only perform snapshot and skip help file generation
/OVERWRITE Overwrite output file if already exists (Only valid if /CHM is specified)
/WAIT Wait for user input before closing the command window after process is completed.
/SQLCE Use this flag to test commandline to process snapshot stored in SQLCE Database for Trial version. (not valid for registered version).

 

EXAMPLES
 

Example-1 : Perform snapshot using windows authentication to connect to metabase and output documentation to CHM file
BIDOC.EXE /SOLUTION AdventureWorks /SERVER DEV001 /METABASE "BIDocumenter" /CHM /OUT "C:\My Docs\AdventureWorks.chm"


Example-2 : Perform snapshot using mixed mode authentication to connect to metabase and output documentation to CHM file
BIDOC.EXE /SOLUTION AdventureWorks /SERVER DEV001 /USER sa /PASSWORD /METABASE BIDocumenter /CHM /OUT "C:\My Docs\AdventureWorks.chm"


Example-3 : Overwrite target file if exists
BIDOC.EXE /SOLUTION AdventureWorks /SERVER DEV001 /METABASE BIDocumenter /CHM /OUT "C:\My Docs\AdventureWorks.chm" /OVERWRITE


Example-4 : Use timestamp suffix in the output file and log file
BIDOC.EXE /SOLUTION AdventureWorks /SERVER DEV001 /METABASE BIDocumenter /CHM /OUT "C:\My Docs\AdventureWorks.chm" /OVERWRITE /FILESUFFIX "MMddyyyy" /LOG "C:\My Docs\Log\AdventureWorks_LOG.txt" /LOGSUFFIX "MMddyyyy"


Example-5 : Only perform snapshot but skip help file generation
BIDOC.EXE /SOLUTION "AdventureWorks" /SERVER "DEV001" /METABASE "BIDocumenter" /NOOUT


Example-6 : For Database/Standard Edition or when Snapshot is stored in SQLCE
BIDOC.EXE /SOLUTION "AdventureWorks" /CHM /OUT "C:\My Docs\AdventureWorks.chm"


Example-7 : Display help
BIDOC.EXE /HELP


Example-8 : Dont close command window after process is completed
BIDOC.EXE /SOLUTION AdventureWorks /SERVER DEV001 /METABASE BIDocumenter /CHM /OUT "C:\My Docs\AdventureWorks.chm" /WAIT


Example-9 : Evaluate commadline for SQLCE Database during trial version
BIDOC.EXE /SOLUTION AdventureWorks /SQLCE /CHM /OUT "C:\My Docs\AdventureWorks.chm" /WAIT