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

HAZOP/Guideord access from Java Script

medini_1051049827

I would like to create a HAZOP or Guide Wor Analysis and fill the entries in the HAZOP with existing model elements based on an imported excel sheet.

This access currently does not seem to be available.

Will this be added to the factory in the future?

Thanks Nils

Find more posts tagged with

medini

medini legacy

Accepted answers

All comments

medini_1024169437

Hi Nils,

I have added an updated version of the factory and the tester for the factory to this article. It offers support to create (1) new HAZOP/Guideword models, (2) new Guideword columns and (3) new entries (rows). It is not yet ready to link causes or effects to the cells. Once that is available, I will post an update. Once you confirm that all is in good shape, we can upload the latest version to the right place for the community.

Note that the lib should work for 19.x as well as 20.x. In 20.x the Guideword needs a mandatory content type, please check the sample code.

Happy Scripting

Jan

medini_1051049827

Hello Jan,

thank you for the reply.

I am able to even add the function on the element property by setting the 'element' property with the function handle.

Creating the malfunction entry seem more difficult. As is seems, the malfunction is held in the guidewordToFailures Property of the HazopEntry, which links the guideword element with the malfunction. So for each malfunction entry in any columns of the table there is one guideworsToFailures element with the keyword as the 'key' property and the malfunction as the 'value' property.

I am just struggling to fill this information.

Regards Nils

medini_1024169437

Hi Nils,

great, so the initial stuff is working. You cannot do the other stuff without a little help from the factory.js.

Please stay tuned, I will try to followup asap with some enhancements.

Jan

medini_1024169437

Nils,

I was meanwhile able to accomplish the other part. It does not fit very well the current Factory API, where we distinguish between creating an Element (createElement) and a Relation (createRelation). MY current solution would introduce a third method "createEntry" and that would be used like this:

/**
 * Introduced to create entries in Maps.
 * 
 * @param {Map}
 * map a map (key maps to multiple values
 * @param {Object}
 * key the key
 * @param {Object}
 * element an element
 */
Factory.createEntry = function(map, key, value);

So to add a failure to a certain guideword column, you would need to do:

Factory.createEntry(hazopEntry.guidewordToFailures, guideword, failure);

Some thoughts about it:

Its not symetric because adding ANOTHER failure to the SAME guideword column would mean to call this method again
Its generic, you need to know that you have to pass "hazopEntry.guidewordToFailures", maybe not convenient
Maybe better use Factory.createRelation, because its more similar to a relation but the API is not ready for that ... it expects a type argument

So some cons here. Maybe you have an idea?

Another option would be to completely separate the HAZOP entry stuff from the factory.

Any thoughts welcome.

Jan

medini_1051049827

Hi Jan,

This sounds good.

I would be ok with the solution in the factory. The factory also provides Factory.createRelation which only builds relation as the what the malfunction/guideword/hazopEntry is. Hence the Factory is a good place. Nevertheless Factory.createRelation maybe better as we do not create a metamodel element but just build very specific relation.

Having to recall the methos every time I think is fine, as this would make the scripting easier. In this case the mailfunctions do not need to be sorted for guidewords, but can be just 'dumped' with thei keyword to the hazopEntry.

Cheers Nils

medini_1024169437

Thanks Nils,

well, I also had the idea to use "Factory.createRelation" first but hesitated because so far it expects 3 arguments, source, target and type. The first two would be similar (guideword == source, target == failure) but the third would be either *really* the type (which is a strange looking one: BasicEMap.Entry) or ... it would be the real map that I need (hazopEntry.guidewordToFailures) which is not really a type and would "break" the API contract.

What do you think?

Jan

medini_1051049827

Hi Jan,

this is difficult. I am not expert enough to judge.

The second option above bears the same problem as factory.createEntry while also being incorrect in the factory.createRelation context. The first option is not intuitive. Hence we may come back to Factory.createEntry(hazopEntry.guidewordToFailures, guideword, failure).

Another option could be a new factory function factory.createGuidewordToFailures.

Re Nils

medini_1024169437

Hm, so many options :-)

medini_1024169437

Hi Nils,

I decided to go for a almost generic name "createMapEntry". You can find the new files attached here or at the usual location.

Have fun

Jan

medini_1024169437

One final note on this: at the moment its is essential to put the $ENHANCED_JAVA_ACCESS$ pragma to the first line of your script, similar to the test script or you will face very strange errors.

Reason is that by default scripts are not allowed to change the containment of objects. That is prevented by wrapping any object collection by a unmodifiable collection which is also done by the map. The function createMapEntry doe snot like that very much. See this article for more information of pragma directives.

Jan

medini_1024169437

Nils,

I improved the factory.js a bit so that the problem is better described in the error message.

In addition I improved the factory to avoid that traces can be created multiple times, see the tester as usual for details

Happy Scripting

Jan

medini_1040753747

Jan,

Not sure what I am doing wrong... I am able to create the Guideword analysis and populate the function and guidewords. But when trying to map the malfunctions or failures, I seem to get the medini object text (instead of the actual failure object) and both failures appear under each guideword instead of 1 each.

Factory.createMapEntry(haze1.guidewordToFailures, gw1, hazFailure1);
Factory.createMapEntry(haze1.guidewordToFailures, gw2, hazFailure2);

I have the pragma included and the latest factory.js... any suggestions?

medini_1024169437

Hi Johan,

that indeed looks weird, need to check myself.

Stay tuned.

Which version are you using?

Jan

medini_1040753747

I have factory.js v2020-08-14

medini analyze 2020 R1.1

medini_1024169437

Strange, I tested my version v2020-09-21 (a bit newer, but no related change) with 2020 R1.1 and did not see any issue. I attached the version + my testing script again for reference. Maybe you can check.

Happy Scripting

Jan

medini_1040753747

Sorry, still same result. Everything works fine except the createMapEntry() part:

medini_1024169437

Hi Johan, I think I could reproduce now: the situation happens if you guideword "content type" does not match your content. Please check the "Test Factory.js", there you see something like:

gw2.contentType = Metamodel.safetyModel.Failure;

That means, only Failures should be entered in the guideword column later. The same happens if you do not have this setting yet.

Happy Scripting

Jan

medini_1040753747

Thank you! That was it :-)