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; } } }

Printing Model Validation Results onto Reports

medini_1060067341

Hello,

Is it possible to print out Validation results onto the generated reports?

I'm not looking for anything too complex. All I want to do if to print out a statement saying if model validation has encountered any warnings/errors or not.

Is that doable? I'm currently using M2Doc.

Thanks!

Lucas

Find more posts tagged with

medini

medini legacy

Accepted answers

All comments

medini_1024169437

Hi Lucas,

it's not (yet) possible but was requested multiple times now so we are on it. Its not that easy because validation results are not persisted and need to be obtained "freshly" so validation need to be run and may take quite some time.

Jan

medini_1024169437

Lucas,

with 2025 R1 there is at lats some improvement for this request: there is a new API that alloww any script to access "issues" for projects. The script can list all issue for a project or create own issues. Sources for issues can be migration, but also validation. With that, it should be easy to write a small scripted service to access those issues and generate tha statement. An example for 25.1 code:

var allIssues = Issues.getAllIssues();
console.log("There are {0} issues in the workspace, {1} of them are errors", 
	allIssues.size(), allIssues.toArray().filter((i) => i.severity == 4).length);

Or:

var ProjectIssues = Issues.forProject(finder.project);
var issues = ProjectIssues.getIssues();
if (!issues.isEmpty()) {
	ProjectIssues.removeIssues(issues);
	ProjectIssues.addIssue(2, finder.project, "There were {1} issues before which the script removed", 
		"No resolution", [ issues.size() ]);	
} else {
	ProjectIssues.addIssue(1, finder.project, "The script did not find any issue", 
		"No resolution", [ ]);	
}

ProjectIssues.openProblemsView();

Still, validation is not excuted by the script so the report would rely on manual project validation. Would that be sufficient? If not, how do you think we can handle this, trigger validation from the m2doc report? As mentione,d it might be a time consuming activity.

Any input highly appreciated.

Happy New Year

Jan

medini_1060067341

Hi Jan and happy new year!

I don't see the model validation not being executed by the script as an issue.

Just being able to reflect the validation results into the generated reports is sufficient for our use case. I'll play around with the new APIs and let you know if I have further questions.

Thanks!

Lucas

medini_1024169437

Happy New Year Lucas,

ok, let me know and finding or idea.

Regards

Jan

medini_1063548292

Hi Jan,

Let me also contribute with some notions.

Having a way to add multiple issues at once would be great
Could be global Issues and ProjectIssues ,
Issues.addIssues(project, Collection)
ProjectIssues.addIssues(Colleciton)
If one could add issue directly with the specification of the parent that would be amazing ...
ProjectIssues.addIssue(Issue issue,Issue parentIssue)
Seems like when one will remove Issue in a problems View ( highlighted one ) and that is a child of some parent and has some siblings it the problems view will delete everything including parent . Is that expected ?
What is the purpose and eventual usage of Issue's "resolution" attribute?Can it by display Ina problems view? I also do not see it in the exported file.

Happy Issuing,

Marian

medini_1024169437

Hi Marian,

thanks for the contribution, interesting ideas. I have a few comments resp. questions back:

1. good idea, we somehow missed that! Do you really need Collection or maybe also Array?

2. okay, how did you do before? issue.parent = p? hm, maybe Issue.add would be better...

3. you refer to manual removal, not via API, right? I can confirm a strange behavior in the view (manual) but removal via API seems to work

4. this is currently used internally by diverse contributors (like consistency check) to define ways to fix an Issue via "Quick Fix". Currently there is no way to use that via a script.

Regards

Jan

medini_1063548292

Hi Jan,

any sort of multiple issues. maybe indeed Array is beter as it is "easier" ( shorter code) to create an array then ArrayList or a Set
previously I did two steps
-> create Issue store in temp variable
-> setup parent ( void issue.setParent(parentissue))
And finally store such issue in an common array to be later "posted" to a project issues:)
I thought about doing it in a single line
Issue(...).setParent(pissue)
but the last method returns void so I had to do it in two steps and using temp variable
I can confirm that removal of any issue using API PojectIssues.removeIssue(...) works flawlessly
My idea behind was that for some issues /validation I was missing a "waiver" where one can provide justification. And I think this attribute seems to be the closest one that could be misused, drawback is that it is currently not visible neither in the problems view nor in the exported file.

PS: If I am not mistaken the Dynamic Constraint Validating concept also does not offer a "waiver" feature.

Regards,

Marian

medini_1024169437

Thanks Marian, very valueable input again, we will fidn a solution for all points, I am sure.

Jan

medini_1024169437

Marian, what do you actually mean by weaver? Could you explain a bit?

Jan

medini_1063548292

Hi Jan,

The waiver concept is quite similar to a Jira ticket with outcome Won't fix.

Meaning if there is a violation due to the executed rules then user can decide to "waive" it for certain violated cases(Objects) -. will not take any action to resolve it ,but is obliged to provide justification why.

And I was referring to the fact that there nowadays no filed where one could directly in the UI enter the justification /mark it as waived..

One has to open the problems view and the export it into file and there can record the waiver with manually added column.

That was also a reason awhy I was asking what is the purpose of the resolution column. where an eventual Waiver & argumentation could be stored.

Marian

medini_1024169437

Thanks Marian, all clear now.

Points 1., 2. and 3. are tackled and will be fixed/improved with 25.2. Point 4 is indeed a missing feature, you cant actually "assess" the validation findings. They are even not persisted anymore since one of the recent releases. The resolution as mentioned is currently used for the quick-fix feature and cannot be utilized by scripts.

Happy Scripting

Jan

medini_1063548292

Hey All,

IN the meantime I have thought a bit and create myself a tiny tiny script that will create the Validation results and placed them into the separate checklist or just as a sub-item hierarchical items in the selected checklist so that they can be further analyzed, addressed and keep record the output inside of the project rather then external word/excel. ,,,

Example with designated checklist as a generated report :

Example as a sub-checklist into existing checklist

PS: just a tiny nudge could the export the validation into the checklist be considered as a useful feature ? maybe feature at Validation View.?

Happy Validation.

Marian

medini_1024169437

As usual, cool ideas Marian! Well done. How do you trigger the validation? You trigger the UI command?

Jan

medini_1063548292

Well Jan,

no the the validation needs to be triggered the old-school -way => needs an individual between the chair and the keyboard:)

But indeed no problem to extend it with first validate and then create a report, it is just matter of 2 to 3 more lines in code.
Something like getting the project from selection, configuring the view with the project&objects to be validated and finally relaunching the validation using the UI action built int the view.

Marian

medini_1024169437

Just an update: 2025 R2 is out and issues 1,2 and 3 are addressed/fixed in that release.

Jan