<< Click to Display Table of Contents >>

Batch processing

Top Previous Next

HTML Documentation Generator may also be invoked from the command line. Your command prompt must be pointed to the \Program Files\Keeptool\Keeptool Version\ directory (assuming the default installation path was chosen) that contains DbDoc.exe, or you must have it declared in your path.

 

A command may specify all of the same options as the logon dialog. You can specify that the Generator should automatically be started and produce its output without any further intervention (batch=y), or you can simply use the command line to specify options and bring up the connect dialog, and start it yourself (batch=n). This will give you a chance to review the options and modify them if you wish.

All options are specified by keyword parameters, as outlined in the table below. You must invoke ohyper.exe at the command prompt, followed by the parameters, as in this example:

 

DbDoc.exe userid=HR/HR@orcl ^

  batch=y ^

  output=%~db0DbDocHR.html ^

  tabfilter="TABLESPACE_NAME LIKE '%USER%'" ^

  plsqlfilter="OBJECT_TYPE = 'PROCEDURE'" ^

  lang=g

 

Note that all parameters, other than userid, have a default value, and that if a value string contains a space, you must surround the string with double quotes. You may list the parameters in any order.

Also, if you enclose the command in a script, be sure to use double percent signs (%%) with the LIKE operand. These will be translated into single percent signs when the command executes.

The following tables shows the parameters that can be set, and the default values that will be applied if they are not specified:

Parameter keyword

Permitted Values (with default marked by a diamond (Default)

Meaning

userid=

user/password[@connect_string]

user and password, and optionally, connect string

output=

 

any file location, defaults to

%TEMP%  (Default)

HTML file that will hold the documentation

lang=

 

e (English) (Default)

g (German)

language in which documentation will be generated

views=

 

y (yes)  (Default)

n (no)

whether views should be included in the Tables section of the report

plsql=

 

y (yes) (Default)

n (no)

whether stored PL/SQL objects should be included in the generated documentation

border=

 

y (yes) (Default)

n (no)

whether HTML tables should have visible borders

title=

any desired title, default to

"Data Model of #o as of #d" (English) (Default)

or

"Datenmodell #o , Stand #d" (German) (Default)

title of the report

tabfilter=

TABLE_NAME LIKE '  '

or

TABLESPACE_NAME LIKE '  '

enclose the string to be matched in single quotes

plsqlfilter=

OBJECT_NAME LIKE '  '

or

OBJECT_TYPE =

enclose the string to be matched in single quotes

or specify

FUNCTION,  PROCEDURE or PACKAGE

triggers=

y (yes)  (Default)

n (no)

allows you to optionally exclude triggers

relations=

y (yes)  (Default)

n (no)

allows you to optionally exclude master/detail relations

dependencies=

y (yes)  (Default)

n (no)

allows you to optionally exclude object dependencies

seealso=

y (yes)  (Default)

n (no)

allows you to optionally exclude "see also" section

batch=

y (yes) (Default)

n (no)

y indicates that the job should be run automatically

n produces a connect dialog with the options set