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

Script to save a UML design diagram as image and import in Medini project as external document

medini_1056077241

Hello,

is it possible to write a script that is launched from a defined Medini UML architecture model and save all the contained diagrams as external document?

For example refer to the attached screen, is it possible to launch a script that creates the diagram image "FSC for ESL.png" and import it as external document in the same package?

Thanks

Samuele

Find more posts tagged with

medini

medini legacy

Accepted answers

medini_1056077241

Hi Jan,

i confirm that there is not an "updateDocument" in the API, only "importDocument".

i solved the problem by creating a custom function that search if the document is already included, if yes the script firct delete the file directly the file on the medini workkspace/project name/docs folder, than export a new diagram with the same name in the same location, using the

java.io.File api.

Now it's working, thanks for the help!

Samuele

Here's code:

// $EXPERIMENTAL$ $STRICT_MODE$ $WARNING_AS_ERROR$ $ENHANCED_JAVA_ACCESS$
/* 
 * Script to export all the diagrams included in the project with "Design" or "design" in the name and import them as external document in Medini, in default folder "External Documents" or in a folder selected by user
 * If the Diagram is not already included in the folder the diagram is exported in temp folder and imported as new
 * If the diagram is already included, the external document file is overwritten with the new export
 * it requires ui.js, factorEx.js and diagram_fixed.js. diagram_fixed.jas is the standard diagram.js with commented line /context.getReportContext().setOption("largeDiagramsOption", LargeDiagramOptions.CONTINUE); to avoid execution run time erorr
 * Instructions: launch it anywhere in a medini project and follow instructions.
 * V1.0 20210806 Samuelma :first release
 */


load(".lib/diagram_fixed.js");
load(".lib/ui.js");
load(".lib/factoryEx.js");


function CheckIfDiagramAlreadyInDocFolder(DiagramName) {

// function to search in project Medini Docs folder if the diagram DiagramName is already existing.
//note this search only in subfolders of Medini Docs folder, for example \docs\__MUz4PX_EeuW84qaQa861g
// it returns a string URL of the file is founded or "not_found" otherwise
var DesignAlreadyIncludedAbsPath ="not_found";
 //get docs folder path
 var projectPath = __filedir;
 var MediniDocsFolder = projectPath.substring(0, projectPath.length -15) + "\\docs\\";
 //console.log(" project path: ''{0}''",DocsPath); 
var ExternalDocsFolder = new java.io.File(MediniDocsFolder);
				//get subfolder list
				var subfolder_list=ExternalDocsFolder.list();
				for (var i = 0; i < subfolder_list.length; i++) {
				//console.log(" lista ''{0}'' as",subfolder_list[i]);
				var InnerFolderToSearchPath= MediniDocsFolder + "\\" + subfolder_list[i];
				//console.log(" percorso lista sotto cartelle''{0}'' as",InnerFolderToSearchPath);
				var InnerFolderToSearch= new java.io.File(InnerFolderToSearchPath);
				if (InnerFolderToSearch.isDirectory()) {
					var inner_folder_document_list = InnerFolderToSearch.listFiles();
					for (var j = 0; j < inner_folder_document_list.length; j++) {
						//console.log(" lista sotto cartelle''{0}'' as",inner_folder_document_list[j]);
						if (inner_folder_document_list[j].getAbsolutePath().indexOf(DiagramName)!=-1){
							//console.log(" diagramm''{0}'' non presente",inner_folder_document_list[j]);
							DesignAlreadyIncludedAbsPath=inner_folder_document_list[j].getAbsolutePath();
						} else {
							//console.log(" diagramm''{0}'' presente",inner_folder_document_list[j]);
						}
					}

				}
				}			
				return DesignAlreadyIncludedAbsPath;
}

