WhereScape RED includes the ability to document the data warehouse, based on the information stored against the metadata for all the tables and columns in the data warehouse. In a larger environment, it may be a good idea to generate documentation in batch mode.
The following syntax chart illustrates the options available:

med.exe /BD { /U UserName { /P Password } } /C OdbcSource { /M Schema } { /N FullName } /D Directory { /G GroupName | ProjectName } /S NumHops { /I- }

Note

{ } indicates an optional parameter and | indicates alternative values.

Parameter Descriptions

The following parameters are available:

Parameter

Specify Value?

Mandatory?

Description

BD

No

Yes

Indicates batch documentation mode.

U

Yes

Sometimes *1

ODBC username parameter.

P

Yes

Sometimes *1

ODBC password parameter.

C

Yes

Yes

ODBC data source parameter.

A

Yes

No

ODBC DSN architecture.

M

Yes

Sometimes *2

Metadata database parameter.

N

Yes

No

RED user name parameter, only for logging purposes.

D

Yes

Yes

Directory name where documentation is created.

G

Yes

No

Group or Project name if specified. All Objects if not included.

S

Yes

Yes

Number of processes/hops in the source diagrams.

I-

No

No

Exclude Impact Analysis on Load tables (reduces the time required to generate documentation)

Note

  • *1. User Name and Password are not required when using a trusted connection or operating system authentication.
  • *2. Metadata Schema is required for DB2 but is not required for Oracle and SQL Server.

Example
The following example connects to a SQL Server repository called WslWarehouse, using a trusted connection into the C:\Temp\my_doco directory with 4 hops in diagrams:

med /BD /C "WslWarehouse" /D "C:\Temp\my_doco" /S "4"


  • No labels