RDM Web Term is a browser-based terminal emulator for MultiValue (Pick-family) host systems, plus two host-integrated productivity features: WCE (an in-browser code editor for MV BASIC/proc source) and WTD (browser-driven data upload/download between the host and your PC). This document covers every screen, setting, and feature of the package — both the web front-end and the MultiValue host-side programs it talks to. For a product overview, see the WebTerm product page.


Overview

WebTerm is a self-contained package (the server folder) that you copy to, or run on, a machine reachable by your users' browsers. Once running, users browse to it and get a full terminal session to a MultiValue host over Telnet or SSH — no client software to install for the terminal itself. Two optional companion pieces round it out:

  • A small desktop helper app, RDM Host Tools, for the handful of things a browser can't do on its own (opening a local file or sending a print job to a local printer from a host-driven action). See Section 8.
  • An admin Dashboard page for monitoring active sessions across all users and jumping into any of them to watch or co-drive live. See Section 6.

A typical session: open WebTerm in a browser, either pick a saved profile from the Session field or fill in Host/Port/Protocol/Terminal Type by hand, click Connect, and you're at your host's login prompt. From there the host can drive two extra browser-side features on demand — WCE (opens host BASIC/proc source in an in-browser code editor) and WTD (prompts you for a file to upload, or hands you one to download) — both covered in their own sections below.

A WebTerm session logged in to a MultiValue host, showing a customer listing

The Terminal Screen

The terminal page: toolbar across the top, the host application's menu screen below

The toolbar

The toolbar changes with the connection. While you're disconnected it shows the connection fields. Once you're connected they fold into a single session chip in the same spot, so the terminal gets the room.

While disconnected

Control Description
Protocol SSH or Telnet — which wire protocol to use to reach the host.
Host/IP Hostname or IP address to connect to. Press Enter to move to the Port field.
Port TCP port to connect on. Press Enter here to connect immediately.
Terminal Type VT (VT100/xterm), WYSE, or ADDS — which terminal emulation WebTerm should translate the host's control codes as. Press Enter here to connect immediately.
Session The session-profile picker — type a new name to define a new profile, or click it to open a dropdown of your saved profiles. See Section 4.
Connect The green button. Connects using the fields to its left.

While connected

Control Description
Session chip The session's name, then its protocol, host and port, and terminal type. The green dot means connected. While WebTerm is automatically reconnecting after a dropped connection, the dot turns amber and the chip reads Reconnecting…. Click the chip to show the connection fields again; they fold back into the chip when you click the terminal or press Esc. Changing them doesn't affect the session you're in, only the next connection.
Capture (document icon) Starts recording the text the host sends, for a downloaded file or the clipboard. While a capture runs, the button turns red with a stop icon, and clicking it stops the capture and saves it. See Capturing a session to a file or the clipboard. Ctrl+Shift+X does the same. It's shown only while you're connected.
Settings (gear) Opens the Settings modal — see Section 3. Ctrl+Shift+S opens it too. It's on the toolbar while disconnected as well.
Disconnect (unplug icon) Ends the session. While WebTerm is reconnecting, the icon spins.
More (⋯) Opens the More menu, below. It's on the toolbar while disconnected as well.

The More menu

Item Description
Switch to 132 columns / Switch to 80 columns Switches the terminal between 80 and 132 columns and re-fits the font to match — a display convenience only, it doesn't reconnect or change what the host thinks your screen size is.
Data upload / download… Types WTD W at the host for you, which opens the WTD wizard — see The wizard. Use it at a TCL prompt, on an account where the WTD host programs are installed. It's greyed out until you are connected. Not shown in a tandem tab.
Reset terminal Clears the screen and resets the local terminal display (buffer, any images left on screen, in-progress download state, size back to the default 80×24) without touching the actual host connection.

Open the menu with a click, or with Enter or the Down arrow on the ⋯ button; the arrow keys move through it and Esc closes it.

In a narrow window (about 820 px or less, such as a phone), the connected toolbar keeps just the session chip, Capture and ⋯. The More menu then also holds Settings, Disconnect and anything else that no longer fits. While disconnected, the connection fields wrap onto several rows above a full-width Connect button.

The toolbar while disconnected: Protocol, Host/IP, Port, Terminal Type, Session and the green Connect button, with Settings and More on the right
The toolbar while connected: the session chip on the left, then Capture, Settings, Disconnect and More on the right
The More menu open: Switch to 132 columns, Data upload / download and Reset terminal

Tandem badge

If you arrive at the terminal page via a Watch or Control link from the Dashboard rather than connecting yourself, a small badge appears reading either "👁 TANDEM VIEW — READ ONLY" or "⌨ TANDEM CONTROL — LIVE INPUT", next to the session chip. The connection fields are disabled if you open them, since a tandem tab attaches to someone else's already-running session instead of starting its own. See Section 7.

The toolbar of a tandem Watch tab: the TANDEM VIEW — READ ONLY badge next to the session chip

Capturing a session to a file or the clipboard

A capture records the text the host sends from the moment you start it until you stop it. Use it to keep a report, a log or anything else that scrolls past.

  1. Click the Capture button (the document icon) in the toolbar. The Begin Capture dialog opens.
  2. Choose where the capture goes:
    • Download file saves it to your browser's Downloads folder when you stop. Type a File name, or keep the suggested one (the session name plus the date and time). A browser can't overwrite or add to an existing file. If a file with that name is already in Downloads, the browser keeps both and usually adds (1) to the new name.
    • Clipboard copies it when you stop, ready to paste. This is best for short captures.
  3. For a file, pick the Encoding:
    • UTF-8 (the default) is what most editors expect.
    • Latin-1 writes back exactly the bytes the host sent, one byte per character. Pick it if your host sends text in a single-byte character set and you need those bytes unchanged.
  4. Click Start Capture.

While the capture runs, the Capture button turns red and a REC timer next to the toolbar buttons shows how long it has run and how much it has recorded. To stop the capture and save it, click either one.

When you stop, the REC timer changes to a spinner with Saving… (or Copying… for the clipboard) while WebTerm builds the file. A large capture can take a moment. The spinner goes away when the capture is saved.

From the keyboard: press Ctrl+Shift+X to open the Begin Capture dialog, then Enter to start. Press Ctrl+Shift+X again to stop the capture and save it. Pressing it while the dialog is open closes the dialog. It uses the Ctrl key on a Mac too, not Cmd. The key is never sent to the host, and it does nothing while you're disconnected or while Settings is open. To turn it off, use Settings → General → Keyboard Shortcuts.

What ends up in the capture:

  • Only text. Screen-control codes are removed: cursor movement, colors, clear-screen and graphics-mode switches. Images, WCE and WTD traffic and the other host features in Section 9 are removed too. Output the host sends only to a local printer (AUX print) is left out.
  • Screen layout, roughly. A move to a later column on the same line becomes spaces. A move to another row starts a new line. That way a form the host paints from top to bottom reads the same way in the file. Box lines drawn in graphics mode come out as +, - and |.
  • What you typed, as the host echoed it. Backspaces are applied, so corrected typing shows up corrected. Each line ends with CR LF, and spaces at the end of a line are trimmed.

When the capture stops:

  • A file downloads straight away, and a note in the corner names it.
  • A clipboard capture you stopped from the toolbar is copied straight away. If a host program or a disconnect stopped it, a Capture ready box appears instead, because browsers only let a page use the clipboard when you click. Click Copy to clipboard. You can also click Save as file instead, or Discard.

Things to know:

  • Disconnecting stops the capture and saves it, whether you click Disconnect or the host ends the session. A dropped connection that Session Resume reconnects keeps the capture going. Output that arrived while you were away is captured once.
  • Reset terminal doesn't stop a capture.
  • Reloading or closing the tab loses a capture that is still running, because it is kept in the page until it is saved. Stop it first.
  • A capture stops by itself at 50 MB and saves what it has.
  • A host program can start and stop a capture too. See Capturing output from a host program.
The Begin Capture dialog: save to a downloaded file or the clipboard, the file name and the encoding
The toolbar while a capture runs: the REC timer and size, and the red Capture button that stops it

Settings

