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 prompt services

medini_1063548292

Hello all!

I have started to get acquainted with a m2doc and discovered couple of interesting services.

Thy are documented in the m2doc page section prompt services.AP

One can add this functions inside of m: statement and that will raise non-modal prompt dialog awaiting user input. ( similar to JS prompt())

I found this prompt services very useful especially when debugging some parts of {m: ... } constructs because of strange behavior
Another use is to actually use the input ain a let statements to define variables.

Result of the prompt can be String, Integer,Double, or even an EObject
Imn case of latter one prompts user with a selection dialog with all available resources in current Medini project.

Examples:
Using 'STR'.promptString()

---- 
'Please state your name\n\tThank you!'.promptString()

m:let promptOutput='Please define values separated by space \n\t[Anything outside of < 1 or > 10 will be disregarded]'.promptString()+''
m:if promptOutput <> ''
'convert ot integer but before use regexp to allow only 0-9 characters, filter content ot keep only unique records and then covert string to integer
'Finally limit the values to a 1..10 only and sort the values in descending order

m:let myValues = promptOutput.tokenize(' ')
->select(e|e.matches('[0-9]+'))->asSet().toInteger()->intersection(OrderedSet{1,2,3,4,5,6,7,8,9,10})
->asSequence()->sortedBy(e|e)->reverse()

------sanity check 
m:if myValues->size() > 0

....... Do some magic .....
m:endif
m:endlet
m:endif
m:endlet
m:endlet

And also some example with 'Some text'.promptEObject()

---This did not work well , shown were all meta objects in project but cannot confirm the select as a valid type
m:let myobj='Please Select an FMEA FailureEntry: (FMEA::FailureEntry) '.promptEObject(FMEA::FailureEntry)

---This worked , allowing select and confirm any EObject
m:let myobj='Please Select an FMEA FailureEntry: (ecore::EObject)'.promptEObject(ecore::EObject)
--USing kernel::MediniObject allowed to confirm only objects such as Failure rate catalog,Mission profile, Traces objects
m:let myobj='Please Select an FMEA FailureEntry: (kernel::MediniObject)'.promptEObject(kernel::MediniObject)

---This did not work well , shown were all meta objects in project but cannot confirm the select as a valid type
m:let myobj='Please Select an FMEA FailureEntry: (FMEA::FailureEntry) '.promptEObject(FMEA::FailureEntry)


---This worked , allowing select and confirm any EObject
m:let myobj='Please Select an FMEA FailureEntry: (ecore::EObject)'.promptEObject(ecore::EObject)
--USing kernel::MediniObject allowed to confirm only objects such as Failure rate catalog,Mission profile, Traces objects
m:let myobj='Please Select an FMEA FailureEntry: (kernel::MediniObject)'.promptEObject(kernel::MediniObject)

However here it I encountered little bit of problem. I was able able to see and select all the object however the only way I was able to confirm selected object was if I used ecore::EObject or kernel::MediniObject. Maybe I could consider to some of the UI.js utilities such as SelectElement() instead of this

PS: You ma have notice I also used M2DOC interpreter view However I did not found an easy way how to create or at least locate pre-generated genconf file that I could use to see all the resources inside of particular project as it was in case when m2doc was triggered from a word template

Happy reporting
Marian

Find more posts tagged with

medini

medini legacy

Accepted answers

All comments

medini_1024169437

Marian, this is awesome, thanks for posting!

I could imagine that we offer a simple service to select an object, I guess that would make it easier for you, right?

I at least will add this to the ideas for further custom medini m2doc services.

What I don't get is that you wrote " will raise non-modal prompt dialog ", how does that work if it is non-modal and does not block the report generation?

There is already the plan to provide the genconf file automatically on our side too.

Jan

medini_1063548292

Hi Jan,

Correction I wanted to say dialog that pauses the processing but i again use wrong words:). But yes i meant a modal dialog

Just to calrify I did not know if you have a plan to provide prompt services (those available in the ui.js lib) so I tried to play with the M2Doc native ones:)

