IRIS ターミナルへのアクセス: Visual Studio Code ユーザー向け総合ガイド

はじめに

InterSystems は先日、Visual Studio Code（VSC）IDE 用の拡張機能は InterSystems Studio に比べてより優れたエクスペリエンスを提供するという考えから、VSC IDE 用の拡張機能を独占的に開発するためにバージョン 2023.2 より InterSystems Studio のサポートを終了すると発表しました。それ以来、VSC に切り替えた開発者や、VSC を使用し始めた開発者が大勢います。 VSC には Studio のような出力パネルがなく、InterSystems が開発したプラグインをダウンロードする以外に IRIS ターミナルを開く統合機能もないため、多くの人は演算を実行する際にターミナルの開き方に迷ったことでしょう。

概要

• はじめに 
• 解決策
  
  • 少なくとも IRIS 2020.1 または IRIS 2021.1.2 を使用するユーザー: Web ターミナルを使用
  • 少なくとも least IRIS 2023.2 を使用するユーザー: WebSocket ターミナルを使用
  • Docker ベースの IRIS を使用するユーザー
  • ローカルマシンでバージョン 2023.2 より前の IRIS を使用するユーザー
  • SSH 接続を使ってリモートサーバーの IRIS でコーディングするユーザー

解決策

VSC でターミナルを開く方法は使用している特定の構成によって異なるため、以下に、状況に最適な解決策をまとめました。

少なくとも IRIS 2020.1.1 または IRIS 2021.1.2 を使用するユーザー: Web ターミナルを使用

少なくとも IRIS 2020.1.1 または IRIS 2021.1.2 を使用し、外部の拡張機能のインストールが許可されている（サードパーティアプリケーションに関する会社のポリシーにより許可されていない場合もあります）ユーザーの場合、VSC 用の Web ターミナル拡張機能が役立つ可能性があります。 ご存知ない方のために説明すると、Web ターミナルは、ObjectScript で制作された InterSystems 製品（IRIS、Caché、Ensemble、HealthShare、TrakCare など）用の Web ベースのターミナルで、ブラウザ内でより高度なバージョンのターミナルを使用することができます（プロジェクトページはこちらです）。 この VSC 拡張機能によって、直接 VSC からクリックするだけで Web ベースのターミナルを起動できます。

Web ターミナルを開くには、InterSystems ツール  をクリックし、ネームスペースを選択して、いずれかのアイコン（ または ）をクリックします。それぞれ、VSC ターミナルパネルかブラウザで Web ターミナルが開きます（Alt を押すとデフォルトアイコンを変更できます）。

少なくとも least IRIS 2023.2 を使用するユーザー: WebSocket ターミナルを使用

少なくとも IRIS 2023.2 を使用するユーザーは、最新バージョンの VSC 拡張機能に含まれる新しい「WebSocket ターミナル」機能を利用できるため、他の回避策は必要ありません。

WebSocket ターミナルを開くには、InterSystems ツールをクリックし、ネームスペースを選択して、Web ターミナルの隣のアイコンをクリックします。

編集: 詳細については、これについて @Brett Saviano が書いたおもしろい記事をご覧ください！

How to run ObjectScript commands in the VS Code integrated terminal（VS Code の統合ターミナルで ObjectScript コマンドを実行する方法）

Docker ベースの IRIS を使用するユーザー

Docker 内の IRIS 環境で作業しており、VSC を使用しているユーザーは、Docker 環境から直背悦ターミナルセッションを開始できます。

ステータスバーで Docker voice をクリックし、Docker でターミナルを開くを選択します。

このポイントについて画像と説明を提供してくれた @Evgeny Shvarov に感謝しています。

ローカルマシンでバージョン 2023.2 より前の IRIS を使用するユーザー

ローカルマシンで実行するバージョンの IRIS で作業するユーザーの場合は、VSC 内に専用の IRIS ターミナルをセットアップすることができます。

1. 1. settings.json ファイルを開きます。 このファイルを見つけるには、表示 > コマンドパレットをクリックして「settings」と入力し、ユーザー設定を開く（JSON）を選択するなど、様々な方法があります。
   2. 「terminal.integrated.profiles.windows」の下に以下のコードを追加します。

