The Console, Dialogs and Other Utilities

Table of contents

• The Console
• Prompt, Alert and File Dialogs
• Including Other Script Files
• Other Features

---

The Console

The Console displays various messages and errors. Open the Console from the Scripts Manager sub-menu ("Show Console").

There are various options in the Console sub-menus:

• Clear Console
• Scroll Lock
• Word Wrap

The Console's font can be set in Preferences - > Scripting -> Console Font.

Output can be sent to jArchi's Console window using the following functions:

console.show();
console.hide();
console.setText("Clear previous text and display this text");
console.log("Hello World");
console.log(object);
console.log("One thing: ", object, another, ...);
console.error(error); // will show the console and display the error in red
console.clear();
console.setTextColor(redValue, greenValue, blueValue);
console.setDefaultTextColor();

Prompt, Alert and File Dialogs

Alert

window.alert("Hello World");

Confirm

var response = window.confirm("Are you sure?");

Prompt

var name = window.prompt("Please enter your name", "Default Name");

Prompt to open a file

var filePath = window.promptOpenFile({ title: "Open Model", filterExtensions: ["*.archimate", "default.archimate"] });

Prompt to open a directory

var dirPath = window.promptOpenDirectory({ title: "Open Folder", filterPath: "/defaultPath" });

Prompt to save a file

var filePath = window.promptSaveFile({ title: "Save Model", filterExtensions: [ "*.archimate", "*.xml" ] });

Prompt for a selection

(Since jArchi 1.4)

var selection = window.promptSelection("Choose selection", ["Option 1", "Option 2"] );

Including Other Script Files

You can include other Archi script or JavaScript files:

load(absolute_path)
load(url)

There is no support for relative locations, so the following format is used:

load(__DIR__ + "path/file.js")

__DIR__ contains the absolute path of the directory containing the current script.
__FILE__ contains the absolute path of current script.
__LINE__ contains the line number in which __LINE__ is used.
__SCRIPTS_DIR__ contains the absolute path of the user's scripts directory as set in preferences.

Other Features

$.fs.writeFile

Write data into a file.

$.fs.writeFile("path/to/some/file", text, "UTF8");    // Store content of 'text' into 'file' using the character encoding specified ('UTF8' in this example)

$.fs.writeFile("path/to/some/file", bytes, "BASE64"); // Store binary content (must be first base64 encoded) into file

$.process.argv (was getArgs())

If you are running a jArchi script from the Archi Command Line Interface (ACLI) you may wish to provide additional command line arguments and retrieve these from jArchi. For example you can run a jArchi script like this:

Archi -application com.archimatetool.commandline.app -consoleLog -nosplash --script.runScript "MyScript.ajs" --myArg "HelloWord"

Note that you can use a single hyphen or double hyphen. -myArg "HelloWord" or --myArg "HelloWord"

Then you can retrieve the user arguments in a jArchi script like this:

var arguments = $.process.argv;

for(i = 0; i < arguments.length; i++) {
    console.log(arguments[i]);
}

$.child_process.exec() (was exec())

Execute a system command or program. Function arguments can be multiple.

Examples:

$.child_process.exec("notepad.exe", "newfile.txt");
$.child_process.exec("notepad.exe");

$.process.engine

Returns the class name of the current Script Engine. Can be useful in scripts to determine with engine is being used in case of API differences.

var engineName = $.process.engine;

$.process.platform

Returns the short name of the current operating system.

var platform = $.process.platform;

$.process.release.archiName

Returns the app name - Archi

var name = $.process.release.archiName;

$.process.release.archiVersion

Returns the app version, for example 4.9.0.202109160630

var version = $.process.release.archiVersion;

$.process.release.jArchiName

Returns the jArchi name - Archi Scripting (jArchi)

var name = $.process.release.jArchiName;

$.process.release.jArchiVersion

Returns the jArchi version, for example 1.2.0.202109160630

var version = $.process.release.jArchiVersion;

shell variable

The current SWT Shell is available thru the shell variable

const TitleAreaDialog = Java.type("org.eclipse.jface.dialogs.TitleAreaDialog")
const MyNewDialog= Java.extend(TitleAreaDialog)
// Nashorn syntax
var dlg = new MyNewDialog(shell) {... override methods here ...}