Regarding the service to select an object I was really thinking about already existing SelectElement() available in the ui.js library with the scope an optional parameter so if it is not defined it will assume the project as a scope.
FYI I have made a little bit of extension to the original SelectElement()

It would be nice if this service could return Sequence ( List) of selected objects

/*
*
* Fucntion former selectElement in UI.js ugraded to supoort multipe choice , filters , preslecetion and chelkall/uncheck all features
*
*/
//5-May-2021: MK extended arguments to preselect (check) some objects {initSel} and add description {description} text 
function selectElementMK(title, type, multiple, root, initSel, description) {
	var selected = undefined;
	UI.execute(function select(monitor) {
		var shell = UI.getWorkbenchWindowShell();
		var dialog = new SelectElementTreeDialog(shell, title, type, multiple);
		AnalyzeUI.INSTANCE.preparate(dialog);
		dialog.setStyle(SelectElementTreeDialog.CHECKBOX);



		if (multiple) {
			dialog.setStyle(SelectElementTreeDialog.PROPAGATE_CHECKED_STATE);
			//5-May-2021: MK added check/uncheck all button in case of multiple selection is opted
			dialog.setStyle(SelectElementTreeDialog.TOOLBAR_CHECK_ALL);
			dialog.setStyle(SelectElementTreeDialog.TOOLBAR_UNCHECK_ALL);
		}
				// use global variable "project" as input if none was defined
		if (root == undefined) {
			root = finder.getProject();
		} else if (isArray(root)) {
			dialog.setTreeContentProvider(new ArrayTreeContentProvider());
			dialog.clearStyle(1 << 12); // <- filter does not work in this case
		}
		dialog.setTreeInput(root);
		//5-May-2021: MK added feature to preselect (check) some objects and add description text 
		if (description) dialog.setDescription(description);
		//MK aded feature to preselect (check) objects
		try {
			//obcjt colelciton as th setInittallSlectedObjcet accetsps single object or collecitons of objects!!!!
			if (initSel && initSel.size()) { 

				//if (initSel.size() == 1) dialog.setInitiallySelectedObject(initSel[0]);
				//if (initSel.size() > 1) dialog.setInitiallySelectedObjects(initSel)
			dialog.setInitiallySelectedObjects(initSel);
			}
		} catch (e) {
					alert("SELECT ELEMENT DIALOG:\n Failed to preselect selected objects")
				}

		var result = Dialogs.openDialog(dialog);

		if (result == 0) { // Window.OK = 0
			selected = dialog.getSelectedModelElements();
			if (!multiple) {
				selected = selected[0];
				// FIXME This should be normally done by the dialog already, why isn't?
				if (selected.prototype == Metamodel.projectmodel.PJProxyModel) {
					selected = selected.originalModel;
				}
			}
		}
	});

	return selected;
}

Marian

medini_1024169437

Thanks Marian for the clarification wrt. modal dialog,

there was indeed no plan yet to provide prompt services but that sounds feasible to me. I added this to our m2doc backlog.

Nice extension to ui.js, I can incorporate that. However, I am not sure about your request "service could return Sequence ( List) of selected objects".

That's a request for any future prompt service, right?

Btw. it should be easy to use eval() any any kind of script like ui.js already now or hack your own simple prompt service.

There are some articles here in the forum how to do that.

Happy Reporting

Jan

medini_1063548292

Hi Jan,

I think there is
actually no need to improve the
selectElement function in the ui.js. The latest released available on this forum actually contains
same functionality. As I had an older
version I did some investigation how to enhance it a bit on my own, my bet.

By “return the
Sequence” I meant that the elect element currently returns either an EObject or
an Array.

but M2Doc simply needs a Collection type so In order to convert it I used java.util.Arrays.asList()
and then one could the further process the selection result in the m2doc

Btw It took me some
time until I found a method how to enable all the applicable classes. In the
m2doc there is a OCL class kernel::MediniObject but I could not find equivalent class in the
JS.