function main() {
	//declare variables
	var diagram;
	var imageFolder;
	var imageFormat;
	var renderedTo;
	var fileUrl;
	var path;
	var start;
	var nameToBeRepaced;
	var newName;
	var newNameFile;




	// Search if a "External Documents" folder is already existing in the Medini project, otherwise request user to input the folder in which import the images
	var documents = finder.findByType(Metamodel.projectmodel.PJPackage).find("name", "External Documents").first();
	if (!documents) {
			//request user to select a folder in Medini project in which add the documents
			documents = selectElement("Select Package destination to import the diagrams image", Metamodel.projectmodel.PJPackage, false);
				if (!documents) {
			console.log("Canceled by user");
		//return;
				}
	}

	//find and cycles on all diagrams in the project where the script is launched
	var result = finder.findByType(Metamodel.projectmodel.PJDiagram).asArray();
	for (var i = 0; i < result.length; i++) {
			diagram = result[i];
			console.log("Diagram {0} is {1}", i, diagram.name);
			//select only the diagrams that contains "Design" or "design" string
			if (diagram.name.indexOf("Design")!=-1 || diagram.name.indexOf("design")!=-1){
				//check if diagram already exists in doc folder
				var CheckResultURL=CheckIfDiagramAlreadyInDocFolder(diagram.name);
				var diagramProxy = diagram;
				if (CheckResultURL=="not_found"){
					//export diagram to temp folder and import it in medini using the importDocument function
					imageFolder = new java.io.File("C:\\temp");
					imageFormat = "PNG";
					//Export diagram to png
					renderedTo = renderDiagram(diagramProxy, imageFolder, imageFormat);
					console.log("Diagram ''{0}'' ws rendered to {1}", diagramProxy.name, renderedTo);
					//renderedTo.name=part.name;
					fileUrl= java.io.File(renderedTo);

					//rename file according to diagram name
					path = fileUrl.getAbsolutePath();
					start = path.lastIndexOf("\\")+1;
					nameToBeRepaced = path.substring(start, path.length());
					newName = path.replaceAll(nameToBeRepaced, diagram.name + ".png");
					newNameFile = new java.io.File(newName);
					fileUrl.renameTo(newNameFile);

					// now insert the exported diagram in Medini folder using the importDocument, from diagram.js library
					var document = importDocument(documents, newNameFile);
					console.log("document ''{0}'' added to Medini folder", document);
					//document.name = diagram.name;

					// and open it
					//openEditor(document, 500);

					//deletes the file in temp folder after Medini is closed
					newNameFile.deleteOnExit();
				} else {
					//delete already existing file and export image directly to the same location
					var AlreadyExistingFile = new java.io.File(CheckResultURL);
					AlreadyExistingFile.delete();
					//export diagram directly to the deleted file loaction, to overwrite
					imageFolder = new java.io.File(AlreadyExistingFile.getParent());
					imageFormat = "PNG";

					//Export diagram to png
					renderedTo = renderDiagram(diagramProxy, imageFolder, imageFormat);
					console.log("Diagram ''{0}'' ws rendered to {1}", diagramProxy.name, renderedTo);
					//renderedTo.name=part.name;
					fileUrl= java.io.File(renderedTo);

					//rename file according to diagram name
					path = fileUrl.getAbsolutePath();
					start = path.lastIndexOf("\\")+1;
					nameToBeRepaced = path.substring(start, path.length());
					newName = path.replaceAll(nameToBeRepaced, diagram.name + ".png");
					newNameFile = new java.io.File(newName);
					fileUrl.renameTo(newNameFile);
				}
		}
	}
}

main();

All comments

medini_1024169437

Hi Samuele,

with scripting it would be at least possible to export any diagram as external image (PNG but also SVG!).
What you do with that after export is up to the script. You coudl for example generate also DITA/DocBook XML and out of that generate a report.

Jan

medini_1056077241

Hi Jan,

thanks for the reply.

Is there any example or sample code on how is possible to export any diagram as external image?

I've checked in the Medini help and the forum but i've not found anything.

Another method that i'd like to use from the script is the "add external document" function.

My idea is to export all the diagrams as .png in a TEMP folder, than launch the method to add all the images in that folder as external documents inside Medini.

Thanks

Samuele

medini_1024169437

Also possible, just need to dig out both scripts/libs, stay tuned.

Jan

medini_1024169437

Samuele,

I found what I have for the external document. There is an additional library you need to load, I have attached it (factoryEx.js). Code is simply but the API needs java.io.File object. See this sample code we once scripted:

	var sel = selection ? selection[0] : undefined;

 if (sel instanceof Metamodel.projectmodel.PJScope) {
 var fileName = inputText("Name", "Please enter a name for the TracWiki Document!", "Document");
 if (fileName == null) {
 return;
 }

 // prepare temporary file
 var file = java.io.File.createTempFile(fileName, ".tracwiki");
 var path = file.getAbsolutePath();
 var start = path.lastIndexOf("\\")+1;
 var nameToBeRepaced = path.substring(start, path.length());
 var newName = path.replaceAll(nameToBeRepaced, fileName + ".tracwiki");
 var wikiFile = new java.io.File(newName);
 file.renameTo(wikiFile);

 // now insert a new document
 var document = importDocument(sel, wikiFile);
 document.name = fileName;
 file.deleteOnExit();
 wikiFile.deleteOnExit();

 // and open it
 openEditor(document, 500);
 }

