nav[aria-label="Primary Navigation"] { padding: 0; & ul { list-style: none; width: 100%; display: flex; flex-direction: row; justify-content: start; align-items: start; gap: 30px; padding: 0; & li { margin: 0; } & ul li { list-style: none; } } }

M2Doc Sample Reports #F: Traceability matrix with JavaScript service

medini_1059007410

This is another article of a series of articles about M2Doc as a new technology to generate Word reports out of medini models. You can find additional extensions (beta status) for 2022 R1 and 2022 R2 in our extension area on the online support page. In the 2023 R1 release M2Doc is already included, just has to be enabled in the Preferences > Reporting. All samples posted here are for 2022 R2. Main intention is to make you aware of the new technology but also to get any kind of feedback.

This sample is about a traceability Matrix (i.e. with a variable number of columns), and because we cannot do this completely in Word, also about the Javascript services, which we introduced for M2Doc.

The usage is rather simple: The list of rows (verticalInputs) and columns (horizontalInputs) is prepared as variables (let statements), and then they are given to the traceabilityMatrix() service. Additional parameters are, which properties shall be used for the first row/column ("label" in this case). The last parameter is for coloring the rows differently. Look into the Word template for more information and documentation.

{ m:let horizontalInputs = vulnerabilities.weaknesses->sortedBy(e|e.id) }
{ m:let verticalInputs = attacks.triggers->sortedBy(e|e.id) }

{ m:verticalInputs->traceabilityMatrix(horizontalInputs, 'label', 'label', null) }

{ m:endlet horizontalInputs }
{ m:endlet verticalInputs }

The output looks like this:

The coloring could be used for checking, if a row item does not have traces to any of the columns items (can be check with an AQL statement), and then marked yellow (wasn't done in the above example).

This is all shown in the attached example project (2022R2).

Note: In case you need multiple Javascript services for M2Doc, which you don't want to combine in one file (which you could), you can also place multiple .js files in the /config/reports folder.

I hope that helps you for your reports.

Happy Reporting,

Nils

Find more posts tagged with

medini

medini legacy

Accepted answers

All comments

medini_1026949627

Hi Nils,

I tried to use operations to get the values for SPFM and LFM for a report (M2DOC). Here is the script added to the DOC-template:

SG	Safety Goal	ZF Safety Level	SPFM	LFM	PMHF result

{ m:for metric | myMetrics.containedElements.originalModel } { m:if metric.individualMetrics==true }{ m:for sg | metric.safetyGoal }

{ m:sg.identifier }

Individual: { m:metric.name }:

{ m:sg.name }

{ m:sg.asil }

{ m: metric.getSpfMetric(sg) }

{ m:metric.getLmpfMetric(sg) }

{ m:endfor } { m:endif } { m:endfor }

According to the metrics I got the error message:

Couldn't find the 'getSpfMetric(EClassifier=DCWorksheet,EClassifier=SafetyGoal)' service

Was service call incorrect?

Kind regards

Günter

medini_1059007410

Hi Günter,

The services are not natively available. You have to add the attached script file to /config/reports of the project and then use the following in the template:

{ m:myDC.getTotalSafetyRelatedFailureRate(mySG) }

Happy Reporting,

Nils

medini_1026949627

Hi Nils,

this does not work. Is it possible that revision 2023R1 is needed? We are still using 2022R1.1.

Kind regards

Günter

medini_1026949627

Hi Nils,

I introduced the issue by myself. Problem is solved.

I used the following script at the template:

This resulted in:

Kind regards

Günter

medini_1059007410

Hi Günter,

That's great, and thanks for the example!

Happy Reporting

Nils

medini_1026949627

Hi Nils,

after moving the for-loop into the table I got the result I wanted:

Kind regards

Günter

medini_1005899080

Hi Nils,

I used the JS Service the first time and adapted the M2DocMatrix formatting in Word. But: I changed the font and the alignment, but it seems to have no influence. (E.g. the formatting is "centered" but in the report the result is aligned left)

Is there some kind of "overwriting" in the script?

Sven

medini_1024169437

Hi Sven,

how did you change the alignment? I am not sure I sued the latest version of Nils project but I did this:

added another bind in the top:

var MElementContainer = bind("org.obeonetwork.m2doc", "org.obeonetwork.m2doc.element.MElementContainer", false);

and then used this to center the text in a cell:

rowCell.setHAlignment(MElementContainer.HAlignment.CENTER);

This worked for me. @Nils: maybe you can verify and update the samples.

Did not try anything for the font.

Jan

medini_1059007410

Hi,

The formatting is done in two steps, as explained in the .docx template. Some modifications can be done on the table style, which is applied by the script. See the template extract below for how to do that (via "Table Design" menu entry!). Directly applying formatting onto the visible table is not effective.

Note that not all formatting can be done by this (Alignment of the whole table is possible via the table style) - MS Word magic ;-)