I have tried using in JS

·
Metamodel.Any-> no possibility to select any
object at all

·
de.ikv.medini.kernel.MediniObject -> this was
simply raising an issue, not recognized by JS

After a while I
found a solution. So when one want to
enable all the classes in the dialog
then I simply pass and empty array.

Example of m2doc service *.js file:

//$EXPERIMENTAL$ $STRICT_MODE$ $WARNING_AS_ERROR$ 

load(“.lib/ui.js”)
({
selectElement3: function(strDescr,objClass,scope) {
 /**
 * Opens an element selection dialog, either single selection or multi-selection.
 * An optional root element can be passed.
 * * @param {strDesc} Description of tree dialog window
 * * @param {objClass} type can be a collection or a single class object
 * * @param {scope} scope of the tree select
 * *
 * @returns arrayList
 */

 var selected;
 //list of class names to be displayed in the dialog window
 var classString = "::";
 try {
 if (objClass && !objClass.size && objClass.instanceClassName) classString+=objClass.instanceClassName;
 else if (objClass && objClass.size) objClass.toArray().forEach(
 function(ele,id){
 classString+=ele.name+(id < objClass.size()-1? ",":".");
 });
 else classString="No class supplied";

 }catch (e) {
 console.log(e.message);

 }
 //console.log("Hello with {0}",classString);
 // if no class is defined then use empty array => enables all mediniObject in the project to be selected
 //objClass = objClass ? objClass: Metamodel.Any; => does not work no objects are visible
 //objClass = objClass ? objClass: de.ikv.medini.kernel.MediniObject => this class is not recognized in the JS
 objClass = objClass ? objClass: [];
 console.log("selectElement3:\n\t class {0}",(classString));
 //available in ui.js : selectElement(title, type, multiple, root, description, preSelection)

 try {
 selected = selectElement("Please make your choice(s)"/*Title*/,
 objClass /*class(es) object or Collection*/,
 true/*multiple*/,
 scope/*root*/,
 ((strDescr||"") +"\n element(s)"+classString)/*Decription*/,
 null/*preselection as Array()*/ );

 //the result can be undefined,empty array or a single /multiple element in Array 
 } catch (e) {
 console.log("Ups SelectElement3\n" + e.message);
 } // try --catch raise treedialog
console.log("User choice {0}",(selected || (selected && selected.length && selected.length>0) ? java.util.Arrays.asList(selected) : "nothing"));
 return (selected || (selected && selected.length && selected.length>0)? java.util.Arrays.asList(selected) : java.util.Arrays.asList([]));
 })

And m2doc usage :

{ m:let selected= 'Please choose something from this nice GUI \n(any Medini Object)'.selectElement(kernel::MediniObject,null) }

{ m: selected->size() }
{ m: selected->sep('\n\t')} 

Display result per class (image,object,attributes)
{ m:for clase | ecore::EClass.allInstances()->intersection(selected.eClass()->asSet())) }
 { m: selected->filter(clase)->first().getImage() }{m: selected->filter(clase)->first()}{ m: clase.eAllAttributes.name->sep(' , ')}
{ m:endfor }
{ m:endlet }

{ m: 'Please choose something from this nice GUI\nno class'.selectElement(null,null)}

{ m: 'Please choose something from this nice GUI\n ecore::EObject class '.selectElement(ecore::EObject,null)}

{ m: 'Please choose something from this nice GUI\n 3 classes'.selectElement({dc::DCWorksheet|projectmodel::PJPackage|sysml::SysMLElement},null)}

PS: Can you confirm that we currently have no select/list dialog outside of
mediniObject such as mission profile,
failure catalog and other objects. Can you perhaps indicate which ui class is
used to display non element objects? Something that can eventually handle
EObject.

Happy reporting!

Marian

medini_1024169437

Hi Marian,

good to hear about your progress, got the point with m2doc need. Some remarks:

Metamodel.Any does not work? Strange, I need to test myself as it was the intention to exactly achieve that, at least for the finder
There is no other *structured* selection dialog at the moment for non EMF objects. You may use selectOptions from ui.js if #elements is <5 I would say
Apart from that, I think mission profiles and failure catalogs are indeed EMF objects...

Happy Scripting

Jan

medini_1063548292

Hi Jan,

Yes the Metamodel.any is not accepted because it is actually resolved to ecore::EObject. And as I learned when I supplied in m2doc ecore::EObject it also does not show anything for selection

JS: element = selectElement("Select a requirement to open", Metamodel.Any,true);

M2DOC: m: 'Please choose something from this nice GUI\n
ecore::EObject class '.selectElement(ecore::EObject,null)

With regards to Mission profiles.

I have feeling that actually the "Select Mission profile" is using the same dialog and maybe extended its class. But there has to be some trick how to convince setTreeContentProvider
method to fetch all the underlying elements of EMF object ( Mission
profile in this case). I think that there might already be some extended
class available in the some.ui related package for that one.

I alos tried navigate to the PJPackage with mission profiles. This package is for some reason hidden to the user in the model browser. So In order to fetch the object i simply used

m2doc
m:projectmodel::PJPackage.allInstances()->select(e|e.name= 'MissionProfiles')

JS
var missions=finder.findByType(Metamodel.projectmodel.PJPackage,true).and("name","MissionProfiles").toList();

I may need to use it as a "root" for dialog to display mission profiles.

Happy reporting,

Marian

medini_1063548292

Hi Jan,

so I think I found the trick!

It required a
little bit of brain cells but In the need
was even able to do it without touching the ui.js library;

So the trick was to
provide objects as a “root” argument of
selectElement dialog

So example with
Mission profiles. Failure Rate catalogs and other that are usually contained in
a PJProxyModel but one can also use
finder to directly find specific metaclass using Metamodel.[package].[class]

Example with
PJPackage ‘MIssionProfiles’ and ESL project as a scope for finder

var missions=finder.findByType(Metamodel.projectmodel.PJPackage,true).and("name","MissionProfiles").toList();
// following Metaclasses can be used to make the MP objects visible :
// Metamodel.safetyModel.IMissionProfile
//Metamodel.failureratecatalogs.MissionProfile
//[] -> any EMF object
// The package MissionProfiles ( in every project ) has to be provided as a "root"
element = selectElement("Select any MProfile form MissionProfiles package", Metamodel.failureratecatalogs.MissionProfile, true,missions.get(0),"PJPackage 'MissionProfiles' as a root");
// now les see what EMF is inside of mission profile 



if(element) {
//expected a Mprofile
 	mp = element[0];
//any EMF inside of MissionProfile
 	element = selectElement("Select any Mprofile internal EMF objects",[], true,mp,"any EMF objects InternalWorkingCycles/workingPhases with Mission Profile object as a root");
 	//set MP.internalWorkingCycles as a root
 	element = selectElement("Select any Mprofile internal Working cycles",[], true,mp.internalWorkingCycles,"Mission Profile.InternalWorkingCycles with Mission Profile object as a root");
 	}

Alternative
is to directly find all
MissionProfiles through finder
using corresponding metaclass ->
effective && faster

