EHANDBOOK Container-Build CLI Parameters
This page describes the command-line parameters used to generate an EHANDBOOK container from source data.
Follow these steps to generate a container:
Step 1: Open a command-line interpreter (CMD or PowerShell on Windows, or bash on Linux). Go to the EHANDBOOK Container-Build installation directory.
-
On Windows, use
eHandbookCB.exe. -
On Linux, use
eHandbookCB.
Step 2: Run EHANDBOOK Container-Build with the required command-line parameters. See the table below for a description of each parameter.
Format:
eHandbookCB.exe <Option>
The following table lists all available EHANDBOOK Container-Build command-line interface (CLI) parameters:
| Parameter | Optional | Value Type | Description |
|---|---|---|---|
-i |
No |
Path enclosed within double quotes |
Location of ASAM catalog file (.ccx) for ASAM-based EHB-CB or top folder of input directory for Directory-based EHB-CB |
-o |
No |
Path enclosed within double quotes |
Location of output folder |
-n |
No |
Path enclosed within double quotes |
Name of the container to be generated. The file extension .ehb is added. Existing containers with the same name will be overwritten! |
-styling |
Yes |
Path enclosed within double quotes |
Location of folder containing the styling information (title page, fonts, company logo etc…) For more details refer to the EHB-CB Styling Guide. Without this option, a default title page is created. |
-gensvg |
Yes |
None |
Option to generate SVG image screenshots out of interactive model. For more details refer to chapter Click Pic. |
-labelamendment |
Yes |
Path enclosed within double quotes |
Option to provide a path and file to rename variables and parameters in Simulink models. |
-lockdir |
Yes |
Path enclosed within double quotes |
Option to provide path for locking directory (only required if multi instances of CB are used) |
-version |
Yes |
None |
Option to display the version of EHB-CB product being used. For more details refer to chapter Configurations in eHandbookCB.ini |
-vmargs |
Yes |
None |
Option to configure special configurations from the eHandbookCB.ini file via command line. For more details refer to chapter Configurations in eHandbookCB.ini |
-rootlevel |
Yes |
Path enclosed within double quotes |
Option to provide path to root level file for one or more model languages. The default value for all the languages is 0. |
-ugg |
Yes |
None |
Use pre-generated images and interactive models from UGG |
-viewtype |
Yes |
Parameter enclosed within double quotes |
Option to provide a view name, for which the models and their screenshots are be generated. If this parameter is not passed, the models are generated without any views applied. For more details refer to chapter View Concept |
-tableconfig |
Yes |
Path enclosed within double quotes |
Option to provide a path to a JSON-file to configure the appearance of the chapter for variables and parameters and their tables. |
-labelconfig |
Yes |
Path enclosed within double quotes |
Option to provide a path to a JSON-file to configure the labels for Simulink blocks and buses or element names in ASCET. |
-autosarcomposition |
Yes |
Text enclosed within double quotes |
Name of the root composition from AUTOSAR. For more details refer to chapter Model Interface & Data Description in AUTOSAR (Classic) |
-ar2ehbcbinput |
Yes |
None |
Generates EHB-CB input directory structure from ARXML files. For more details refer to chapter Generation of Input Directory Structure from AUTOSAR files |
-epwd |
Yes |
Text enclosed within double quotes |
Password to encrypt the container For more details refer to chapter Encryption |
-epwdf |
Yes |
Text enclosed with percentage character e.g. %my_secret% |
Password to encrypt the container stored in the given text file. The password file is deleted after container encryption. |
-componentconnectormappingfile |
Yes |
Path enclosed within double quotes |
JSON file containing mapping information across domains e.g. AUTOSAR to MSR. For more details refer to chapter Mapping signals across domain |
-genxdiovr |
Yes |
None |
Option to create MSR Diagnosis XDI overview table by aggregating the XDI information |
-help |
Yes |
None |
Show command line help documentation. |
EHB-CB command line parameters, useful for debugging purposes:
| Parameter | Optional | Value Type | Description |
|---|---|---|---|
-noclean |
Yes |
None |
Deprecated. |
-debugreq |
Yes |
None |
Option to print extended debug messages to log file |
-nogenhtml |
Yes |
None |
Option to avoid pre generation of html in the container |
EHB-CB command line parameters, only valid if optional ASCET converter add-on is included in EHB-CB tool:
| Parameter | Optional | Value Type | Description |
|---|---|---|---|
-ascetview |
Yes/No |
Path enclosed within double quotes |
Location of ASCET view configuration file. Mandatory when -viewtype parameter is passed. |
-splitApp |
Yes |
None |
In ASCET-DEVELOPER projects, -splitapp is an option used to create functional components out of static class present in the app file. Note: This option works only with Directory-Based EHB-CB. |
-ascetdeveloperexcludepackages |
Yes |
Path enclosed within double quotes |
Path to file containing list of ASCET-DEVELOPER packages that shall be excluded from processing. Note: This option works only with Directory-Based EHB-CB. |
-ascetdevelopernestedclasses |
Yes |
None |
Generate documentation for nested classes in ASCET-DEVELOPER apps. Note: This option works only with Directory-Based EHB-CB when the ASCET-DEVELOPER .app file is passed as input argument. |
-ihf |
Yes |
Text enclosed within double quotes |
Option to trigger filtering for intermediate ASCET hierarchies. For more details refer to chapter intermediate hierarchy filtering |
-includeSourceCode |
Yes |
None |
Option to process and store ESDL, Matlab function and C code blocks during container generation and show them in the EHANDBOOK-NAVIGATOR code viewer. The previously available "-includeMatlabFunctionCode" argument has been removed and superseded by -includeSourceCode. |
EHB-CB command line parameters, only valid if optional C-code converter add-on is included in EHB-CB tool:
| Parameter | Optional | Value Type | Description |
|---|---|---|---|
-cat |
Yes |
None |
Enable of special C-Code handling for external tools. |
-ccodeview |
Yes/No |
Path enclosed within double quotes |
Location of C-Code view configuration file. Mandatory when -viewtype parameter is passed. |
-ccodemeta |
Yes |
Path enclosed within double quotes |
Path to file with configuration information to allow the decoration of sub-routines with custom images and others. For more details refer to chapter C-Code Configuration |
EHB-CB command line parameters, only valid if optional Simulink converter add-on is included in EHB-CB tool:
| Parameter | Optional | Value Type | Description |
|---|---|---|---|
-nomatlab |
Yes |
None |
Option not to use MATLAB for enhanced rendering of Simulink models. Container generation time gets considerable faster. |
-simlib |
Yes |
Path enclosed within double quotes |
Path to root directory to all Simulink libraries. Directory may contain sub directories, too. Multiple root directories can be specified, separated by commas. Paths to all libraries required by the Simulink model must be provided, including MATLAB Simulink system libraries. |
-simlibfile |
Yes |
Path enclosed within double quotes |
JSON file containing paths to all libraries required by the Simulink model must be provided, including MATLAB Simulink system libraries. (see chapter SIMULINK library paths support |
-simulinkview |
Yes |
Path enclosed within double quotes |
Location of Simulink view configuration file to specify non-expandable blocks (see chapter Configure Simulink Blocks as Non-Expandable) |
-matlabpath |
Yes |
Path enclosed within double quotes |
Installed MATLAB path till matlab.exe to be used for generating mask data for Simulink models. (see also chapter Timeout for MATLAB API Communication and chapter Timeout for MATLAB Instance Startup) In order to have proper mask generation, it is recommended to connect to the same MATLAB version in which the model is generated. |
-enableVariantBlockConfiguration |
Yes |
None |
Option to process the Simulink Variant blocks during container generation, and show the active and inactive variant choices in EHANDBOOK-NAVIGATOR. |
EHB-CB command line parameters, only valid if optional PDF converter add-on is included in EHB-CB tool:
| Parameter | Optional | Value Type | Description |
|---|---|---|---|
Yes |
None |
Option to generate PDF documentation from EHB container content. |
Please refer to the sample below with all mandatory parameters:
eHandbookCB.exe (1)
-i "D:\TestData\Asam_Data\input\asamCC.ccx"
-o "D:\TestData\Container\output"
-n "DemoContainer"| 1 | On Linux, use the executable eHandbookCB |
Step 3: Press Enter.
Step 4: The log information is displayed in the command prompt console.
Step 5: Once the EHANDBOOK container is created successfully, the following message is displayed in the command prompt console:
"INFO - Container creation successful! [path in which container is created]"The output folder now contains an EHANDBOOK container with the .ehb extension and the name specified with the -n argument.