JArchi Scripting: Import From CSV

Update: 08/06/2022

I’ve updated the script as hosted on GitHub Gists to now support Specializations, as well as introduce the funcationality to create a new view including the new/matched Elements from the import.

A couple of weeks back, I posted my jArchi script for exporting a view from Archi into CSV format to load into your spreadsheet application of choice. This week, I’ll go through the other side of the equation, once you’ve dumped your view to Excel, made your changes, how you can go about getting those amendments back into Archi.

Quick warning, this shouldn’t hose your model, but please backup your model first, just in case!

Here is the Import from CSV jArchi script from GitHub Gists.

This script requires PapaParse. Download the papaparse package, and extract the papaparse.min.js script into a “lib” folder in the same location as the Import from CSV.ajs script in your jArchi script folder.

This script will:

  • Prompt for a CSV file (in the format generated by the Export to CSV script)
  • Load the CSV and parse using PapaParse
  • For each row in the CSV
    • Attempt to match the Archi Concept in the row using the UID in the CSV.
    • If there is no UID, attempt to match the Archi Concept using the Object Name
    • If there are no matches, or more that one match was found, create a new Archi Concept using the common properties, Name, Documentation and Type, else update the matched concept with the matched details.
    • Loop through all other columns in the CSV.
      • If the row has a value in this column, update the property on the Archi Concept with the value.
      • If the row doesn’t have a value in the column, remove the property from the Archi Concept
* Import from CSV
* Requires jArchi – https://www.archimatetool.com/blog/2018/07/02/jarchi/
* Requires PapaParse – https://www.papaparse.com/
* Works with Export to CSV Script – https://gist.github.com/smileham/15c445b17a92bd6f5dc1508e573bcd8a
* Version 1: Import from CSV
* Version 1.1: Force character encoding to use UTF-8
* Version 2: Support for Specialization and creates "CSVImport-timestamp" view
* Version 2.1: Added formatting for CSVImport view, including groups to highlight match/new components.
* (c) 2018 Steven Mileham
var debug = true;
console.log("> Import CSV");
load(__DIR__ + "lib/papaparse.min.js");
console.log("> Loaded Papa Parse");
var filePath = window.promptOpenFile({ title: "Open CSV", filterExtensions: ["*.CSV"], fileName: "default.csv" });
if (filePath) {
var FileReader = Java.type("java.io.FileReader");
var Types = Java.type("java.nio.charset.StandardCharsets");
var theCSVFile = new FileReader(filePath,Types.UTF_8);
var theCSV ="";
var data = theCSVFile.read();
console.log("> Please Wait…");
while(data != -1) {
var theCharacter = String.fromCharCode(data);
data = theCSVFile.read();
console.log("> File Loaded");
theDataFile = Papa.parse(theCSV);
theData = theDataFile.data;
theDataHeaders = theData[0];
var newGroupStart = 48;
var nameGroupStart = 180;
var uidGroupStart = 312;
var maxPerRow = 10;
var newGroupCount=0;
var nameGroupCount=0;
var uidGroupCount=0;
var newGroupRow=1;
var nameGroupRow=1;
var uidGroupRow=1;
var theDate = new Date();
var theView = model.createArchimateView("CSVImport-"+theDate.toString());
var templateObject = theView.createObject("note", 0, 0, -1, -1);
var templateHeight = templateObject.bounds.height;
var templateWidth = templateObject.bounds.width
var titleNote = theView.createObject("note", 12, 12, maxPerRow*templateWidth, 24);
titleNote.text = "Import from:"+filePath+" on "+theDate.toString();
var newGroup = theView.createObject("diagram-model-group", 12, newGroupStart, maxPerRow*templateWidth, templateWidth);
newGroup.name = "New Elements";
var nameGroup = theView.createObject("diagram-model-group", 12, nameGroupStart, maxPerRow*templateWidth, templateWidth);
nameGroup.name = "Matched by Name";
var uidGroup = theView.createObject("diagram-model-group", 12, uidGroupStart, maxPerRow*templateWidth, templateWidth);
uidGroup.name = "Matched by UID";
var commonProperties = ["UID","Name", "Documentation","Type","Specialization"];
for (var i=1; i<theData.length; i++) {
var matchType = 3;
var theConcept = null;
var theObject = [];
for (var j=0; j<theDataHeaders.length; j++) {
theConcept = $("#"+theObject.UID).first();
if (!theConcept) {
debug? console.log("> Missing UID, checking Name"):true;
theConcept = $("."+theObject.Name).first();
if (!theConcept || theConcept.length>1) {
debug? console.log("> Creating Concept"):true;
theConcept = model.createElement(theObject.Type,theObject.Name);
debug? console.log(theConcept):true;
if (theObject.Specialization!="")
theSpecializations = model.specializations;
for (var j=0; j<theSpecializations.length; j++) {
debug? console.log("> Checking Spec " + theSpecializations[j]):true;
if (theSpecializations[j].name==theObject.Specialization && theSpecializations[j].type == theObject.Type)
debug? console.log("> Setting Spec " + theConcept.specialization):true;
if (theConcept.specialization==null)
debug? console.log("> Creating Spec " + theObject.Specialization):true;
model.createSpecialization(theObject.Specialization, theObject.Type);
for (var j=0; j<theDataHeaders.length; j++) {
switch (theDataHeaders[j]) {
case "UID":
case "Name":
case "Documentation":
case "Type":
case "Specialization":
if (theObject[theDataHeaders[j]]) {
else {
newGroup.bounds = {x:newGroup.bounds.x, y:newGroup.bounds.y, width:maxPerRow*templateWidth,height:(templateHeight+12)*newGroupRow+24};
nameGroup.bounds = {x:nameGroup.bounds.x, y:newGroup.bounds.y+newGroup.bounds.height+12, width:maxPerRow*templateWidth,height:(templateHeight+12)*nameGroupRow+24};
uidGroup.bounds = {x:uidGroup.bounds.x, y:nameGroup.bounds.y+nameGroup.bounds.height+12, width:maxPerRow*templateWidth,height:(templateHeight+12)*uidGroupRow+24};
switch (matchType) {
case 3:
if (uidGroupCount>=maxPerRow)
theGroupStart = uidGroup.bounds.y;
theGroupCount = uidGroupCount;
theGroupRow = uidGroupRow;
case 2:
debug? console.log("> Name Group Width " +nameGroup.bounds.width):true;
if (nameGroupCount>=maxPerRow)
theGroupStart = nameGroup.bounds.y;
theGroupCount = nameGroupCount;
theGroupRow = nameGroupRow;
debug? console.log("> NEW Name Group Width " +nameGroup.bounds.width):true;
case 1:
if (newGroupCount>=maxPerRow)
theGroupStart = newGroup.bounds.y;
theGroupCount = newGroupCount;
theGroupRow = newGroupRow;
var theViewObject = theView.add(theConcept, (theGroupCount*templateWidth)-(templateWidth-12)+(theGroupCount*12), theGroupStart+12+((theGroupRow-1)*templateHeight)+(theGroupRow*12), -1, -1, true);
console.log("> Parsing Complete")
else {
console.log("> Cancelled");

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out /  Change )

Twitter picture

You are commenting using your Twitter account. Log Out /  Change )

Facebook photo

You are commenting using your Facebook account. Log Out /  Change )

Connecting to %s

This site uses Akismet to reduce spam. Learn how your comment data is processed.