Any other formatting has to happen via the script.

I hope that helps.

Happy reporting,

Nils

medini_1073221077

I've partly been successful in using rowCell.setVMerge(MTable.MCell.Merge.CONTINUE) to merge vertical cells. The goal is to write a FMEDA report generator that can display the FMEDA in giant tables in a Word document in combination with a big page size. It works quite ok, but I have one problem still. Tables with merged vertical cells does not work with the "Repeat header row on each page"-feature that is available in Word. It works fine if I merge the cells manually within Word, but not directly from M2DOC.

Here is a snipped from my code:

var row = new MTableImpl.MRowImpl();
table.getRows().add(row);

// Component
var rowText = new MTextImpl(rowListItem.element.name, textStyle);
var rowCell = new MTableImpl.MCellImpl(rowText, null);
// Merge cells
if(rowListItem.failureModes.size() > 1 && index > 0)
	rowCell.setVMerge(MTable.MCell.Merge.CONTINUE);
row.getCells().add(rowCell);

Any idea if it is a limitation/bug in M2DOC or if I'm doing something wrong?

// Mattias

medini_1073221077

I managed to find out what I had done wrong. It turned out that I had to create the cells that I wanted to merge first and THEN merge them.

The first cell to merge

rowCell.setVMerge(MTable.MCell.Merge.RESTART)

Each cell that will merge with the first

rowCell.setVMerge(MTable.MCell.Merge.CONTINUE)

medini_1024169437

Thanks Mattias for posting this finding.

Jan

medini_1062508839

Hi Nils,

I have used your example and edited it to export different traceability matrices to a word document. I am then copying the table from word and pasting it into excel where it is easier to manage.

I have a problem now that word seems to have a maximum number of columns and, looking on the internet, it seems to be 63 columns.

Unfortunately for my trace matrices there will be more than 63 requirement columns needed. Is there any advice you can give me to get round this problem? I have tried different page sizes but the limit does not seem to change.

Ideally I would like to export any trace matrix that I can create in Medini to an excel file, that would be my perfect solution. Is this possible using a script of some sort?

Thanks,

Andy

medini_1059007410

Hi Andy,

Indeed, Word has a hard limitation on the maximum number of columns.

Still using the M2Doc & Word way, you could limit the number of horizontalInput columns before creating the matrix (via "->subSequence(a,b)"), although that's manual work, especially as you'll have to combine the tables later in Excel again.

Direct export of a traceability matrix to Excel is actually a native feature of medini: Open the trace matrix you want ("Open Trace Matrix..." from the context menu in the model browser - you can already mark both axis elements before) and then use "Generate a report from the table" in the button bar at the top. Select Excel as output format.

Does that fit to your use case?

A third option would be a full script creation for Excel export (examples of creating Excel files are in the forum), but that's much more work.

Regards,

Nils

medini_1062508839

Hi Nils,

Thanks for your reply - the "generate a report from the table" solution is exactly what I was looking for. Strangely a colleague of mine messaged me with the same answer today also. I was hoping that button did exist for the trace matrix but I did not find it. It is not duplicated in the top right corner of the trace matrix window, like it is for the requirements table window, so I did not think to look on the main medini menu bar.

Thanks for your help,

Andy