Its not nice but the pure import part is simple.

Jan

medini_1024169437

To render diagrams into image files you need the latest diagram.js which I have attached.

Sample script could look like:

load(".lib/diagram.js");

function main() {
	if (!selection || !selection.length) {
		throw "Please select a diagram";
	}

	var diagramProxy = selection[0];
	// var diagram = diagramProxy.diagram;
	var imageFolder = new java.io.File("C:\\temp");
	var imageFormat = "PNG";
	var renderedTo = renderDiagram(diagramProxy, imageFolder, imageFormat);

	console.log("Diagram ''{0}'' ws rendered to {1}", diagramProxy.name, renderedTo);
}

main();

You may use "SVG" instead of "PNG". I think the returned value is a String not a java.io.File.

Jan

medini_1056077241

Hi Jan, thanks for the replay.

I've copied the diagram.js file in script/lib folder, and created a simple script with the code provided in your second answer:

load(".lib/diagram.js");

function main() {
	if (!selection || !selection.length) {
		throw "Please select a diagram";
	}

	var diagramProxy = selection[0];
	// var diagram = diagramProxy.diagram;
	var imageFolder = new java.io.File("C:\\temp");
	var imageFormat = "PNG";
	var renderedTo = renderDiagram(diagramProxy, imageFolder, imageFormat);

	console.log("Diagram ''{0}'' ws rendered to {1}", diagramProxy.name, renderedTo);
}

main();

