M2Doc FMEDA result table

Question

Hi,

I want to add in my M2Doc report the result table with the individual metrics:

how can I access this data?

Or: Alternative: I list all SGs with the evaluation results:

Up to now I was not able to find these values.

Thanks,

Sven

medini_1063548292 · Answer

Hi All,

A small update.

So with 24R2 the Evaluation service is now possible to be called on any Object ( string, integer, Collection).

Thanks for extension!

I have tested it out and have some observations, that may be useful for others.

There some differences compared to a regular JS execution.

Capabilities of the service are little bit different depending on the context that is caller.

The operators

* Aql dot operator on a single object => called once with object as 'self' in JS 
* Aql dot operator on a Collection => called on every object inside of the Collection as 'self' in JS 
* Aql -> operator on a single object => called once with object as 'self' in JS 
* Aql -> operator on a Collection  => called once with Collection as 'self' in JS

The __homedir ,__tool_version , ... JS objects

* they are simply not available at all
This is important to know if you load some regular JS scripts that are relaying on those objects

The load("")

* Relative file path works only in case the caller context is Medini Object ( object contained within a medini project)
For other cases one will encounter following error:

Error: java.lang.IllegalStateException: unable to obtain calling script file - cannot resolve relative file name

* Absolute file path works, but keep in mind that every load(absPath) statement will create a temporary file somewhere in the PC's temp folder. Additionally nested files load() calls with relative path will still not work
* The only workaround here is to use absolute file path

The finder

* finder is only available if the context caller object is Medini Object

* for the Integer, String, null, Collection it will not  crate a finder object.
There is eventual workaround to use combination of AQL query and Parameters passed to eval to create a scoped finder.  Or just use some Medini object, ideally MediniProject as the query is the safest:)

* //m2doc query to create a Scoped Finder for a given Eval service inside of the m2doc template file
// the AQL query will ALWAYS yeild a single project (Owner of the M2Doc checklist)
//the JS Gobal.projects will list ALL open medini projects
//example use eval & finder to list all TAGGED objects with tag 'PENDING-TASK' 
{m: ''.eval('var finder = Global.getFinder(p2);
 finder.findByTag(\'PENDING-TASK\').asList()',projectmodel::MediniProject.allInstances()->first())->sep('
')}

// now using Mediniproject as a Context
{m: (projectmodel::MediniProject.allInstances()->first()).eval('finder.findByTag(\'PENDING-TASK\').asList()')->sep('
')}

The bind ( aka $EXPERIMENTAL$ pragma)

* works without any differences compared to a regular JS execution

PS: I tried to implement custom Scripted service

({ evalm2: function(/*Object*/self2,/*String*/script)
	{
	var self = self2;
	return eval(script);
	},
})

*  but It get rid of only problem with the finder. 
* The __homedir, _tool_version, ...and other objects were still missing.
* The load()  with relative file path was problematic but his time for all possible caller contexts
with different Error:  java.lang.IllegalStateException: unable to obtain script scope - cannot load other scripts
* After playing around I found out that during the initial m2doc step (scan for external services) the load was working just fine, and the error above was issued when the custom service was called from the M2doc template.

PS2: I am also attaching some m2doc word template with the exercise/test of the eval(). You can also extend your scripted services with the evalm() as mentioned in previous PS  to have the full template without errors :)
Happy Evaluating,Marian

medini_1063548292 · Answer

HI
Nils ,

just
to clarify the "access" directly the m2doc variable. It is
because I passed a value (index) in between the string code snippet
for eval() . It is not physically passing object but a string.

Anyway it could be done passing a mediniIdentifier and suing finder with
filter on meidniIdentifier  inside of eval().

In
the meantime, I have played around more with eval() trying to figure out how to
implement "real" local template variable concept. Without let..endlet
(Teaser trailer you can expect a separated article on that topic form me).

Here
are my observations. (2024R1)

Object type( object.eval())  
Description  Integer,String  
Service not supported  Null, MetaClass  
Service supported but problems with  finder , load  Emf object instance  
Works without any issues  AQL collection  
Not supported  ().eval() , works only on first objects m, resth having an issue  AQL collection operation  
Not supported  ()->eval()

There
were some cases where it worked only partially. or instance problems with
load() and finder ..

Please
take a look and use attached word template to see more details.

PS:
I have just noticed the Jan's post about planned enhancements for 24R2, not
sure whether it will also address the cases in the provided
template. Looking forward for the next release to see eval
enhancements. :)

Happy
reporting,

Marian

medini_1059007410 · Answer

Hi Marian,

Nice tweak, thanks for sharing! I wasn't aware that the JS can directly access other variables.

In order to avoid the need for these tweaks, we will allow more parameters for eval() in 2024R2. :-)

Regards,

Nils