Warning Messages

NOTICE

Incomplete container content due to defective or inconsistent input data

Content of the generated EHANDBOOK Container may be missing, if the input data used for generating the container is defective or inconsistent. Affected container contents cannot be displayed or will be displayed incorrectly in the EHANDBOOK-NAVIGATOR. Therefore, always check the log file of the EHANDBOOK Container-Build. Defective or inconsistent input data that have led to errors when converting will be tracked in the log file.

The content consistency is in the responsibility of the data supplier (documentation publisher). We recommend that the data supplier develop a standard procedure for pre-processing the input data outside the EHANDBOOK Container-Build tool chain to ensure the data consistency and to reduce the workload for reviewing the input data. In addition, the pre-processing should be properly documented to ensure transparency.

After generating a new container:

  1. Check the entries in the log file of the EHANDBOOK Container-Build indicating defective or inconsistent input data.

  2. If necessary, fix the incorrect or inconsistent input data.

  3. Re-build the EHANDBOOK Container.

  4. Only provide containers for further usage in the EHANDBOOK-NAVIGATOR, if the log file contains no entries, indicating any defective or inconsistent input data.

NOTICE

Incomplete container content due to wrong or corrupt file formats

Content of the generated EHANDBOOK Container may be incomplete, if the input data used for generating the container are not compliant to the following file formats:

  • ASAM formats

    • CCX

    • FSX

    • MDX

  • Image formats

    • JPG

    • PNG

    • EPS

  • Formulas

    • TeX

  • Text formats

    • AsciiDoc (supported subset)

These container contents can not be displayed in the EHANDBOOK-NAVIGATOR. Therefore, always check the log file of the EHANDBOOK Container-Build, after generating a new container. Missing, incorrect or false content will be tracked in the log file.

After generating a new container:

  • Check the entries in the log file of the EHANDBOOK Container

Build indicating missing or incorrect container content.

  • Ensure that the data used during the import match the above specified formats.

  • Generate a new container.

  • Only provide containers for further usage in the EHANDBOOK- NAVIGATOR, if the log file contains no entries indicating any missing or incorrect content.

If it is not possible to completely clean up the log file, inform the intended user of the container about this missing, incorrect or false container content.

NOTICE

Incomplete, wrong or differing representation of model screenshots and interactive models from source data.

During the conversion of ASCET models, Simulink/Stateflow models or C-Code to interactive models and/or SVG graphics, the generated outputs may differ from the original model visualizations. As C-Code is written in textual form while interactive models are graphical diagrams, the semantic and interpretation can differ.

The following deviations between the model and the EHANDBOOK Container content may occur:

  • Missing or wrong graphics

  • Wrong targets on linked graphics

    • Wrong model links

    • Wrong model hierarchy links

  • For C-Code visualizations, different interpretations and semantics

Possible root causes of these deviations are:

  • Link specification in input text does not match to model hierachy path

  • Referenced model/source files are missing

  • Matlab connection for mask generation in Simulink was broken,

  • EHB-CB tool error due to internal error or unsupported source content

  • Technical limitations, especially for representing C-Code as graphical visualization

To identify deviations:

  1. Check the entries in the log file of the generated EHANDBOOK Container for Warnings and Errors

  2. Check the links between SVG graphics and interactive models in the EHANDBOOK Container

It is the responsibility of the creator of the EHANDBOOK Container to check the log files generated by EHANDBOOK Container-Build and to check the outputs for wrong model references and initiate the correction in the sources.

To ensure consistency and mitigate limitations:

  1. Check the release notes and the known issues of EHANDBOOK Container-Build as well as EHANDBOOK-NAVIGATOR.

  2. Compare the C-Code source code with the its graphical representation in EHANDBOOK-NAVIGATOR.