Configure the InterSystems VS Code Extensions

settings.json

Here is the simplest settings.json file content for an ObjectScript project (connection details are managed by the InterSystems Server ManagerOpens in a new tab, as described in Configuring a Server):

{
    "objectscript.conn": {
        "server": "iris",
        "ns": "USER",
        "active": true
    }
}

If you need ObjectScript compilation flags other than the default ones, add an objectscript.compileFlags property to settings.json (more compileFlags information is available on the settings reference page):

{
    "objectscript.conn": {
        "server": "iris",
        "ns": "USER",
        "active": true, 
    },
    "objectscript.compileFlags": "cuk/compileembedded=1"
}

launch.json

Here is the simplest launch.json file content, with which you can debug the method Test in the class Example.Service, passing 2 parameters as input (see Running and Debugging for more information):

{
    "version": "0.2.0",
    "configurations": [
        {
            "type": "objectscript",
            "request": "launch",
            "name": "Example.Service.Test", 
            "program": "##class(Example.Service).Test(\"answer\",42)"
        }
    ]
}

If you want to debug a running process, launch.json should have a section like this, which will present a dropdown menu of running processes:

{
    "version": "0.2.0",
    "configurations": [
        {
            "type": "objectscript",
            "request": "attach",
            "name": "Example-attach-to-process", 
            "processId": "${command:PickProcess}"
        }
    ]
}

Note that configurations is an array, so you can define multiple configurations and choose the one to use from a dropdown menu in the Debug pane.

Multi-Root Workspaces and Server-Side Editing

If your project requires more than a single root folder, you need to use a feature called multi-root workspaces. See Multi-Root WorkspacesOpens in a new tab in the VS Code documentation.

In this case settings are stored in a file with a .code-workspace file extension. This workspace file can be located anywhere. It defines what root folders the workspace consists of, and may also store other settings that would otherwise be stored in settings.json or launch.json. Settings in a root folder’s .vscode/settings.json or .vscode/launch.json will override those in the workspace file, so be careful to use one or the other unless you truly need to leverage this flexibility.

You can have a workspace file even if you are only working with a single root folder.

To edit InterSystems ObjectScript extension settings in a .code-workspace file in VS Code, perform the following steps:

1. Open the workspace using File > Open Workspace from File.

2. Select File > Preferences > Settings (Code > Preferences > Settings on Mac).

3. Select the Workspace tab.

4. Search for objectscript: conn and click on Edit in settings.json. This opens the .code-workspace file for that workspace.

The InterSystems Objectscript extension uses the multi-root workspaces feature to support Objectscript development directly in namespaces on InterSystems servers.

Editing a Server Configuration

If you need to modify a server configuration, perform the following steps:

1. Select File > Preferences > Settings (Code > Preferences > Settings on Mac) from the menu.

2. Select the User settings level.

3. Select Extensions from the outline section of the editor pane.

4. Select InterSystems Server Manager from the list to find the InterSystems Server Manager area of the edit pane, as illustrated in the following screen shot:

   

5. Select Edit in settings.json.

You can also access the settings.json file within the InterSystems view container: select the ... (ellipsis) button in the title bar of the Servers view, and then select Edit Settings.

A server configuration in the settings.json file has the following structure, populated with the values you entered when you configured the server:

{
    "intersystems.servers": {
        "iris-1": {
            "webServer": {
                "scheme": "http",
                "host": "localhost",
                "port": 443
            },
            "username": "_SYSTEM"
        }
    }
}

The components of this server definition are as follows:

• "iris-1" — the arbitrary name to identify the InterSystems IRIS server.

• "webServer" — the collection of properties which define the web server you use to connect to the InterSystems IRIS server through the InterSystems Web GatewayOpens in a new tab.

  • "scheme" — the protocol used for connections ("http" or "https").

    Note:

    Additional configuration may be necessary if you want to establish an HTTPS connection using a self-signed certificate.

  • "host" — the host name or IP address for the web server.

  • "port" — the port number for the web server.

  • "pathPrefix" — where applicable, the directory path under which the web server publishes the target InterSystems IRIS server’s web services.

• "username" — the username VS Code uses to authenticate to the server.

• "password" — password for the specified username. For security reasons, InterSystems strongly recommends authenticating through VS Code instead of specifying passwords as plaintext within the settings.json server definition.

Establish an HTTPS Connection Using a Self-Signed Certificate

Your organization may issue self-signed certificates to facilitate HTTPS connections to development or testing servers.

In order for VS Code to allow an HTTPS connection to an InterSystems server using a self-signed certificate, perform either of the following configuration changes:

• Within the VS Code User SettingsOpens in a new tab, set variables as follows:

  • "http.proxyStrictSSL": false

  • "http.proxySupport": "fallback" or "http.proxySupport": "off"

  Then, save the configuration and reload VS Code.

  Caution:

  This configuration disables certificate checking, and is therefore inappropriate for use outside of a secure private network.

• Add the self-signed certificate to your operating system’s root certificates. (Refer to the documentation for your operating system for specific instructions about how to do this.) Then, reload VS Code.

Editing a Server Connection

If you need to modify an existing server connection, perform the following steps:

1. Select File > Preferences > Settings (Code > Preferences > Settings on Mac) from the menu bar.

2. Select the Workspace settings level.

3. Search for objectscript: conn.

4. Select Edit in settings.json.

A connection configuration in the settings.json file has the following structure, populated with the values you specified when you configured the connection:

"objectscript.conn": {
  "ns": "USER",
  "server": "iris-1",
  "active": true,
},

The components of this configuration are as follows:

• "ns" — namespace to use on the server

• "server" — server name, as specified in the server configuration

• "active" — boolean value specifying whether the connection is active.