Web Terminal

Web-based terminal for InterSystems products. Access your database from everywhere!

• Visit the project’s page for more details.
• Download the latest version from here.
• Read more and discuss WebTerminal on InterSystems Developer Community.
• Read complete documentation about WebTerminal.

Preview

Syntax highlighting & intelligent autocomplete!

Embedded SQL mode!

Even more features!

Key Features

Installation

Download the latest version from the project page and import downloaded XML file into any namespace. Compile imported items and the WebTerminal is ready!

Usage

After installation, you will be able to access application at http://[host]:[port]/terminal/ (slash at the end is required).
Type /help there to get more information.

Integration and WebTerminal’s API

To embed WebTerminal to any other web application, you can use <iframe> tag. Example:

Note that terminal URL may include optional GET parameters, which are the next:

• ns=USER Namespace to open terminal in. If the logged user has no access to this namespace,
  the error message will appear and no namespace changes will occur.
• clean Start the WebTerminal without any additional information printed. It is not recommended to
  use this option if you are using terminal as a stand-alone tool (for everyday use), as you can miss
  important updates.

To use WebTerminal’s API, you need to get WebTerminal instance first. Use iframe’s
onTerminalInit function to get it.

document.querySelector("#terminal").contentWindow.onTerminalInit(function (terminal) {
    // now work with terminal object here!
});

This function is triggered after WebTerminal establish an authorized connection.
The next table demonstrates available API. Left column are terminal object properties.

The next example demonstrates a way to intercept terminal’s input:

let iFrame = document.querySelector("#terminal");
function myInitHandler (terminal) {

terminal.execute("set hiddenVariable = 7", {

echo: false // the default is false, this is just a demo

});

terminal.onUserInput((text, mode) => {

if (mode !== terminal.MODE_PROMPT)

return;

terminal.print("\r\nYou've just entered the next command: " + text);

});

terminal.onOutput((chunks) => {

// If you "write 12", chunks are ["\r\n", "12", "\r\n"].

// If you "write 1, 2", chunks are ["\r\n", "1", "2", "\r\n"].

if (chunks.slice(1, -1).join("") === "duck") { // if the user enters: write "duck"

alert(You've found a secret phrase!);

}

});

}
// At first, handle iFrame load event. Note that the load handler won't work

// if this code is executed at the moment when iFrame is already initialized.

iFrame.addEventListener("load", function () {

iFrame.contentWindow.onTerminalInit(myInitHandler); // handle terminal initialization

});

WebTerminal Project Development

We are glad to see anyone who want to contribute to Web Terminal development! Check our
developer’s guide.

To be short, the “hot start” is extremely easy. Having latest Git and
NodeJS installed (tested on NodeJS v4-8), execute the following:

git clone https://github.com/intersystems-community/webterminal
cd webterminal # enter repository directory
import         # build & import the project. YOU NEED TO EDIT CONSTANTS IN THIS FILE FIRST

Now, in build folder you will find WebTerminal-v*.xml file. Every time your
changes are ready to be tested, just run import again.