"terminal.integrated.profiles.windows":{

    "IRIS Terminal": {
    
        "path": [
    
            "C:\\InterSystems\\IRISHealth\\bin\\irissession.exe"
        ],
    
        "args": ["IRISHEALTH"],
    
        "icon": "terminal-cmd"
    } 

}

注意: 正しい irissession.exe のパスを挿入してください。

c. VSC からターミナルを開くには、ターミナル > 新しいターミナル > プロファイルを起動… > IRIS ターミナルに移動します。

d. ターミナルメニューに 'IRIS ターミナル' voice が表示されます。

SSH 接続を使ってりモードサーバーの IRIS でコーディングするユーザー 

SSH 接続（PuTTY の使用など）を使ってアクセスできるリモートサーバー（会社サーバーなど）の IRIS バージョンを使用するユーザーの場合、Remote - SSH VSC 拡張機能を使用して、VSC をサーバーに直接接続できます。 これを行うには、以下を実行します。

1. 1. VSC に Remote - SSH: Editing Configuration Files 拡張機能をインストールします。
   2. サイドバーの「リモートエクスプローラー」アイコンをクリックします。
   3. 「SSH 構成ファイルを開く」を選択します。

次のパスの構成ファイルを開きます: C:\Users\<username>\.ssh\config

1. 4. 構成ファイルに以下のコードを挿入します。 

Host my-putty-connection

    HostName < IP address or server name >

    User < username >

    IdentityFile < private key path on your local machine >

    Port < port > 

IP アドレスとポートは PuTTY に指定されたホスト名とポート、ユーザー名はリモートサーバーにアクセスする際に使用するユーザー認証情報、そして IdentityFile は PuTTY 秘密鍵へのファイルパスです。

注意:  PuTTY が生成した秘密鍵の元のフォーマット（.ppk）は VSC で読み取れません。 PuTTY 経由で VSC とリモートサーバーの接続を確立するには、元の秘密鍵を複製して .pem フォーマットに変換する必要があります。 この変換は、以下のように行います。

1. PuTTYgen アプリケーションを起動します。
2. File メニューから、Load private key をクリックします。
3. .ppk フォーマットの秘密鍵を選択して、Open を選択します。
4. Conversions メニューで Export OpenSSH Key (force new file format) をクリックします。
5. .pem 拡張子を使った新しい名前を設定し、Save ボタンをクリックします。
6. この新しい .pem ファイルへのパスを VSC の IdentifyFile パラメーターにリンクします。
   1. ファイルを保存します。 数秒ほどすると、Remote Explorer パネルに新しい接続が表示されます。
   2. 「Connect in New Window...」をクリックして新しい VSC ウィンドウに SSH 接続を開きます。
7. リモートマシンのオペレーティングシステムを選択します（初回アクセスのみ）。
8. 新しいウィンドウで、Terminal > New Terminal に移動します（または Ctrl + ò または Ctrl + Shift + ò を使用します）。
9. これで、リモートマシンに接続し、VSC 内で IRIS ターミナルを使用できるようになりました。

注意: この操作は、以前に PuTTY 経由でリモート接続を開始したことがあり、PuTTY が閉じられている場合またはリモートサーバーに接続していない場合にのみ機能します。 この操作では、PuTTY は起動せず、PuTTY が確立するトンネルに VSC が接続されるだけです。

VSC を通じて PuTTY 接続を開始するには、バッチファイルを使用できます（Windows）。 提供されている connect_remote.bat ファイルは、PuTTY に含まれる Plink コマンドを使用してセッションを開始します。

@echo off

set SESSION="<your saved session name>"

plink -load %SESSION%

セッションを開始するには、VSC ターミナルに .\connect_remote.bat と入力して、リモート接続を開き、認証情報を入力します。

注意: こちらの後のメソッドによって、すべての VSC ショートカットをサポートするターミナルバージョンにアクセスできるようになります！ Shift+Insert ではなく、Ctrl＋V を使用できるようになります 🎉