Page History
Documentation generation can be invoked through the command line.
Document
| Code Block |
|---|
repo |
...
category |
...
model |
...
version (only valid when versions are used) |
...
'source' / 'model' / 'compare' |
...
-title |
...
-o 'html' / 'word' ('html' not valid for 'compare gap') |
...
-d (directory, only valid for html) |
...
-f (file, only valid for word) |
Source / Model:
| Code Block |
|---|
-iss 'yes'/'no' (include source systems; default no for 'source', yes for 'model') |
...
-ors 'yes'/'no' (only referenced source systems; valid if iss is yes) |
...
-gd (general documentation) |
...
-od (overview diagrams) |
...
-nts (notes) |
...
-an (attribute notes) |
...
-kw (keywords) |
...
-sm (source mappings) |
...
-smd (source mapping diagrams) |
...
-ac (attribute comments) |
...
-ad (attribute documentation) |
...
-qry (queries) |
...
-idx (indexes) |
...
-erd (generate erds) |
...
-em (entity metrics) |
...
-rm (relation metrics) |
...
-am (attribute metrics) |
...
-mg (metric graphs) |
...
(use the defaults as per already if param not specified; some of the html settings have been ignored, just use defaults |
...
Compare:
| Code Block |
|---|
'structure' / 'profiling' / 'gap' |
...
'with' |
...
repo |
...
category |
...
model |
...
version (only valid when versions are used) |
Examples:
| Code Block |
|---|
jre\bin\java -Xmx512m -XX:MaxMetaspaceSize=512m -splash: -jar WhereScape-3D-HEAD-bundle.jar document "Local repository" "Source" "Northwind" "Master" model -ad -nts -kw -sm -smd -erd -mg -qry -idx -em -am -rm -vst tinbsv -iss yes -ors yes -title "Source system design" -o html -d "%UserProfile%\WhereScape\3D\Documentation\001" |
...
jre\bin\java -Xmx512m -XX:MaxMetaspaceSize=512m -splash: -jar WhereScape-3D-HEAD-bundle.jar document "Local repository" "Source" "Northwind" "Master" compare gap with "Local repository" "Source" "Northwind" "1.0" -title "" -o word -f "%UserProfile%\WhereScape\3D\Documentation\001.docx" |
...
jre\bin\java -Xmx512m -XX:MaxMetaspaceSize=512m -splash: -jar WhereScape-3D-HEAD-bundle.jar document "Local repository" "Source" "Northwind" "Master" compare structure with "Local repository" "Source" "Northwind" "1.0" -title "" -o html -d "%UserProfile%\WhereScape\3D\Documentation\001" |
To keep things practical we assume:
...