EHB-CB INI Configuration (General)

This page documents general eHandbookCB.ini options and non-Simulink-specific advanced settings.

In addition to the command line parameters, there are also some special configurations in the eHandbookCB.ini file possible. This file is located in the same directory as the eHandbookCB.exe. It is a plain text file and can be edited with any text editor. However user can also configure this special configurations via command-line argument "-vmargs", see the command line list here.

Running EHB-CB in Multi Instance Mode

For running EHB-CB in multi instance mode, the following have to be specified:

  1. Add the following arguments for the Java Runtime Environment into the eHandbookCB.ini file:

    • -Dosgi.instance.area=”dir path”
      (Must be different for each EHB-CB instance)

    • -Dosgi.configuration.area=”dir path”
      (Must be different for each EHB-CB instance)

    • -Djava.io.tmpdir=”dir path” (Optional)
      Handling of temporary files. This parameter is optional, if not supplied, EHB-CB handles creation of separate temp directory created for multi-instance within @user.home\AppData\Local\Temp

  1. Launch of EHB-CB with the additional command line parameter: -lockDir ”dir path” (Must be identical for all EHB-CB instances)
    Required to handle lock for PDF FLY as it support single instance only and other EHB-CB instance waits until the first EHB-CB instance completes the image conversion using PDF FLY.

Please refer to the sample below with parameters that need to be provided for running EHB-CB in multi instance mode:

eHandbookCB.exe (1)
-i "D:\TestData\Asam_Data\input\asamCC.ccx"
-o "D:\TestData\Container\output"
-n "EhcbDemoContainer"
-lockdir "D:\LockDir"
-vmargs
-Dosgi.instance.area=@user.home/EHANDBOOK-CB/instance
-Dosgi.configuration.area=@user.home/EHANDBOOK-CB/configuration
-Djava.io.tmpdir="D:\temDir"
1 On Linux use the executable eHandbookCB

All the above parameters must be used consistently in a Batch Job Server environment. Incomplete parameter supply will result in inconsistent behavior of the EHANDBOOK Container-Build. |

Option for Generating TOC Entries for System Constants (A2L, MDX, C-Code, Excel, ARXML)

A Table of Contents (TOC) entry for System Constants can be generated by using metadata sources such as A2L, MDX, C-Code, Excel, and ARXML.

Below argument can be added to *.ini or passed via CLI:

-DgenerateSystemConstants

Sprotty SVG Image Renderer

This is an experimental feature. It may change or be removed in future releases.

You can enable Sprotty as the rendering engine for SVG images. This can improve the visual quality and performance of the generated SVGs.

This option is disabled by default and must be used with the -gensvg option.

To enable it, add the following argument to your *.ini file or pass it via the CLI:

-DenableSprottyRendering=true

RAM Usage

The maximum RAM memory that EHANDBOOK Container-Build is allowed to use is specified within the -Xmx parameter in the eHandbookCB.ini file.

In this example, the memory limit is set to 8 GB:

-startup plugins/org.eclipse.equinox.launcher_1.5.100.v20180827-1352.jar
--launcher.library plugins/org.eclipse.equinox.launcher.win32.win32.x86_64_1.1.800.v20180827-1352
--launcher.appendVmargs
-vmargs
-Xms256m
-Xmx8g (1)
--add-modules=java.xml.bind
-Dorg.eclipse.update.reconcile=false
1 Set maximum RAM to 8 GB. Refer to, System Requirements

Thread Configuration for PDF Generation

PDF generation using command line argument -pdf is a multithreaded operation. This operation uses all the existing logical CPU cores available on the system for conversion. This might impact the overall system performance.

In order to make PDF generation more optimal, the maximum number of used threads that get spawned during PDF generation can be configured.

If the number of threads configured is greater than available logical CPU cores, then all the available logical cores are utilized.

-DthreadCountForPdfGeneration=4

This option accepts integer value.

ASCET models without ASCET project component

ASCET project component serves as an entry point for processing an ASCET model in EHANDBOOK. However a user might not define an ASCET project in an ASCET model. In such an instance, EHANDBOOK would consider components with names matching with the ASCET model name for processing. Component types which are considered for name matching and processing further are as follows:

  • ASCET_MODULE

  • AUTOSAR_SOFTWARE_COMPONENT

  • StateMachine

This behavior can be configured with the following argument.

-DaxlFileWithNoProjectComponent

ASCET models with white-listed project components

ASCET project specification serves as an reference for processing components in an ASCET model in EHANDBOOK. However we could generate kaom and svg for the white-listed components specified in a JSON which are not part of specification. In such an instance, EHANDBOOK would consider such components in the ASCET model name for processing.

This behavior can be configured with the following argument.

-DascetGenerateAllComponents

ASAM GUI Mode

Per default, the EHANDBOOK Container-Build tool starts with the GUI for Directory-based input data (i.e., if no command line parameters are given). To start the tool with the GUI for ASAM-based input data, the following entry has to be added in the eHandbookCB.ini file:

-Dasam.cb=true

MiKTeX Tool Configuration

Configure path of MiKTeX location used for TeX formula conversion. By default TB_MIKTEX_HOME environment variable is used, otherwise the location provided with this option. Refer to MiKTeX.

-DmiktexEnvVariable="C:\Program Files\MiKTeX 2.9\miktex\bin\x64"

PDF FLY Tool Configuration

Configure path of PDF FLY location used for EPS image to SVG image conversion. By default TB_PDFFLY_HOME environment variable is used, otherwise the location provided with this option. Refer to PDF FLY.

-DpdfEnvVariable="C:\ProgramData\chocolatey\lib\pdf-fly\pdf-fly-9.0.6"