var objects = finder.findByType(Metamodel.failureratecatalogs.MissionProfile,true).toList();
element = selectElement("Select any Mprofile internal EMF objects",[], true,objects,Mission Profles in current project");

Example how to
collect all PJElement, resolved eventual proxies and use selection dialog on
the result collection, select mission profile and navigate further

// collect all PJElements, and navigate to underlying proxies:
var pjelements = finder.findByType(Metamodel.projectmodel.PJElement,false).toList();
objects=pjelements.clone();
//empty list using setSize(0)
objects.setSize(0);
pjelements.toArray().forEach(function (proxy) {
if (proxy.originalModel) // PJProxyModel -> .originalModel 
{ objects.add(proxy.originalModel);} 
else if (proxy.diagram) //PJDiagram -> .diagram
 { objects.add(proxy.diagram);} 
else { objects.add(proxy)}
});
//Step 1 prompt all PJelements
element = selectElement("Select any internal EMF objects",[], true,objects,"All resolved PJelement objects"); 
//step 2 filter on mission profiles
element = selectElement("Select internal Mission Profile objects",Metamodel.failureratecatalogs.MissionProfile, true, objects,"In PJelement objects"); 
//step3 focus of detials for given mission profile
if (element && element.length && element.length>0){
	element = selectElement("Select any Mprofile internal EMF objects",[], true,element[0]," any EMF objects InternalWorkingCycles/workingPhases with Mission Profile '"+(element[0].name||"")+"' as a root "); 

}

I have still difficulty with Metamodel.Any supplied to finder.findByType(Metamodel.Any) . I cannot make it work I always get zero objects. Any idea what i am missing here ? Is there any specific *.js library that need be loaded to recognize the MetamodelAny ?

Happy reporting,

Marian

medini_1024169437

Hi Marian,

I was OOO for some time so sorry for the slow response. Seems you made quite some progress, that's awesome! Thanks for posting here. For the last problem, I can confirm that Metamodel.Any aka EObject the dialog doe snot let you select anything. I as an experiment introduced also Metamodel.AnyMedini (pointing to Kernel.MediniObject) and it worked. So we will extend Metamodel in the future by the Kernel package.

I searched further for an intermediate solution and found a rather hacky one.Idea is to navigate the metamodel upwards to MediniObject. I selected a rather "unimportant" class with as minimal super classes as possible and tried to walk up to MediniObject. I came up with this code which fortunately works:

load("ui.js");

var MediniObject = Metamodel.safetyModel.Dependable.eAllSuperTypes[1];
alert(MediniObject);
var element = selectElement("Select any", MediniObject, true);
console.log("Selection: {0}", element);

I hope this is sufficient as intermediate solution.

Jan

medini_1063548292

Hi Jan,

No worries
good to have you back

I actually also
tried to a little hack. trying to use bind instantiating directly MediniObject
meta-model package but without a success. Then I searched a forum a bit a found
this particular *.js proposed by some person with same initials as you .
Luckily there was also a suggested solution usable for this case.

https://medini.freshdesk.com/support/discussions/topics/1000101871

var EcorePackage = bind("org.eclipse.emf.ecore", "org.eclipse.emf.ecore.EcorePackage", false);
....

element = selectElement("Select any EMF object in current project", EcorePackage.Literals.EMODEL_ELEMENT, true,objects,"Any object");

Marian

medini_1024169437

Hi Marian,

so you say that EModelElement works while EObject does not, right?

Will check the other thread later.

Jan

medini_1063548292

Hi Jan,

yes indeed. I can confirm and it also works for finder :

var fidnerResults=finder.findByType(EcorePackage.Literals.EMODEL_ELEMENT,false).toList();

Marian

medini_1024169437

Nice! So we will add Kernel but also ECore package to Metamodels to simplify scripting this with 2024 R1

Regards

Jan

medini_1024169437

Just to conclude here:

We added Ecore and Kernel to Metamodel in 2024 R1 so scripting and writing M2doc services using scripts should be easier
We added an improved own prompt service to m2doc in upcoming 2024 R2, the prompt<Native> should work as the one offered by m2doc before, the prompEObject is using our own well known element selection dialog, so you dont see these resources etc.
However, it just offers EObject promptEObject(String message, EClass acceptedEClass) as the original, no support for multi selection or even details as our selectElement in ui.js

Marian, maybe you can help to define a prompt service method which is as generic as our ui.js script? We want to improve for next release and offer more prompt support

Jan

medini_1063548292

Thanks Jan!

I will definitely like to help with the definition of prompt service. I already have a pool (not a swimming pool) of ideas so I will go ahead create a freshDesk ticket to exchange ideas. Once we will converge we can post the conclusion in here.

Happy reporting,

Marian

medini_1024169437

Perfect, lets do it like that.

Jan