The system tell me "Failed to execute Java Script: ReferenceError: "bind" is not defined. (C:\Users\samuelma\Documents\Analyze Workspace 2021 R1\ESL\config\scripts\.lib\diagram.js#244)
ReferenceError: "bind" is not defined. (C:\Users\samuelma\Documents\Analyze Workspace 2021 R1\ESL\config\scripts\.lib\diagram.js#244)"

I think some library that includes the bind function definition is not defined.

I've also seen that diagram.js#244 has this code:

if (!bind) {
	 throw "This script requires extended API";
	}

any help on how to obtain extended API?

thanks

Samuele

medini_1024169437

I forgot: the script that loads the library must have at at least the EXPERIMENTAL pragma, so put this in the first line:

// $EXPERIMENTAL$

Jan

medini_1056077241

Hi Jan,

thanks for the reply, adding // $EXPERIMENTAL$ on top of the script and commenting the 259 line of diagram.js:

	//context.getReportContext().setOption("largeDiagramsOption", LargeDiagramOptions.CONTINUE);

i was able to use script number 2 and export to diagram.

I've an issue with script number 1, to import an external image as an external document in medini folder.

I don't get the point:

"API needs java.io.File object"

how can i add the java.io.File library into the script?

if try to execute it as is i get an error, see attached screenshot.

Thanks

Samuele

medini_1024169437

Samuele,

thats simply because I ripped the code form a fucntion and there I had a return statement but that not allowed on root scope.

So please replace the "return;" by something like "throw 'canceled by user'"

Happy Scripting

Jan

medini_1056077241

HI Jan,

i've modified the script using your suggestion and i think i'm at a good point.

With the current script i'm able to export all diagrams that matches one or more string keywords to C:/temp folder as .png files, and import them in an "External Document" Medini package if exist or otherwise in a package selected by the user.

I've only one problem left, if the diagram is already existing in the "External document" medini package it is not overwritten because each time a new external document is imported it is saved to a unique path that is generated with random numbers, like "_-xHl8PX8EeuEPYl1XvRZbQ".

Any suggestion?

is it possible to search/copy/paste files from medini script in Medini project_folder/docs folder with some java APIs?

I share the script for others if it helps:

// $EXPERIMENTAL$ $STRICT_MODE$ $WARNING_AS_ERROR$ $ENHANCED_JAVA_ACCESS$
load(".lib/diagram_fixed.js");
load(".lib/ui.js");
load(".lib/factoryEx.js");

function main() {
	// Search if a "External Documents" folder is already existing in the Medini project, otherwise request user to input the folder in which import the images
	var documents = finder.findByType(Metamodel.projectmodel.PJPackage).find("name", "External Documents").first();
	if (!documents) {
			//request user to select a folder in Medini project in which add the documents
			documents = selectElement("Select Documents Folder", Metamodel.projectmodel.PJPackage, false);
				if (!documents) {
			console.log("Canceled by user");
		//return;
				}
	}

	//find and cycles on all diagrams in the project where the script is launched
	var result = finder.findByType(Metamodel.projectmodel.PJDiagram).asArray();
	for (var i = 0; i < result.length; i++) {
			var diagram = result[i];
			console.log("Diagram {0} is {1}", i, diagram.name);

			//select only the diagrams that contains "Design" or "design" string
			if (diagram.name.indexOf("Design")!=-1 || diagram.name.indexOf("design")!=-1){
				var diagramProxy = diagram;
				var imageFolder = new java.io.File("C:\\temp");
				var imageFormat = "PNG";

				//Export diagram to png
				var renderedTo = renderDiagram(diagramProxy, imageFolder, imageFormat);
				console.log("Diagram ''{0}'' ws rendered to {1}", diagramProxy.name, renderedTo);
				//renderedTo.name=part.name;
				var fileUrl= java.io.File(renderedTo);

				//rename file according to diagram name
				var path = fileUrl.getAbsolutePath();
	 var start = path.lastIndexOf("\\")+1;
	 var nameToBeRepaced = path.substring(start, path.length());
	 var newName = path.replaceAll(nameToBeRepaced, diagram.name + ".png");
	 var newNameFile = new java.io.File(newName);
				fileUrl.renameTo(newNameFile);
					 // now insert the exported diagram in Medini folder using the importDocument, from diagram.js library
	 var document = importDocument(documents, newNameFile);
	 console.log("document ''{0}'' added to Medini folder", document);
				//document.name = diagram.name;

	 // and open it
	 //openEditor(document, 500);

				//deletes the file in temp folder after Medini is closed
	 newNameFile.deleteOnExit(); 
		}
	}
}

main();

Thanks

Samuele

medini_1024169437

I could think of two different solutions:

lightweight: give the document the name of teh diagram (as you did in line 46) and search for it before you create/import a new one, and just *update* the document, do not import it again
heavy: same as above but create a Trace relation between the diagram and the document so you can see whether there is one (maybe better if multiple diagrams have the same name

While writing, I reocgnized that there is no "updateDocument" right now at the API, right?

Jan

medini_1056077241

Hi Jan,

i confirm that there is not an "updateDocument" in the API, only "importDocument".

java.io.File api.

Now it's working, thanks for the help!

Samuele

Here's code:

// $EXPERIMENTAL$ $STRICT_MODE$ $WARNING_AS_ERROR$ $ENHANCED_JAVA_ACCESS$
/* 
 * Script to export all the diagrams included in the project with "Design" or "design" in the name and import them as external document in Medini, in default folder "External Documents" or in a folder selected by user
 * If the Diagram is not already included in the folder the diagram is exported in temp folder and imported as new
 * If the diagram is already included, the external document file is overwritten with the new export
 * it requires ui.js, factorEx.js and diagram_fixed.js. diagram_fixed.jas is the standard diagram.js with commented line /context.getReportContext().setOption("largeDiagramsOption", LargeDiagramOptions.CONTINUE); to avoid execution run time erorr
 * Instructions: launch it anywhere in a medini project and follow instructions.
 * V1.0 20210806 Samuelma :first release
 */


load(".lib/diagram_fixed.js");
load(".lib/ui.js");
load(".lib/factoryEx.js");


function CheckIfDiagramAlreadyInDocFolder(DiagramName) {

// function to search in project Medini Docs folder if the diagram DiagramName is already existing.
//note this search only in subfolders of Medini Docs folder, for example \docs\__MUz4PX_EeuW84qaQa861g
// it returns a string URL of the file is founded or "not_found" otherwise
var DesignAlreadyIncludedAbsPath ="not_found";
 //get docs folder path
 var projectPath = __filedir;
 var MediniDocsFolder = projectPath.substring(0, projectPath.length -15) + "\\docs\\";
 //console.log(" project path: ''{0}''",DocsPath); 
var ExternalDocsFolder = new java.io.File(MediniDocsFolder);
				//get subfolder list
				var subfolder_list=ExternalDocsFolder.list();
				for (var i = 0; i < subfolder_list.length; i++) {
				//console.log(" lista ''{0}'' as",subfolder_list[i]);
				var InnerFolderToSearchPath= MediniDocsFolder + "\\" + subfolder_list[i];
				//console.log(" percorso lista sotto cartelle''{0}'' as",InnerFolderToSearchPath);
				var InnerFolderToSearch= new java.io.File(InnerFolderToSearchPath);
				if (InnerFolderToSearch.isDirectory()) {
					var inner_folder_document_list = InnerFolderToSearch.listFiles();
					for (var j = 0; j < inner_folder_document_list.length; j++) {
						//console.log(" lista sotto cartelle''{0}'' as",inner_folder_document_list[j]);
						if (inner_folder_document_list[j].getAbsolutePath().indexOf(DiagramName)!=-1){
							//console.log(" diagramm''{0}'' non presente",inner_folder_document_list[j]);
							DesignAlreadyIncludedAbsPath=inner_folder_document_list[j].getAbsolutePath();
						} else {
							//console.log(" diagramm''{0}'' presente",inner_folder_document_list[j]);
						}
					}

				}
				}			
				return DesignAlreadyIncludedAbsPath;
}

function main() {
	//declare variables
	var diagram;
	var imageFolder;
	var imageFormat;
	var renderedTo;
	var fileUrl;
	var path;
	var start;
	var nameToBeRepaced;
	var newName;
	var newNameFile;




	// Search if a "External Documents" folder is already existing in the Medini project, otherwise request user to input the folder in which import the images
	var documents = finder.findByType(Metamodel.projectmodel.PJPackage).find("name", "External Documents").first();
	if (!documents) {
			//request user to select a folder in Medini project in which add the documents
			documents = selectElement("Select Package destination to import the diagrams image", Metamodel.projectmodel.PJPackage, false);
				if (!documents) {
			console.log("Canceled by user");
		//return;
				}
	}

	//find and cycles on all diagrams in the project where the script is launched
	var result = finder.findByType(Metamodel.projectmodel.PJDiagram).asArray();
	for (var i = 0; i < result.length; i++) {
			diagram = result[i];
			console.log("Diagram {0} is {1}", i, diagram.name);
			//select only the diagrams that contains "Design" or "design" string
			if (diagram.name.indexOf("Design")!=-1 || diagram.name.indexOf("design")!=-1){
				//check if diagram already exists in doc folder
				var CheckResultURL=CheckIfDiagramAlreadyInDocFolder(diagram.name);
				var diagramProxy = diagram;
				if (CheckResultURL=="not_found"){
					//export diagram to temp folder and import it in medini using the importDocument function
					imageFolder = new java.io.File("C:\\temp");
					imageFormat = "PNG";
					//Export diagram to png
					renderedTo = renderDiagram(diagramProxy, imageFolder, imageFormat);
					console.log("Diagram ''{0}'' ws rendered to {1}", diagramProxy.name, renderedTo);
					//renderedTo.name=part.name;
					fileUrl= java.io.File(renderedTo);

					//rename file according to diagram name
					path = fileUrl.getAbsolutePath();
					start = path.lastIndexOf("\\")+1;
					nameToBeRepaced = path.substring(start, path.length());
					newName = path.replaceAll(nameToBeRepaced, diagram.name + ".png");
					newNameFile = new java.io.File(newName);
					fileUrl.renameTo(newNameFile);

					// now insert the exported diagram in Medini folder using the importDocument, from diagram.js library
					var document = importDocument(documents, newNameFile);
					console.log("document ''{0}'' added to Medini folder", document);
					//document.name = diagram.name;

					// and open it
					//openEditor(document, 500);

					//deletes the file in temp folder after Medini is closed
					newNameFile.deleteOnExit();
				} else {
					//delete already existing file and export image directly to the same location
					var AlreadyExistingFile = new java.io.File(CheckResultURL);
					AlreadyExistingFile.delete();
					//export diagram directly to the deleted file loaction, to overwrite
					imageFolder = new java.io.File(AlreadyExistingFile.getParent());
					imageFormat = "PNG";

					//Export diagram to png
					renderedTo = renderDiagram(diagramProxy, imageFolder, imageFormat);
					console.log("Diagram ''{0}'' ws rendered to {1}", diagramProxy.name, renderedTo);
					//renderedTo.name=part.name;
					fileUrl= java.io.File(renderedTo);

					//rename file according to diagram name
					path = fileUrl.getAbsolutePath();
					start = path.lastIndexOf("\\")+1;
					nameToBeRepaced = path.substring(start, path.length());
					newName = path.replaceAll(nameToBeRepaced, diagram.name + ".png");
					newNameFile = new java.io.File(newName);
					fileUrl.renameTo(newNameFile);
				}
		}
	}
}

main();

medini_1024169437

Nice solution, Samuele, and thanks for posting the script.

The only point I see is that undo/redo behavior would not work properly, maybe not an issue for you anyway.

We will try to offer the update feature as well in the API.

Jan