Open the Settings modal from the gear icon, or press Ctrl+Shift+S (press it again to close it without saving). It has four tabs; Save writes everything in the modal (plus the toolbar's connection fields) into whichever profile name is currently in the Session field — so Settings values are really just extra fields on a session profile, not a separate global preferences store. If the Session field is empty, Save silently does nothing.


General tab (shown by default)

Input Behavior

Setting Default Description
Ctrl+H as Backspace On Treats Ctrl+H the same as Backspace while typing.
Keyboard Shortcuts On Ctrl+Shift+X starts and stops a capture, and Ctrl+Shift+S opens and closes Settings. Turn it off if something else on your computer uses those keys. When it's off, they do what they did before: nothing reaches the host.
Play Bell Sound Off Plays an audible bell when the host sends a BEL character.

Display

Setting Default Description
Show Terminal Scrollbar Off Shows/hides the terminal's scrollbar.
Auto-Hide Toolbar Off Hides the top toolbar to give the terminal more room. Move the mouse (or tap) near the top edge of the screen to bring it back.

Terminal Colors

Setting Default Description
Background #0805ad (dark blue) Terminal background color.
Foreground #ffeb00 (yellow) Terminal text/cursor color. The text-selection highlight is derived from this color too.

A live preview swatch next to the two color pickers updates immediately as you adjust either one. Clicking the swatch itself asks to reset both colors back to their defaults.

The Settings modal open on its General tab: input behavior, display and terminal colors

Connection tab

Behavior

Setting Default Description
Connect Automatically On Page Load Off Skips the manual Connect click — WebTerm connects itself as soon as the page finishes loading.
Automatically Resume Session After Disconnect Off On an unexpected drop (network blip, page reload, browser crash-restore), silently reattaches to the same still-live host session instead of requiring a fresh login. Turning this off mid-session immediately discards any resume credential already held, so a later drop can no longer silently reattach. See Section 5.

Security

Setting Default Description
Use SSH Legacy Cipher and Exchange Off Needed for older SSH hosts that don't support modern ciphers.
Send SSH Bypass for Local Login Off Sends a configured bypass password for local login prompts.

Session Overrides

Setting Default Description
Custom Rows / Custom Columns Blank (24×80) Override the terminal size sent to the host at connect time.
Custom ViewType Blank Send an arbitrary terminal-type string to the host instead of being limited to the VT/WYSE/ADDS dropdown.
Legacy Line Wrap Off WYSE and ADDS only. Goes back to the 82-column screen and line wrap WebTerm used before 2.8.18. Turn it on only if a host's screens look wrong without it. See Terminal type profiles.

Profiles and Shortcuts

  • Desktop Shortcut — downloads a shortcut file that opens and connects to the session in the toolbar with a double-click. See Desktop Shortcuts.
  • Export Profiles and Import Profiles — back up your saved profiles or move them to another browser. See Exporting and Importing.
Settings, Connection tab: behavior, security, session overrides, and profiles and shortcuts

Function Keys tab

Each key has a text field for the literal string or escape sequence to send to the host when that key is pressed. All are blank by default. Use \n (or the older AccuTerm-style ^M) in a value to embed a carriage return.

Setting Default Description
Send Terminal Default When Blank On Controls what happens for a key with no data string. On, pressing it sends the active emulation's built-in escape code for that key (see Section 9) — same as a physical terminal. Off, pressing it sends nothing at all.

Modifier layers

The Modifier buttons choose which set of keys the table shows:

  • None is the plain keys: F1 through F12, plus End.
  • Shift, Ctrl, Alt, Ctrl+Shift, Ctrl+Alt, Alt+Shift and Ctrl+Alt+Shift each give F1–F12 a second meaning. Fill in Shift+F1, for example, and Shift+F1 sends its own string. On a Mac, Alt is the Option key. The Cmd key isn't a modifier here.

A number on a button shows how many keys are set on that layer. A modified key you leave blank sends nothing, even if the plain key has a string. That way a stray Shift or Ctrl can't send, say, a login string set on F1. "Send Terminal Default When Blank" applies to the plain keys only.

Some combinations belong to the browser or the operating system:

  • Not available: on Windows and Linux, Alt+F4 closes the browser window and Ctrl+F4 closes the tab, so those fields are greyed out there. On a Mac they're available, with a note.
  • ⚠ May not work everywhere: Shift+F10 can also open the page's context menu on Windows. On a Mac with keyboard navigation turned on, macOS uses Ctrl+F2 and Ctrl+F3. On Linux, Ctrl+Alt+F1–F12 switch to another console. These keys still work where nothing else claims them.

Test a key shows what the browser delivered and what WebTerm would send for it. Click the box, then press a key. If nothing shows up, the browser or your system kept that key for itself. On a Mac, function keys need Fn held down unless Use F1, F2, etc. keys as standard function keys is turned on in System Settings → Keyboard.

Modified keys are saved with the session profile like everything else on this tab, and travel with profile exports and the URL Builder.

Settings, Function Keys tab, with F1 and F2 set to host commands
The Shift layer of the Function Keys tab, with Shift+F1 and Shift+F3 set and a warning on Shift+F10

About tab

Shows the RDM Infinity logo/copyright, the running Version number, the current Session ID (handy if you need to reference a specific session with support or in the Dashboard's session table), and open-source attributions.

Two collapsible sections near the bottom let you install the MultiValue host programs the terminal integrates with, straight from the browser — see Section 12:

  • "Deploy host tools to remote server" — installs WCE.
  • "Deploy WTD (WebTerm Data) tools to remote server" — installs WTD.
Settings, About tab: version, session ID and the host program install sections

Settings locked by a link

An admin can send a link from the Dashboard's URL Builder with a Settings Lock. When you open WebTerm from one, a notice at the top of Settings says so, and the tabs you can't change show a lock.

  • Function Keys Only: Settings opens on the Function Keys tab. You can change your function keys, including the Shift, Ctrl and Alt ones, and Send Terminal Default When Blank. Everything else is greyed out. Save keeps your function keys in this browser, for that host, and they come back the next time you open the link. The link's other settings stay as the link sets them.
  • Locked: every setting is greyed out and Save is turned off. Close still works.

On a locked link, the link's own settings are used in place of anything you saved in this browser before, and nothing is saved as a session profile. The toolbar's connection fields and the Session field are greyed out too, and so are Import Profiles and Desktop Shortcut on the Connection tab. Export Profiles still works, and so does the About tab. If something needs to change, ask whoever sent you the link for a new one.

Settings opened from a link that allows function-key changes only: a lock notice above the tabs, General and Connection marked locked

Session Profiles

A profile bundles up everything on the toolbar and in every Settings tab — connection details, keyboard/security/display options, colors, row/column overrides, and all thirteen function-key strings — under one name, so you can switch between different hosts/setups instantly instead of re-entering everything each time.

  • Saving: fill in the Session field and whatever else you want remembered, then click Save in the Settings modal. If the name matches an existing profile it's updated; otherwise a new one is added.
  • Loading: click the Session field to open a dropdown of your saved profiles (name + host shown for each); type to filter the list live. Selecting one fills every field from that profile. If you're currently connected, you're asked first whether to disconnect. If "Connect Automatically On Page Load" is on, selecting a profile connects right away.
  • Deleting: each row in the dropdown has a small delete (✕) button; it asks for confirmation and removes the profile immediately — there's no undo and no bulk-delete screen.

Profiles are stored in your browser (not on the server), so they're local to whichever browser/machine you saved them from.

The Session field's dropdown listing saved profiles, each with its host and a delete button

Exporting and Importing

Since profiles live only in your browser, Settings → Connection → Profiles and Shortcuts lets you move them to another machine or back them up to a file:

  • Export — downloads every saved profile on this browser to a single file (webterm-profiles-<date>.wtprofiles). The file's contents are encoded (not plain, readable JSON) so a stray glance in a text editor doesn't expose hostnames or any passwords saved in your function-key strings — this is obfuscation for casual readability only, not encryption, so still treat the file as sensitive.
  • Import — pick a previously exported .wtprofiles file. WebTerm shows how many profiles are new versus how many already exist under the same name before doing anything; confirming overwrites any same-named profile and adds the rest, leaving every other existing profile untouched.

Each profile's WCE Settings are part of its export and are restored on import.

The Profiles and Shortcuts section of Settings, Connection, with the Desktop Shortcut, Export and Import buttons

Desktop Shortcuts

Settings → Connection → Profiles and Shortcuts → Desktop Shortcut downloads a shortcut file that opens WebTerm in your default browser when you double-click it. Your browser saves it to your Downloads folder; drag it to the Desktop (or anywhere else) from there. Some browsers ask you to confirm keeping a shortcut file before they save it.

  • What it opens: the session in the toolbar, using the current host, port, protocol, terminal type, Settings and function-key strings (whatever is on screen, even if you haven't saved it). Double-clicking it opens WebTerm, fills everything in and connects straight away, whether or not "Connect Automatically On Page Load" is on. The session is not added to that browser's saved profiles, and connecting or disconnecting doesn't save it. Click Save in Settings if you want to keep it as a profile, and picking a saved profile from the Session field replaces it as usual. Needs a host to be filled in.
  • Which kind of computer: WebTerm makes the shortcut for the computer you're on, and the row says which kind of file it will download. To make one for someone on another kind of computer, click Other computer… and pick Windows, macOS or Linux.
  • Phones, tablets and Chromebooks can't use a shortcut file, so the row doesn't appear there.
  • To open a blank WebTerm page, bookmark it or use your browser's own "create shortcut" or "add to dock" option.
Platform File Notes
Windows <name>.url Shows the WebTerm icon, which Windows fetches from the WebTerm server. If the server can't be reached when Windows draws the icon, the default browser's icon shows instead.
macOS <name>.zip holding <name>.webloc Double-click the zip (Safari may unzip it for you) to get the .webloc with the WebTerm icon. macOS only puts a custom icon back when it unzips the file, so the shortcut comes zipped; a tool other than Archive Utility may leave a plain .webloc with the browser's icon and a __MACOSX folder, which you can delete.
Linux <name>.desktop Opens the link with xdg-open. Most desktops won't run a downloaded .desktop file until you trust it: on GNOME, right-click it on the Desktop and choose Allow Launching; elsewhere, mark it executable (chmod +x "<name>.desktop").

A session shortcut works on any computer and in any browser, because it carries the connection details itself instead of pointing at a saved profile. Those details are in the part of the link after #, which browsers never send to the WebTerm server. It holds no login password, but it does include your function-key strings, so if any of them type a password, treat the shortcut file like the exported profiles file. If you change the session later, download a new shortcut; an existing one keeps the settings it was made with.

The Desktop Shortcut row in Settings, Connection, Profiles and Shortcuts

Session Resume

Every time you connect, the server gives your browser a resume credential tied to that backend session. Two settings control it:

  • Whether WebTerm uses it: Settings → Connection → "Automatically Resume Session After Disconnect" (off by default).
  • How long a dropped session stays resumable: a server-wide setting an admin controls from the Dashboard's Settings tab (default 180 seconds).

With it turned on:

  • An unexpected drop (a network blip, as opposed to you clicking Disconnect or the host ending the session):
    • WebTerm shows [Connection lost -- attempting to reconnect...], the session chip turns amber and reads Reconnecting…, and the Disconnect icon spins.
    • It retries reattaching to the same still-live host session a few times, with increasing delay.
    • A successful reattach shows [Reconnected], and you pick up exactly where you left off.
    • If the credential has expired or the session is really gone, it gives up right away.
  • Reloading the page, or the browser crash-restoring your tab, also reconnects you to the same session, with your colors, function keys, custom rows/columns, and other settings intact — not a blank default form. This works per-tab: closing a tab normally clears its resume state.
  • Duplicating a connected tab, or opening a new tab from it, starts a new session of its own. It doesn't take over the session that's running in the original tab.
  • If a session is ever taken over by another window anyway, the window that lost it shows [Session taken over in another window] and doesn't try to reconnect, so the two windows can't keep taking the session from each other.
  • Turning the setting off while a session's resume credential is still held immediately discards it, so a later unexpected drop can no longer silently reattach — you'd get a fresh login instead.

Regardless of the setting:

  • Clicking Disconnect yourself always ends the backend session immediately — there's nothing left to resume even if you reconnect right after.
  • If the host session ends on its own (you typed exit or logged out), WebTerm shows a clean [Session ended] message instead of trying (and failing) to reconnect.
  • A tandem Watch/Control tab never auto-resumes — if it drops, it just disconnects.
The terminal after an unexpected drop: [Reconnected], and the same host session carrying on

The Dashboard

The Dashboard is a separate admin/monitoring page — reached by browsing directly to it at /dashboard (for example https://your-webterm-host/dashboard; /dashboard.html works too), not linked from the terminal toolbar — for seeing every active session across all users and jumping into any of them.

The Dashboard Overview tab with live session stats, the data transfer chart and the sessions table

Signing in

Access is by individual username and password, not a single shared secret. Enter your credentials and click Sign in (or press Enter in either field).

  • Wrong credentials report "Invalid username or password."
  • Lockout: five failed attempts against the same account lock it for 15 minutes, even if the next attempt would have been correct. This is a brute-force guard.
  • Session: signing in starts a session tied to your browser (an httpOnly, secure cookie, so there's nothing to copy or store). It lasts up to 8 hours of activity, or until you click Sign out, which ends it immediately in the browser and on the server.
  • Top bar: shows your username and role. The sun/moon icon beside it switches the dashboard between dark (default) and light mode, and remembers your choice.
The Dashboard sign-in box

Roles

Every account is either Admin or Support:

Overview / URL Builder / Watch Control Users tab Settings tab
Admin ✅ ✅ ✅ ✅
Support ✅ — — —

A Support account can do everything on the Dashboard except open a Control tandem link, manage accounts, or reach the Settings tab — all three are hidden from the Support UI entirely (there's no grayed-out button to notice), and all three are also rejected on the server if attempted directly, so hiding the button isn't the only thing standing in the way.

The Dashboard signed in as a Support account: no Users or Settings tab, and Watch but no Control links

Overview tab

  • Stat tiles: Active Sessions (with a small trend sparkline), and cumulative bytes transferred To Host / To Client across every session.
  • Data Transfer chart: a two-line chart of recent to-host/to-client traffic (roughly the last 5 minutes); hovering shows exact byte values for a moment in time. This history lives only in your open Dashboard tab and resets if you reload — nothing is stored server-side.
  • By Protocol / By Browser: breakdowns of currently-active sessions.
  • Sessions table: one row per active (or recently dropped but not yet cleaned up) session.
    • Columns: ID, status, protocol, emulation, host, client IP, connected duration, bytes each direction, and tandem viewer count.
    • Each row has a Watch link, plus a Control link for Admin accounts (see Section 7).
    • A filter box narrows the table live by id, host, IP, protocol, emulation or status.
    • Pagination (25/50/100/250 rows per page) keeps a busy fleet manageable.

The table refreshes automatically every 5 seconds while you're signed in.

The sessions table, with Watch and Control links for each live session

URL Builder tab

Builds a single pre-filled link to the terminal, so an admin can hand someone a link instead of walking them through manual setup. That's useful for a kiosk-style workstation, a support link, or putting a group of users on the same host and settings. It's laid out like the terminal's own Settings, with the link in a panel beside it.

  • General, Connection and Function Keys tabs hold the same settings as the terminal page, grouped the same way. The Connection tab also has the host fields from the toolbar (Protocol, Host / IP, Port, Terminal Emulation).
  • A setting is only added to the link when it differs from its default, so a mostly-default link stays short. Each setting that will go into the link shows an IN LINK tag, and each tab shows how many of its settings are in the link.
  • Function Keys works like the terminal's Function Keys tab: pick a modifier (None, Shift, Ctrl, Alt and their combinations) and fill in its keys. Each modifier shows how many keys are set. The Shift, Ctrl and Alt keys go into the link as one fkMods parameter (see Modifier layers).
  • The Your Link panel stays in view as you scroll. The link updates as you change settings.
    • Target Page is the terminal page the link opens. Leave it blank for this server's.
    • Encode Settings in the Link (on by default) puts every setting after a # as one encoded value, so the link reads like …/index.html#wt=cHJvdG9jb2w9… instead of listing hosts and function-key strings in plain text. Anything after # is never sent to the server, so those settings also stay out of web-server and proxy logs. Turn the switch off for a plain ?host=…&port=… link.
    • Settings Lock limits what the person who opens the link can change in Settings: Unlocked (the default), Function Keys Only, or Locked. It needs Encode Settings in the Link, and is greyed out without it. See Settings locked by a link for what the visitor sees.
    • What's in this link, at the bottom of the panel, lists the link's settings in plain text so you can check what you're sending.
    • Copy Link puts the link on the clipboard, Open launches it in a new tab, and Reset restores every setting to its default.
  • Starting from an existing link: paste any WebTerm link, plain or encoded, into the Link box and press Enter (or click away). The builder fills in its settings from that link, Settings Lock included, so you can change a few and copy a new link. The Encode switch stays as you set it, so a plain link can come back out encoded, or the other way round. Settings the builder has no field for, such as embed=1, are kept as they are; the message under the buttons lists them.
  • The encoding isn't encryption. Anyone who runs the value through a base64 decoder can read it, so don't rely on it to hide passwords. The same goes for Settings Lock: it stops casual changes, but someone who removes the #wt=… part of the link gets an ordinary, unlocked page.
  • Settings typed onto the end of a link by hand still work, encoded or not, unless the link has a Settings Lock. On an encoded link, put them before the #, as in …/index.html?fk1=MENU%5Cn#wt=…. A setting typed this way takes priority over the same one inside #wt=. A locked link ignores them.
  • Available to both Admin and Support accounts.
The URL Builder tab building a pre-filled link

Users tab (Admin only)

Only visible to Admin accounts — manages who can sign in to the Dashboard at all, without touching any file on the server by hand.

  • Add User — username, a password (minimum 10 characters), and a role (Support or Admin).
  • Accounts table — one row per account: username, role, when it was created, and its last successful sign-in (or "Never"). Each row has:
    • A role dropdown — moves an account between Support and Admin immediately.
    • Reset Password — sets a new password for that account right away. The account isn't notified automatically — pass the new password along yourself.
    • Delete — permanently removes the account, after a confirmation prompt.
  • The last remaining Admin account can't be demoted or deleted by anyone, itself included, so the Dashboard can never end up with no admin able to manage accounts. You also can't delete the account you're currently signed in as — sign in as a different admin to remove it.
The Users tab: Add User form and the accounts table with role, reset and delete controls

Settings tab (Admin only)

Only visible to Admin accounts — edits config.json on the server directly, instead of you having to find and hand-edit the file yourself.

Most settings take effect as soon as you click Save, with no restart, so nobody's session is interrupted. The save message says "Saved and applied."

  • New sessions get the new value: SSH Bypass Password, License Key, Terminal Type Override, Session Resume Grace and SSH Client Identifier. Sessions already open keep what they started with (for example, their resume grace).
  • Logging (Session Logging, SSH Debug Mode, Telnet Handshake Output) switches on or off at once, for open sessions too.
  • Replacing the SSL certificate while HTTPS is on puts the new certificate into use for new connections as soon as both the certificate and its key are uploaded. Open sessions aren't interrupted. If the certificate and key don't match yet (for example, you've uploaded only one of them), the old certificate stays in use and the message says why.
  • An invalid license key is refused when you save it, so it can't stop the server from starting later.

Two settings change how WebTerm listens for connections, so they still need a restart: the Port, and turning HTTPS on or off. Saving either one shows "Saved. Takes effect after a restart." and a banner above the cards that names the change, for example "Restart required for the new port. Restarting ends every open session." The banner stays until you restart:

The Restart Now button on that banner restarts WebTerm in place — expect it back within about 15–30 seconds. Restarting ends every open session, so pick a quiet moment.

If you edit config.json by hand instead of using this tab, WebTerm only reads the change on its next restart, and the banner lists those settings until then.

Network

Setting Default Description
Port 3000 The TCP port WebTerm listens on.

Session / Security

Setting Default Description
SSH Bypass Password Not set The password WebTerm sends for Settings → Connection → Security → "Send SSH Bypass for Local Login" on the terminal page (see Section 3). Write-only: the field always shows blank, and a hint above it just confirms whether one is currently set. Leave it blank when saving to keep the current password unchanged; type a new one to replace it.

SSL / HTTPS

Setting Default Description
Enable HTTPS Off Serves the app over HTTPS instead of plain HTTP. WebTerm refuses to save this turned on until both a certificate and a key are uploaded below.
Upload Certificate / Upload Key Not uploaded Uploads a .crt/.pem certificate and/or a .key/.pem private key — each is checked for a plausible PEM header before being accepted, not just any file. Uploading (Upload) is a separate step from turning HTTPS on (Save Enable/Disable) — upload both files first, then enable. Once HTTPS is on, uploading a new certificate and key replaces the running certificate without a restart. Whatever you upload is always stored as certs/server.crt and certs/server.key; an existing file is backed up alongside itself (.bak) before being overwritten.

License

Setting Default Description
License Key Not configured Same write-only pattern as the bypass password — the field is always blank, and a status line above it reports whether a key is configured and valid rather than showing the key itself. Paste a key here to add one for the first time or replace the one already set.

Terminal

Setting Default Description
Terminal Type Override Blank (auto) Forces every connecting session to a specific terminal type on the server side, overriding whatever the user picked from the toolbar's Terminal Type dropdown (see Section 9). Leave blank to let each user's own choice stand.
Session Resume Grace (seconds) 180 How long a dropped session stays eligible for Session Resume before the server gives up on it for good.
SSH Client Identifier Blank (default) Replaces the software name WebTerm reports to SSH hosts during the connection handshake (sent as SSH-2.0-<value>). Leave blank for the default. Some SSH servers only start a session for OpenSSH clients: they accept the login but never show a prompt, so the terminal sits blank after "Connection successful". For those hosts set this to OpenSSH_for_Windows_9.5. Applies to every SSH session on this server. Letters, digits and punctuation only, with no spaces or -.

Logging

Setting Default Description
Session Logging Off Writes session activity to logs/sessions.log.
SSH Debug Mode Off Verbose SSH key-exchange logging — turn on when troubleshooting a connection that won't negotiate.
Telnet Handshake Output On Echoes Telnet IAC handshake bytes to the server console. Turn off to quiet a busy console/log on a server handling a lot of Telnet traffic.

One config.json setting has no control here on purpose: sessionSecret, which signs Dashboard/Tandem session cookies, is generated automatically the first time WebTerm is installed and is never shown or accepted anywhere in this API — edit it directly in config.json only if you specifically need to (for example, to invalidate every existing Dashboard session at once), and restart afterward.

The Dashboard's Settings tab, showing the Restart, Network, Session/Security, SSL/HTTPS, License, Terminal, and Logging cards
The restart-required banner, naming the setting that's waiting for a restart

Custom Emulation

Settings → Custom Emulation is an advanced setting for a host whose programs send screen codes that WebTerm's WYSE or ADDS emulation doesn't handle, so its screens draw wrongly in WebTerm while they look right on the terminal or in other emulators. Instead of waiting for a WebTerm update, an admin pastes the host's terminfo entry, the standard description of a terminal's codes, and WebTerm reads the codes from it. Most sites never need it.

  1. Get the terminfo entry. On the host (or any Linux machine, if the host isn't one), run infocmp -1 with the terminal type your users are set to, for example infocmp -1 wy60, and copy the whole output.
  2. Paste it into Terminfo entry. Overrides says which WebTerm emulation the map changes, WYSE or ADDS; WebTerm fills it in when the entry's name makes it clear. Name is optional and defaults to the entry's own name.
  3. Click Check. WebTerm lists every code it read and what it will do with it. Codes marked "Only part of a longer code" appear only inside a longer code, such as the terminal's start-up string, and are left to the built-in rules. Left out lists anything WebTerm can't use and why. Keys in this entry shows what the terminal's keys send, for reference only: the map doesn't change what WebTerm's keyboard sends.
  4. Try it in Test. Type some host output in terminfo notation (\E for ESC, ^X for a control key) and click Test to see how the map reads each code. A code that is not in the map is left to the built-in rules, which may also use the characters after it, so text shown after it may really be part of that code (for example \E=!! is a cursor move, not =!! printed).
  5. Click Save. The map is stored on the server and used by every new terminal session whose terminal type is the one it overrides. A browser tab that's already open picks it up when the page is reloaded.
  • The map adds to the built-in codes rather than replacing them. Where it lists a code, it decides what that code does; every code it doesn't list still works as before.
  • There's one map per WebTerm server. It's kept in emulation-map.json next to config.json, and updates keep it.
  • While the map is on, the terminal page's Terminal Type list and the toolbar's session chip show the emulation it overrides as WYSE (custom) or ADDS (custom). Hovering over the list names the map.
  • Use this map turns it off without deleting it; Remove deletes it. Either way, sessions go back to the built-in codes.
  • VT sessions never use a map.
Settings, Custom Emulation: a pasted Wyse 60 terminfo entry after Check, with the codes WebTerm read from it and a Test of some host output

Creating the first account

Accounts live in a per-account store rather than a single shared secret, so the very first Admin account has to be created from the server's own command line — there's no one signed in yet to use the Users tab. From the server directory on the machine running WebTerm:

node tools/create-user.js <username> <password> admin

Every account after that first one can be created from the Users tab by any existing Admin.


Tandem Viewing and Control

Tandem lets a second browser tab attach to a session that's already running in someone else's tab — for support, training, or supervision — without that person having to share their screen.

  • It's started from the Dashboard's session table, not from the terminal page.
  • You must be signed in to the Dashboard. The tab that opens authorizes off that login, so the link is no use to someone who isn't signed in themselves.

There are two kinds of tandem tab:

  • Watch — a read-only view of the live session. Available to both Admin and Support accounts.
    • It shows everything the session outputs, rendered with that session's own terminal emulation.
    • Nothing typed in the watching tab is ever sent to the host.
    • The toolbar shows a "👁 TANDEM VIEW — READ ONLY" badge next to the session chip, and the connection fields are disabled because you're attaching, not connecting.
  • Control — the same attachment, but two-way. Admin accounts only.
    • Keystrokes typed in this tab are sent to the live host, mixed in with whoever else is typing. There is no locking or turn-taking.
    • Control always asks for confirmation before opening, so a stray click can't inject keystrokes into someone else's session.
    • Its badge reads "⌨ TANDEM CONTROL — LIVE INPUT".
    • A Support account doesn't see the Control link, and the server rejects a Control attempt from a Support session even if the link is opened directly.

Any number of Watch tabs can be open on the same session at once; each is independent and closing one doesn't affect the original session or any other viewer.

A tandem Watch tab mirroring another user's live session, read-only

RDM Host Tools Helper

A small optional desktop helper app that lets a host-driven action do a couple of things a browser sandbox can't do on its own: open a local file/URL directly on your machine, or send a print job to a local printer, both triggered from the host side rather than anything you click in the browser.

When one of those actions fires:

  • Helper app installed: WebTerm hands off to it through a custom URL scheme. You shouldn't notice anything beyond the file opening or the print job appearing.
  • Helper app not installed: WebTerm detects that (nothing on your system claims the handoff within about 2 seconds) and opens a small download page. It has Download for Windows, Download for macOS and Download for Linux buttons, with the one for your system highlighted. Install it once and the handoff works silently from then on.

Linux packages. Download for Linux opens a chooser rather than downloading, because one package doesn't fit every distribution:

  • Ubuntu / Debian (.deb) — Ubuntu, Debian, Linux Mint, Pop!_OS and other Debian-based distributions. Install with sudo apt install ./Linux-RDMHostTools-amd64.deb.
  • Red Hat / Rocky / AlmaLinux / Fedora (.rpm) — Red Hat Enterprise Linux, Rocky Linux, AlmaLinux, Oracle Linux, CentOS Stream, Fedora and other RPM-based distributions. Install with sudo dnf install ./Linux-RDMHostTools-x86_64.rpm.

Each comes in Intel/AMD 64-bit (x86_64) and ARM 64-bit (aarch64). Most browsers don't say which distribution they're running on, so the page highlights a package only when it can tell. Otherwise, run cat /etc/os-release to see your distribution and uname -m to see your CPU type.

Registering the helper on Linux. The package registers the helper with your desktop as it installs, so on most desktops (GNOME, KDE Plasma, Cinnamon, Xfce and MATE, on Ubuntu, Debian, Fedora, Red Hat, Rocky and AlmaLinux) there's nothing more to do. A few setups may not pick it up on their own:

  • Browsers installed as a Snap or Flatpak, including Ubuntu's default Firefox. These may ask you to choose an application the first time.
  • Minimal installs without the desktop-file-utils package.
  • Window managers without a full desktop environment, such as i3 or Sway.

If WebTerm still opens the download page after you've installed the helper, register it for your user account by running this as yourself, not with sudo:

xdg-mime default rdmhosttools.desktop x-scheme-handler/rdmhosttools

It only affects your own account, so on a shared computer each user who sees the problem runs it once. You can check the result with xdg-mime query default x-scheme-handler/rdmhosttools, which should print rdmhosttools.desktop.

The first time a site opens the helper, your browser also asks whether to open RDM WebTerm Host Tools. That's the browser's own security prompt, on every platform; allow it, and tick the box to always allow it if one is offered.

Every installer shows or includes the RDM WebTerm Host Tools End User License Agreement: the Windows and macOS installers ask you to accept it before installing, and the Linux packages install it as /usr/share/doc/rdmhosttools/LICENSE (.deb) or /usr/share/licenses/rdmhosttools/LICENSE (.rpm).

The RDM Host Tools download page WebTerm opens when the helper app isn't installed

Terminal Emulation and Host Integration Features

This section covers what each Terminal Type actually does, plus a set of features an MV host program can trigger on the browser side — drawing images, popping an alert, opening a local file, printing locally, capturing output to a file, and querying the terminal — all driven by escape sequences the host writes, not by anything the user clicks.


Terminal type profiles

The Terminal Type dropdown (VT / WYSE / ADDS) controls how WebTerm translates the host's raw control codes:

  • VT — treated as VT100/xterm-compatible; almost no translation needed. The default/fallback choice.
  • WYSE — for hosts emitting classic Wyse-50/60 ("WY60") escape sequences, the terminal type most MultiValue systems expect.
  • ADDS — for hosts emitting ADDS Viewpoint-style escape sequences.

In every type, a screen the host clears is kept in the scrollback history above it, so you can scroll back to earlier pages, even after a command such as clear.

Pick the one that matches what your host is configured to talk to. If your host sends WYSE or ADDS codes that WebTerm doesn't handle, an admin can add them from the host's terminfo entry: see Custom Emulation. The wrong choice visibly corrupts cursor positioning and text attributes, because WYSE and ADDS use overlapping escape sequences for different things.

WYSE supports the full set of Wyse-50 screen attributes: reverse, underline, dim and hidden text, in any combination. Hidden text, such as a password typed at a prompt, can't be copied or captured from the screen. Blinking text is shown as reverse video, and protected fields are shown dim, as they are on a real Wyse terminal.

Line wrap under WYSE and ADDS. The screen is 80 columns (132 in wide mode), and a line wraps the way it does on a real Wyse or ADDS terminal: as soon as a character is written in the last column, the cursor moves to the start of the next row. So:

  • A host that writes a full 80-character row and then moves the cursor, or sends a carriage return and line feed, gets the same screen as on the terminal. A full-width row followed by a new line leaves a blank row, as it does on a real Wyse or in AccuTerm.
  • Writing in the bottom-right corner scrolls the screen up one row.
  • Under WYSE, the host's auto-wrap on and off codes (ESC d / and ESC d .) are honored, and a backspace at the start of a row that wrapped goes back to the end of the row above, so erasing typed input that ran past column 80 works.

VT sessions are 82 columns and keep the standard xterm wrap. If a WYSE or ADDS host's screens look wrong after updating to 2.8.18, turn on Legacy Line Wrap (Settings → Connection → Session Overrides) and let us know.

Three related settings:

  • Custom ViewType (Settings → Connection → Session Overrides) only changes the terminal-type string presented to the host or login process. It doesn't change which of the VT/WYSE/ADDS translations WebTerm applies, so set both to match if your host cares about the reported type.
  • Legacy Line Wrap (Settings → Connection → Session Overrides) puts WYSE and ADDS back on the 82-column screen and xterm-style line wrap from before 2.8.18.
  • Terminal Type Override (Dashboard Settings → Terminal) lets an admin force this dropdown's value for every session server-wide. It takes precedence over whatever an individual user picks.

Graphics mode remaps a set of plain characters into box-drawing line characters, so a host program can draw forms, boxes and borders using ordinary characters.

  • The host turns it on and off with escape sequences; it isn't something you toggle.
  • Under WYSE and ADDS, the full Wyse-50 line set is supported: corners, lines, T-junctions, crosses and the checkerboard fill. ADDS also takes the ADDS Viewpoint letter sets.
  • It's turned off automatically on disconnect and on ⋯ → Reset terminal.
A WYSE host screen drawn with graphics-mode box lines and T-junctions

Host-drawn images

A host program can overlay images directly on the terminal screen at a specific character-cell position:

  • Show: ESC STX "iL,":path:",":x:",":y:",":width:",":height:",":aspect:",":border:CR
    • path — image URL/path; also serves as that image's identity for later removal.
    • x, y — position in terminal character cells (column, row) from the top-left corner.
    • width, height — a plain number is sized in character cells; a value ending in px is treated as literal pixels.
    • aspect — 1 forces a square image (height matches the computed width); anything else uses height as given.
    • border — anything other than N draws a visible border around the image.
  • Remove one image: ESC STX "iD,":path:CR — removes the image previously shown with that same path.
  • Clear all images: ESC STX "iC":CR

Images are also removed automatically on a full clear-screen, on ⋯ → Reset terminal, and on disconnect, so a host program only needs an explicit remove/clear when it wants to take an image down mid-session without also clearing the screen.

An inventory lookup screen with an image the host placed beside the text

Host popup alerts

A host program can pop a blocking browser alert: ESC STX "P" ... "&" message \x19 ... CR (the message text is delimited by a leading & and a trailing EM character, \x19). WebTerm shows it as a native browser alert box; once the user dismisses it, WebTerm sends FF CR LF back to the host as an acknowledgment so the host program knows it's safe to continue.


Opening a local file/URL, and local printing

Two related features hand off from the host to the optional RDM Host Tools helper app on the user's machine:

  • Open a URL or local file: ESC STX "<" url CR opens a normal URL in a new browser tab, or — for a file:// path specifically — hands it to the Host Tools helper app instead (since browsers block navigating directly to local files from a web page). A second form, ESC STX ">" payload CR, always hands off to the helper app and sends FF CR LF back to the host afterward as an acknowledgment.
  • Print to a local printer (AUX/slave print): requires the Host Tools helper app.
    • Wrap a block of output between the same "start slave print" / "stop slave print" escape sequences a real terminal uses for a physically attached slave printer:
      • WYSE: start with DC2 (CHAR(18)), CAN (CHAR(24)) or ESC d #, and stop with DC4 (CHAR(20)). Output after DC2 also shows on screen; after the other starts it goes only to the printer.
      • ADDS: start with ESC 3 and stop with ESC 4.
      • VT: start with ESC[5i and stop with ESC[4i. The output goes only to the printer. Print-screen (ESC[i) and auto print (ESC[?5i) aren't supported.
    • WebTerm captures whatever is written between those markers and, once the block ends, hands it to the helper app to send to the user's default local printer.
    • No separate print protocol is needed beyond those control codes.

If the Host Tools helper app isn't installed for either of these, the user is taken to its download page instead (see Section 8).


Capturing output from a host program

A host program can start and stop the same capture as the toolbar's Capture button, for example to save a report to a file on the user's PC:

  • Start: ESC STX "iRS,":dest:",":encoding:",":file name:CR
    • dest — F downloads a file when the capture stops (the default), C copies it to the clipboard.
    • encoding — U UTF-8 (the default), L Latin-1, the host's bytes as sent. Only used for a file.
    • file name — the name the file downloads as. .txt is added if it has no extension. Leave it empty to use the session name plus the date and time. It goes last, so it may contain commas.
    • If a capture is already running, it is stopped and saved first.
  • Stop and save: ESC STX "iRE":CR
  • Stop and throw the capture away: ESC STX "iRX":CR
* Save a customer list to CUSTOMERS.txt in the user's Downloads folderPRINT CHAR(27):CHAR(2):"iRS,F,U,CUSTOMERS.txt":CHAR(13):EXECUTE "LIST CUSTOMERS NAME CITY STATE BALANCE"PRINT CHAR(27):CHAR(2):"iRE":CHAR(13):

Notes:

  • The capture starts with the first character after the iRS frame and ends just before the iRE frame, even when the frames and the output arrive together. The frames themselves are never part of the capture.
  • WebTerm sends nothing back to the host for these frames, so a program can carry on without waiting, and an INPUT never receives stray text.
  • The user sees a note in the corner when a host program starts a capture, and the toolbar shows the red button and REC timer while it runs. The user can stop it early from the toolbar.
  • A clipboard capture (C) asks the user to click Copy to clipboard when it stops, because browsers only let a page use the clipboard on a click.
  • A tandem tab ignores these frames. Only the primary session's browser captures. A tandem user can still capture from the toolbar.

Identifying the client and querying window size

A host program can ask WebTerm what it is: its version, emulation, screen size and the features it supports. WebTerm answers each query as if the user had typed the reply, ending in a CR, so a program reads it with INPUT. The reply doesn't appear on screen unless the host echoes it, so turn echo off first. The easiest way is to call WT.CLIENT.INFO, which sends the queries and reads the replies for you.

WebTerm information query

Send ESC STX "iQ" CR. WebTerm replies with one line that starts with WT_INFO:, followed by key=value fields separated by ;:

WT_INFO:term=1.6.26;app=2.8.28;emu=WYSE;cols=80;rows=24;caps=DEGIMPSUV
Key Value
term WebTerm's emulator version, the same one the identify query returns
app The WebTerm server version. Blank in the first moment after the page opens, before the page has read it.
emu The emulation: VT, WYSE or ADDS
cols, rows The screen size in effect, the same as the PInitSession.Output query below
caps The capability letters, the same as the capabilities query below
  • Look fields up by name, not by position. Later versions of WebTerm may add fields; skip any you don't know.
  • The WT_INFO: prefix tells the reply apart from anything the user typed ahead.
  • This query is new in emulator version 1.6.26. An older WebTerm ignores it and sends no reply, so check the version from the identify query first, or use the AccuTerm-style queries below.

AccuTerm-style queries

WebTerm also answers these AccuTerm queries, so programs written for AccuTerm keep working.

  • A host program can ask "what terminal client is this?" by sending ESC STX "I" CR; WebTerm replies with an identity/version string (e.g. RDM Web Term 1.6.26;1.6.26;;;;;; + CR), letting a host program detect it's talking to WebTerm specifically (rather than a physical terminal) and branch on version if needed. This mirrors AccuTerm's own ESC STX I release-info query, but WebTerm identifies itself by name rather than claiming to be AccuTerm. Every WebTerm version answers it, so it's the way to check for WebTerm before using the information query.
  • A host program can query WebTerm's supported features with the AccuTerm-style host capabilities query, ESC STX "?" CR. WebTerm replies with platform*product*license*capabilities*services + CR, for example 0*0*1*DEGIMPSUV*g + CR:
    • platform and product are 0, because WebTerm has no AccuTerm-registered platform or product number.
    • license is 1 (single user).
    • capabilities is the subset of AccuTerm's letter codes WebTerm implements today: D WTD download, E execute/open a local file or URL via Host Tools, G GUI (images/popups/alerts), I image display, M query status (the PInitSession.Output query below), P packetized ESC-STX feature-frame messages, S scripting (HScript), U WTD upload, and V this capabilities command itself.
    • services is g (GUI automation) only. WebTerm has no Object Bridge (a) or file converter (b) service.
  • A host program can query the terminal's current column/row size at any point in a session (not just at login) by sending ESC STX "PInitSession.Output" CR; WebTerm replies with "<cols>,<rows>" CR reflecting whatever size is actually in effect, including any custom rows/columns override or a mid-session 80/132-column switch.

Checking for WebTerm from your own programs

The WCE install includes WT.CLIENT.INFO, a cataloged subroutine that sends the queries and returns the answers, so you don't have to handle the replies yourself:

CALL WT.CLIENT.INFO(IS.WT, CLIENT, VER, CAPS, COLS, ROWS, EMU, APP)IF IS.WT AND INDEX(CAPS,"D",1) THEN   * Running in WebTerm, and WTD downloads are availableEND
Argument Returns
IS.WT 1 when the terminal is WebTerm, 0 otherwise
CLIENT The name part of the identify reply, for example RDM Web Term 1.6.26. Another emulator that answers the identify query, such as AccuTerm, shows up here with IS.WT set to 0. Blank when nothing answered.
VER WebTerm's emulator version, for example 1.6.26. This is the terminal's version, not the WebTerm server's.
CAPS The capability letters, for example DEGIMPSUV (listed above)
COLS, ROWS The screen's current size, for example 80 and 24
EMU The emulation: VT, WYSE or ADDS
APP The WebTerm server version, for example 2.8.28

When the terminal isn't WebTerm, only IS.WT and CLIENT are filled in.

  • It sends the identify query first. On emulator version 1.6.26 or later it gets everything else from one information query. On an older WebTerm it uses the capabilities and PInitSession.Output queries instead, and leaves EMU and APP blank.
  • A terminal that doesn't answer, such as a real Wyse, isn't left waiting: the subroutine waits up to 3 seconds for each reply, then returns with IS.WT set to 0.
  • Call it before your program asks the user anything. Keys the user typed ahead arrive in the same input as the replies and could be read as part of them.
  • To try it, run WT.TEST and choose A (Layout / Terminal Info). W sends the information query and shows the raw reply; I calls WT.CLIENT.INFO and shows what it returned.

132-column mode

The host can switch a session between the normal 80×24 size and a wider 132-column mode using the appropriate escape sequence for the active emulation; WebTerm resizes and re-fits the font automatically when it happens. Independent of that, the toolbar's Toggle Terminal Size button lets a user flip between 80 and 132 columns manually at any time.

A 132-column report after the host switched the terminal to wide mode

The bell

When Settings → General → "Play Bell Sound" is on, any BEL character from the host plays a short audible tone.


Function keys — built-in defaults

A function key whose field in Settings is blank still sends a built-in default for the active terminal type. For example, VT100's F1–F12 send the standard xterm sequences. Filling in a field only matters when you want to override that default.

  • Turning the fallback off: Settings → Function Keys → "Send Terminal Default When Blank" controls it. Turn it off to send nothing at all for keys you haven't assigned.
  • Shift, Ctrl and Alt with a function key send their own string when you've set one on that modifier layer, and nothing otherwise. They don't send the plain key's string or its built-in default.
  • The arrow and navigation keys send the codes the terminal's keyboard sends (its terminfo):
    • WYSE (wy50/wy60): the arrows send ^K up, ^J down, ^L right and ^H left. Home sends ^^ (RS), End ESC T, Delete ESC W, Page Up ESC J and Page Down ESC K.
    • ADDS (Viewpoint): the arrows send ^Z up, ^J down, ^F right and ^O left, and Home sends ^A. The Viewpoint keyboard has no End, Insert, Delete, Page Up or Page Down key, so those send nothing.
    • VT100: the ANSI arrows (ESC [ A to ESC [ D) and the VT220 codes for the others (Home is ESC [ 1 ~, Delete ESC [ 3 ~).
    • The End field in Settings → Function Keys overrides End's code in every emulation when it's filled in.
  • Ctrl+Space sends Ctrl-W to the host, so you don't have to fight the browser's own "close tab" shortcut to send that control character.
  • Ctrl+Shift+X starts and stops a capture, and Ctrl+Shift+S opens and closes Settings. Neither is ever sent to the host. Turn them off in Settings → General → Keyboard Shortcuts.
  • Closing or reloading the tab while connected shows a confirmation prompt and sends Ctrl-W to the host first, in case that's what you meant to do.

WCE — Web Code Editor


What it does

WCE lets you open, edit, and compile MultiValue BASIC (or proc) source directly from your browser, using a full code editor (with MV BASIC syntax highlighting) in place of a line editor at TCL. It's driven entirely from the host side — you invoke it as an MV program, and it opens the item in a new browser tab.

A Pick BASIC program open in the WCE editor tab

Using it

From TCL, on an account where the host programs are installed (see Installing the Host Programs):

WCE <file-name> <item-name>WCE DICT <file-name> <item-name>WCE <file-name> <item-name> <item-name2> <item-name3> ...
  • <file-name> <item-name> — opens that item from that file in a new editor tab. If the item doesn't exist yet, WCE offers to create a blank one first.
  • DICT — opens a dictionary item instead of a data item (same file/item arguments, applied against the file's dictionary).
  • Multiple items — list up to 10 additional item names after the first to open each one in its own tab in a single WCE invocation. The same file name applies to every item in the list.
  • WCE locks every item before it opens any tabs. If one of them is locked by another user, or you decline to create a missing one, WCE releases the items it already locked and stops, so you never get a partial set of tabs.
  • Each item stays locked while its tab is open, including across saves, and is released when that tab closes.
  • Items larger than the configured size limit (2,000,000 characters by default, see WCE.CONTROL) are refused.

The editor tab

Each item opens in its own browser tab (editor.html). Across the top is a menu bar — File, Edit, Build, Insert, Go, View, Help — followed by the Save and Compile buttons, an Exit button if you've turned it on in WCE Settings, and Back. On the right are an orange ● when there are unsaved changes, the item's file and name, the host platform (D3, jBASE or MVsharp; WCE 1.x instead when the host runs an older WCE), the latest status (for example "Saved 2:41 PM"), and the red ✕ to close.

Open a menu by clicking it, or press Alt plus the underlined letter (Alt+F for File). On a Mac the key is Option (Option+F), so Option plus one of the menu letters opens the menu instead of typing a special character in the editor. Once a menu is open, the arrow keys move around it and across to the other menus, Enter runs the highlighted item, and Esc closes it. Greyed-out items say why when you hover over them. Help → Keyboard Shortcuts lists every shortcut, and F1 opens a searchable list of every command.

Menu Command Shortcut
File Save Ctrl+S
Revert to Last Save
Compare with Last Save
Compare with Pasted Source…
Download a Copy
Close Ctrl+Shift+X
Edit Undo Ctrl+Z
Redo Ctrl+Y
Find Ctrl+F
Replace Ctrl+H
Toggle Comment Ctrl+/
Format Document Shift+Alt+F
Format Selection Ctrl+K Ctrl+F
Build Compile Ctrl+F12
Catalog
Compile + Catalog Ctrl+Shift+F12
WCE Settings…
Insert Value Mark (ý) Ctrl+]
Sub-Value Mark (ü) Ctrl+\
Go Back Alt+←
Go to Line Ctrl+G
Go to Label Ctrl+Shift+O
Find Jumps to Label Shift+F12
Open Program F12
Peek Alt+F12
Next Problem F8
Previous Problem Shift+F8
View Language, Theme, Font Size, Indent Size
Font Size: Bigger Ctrl+=
Font Size: Smaller Ctrl+-
Font Size: Reset Ctrl+0
Word Wrap Alt+Z
Minimap, Show Whitespace, Highlight VM/SVM Marks, Code Checks
WCE Settings…
Help Keyboard Shortcuts Ctrl+K Ctrl+S
Command Palette F1
About WCE: WebTerm version, host platform, links
  • Save sends your edited content back to the host, which writes it to the item exactly as shown, including leading blank lines and indentation. The ● goes away once the host confirms the save.
  • Compile compiles the item with the configured compile verb (the host's WCE.CONTROL one, unless WCE Settings changes it for your profile). The result appears in a notification in the editor tab: the command that ran, with the compiler's output underneath one line per line. It's marked green with a ✓ when the output reports success (for example D3's [241] Successful compile!) and red when it reports errors, and the status in the menu bar says Compiled or Compile errors to match. The notification stays for 30 seconds; the × closes it sooner.
  • Catalog catalogs the item with the configured catalog verb, chosen the same way.
  • Compile + Catalog compiles, then catalogs, and shows both outputs together. The catalog step runs even if the compile reported errors, so check the compile output.
  • Close (or the toolbar's Exit button, when it's shown) closes the tab and releases its item's lock. Once every editor tab tied to a terminal session is closed, the host-side WCE program returns to TCL.
The editor after Compile: the menu bar, and the compiler output in a green notification

Ending an editing session

While WCE is running, the terminal tab shows an "Editing opened in a new tab" popup in the corner. WCE on the host is waiting for the editor, so anything you type in the terminal goes to WCE rather than TCL until the session ends. It ends in one of two ways:

  • Close every editor tab for that session. Closing the last one returns WCE to TCL.
  • Click End Editing Session in the terminal's popup, and confirm. WCE returns to TCL straight away and releases every item it locked, even if editor tabs are still open. Use this if an editor tab got lost or closed without WCE noticing.

An editor tab whose session has ended shows a yellow bar saying so. It can no longer save, compile or open programs, but your text stays in the tab, and any unsaved changes are kept as a draft (see Unsaved changes and drafts). To save them, run WCE on the item again and click Restore, or use File → Download a Copy. Starting a new WCE in the same terminal also ends any earlier session's tabs that are still open.

Save, Compile and Catalog always act on the file the tab's item came from, so tabs opened from different files each compile and catalog into their own file.

Catalog, Compile + Catalog and opening called programs need WCE 2.0 or later on the host; with an older WCE they're greyed out, and the menu bar shows a grey WCE 1.x tag in place of the platform (hover it for details). Save and Compile work with any WCE version. To update, re-run the install from Settings → About (see Section 12).

You can have several editor tabs open at once (from one or more WCE invocations); each is tracked independently.


Navigating and autocomplete

  • Jump to a label — double-click the label name after GOSUB, GOTO, GO TO or RETURN TO, including any name in an ON x GOSUB A, B, C list, and the editor jumps to where that label is defined.
    • Both alphanumeric labels (PROCESS.LOOP:) and numeric statement labels (100) work.
    • A label can even be a BASIC keyword, such as LOOP:, when nothing but a comment follows the colon on that line. (PRINT:, CRT: and DISPLAY: are still statements.)
    • F12 does the same from the keyboard, and Alt+← or the Back button returns you to where you jumped from.
  • List all labels — Ctrl+Shift+O lists every label in the program; type to filter, then Enter to jump.
  • Find every GOSUB to a label — put the cursor on a label (the definition or any jump to it) and press Shift+F12.
  • Autocomplete — suggestions include the variables, file variables, EQUATEs, labels and other names already written in this program, updated as you type, as well as keywords, functions and snippets. Matching is fuzzy, so REC finds CUST.REC. Right after GOSUB/GOTO only labels are suggested.
  • Dotted names such as CUST.REC are treated as one word by double-click, Ctrl+←/→ and autocomplete.
  • System variables such as @AM, @VM and @USER have their own colour.
  • The editor uses the syntax dialect for the host's platform (D3, jBASE or MVsharp). It's detected automatically with WCE 2.0 or later on the host.
  • On an MVsharp host the editor colours MVsharp's own statements and functions as well: clause words such as FROM, SETTING and CAPTURING, the word operators EQ, NE, GT, LT, GE, LE and MATCHES, and functions such as XDOMOPEN, PARSEJSON and FILE.COPY. A function name is coloured only where ( follows it, so a variable called COUNT or DATE stays plain, and a word that is both a statement and a function (CONVERT, LOCATE) takes the colour that fits how it is used. A * or ! after a statement number starts a comment. D3 and jBASE hosts use the standard word list.
Autocomplete suggesting variables and labels already used in the program

MVsharp embedded C#

MVsharp programs can contain C# in tagged sections: [CSHARP] … [/CSHARP] in the program's code, and [REFERENCES], [USING] and [CLASSES] sections for what that C# needs. The editor colours the contents of these sections as C#, while the code around them keeps its BASIC colouring. The opening tag must start its line; the closing tag can come anywhere after it, including later on the same line ([USING] System.Text; [/USING]). Tags aren't case-sensitive.

Inside these sections the BASIC features stay out of the way:

  • Code checks don't read the C# as BASIC, and autocomplete doesn't offer BASIC suggestions.
  • Label jumps and Go to Definition don't apply.
  • Names used in the C# don't show up in autocomplete for the BASIC code.

A section's own problems are underlined as warnings:

  • an opening tag with no closing tag (the section then runs to the end of the program)
  • a section closed by a different tag ([CSHARP] … [/USING])
  • a closing tag with no section open
An MVsharp program whose [CSHARP] and [USING] sections are coloured as C#

Code checks

While you type, the editor underlines problems it can spot without compiling:

  • Red (error):
    • a statement that starts with a word that isn't a BASIC statement and isn't an assignment, for example a typo like PRIT "HELLO" or I X = 1 THEN ("Unknown statement PRIT. Did you mean PRINT?"). Statements after THEN/ELSE on the same line are checked too. Assignments of every form (X = 1, REC<1,2> = "A", ARR(3) += 1, MSG := "B") are fine. On an MVsharp host, MVsharp's own statements and a function called on its own line, such as CACHE("_VOC"), are fine too.
    • a GOSUB/GOTO (or ON x GOSUB list entry) to a label that isn't defined in this program, with a "Did you mean …?" suggestion when there's a close match.
    • a label defined twice.
  • Yellow (warning): block structure that doesn't match up — for example a LOOP with no REPEAT, a FOR with no NEXT, an IF … THEN or READ … ELSE block with no END, or an END CASE with no BEGIN CASE. A plain END at the end of the program is fine, and so is a REPEAT at the end of a line, as in UNTIL X > 5 DO REPEAT.

Hover over an underline to read the message, and press F8 / Shift+F8 to step through them. When a message suggests a fix ("Did you mean PRINT?"), put the cursor on the underlined word and press Ctrl+. (or click the lightbulb), then Enter, to apply it. The warnings come from reading the program's structure rather than compiling it, so the compiler's own output is still the final word. Turn the checks off with View → Code Checks.

Code checks underlining an unknown statement, with the "Did you mean PRINT?" message

Formatting

Edit → Format Document (Shift+Alt+F) re-indents the whole program by its block structure: the contents of IF … THEN / ELSE … END, LOOP … REPEAT, FOR … NEXT, BEGIN CASE / CASE … END CASE, and READ / OPEN / LOCATE … THEN / ELSE / LOCKED … END blocks move in one level, and WHILE … DO / UNTIL … DO line up with their LOOP. Format Selection does the same for just the selected lines.

Code under a NAME: label — a GOSUB routine — is indented one level from its label, and the RETURN that ends the routine lines up with the label again. (A RETURN inside an IF … END or other block stays indented with that block.) Numeric statement labels (100) don't start an indented region, since they're usually GOTO targets inside the main code.

An MVsharp embedded C# section (see above) doesn't change the BASIC indentation around it. Its opening tag is indented like a statement at that point. The C# inside moves by the same amount, so its own layout is kept, and a closing tag on its own line lines up with the opening tag.

Formatting only ever changes the spaces at the start of lines, so it can't change what the program does. Label lines and comments that start in column 1 are left exactly where they are, blank lines are emptied, and tabs at the start of a line become spaces. The indent size (3 spaces unless you change it) is set under View → Indent Size. Ctrl+Z undoes a format in one step.

A program before (left) and after (right) Format Document, shown with Compare with Last Save

Unsaved changes and drafts

  • The orange ● in the menu bar, and in the browser tab's title, means there are changes the host hasn't confirmed saving yet. Undoing back to the saved text clears it too.
  • File → Revert to Last Save throws away your changes and goes back to the last copy the host saved (it asks first).
  • File → Compare with Last Save shows the last saved copy and your current text side by side, with the differences highlighted. Esc closes it.
  • File → Compare with Pasted Source… compares the item as it is in the editor now (unsaved edits included) with source you paste in, for example a copy from another account or an older version.
    • Paste into the empty left pane. The right pane is the item and can't be changed from here.
    • The count at the top shows how many blocks differ (Identical if none), and ↑ / ↓ step through them.
    • Inline switches to a single-column view. Ignore leading/trailing spaces (on by default) can be turned off to see indentation changes.
    • The pasted text is never sent to the host and nothing in this window saves. It is kept until the editor tab closes or reloads, so reopening the compare shows it again.
  • File → Download a Copy saves the current text to a .txt file on your computer.
  • Drafts: while you have unsaved changes, the editor keeps a copy of them in this browser.
    • If the tab closes, the browser crashes, the terminal session drops, or the editing session ends before you save, the next time you open that item in WCE a yellow bar offers to Restore those changes (as unsaved edits you can then save) or Discard them.
    • Drafts are cleared once the host confirms a save or you close the tab on purpose. Closing a tab whose editing session has already ended keeps its draft.
    • Items over 1 MB aren't kept as drafts, and drafts stay in the browser they were made in.
Compare with Last Save showing unsaved edits side by side with the saved copy

View settings

The View menu's settings — language, theme, font size (also Ctrl+= / Ctrl+- / Ctrl+0), indent size, word wrap, minimap, visible whitespace, highlighting of value/sub-value marks (ý and ü get a coloured box, with a tooltip saying which they are) and code checks — are remembered in this browser for every editor tab.

The View menu: language, theme, font and indent size, word wrap, minimap, code checks and WCE Settings

WCE Settings

View → WCE Settings… (also in the Build menu and the F1 command list) holds settings that belong to a connection profile, so different hosts can work differently:

  • Compile verb and Compile options — the command Compile runs, in place of the host's own. Options go after the file and item, so a compile verb of COMPILE with options (D runs COMPILE BP MY.PROG (D.
  • Catalog verb and Catalog options — the same for Catalog. Compile + Catalog uses both.
  • Show an Exit button next to Compile — adds an Exit button to the toolbar. It does the same as the ✕ in the corner.

Leave a verb or options field blank to use the host's own value from WCE.CONTROL, which is shown next to each field. If the host has default options you don't want, you can't blank them out from here; type the options you do want instead. The Preview line shows the commands the host will run for the item you're editing. Use host defaults clears all four fields.

The settings are saved in this browser under the name of the session's profile (the dialog shows which). A session with no profile name keeps its own settings under its host and port. Every editor tab opened from that profile uses them, including tabs already open. Deleting a profile deletes its WCE Settings, and exporting and importing profiles carries them along.

Changing the compile and catalog commands needs WCE 2.1 or later on the host. With an older WCE those fields are greyed out; re-run the install from Settings → About (see Section 12). The Exit button works with any version.

The WCE Settings dialog: compile and catalog verbs and options, a preview of the commands, and the Exit button option

Opening and peeking at called programs

With WCE 2.0 or later on the host, you can get to the source of another program straight from the one you're editing:

  • Open it in a new tab — double-click one of these:

    • the program name in CALL NAME or ENTER NAME
    • the first word inside an EXECUTE, PERFORM or CHAIN string (EXECUTE "MY.REPORT ...")
    • either word of a $INCLUDE/INCLUDE/$INSERT

    Double-click asks "Do you want to open <name>?" first, so a stray double-click doesn't open anything. Press Enter or click Open to go ahead, or Esc/Cancel. F12 or right-click → Open Program in New Tab opens it straight away.

    It opens locked, in its own tab. That tab saves, compiles and catalogs against the program's own file, even when that file is in another account.

  • Peek at it — Alt+F12 or right-click → Peek Program / Label shows the program inline, in a window under the current line, without opening a tab or locking it. Press Esc to close it. Anything typed in the peek window isn't saved; use Open for that. Alt+F12 on a GOSUB/GOTO label peeks at the label instead.

WCE finds the program's source the way your platform records it:

Platform Where WCE looks
D3 The program's MD entry. It must be a VR entry; attribute 4 names the source file and item, e.g. dm,bp, list-users.
MVsharp The program's MD entry. It must be a Program entry; attribute 4 names the source file, e.g. SOURCE-MIS,SOURCE,.Lib (file SOURCE in account SOURCE-MIS). The item is the program name.
jBASE jshow -c <name>. WCE uses the first entry listed, the one that actually runs, and ignores copies marked (DUP!!). Its source file line names the file; for a main program the item is the program name.

If that doesn't find it, WCE tries each file in the search list in WCE.CONTROL attribute 5, in order. Anything else, such as a built-in verb, a PROC or a file pointer, reports "<name> is not a cataloged program."

A few cases can't be opened: CALL @VAR picks its subroutine at run time, and an item locked by another user opens only as a peek.

Peek showing the PRICE.CALC subroutine inline under its CALL, without opening a tab

WCE.CONTROL settings

WCE keeps its settings in the WCE.CONTROL item in the WTS file. WCE creates it with defaults the first time it runs, and fills in any missing attributes on later runs, but it never overwrites a value that's already there. Re-installing WCE leaves it untouched. There's no settings screen for it; edit the item on the host. Users can change the compile and catalog commands for their own profile in WCE Settings, which take the place of attributes 1–4 when filled in.

Attribute Meaning Default
1 Compile verb BASIC on jBASE, COMPILE on D3 and MVsharp
2 Extra text added after the file and item on the compile command (none)
3 Catalog verb CATALOG
4 Extra text added after the file and item on the catalog command (none)
5 Source files to search, in order, when a called program isn't found through MD or jshow (multi-valued, one file per value) (none)
6 Largest item WCE will open, in characters 2000000
7 Settings layout version, maintained by WCE 2

For a dictionary item (WCE DICT ...), the commands are run as <verb> DICT <file> <item>.


Notes and limits

  • WCE is a host-driven feature — there's no "Open in WCE" button in the browser; you always start it by running the WCE program from TCL.
  • Only plain data/dictionary items are supported (no binary content).
  • One WCE invocation opens items from one file.

WTD — WebTerm Data (Upload/Download)


What it does

WTD moves data between your browser and the MV database:

  • Download (export) a set of MV items to a CSV or Excel file on your PC.
  • Upload (import) a CSV file or Excel workbook from your PC into the MV database.

It's modeled on the Manual Upload/Download utility found in other MultiValue terminal products, with the same terminology and prompt sequence where practical, so it should feel familiar if you've used one before. The one difference is that there's no protocol choice: the browser's own connection does the job a separate transfer protocol would otherwise handle.


Starting it

From TCL, on an account where the host programs are installed (see Installing the Host Programs):

WTD

Run bare, WTD walks you through everything with prompts. To fill in a step-by-step form in the browser instead, answer W, or start it directly with WTD W or the toolbar's ⋯ → Data upload / download… — see The wizard. Any value you'd otherwise be prompted for can also be supplied directly on the command line — anything left off just gets prompted for — so the same program works equally well typed by hand or driven unattended from a PROC/paragraph:

WTD WWTD S <mv-file> <item-list|*|(listname|blank> <attr-list|*|+> <pc-file-name> [<Y/N header> [<Y/N explode> [<T/C delimiter>]]]WTD R <mv-file> <item-id> [<Y/N overwrite>]WTD R S <mv-file> <item-id> [<Y/N overwrite>]WTD R B <mv-file> <Y/N use-header> <attr-list-or-*-or-placeholder> <header-skip> <Y/N auto-id> <auto-id-prefix> <auto-id-start> <Y/N overwrite>

The first answer picks the direction:

Answer Direction Meaning
S / SEND / DOWNLOAD Download Export MV items to your browser as a file
R / RECEIVE / UPLOAD Upload Import a browser-picked CSV or Excel file into the MV database
W / WIZARD Either Opens the wizard in the browser, which asks for the direction itself
H / ? — Shows a short help summary
E / EXIT — Cancels
WTD run bare at TCL, asking for the direction

The wizard

The wizard collects the same answers as the prompts below, in a form that opens over the terminal. It knows the file you're working with: it checks that the host can open it and reads its dictionary, so you pick fields from a list instead of typing attribute numbers.

Start it one of three ways, from a TCL prompt:

  • On the toolbar, click ⋯ and then Data upload / download…. It types WTD W for you.
  • Type WTD W.
  • Type WTD and answer W.

Choose Download or Upload, then work through the steps with Next and Back. Enter in a text field is the same as Next. The last step's button starts the transfer, and the wizard closes while the usual progress and result popups take over. Cancel, the ✖ button and Esc all close the wizard and return you to TCL without transferring anything.

If the wizard doesn't appear, the host is still waiting for it: press Enter in the terminal to get TCL back. That happens when the terminal isn't WebTerm, or is a WebTerm older than the wizard. If the host instead answers "Please answer S, R, H or E.", its WTD programs are older than the wizard; install them again.

The wizard runs one transfer each time it's opened. The prompts and command-line arguments described in the rest of this section work exactly as before.

The WTD wizard open over the terminal, asking whether to download or upload

Choosing the host file

Both directions ask for a host file. Type its name, or click Browse files to pick it from a list of the account's files. With the list open, typing in the name field narrows it to the names containing what you typed; click a name to use it. The list is read from the host the first time you open it, which can take a few seconds on an account with a large MD.

The list is a help, not a limit. A file that isn't on it can still be typed, and the wizard checks any name with the host when you click Next. What the list holds depends on the host:

  • D3 and MVsharp — the file and synonym entries in the account's MD: items whose first attribute starts with D, Q or F.
  • jBASE — the same kinds of entry in the MD or VOC, if the account has one, plus everything in the account's directory that opens as a file. Files reached only through JEDIFILEPATH aren't listed.

A list of more than 300 matches shows the first 300; type part of the name to narrow it. If Browse files isn't there, the host's WTD programs are older than the file list; install them again.

The wizard's File step for an upload with Browse files open, listing the account's files

Wizard download

  1. Source — the host file, and which items to export: every item, a list of item-ids you type (one per line or comma-separated), or a saved list by name. If a select list was active when you started the wizard, a fourth choice exports those items. An item-id containing a comma can't be exported from that list, the same limit as an item list typed at the prompt.
  2. Columns — choose the columns and their order, or take every attribute with or without the item-id. Available lists Item-ID and each field in the file's dictionary; click one to add it. Use the arrows to reorder and ✖ to remove. Add an attribute by number adds an attribute the dictionary doesn't name. A column added from the dictionary gets the field's name as its header; a numbered one gets "Attribute <n>".
  3. Output — the file name on your PC, CSV or Excel, whether the first row is a header, whether each multivalue gets its own row, and (CSV only) comma or tab. Changing the format changes the file name's extension, and the other way round.

The dictionary fields offered are items whose first attribute starts with A or S, or with D when the item isn't named after the file, and whose second attribute is a number. For a multipart file such as INVOICE,2012, the wizard reads the dictionary of INVOICE. A field that points at attribute 0 is the item-id and is offered as Item-ID.

The wizard's Columns step for a download: the CUSTOMERS dictionary fields, picked and ordered

Wizard upload

  1. File — choose the CSV file or Excel workbook, say whether it holds many items (one row per item) or one item (one row per attribute), and name the host file to upload into. If the workbook has more than one sheet, a Sheet list appears so you can pick the one to upload; it starts on the first sheet.
  2. Mapping (many items) — each column of the file is listed with its heading, a sample of its values and where it goes: Item-ID, a dictionary field, an attribute by number, or Don't import.
    • The wizard fills this in from the header row: a heading of 0, ID, ITEM-ID or @ID goes to Item-ID, a number goes to that attribute, and a dictionary field name goes to that field. With no header row, or one it can't match at all, it assumes the item-id comes first and the attributes follow in order, the layout a * download produces.
    • Rows to skip at the top and The next row is a header say where the data starts. Changing either one re-reads the header and resets the mapping.
    • Each attribute can be used by one column only.
    • Generate item-ids gives rows without an item-id a prefix plus a running number. It's always on when no column is mapped to Item-ID. Without it, rows with a blank item-id are skipped.
    • Replace items that already exist — unticked, those rows are skipped and counted in the result.
    • Rows that are blank in every mapped column aren't sent.
  3. Item (one item) — the item-id to write, and whether to replace it if it exists.

The result popup is the same one a prompted upload shows: how many items were written, and how many were skipped and why.

The wizard's Mapping step for a bulk upload: each column of the file matched to an attribute of CUSTOMERS

Download (Send)

Prompts, in order:

  1. Source file — the MV file to export from.
  2. Item list — one of:
    • a comma-separated list of item-ids
    • * for every item in the file
    • (listname to export a specific saved list (loaded the same way a saved SELECT/GET-LIST list would be)
    • left blank, to export whatever list is already active on that file from an earlier SELECT/GET-LIST you ran yourself before starting WTD
  3. Attributes to transfer — a comma-separated list of attribute numbers and/or dictionary field names, in the order you want them as columns. * means every attribute with item-id first; + means every attribute without the item-id; an explicit 0 in a list means "put the item-id here." Column headers (see next prompt) use the dictionary name for a named entry or "Attribute <n>" for a numeric one.
  4. Target file name — the name of the file that lands on your PC. The extension picks the format: .xlsx or .xls produce a real Excel workbook; anything else produces a CSV.
  5. Generate Header Record? — Y adds a first row of column labels. If your attribute list was *, the header row is just a single *, matching the same convention other versions use for that case.
  6. Explode MultiValue Fields? — Y gives every multivalue its own row (single-valued attributes repeat on each row that came from exploding a multivalued one alongside them); N (default) joins a field's multiple values into one cell, separated by semicolons.
  7. Field delimiter — Tab or Comma (default) for the CSV's own field separator. Only applies to CSV output; an Excel file has no such setting.

Once you answer everything, a popup on the terminal screen tracks progress ("Download in progress", with a bar that fills as the host works through the items and a count of how many are done, → "Download complete: filename (N row(s))."), and the file itself lands wherever your browser normally saves downloads. The popup stays up until you click Dismiss, so you always get positive confirmation even for a transfer that finishes in the blink of an eye.

A WTD download: the prompts answered at TCL and the Download complete popup

Upload (Receive)

Answering R offers a second choice — which shape of import you want:

  • B / BULK (the default if you just press Enter) — many items, one row of the file per item, matching the shape other versions use for import.
  • S / SINGLE — this app's own shape: a single item, one row of the file per attribute of that item, with the row's columns becoming the multivalues within that attribute.

Single-item upload prompts for: target file, target item-id, and whether to overwrite an existing item. Once you answer, the browser opens a file picker; choose your CSV file or Excel workbook and the upload streams in, attribute by attribute.

Bulk upload prompts for:

  1. Target file.
  2. Use Header Record? — Y (the default) means the file's own first row tells WTD which attribute each column belongs to (same numbers/names/* vocabulary as the download attribute list, including 0 for item-id). N means you supply that mapping yourself in the next prompt instead.
  3. Attributes to transfer — only asked when you answered N above; same syntax as the header row would have used.
  4. Rows to skip before the header row (or before the data, when you answered N) — extra rows at the top of the file to ignore, such as a title line or a blank line, before the header or data begins (0 by default). Don't count the header row itself. If the row WTD lands on is blank, the upload stops and tells you which row of the file it read.
  5. Automatically generate item-ids? — Y generates a sequential id (a constant prefix plus a starting number, asked next) for any row that doesn't otherwise supply one via a mapped 0 column. If you say N and a row doesn't have an item-id either way, that row is skipped rather than failing the whole import — the final message tells you how many rows were skipped and why.
  6. Overwrite existing items?

Like download, the browser shows a progress popup through file selection, processing, and upload. Its bar fills while the rows are being sent, then slides back and forth while the host stores them: the host reports nothing until it has finished, so that part shows only that the upload is still running. It ends in a dismissible result: for single-item upload, "Upload completed. N attribute(s) written…"; for bulk, a breakdown of how many items were written vs. skipped and why (no item-id, or already existed with overwrite off).

On MVsharp: some MVsharp terminal modes drop control characters from typed input. Before WTD 2.0, that ran each uploaded row's columns together into one value, and the wizard failed with "asked for something this host program does not know". WTD 2.0 with WebTerm 2.8.21 or later sends uploads and wizard requests as plain text, so they work in every mode. If you see either symptom, update WebTerm and redeploy WTD from Settings → About.

You can cancel from the initial file-picker prompt without affecting anything on the host.

A WTD bulk upload: the browser's upload prompt for the file

Multipart files

Every transfer works with a multipart file (a file with several data sections, such as INVOICE,2012): type the name with its comma wherever WTD or the wizard asks for the host file, for example WTD S INVOICE,2012 * * invoices-2012.xlsx. Dictionary field names come from the file's own dictionary (INVOICE), which its parts share. The wizard's Browse files list shows only the file itself, so type the part's name.

This needs WTD 2.1 or later on the host. With an older WTD, an upload to a multipart file stops with "header mismatch", an Excel or tab-delimited download comes out as a comma-delimited CSV, and the wizard says the name needs WTD 2.1. Install the host programs again to update them.


File format notes

  • Uploads accept standard CSV: comma-separated, double-quote-quoted fields, embedded commas/quotes inside quoted fields.
  • Uploads also accept Excel workbooks (.xlsx, .xlsm, .xls) directly, with no need to save them as CSV first:
    • Each cell is uploaded as the text Excel displays, the same as saving the sheet as CSV would give. A date arrives as a date (10/7/2026), a formula as its result, and a number with its formatting (a cell shown as $1,234.50 uploads as $1,234.50). Format a column as General or Text in Excel if you want the plain value.
    • One sheet is uploaded. A workbook with several sheets asks which one: the wizard shows a Sheet list, and the prompted upload shows a button for each sheet after you choose the file. Hidden sheets are not offered.
    • Rows keep their position in the sheet, so row 3 is the third row uploaded even if rows 1 and 2 are empty. Empty rows after the last row of data are ignored.
    • A password-protected workbook can't be read. Remove the password or save it as CSV.
    • Excel files are read by a spreadsheet library the page loads from the internet. If your network blocks it, the upload tells you so; save the file as CSV and upload that.
  • Downloads produce CSV by default, or a real binary Excel file (not just CSV with an .xls/.xlsx name) when you name the target file with either extension.

Calling WTD from your own programs

If you're writing an application that needs to trigger a transfer without any chance of an interactive prompt, you have two options:

  • CALL the underlying subroutine directly — WTD.DOWNLOAD, WTD.UPLOAD, or WTD.UPLOAD.BULK — each is a plain, fully non-interactive subroutine; see the parameter comments at the top of each program in downloads/DeployWTD.txt for the exact argument list (the source is not left on the host). WTD.UPLOAD and WTD.UPLOAD.BULK set PROMPT "" while they read the uploaded rows, and the setting stays in effect after they return, so set your own prompt character again afterwards if your program relies on it.
  • EXECUTE the WTD mainline itself with every positional argument supplied, e.g. EXECUTE "WTD S CUSTOMERS * 0,CUSTNAME customers.csv Y N" CAPTURING REPLY — since every value is present, it runs straight through with no prompts.

To open the wizard from your own program instead, CALL WTD.WIZARD(STATUS.CODE, STATUS.MSG). It returns when the transfer finishes or the user cancels. It reads any active select list when it starts (to offer it as the items to download), so the list is used up afterwards, and it leaves PROMPT "" in effect.


Installing the Host Programs

Both WCE and WTD need their MV BASIC programs installed on your host account before they'll work — they're separate program files, so you can install one without the other.


From the browser (recommended)

Open Settings → About, and you'll find two expandable sections near the bottom:

  • "Deploy host tools to remote server" — installs WCE. Expand it and choose your host's flavor: D3, jBase, or MVsharp.
  • "Deploy WTD (WebTerm Data) tools to remote server" — installs WTD, with the same three flavor choices.

Clicking a link streams the matching install script straight into your current terminal session over the socket, exactly as if you'd pasted it in yourself at TCL — no separate upload step. Once it finishes, the Settings panel closes automatically.

Make sure you're sitting at a TCL/ECL command prompt (not, say, mid-way through another program) before clicking, since the install script is typed into whatever's currently listening for input.

The install first creates the program file (WTS for WCE, WTD.BP for WTD), then checks it with COUNT <file> before typing anything else. If the host says the file doesn't exist, the install stops there and WebTerm tells you so. That way no program lines end up typed at TCL. Create the file yourself, then run the install again. Older jBASE releases reject the plain CREATE-FILE <file> the jBase install uses; on those, create it with CREATE-FILE WTS TYPE=UD (or CREATE-FILE WTD.BP TYPE=UD). If the file is already there, the install carries on as normal.

Settings, About with both install sections expanded: D3, jBase and MVsharp links for WCE and WTD

Manually

Each install script is also available as a plain downloadable file, if you'd rather review it first or paste it by hand. Each feature has one install script for every host type: downloads/DeployWCE.txt for WCE and downloads/DeployWTD.txt for WTD.

Before pasting a script by hand, replace its placeholders. The browser install does this for you.

Placeholder D3 jBase MVsharp
{{CREATE_FILE}} (first line), WCE CREATE-FILE WTS 3 11 CREATE-FILE WTS CREATE-FILE WTS TYPE=DIRECTORY
{{CREATE_FILE}} (first line), WTD CREATE-FILE WTD.BP 3 11 CREATE-FILE WTD.BP CREATE-FILE WTD.BP TYPE=DIRECTORY
{{PLATFORM}} (WCE and WTD) D3 JBASE MVSHARP

Get to a TCL prompt on the account where you want the tools installed, then paste the whole file's contents in. A pasted script can't check its own first line, so if CREATE-FILE fails (as it does on older jBASE releases), create the file yourself first, for example CREATE-FILE WTS TYPE=UD, and paste the script again. Each script creates its own program file (WTS for WCE, WTD.BP for WTD), pastes in every program the feature needs, compiles and catalogs each one, then deletes the pasted source — cataloging is what makes them callable by name from any account that has access to it, not just the one you installed on.

Only the compiled, cataloged programs stay on the host. The source is removed at the end of the install whether or not it compiled, so if a program fails to compile, read the compiler's messages on the screen and run the install again once the cause is fixed.


What gets installed

WCE installs three compiled programs from file WTS: WCE itself; WT.TEST, a menu-driven test program that exercises each WebTerm host feature; and WT.CLIENT.INFO, a subroutine your own programs can call to find out whether they're running in WebTerm (see Checking for WebTerm from your own programs). Each of WT.TEST's menus and tests starts on a cleared screen and waits for Enter before going back to the menu, so a host that pauses long output a page at a time can't interrupt a test. WCE also creates a small WCE.CONTROL settings item the first time it runs (see WCE.CONTROL settings).

WTD installs seven compiled programs from file WTD.BP:

  • WTD — the mainline program you actually run from TCL.
  • WTD.DOWNLOAD, WTD.UPLOAD, WTD.UPLOAD.BULK — the three subroutines that do the real work, independently callable from your own programs (see Calling WTD from your own programs).
  • WTD.WIZARD — the host side of the wizard: it opens the form in the browser, lists the account's files, answers its questions about the chosen file, and runs the transfer through the three subroutines above.
  • WTD.RESOLVE.ATTRS, WTD.INGEST.ROWS — shared internal helpers used by the above; you shouldn't need to call these directly.

Re-installing / updating

Re-running an install script for either feature is safe — it pastes each item's source in again, recompiles and re-catalogs it, and removes the source afterwards, so you can use the same install flow to pick up a newer version later. WCE's WCE.CONTROL settings are kept as they are.

The WTD wizard needs a WTD install that includes WTD.WIZARD. An account that had WTD installed before the wizard was added needs the WTD install run again before WTD W or ⋯ → Data upload / download… button will work.


Embedding WebTerm in an iframe

WebTerm can be embedded as a bare terminal inside another page's <iframe>, with the header/toolbar and Settings modal removed entirely — useful for surfacing a terminal inside an internal portal, kiosk app, or another product's UI without WebTerm's own chrome around it.


Turning it on

Add embed=1 to the terminal URL, e.g.:

https://your-webterm-host/index.html?embed=1&host=10.0.0.5&port=23&protocol=telnet&termType=vt100&connectOnLoad=true
  • embed=1 hides #controls (the toolbar) and the Settings modal permanently — unlike Settings → General → Display → "Auto-Hide Toolbar", nothing brings them back, including moving the mouse near the top edge. There's no in-page way to open Settings or click Connect once embedded.
  • There's no Connect button in embed mode, so pass connectOnLoad=true, plus the connection fields it needs (host, port, protocol, termType, etc.), so the session starts itself.
  • Any other setting normally reached from the Settings modal (colors, function keys, custom rows/columns, and so on) can be set the same way. See Section 3 for the full field list, or build the link with the Dashboard's URL Builder tab and add embed=1 to the result by hand. embed=1 must be a plain setting: on a plain link add &embed=1, and on an encoded link put ?embed=1 just before the #wt=.
  • Every other URL — anything without embed=1 — behaves exactly as before; this is opt-in per link, not a server-wide mode.
WebTerm opened with embed=1: the bare terminal, no toolbar

The admin Dashboard is never embeddable

dashboard.html (and its underlying API routes) refuses to render inside a frame at all, from any origin, embed mode or not — the server sends the response headers that tell every browser to block it. This is intentional: an embedded WebTerm is meant to expose the terminal only, never the session-monitoring/admin surface, and there's no way to reach the Dashboard from inside an embedded terminal page to begin with.