Representational state transfer (REST) は、Webサービスを作成するために使用される一連の制約を定義するソフトウェアアーキテクチャスタイルです。 RESTful Webサービス（RWS）と呼ばれる、RESTアーキテクチャスタイルに準拠したWebサービスは、インターネット上のコンピュータシステム間の相互運用性を提供します。 REST準拠のWebサービスを使用することで、要求されたシステムは、統一され事前定義されたステートレスな操作のセットを使用して、Webリソースのテキスト表現にアクセスし操作することができます。 SOAP Webサービスなどの他の種類のWebサービスは、独自の任意の操作セットを公開します。 詳細はこちら。
相互運用プロダクションでは、HTTPクライアントとして動作するビジネスオペレーションを常に設定することが可能です。このオペレーションはOAuth 2.0による認証を利用しますが、この認証方式に対応するためにはオペレーションのカスタマイズが必要でした。 最近リリースされた v2024.3以降では、 この処理をより容易に行うための新機能が追加され、新たな設定オプションが提供されています。
HTTPアウトバウンドアダプターをご利用のビジネスオペレーションにおいて、OAuthグループの下に新しい設定項目が追加されております。
例えば：
新しいOAuth関連の 設定に関するドキュメントはこちらでご覧いただけます。
関連するオペレーションのスクリーンショットの例を以下に示します：
.png)
最近あるお客様にIRIS for Healthをご紹介する機会があり、技術者の方向けのデモを交えた説明をするためにIRIS for Healthのデモ環境の準備をしました。
元ネタは @Mihoko Iijima がポストした以下の投稿です。
FHIR R4 リソースリポジトリを簡単にお試しいただける開発環境テンプレートのご紹介
非常にわかりやすい動画での説明もあるのでご覧ください。
これから試す方向けに、新しいバージョン（2025.3）でお試しいただけるよう若干の修正をしましたので、紹介します。
https://github.com/TomoOkuyama/iris4h-demo
主な修正点は以下です。
これは InterSystems FAQ サイトの記事です。
通常、フォームデータを受け取りたい場合は、CSPと同様に %request.Get() で受け取れます。
URLパラメータで、?name=123 のようにリクエストする場合も、同様に%request.Get(“name”) で受け取れます。
ファイルの場合は、%request.MimeDataで取得できます
例：
set fname=%request.MimeData("files",1).FileName
set upload=%request.MimeData("files",1)
set save=##class(%Stream.FileBinary).%New()
set save.Filename="C:\work\in\"_fname
do save.CopyFromAndSave(upload)
HTMLやPostmanなどで、通常のテキストデータをフォームデータとして送る場合も、%request.Get() で受け取れます。
例：
set name=%request.IRISではCSPタグベースの開発は、非推奨(Deplicated)になっています。
非推奨とはいえ、いますぐ使えなくなることはないと思います。
が、CSP機能に含まれるHyperEventの#server()#呼び出しは、かなりやばいということがわかってきました。
これはChromeを始めとするメジャーなブラウザーが提供しているSynchronous XMLHttpRequestという関数を呼び出しています。
この関数をGoogleは10年前くらいから非推奨機能としていて、いつか完全に機能をドロップすると宣言しています。
インターシステムズのドキュメントにもさりげなく記載されています。
とはいえ、10年もそのままなので、希望的観測をすれば、今後も使える可能性は高いかもしれません。
しかし、ある日突然なくなるリスクはゼロではありません。
ですので、#server()#呼び出しをお手元のコードからなるべく早く取り除くのが賢明です。
それでは、どうすれば良いのか？
ということですが、今のご時世で考えれば、REST APIに変えましょうというのが美しい世界ですが、おそらく書き換えのコストは、半端じゃないでしょう。
ということで、現実的な解は、#Call()#に置き換えることだと思います。
最近話題のClaude Codeを使って、ObjectScriptプログラミングをトライしてみました。
もちろんClaude CodeにObjectScriptのコードを書かせるにはそれなりの指示が必要ですが、適切なプロンプトを与えると想像以上にちゃんとしたObjectScriptコードを書いてくれます。
今回試したのは、少し前に投稿したCSPの#server問題に対応するため、#serverをREST APIに書き換えるというものです。
元のソースは、
https://github.com/wolfman0719/shopdemo
これはCSPのデモアプリケーションですが、しっかりと#server機能を使用しています。
結論をいうと、%sessionがRESTとCSP間で共有できないという根本問題があって、実行成功までには至っていませんが面倒なコーディングをかなりカーバーしてくれることがわかります。
(REST APIをCSPクラスで実装することで%session共有の問題を回避でき、Claude Codeが生成したロジックの正しさは証明されました)
そして、Claude Codeは、 ObjectScriptのことかなり理解してくれています。
ObjectScriptプログラマーが少ない問題を大きく改善してくれる可能性があります。
それでは、私がどのようなことを行ったか説明します。
あるお客さんから、ワークフローの待受画面での新着通知方法についてご相談がありました。
何か良い方法は無いでしょうか。 といった内容です。
この課題に対して調査したところ、以下の方式が見つかりました。
今回は以下の点について手順や設定等解説していきたいと思います。
nginx-push-stream-module を使った SSE (Server-Sent Events) 通知/subscribe) とサーバ送信 (/publish) の最小実装まずは全体像です。データの流れをシンプルに分けることで、役割が明確になります。
FHIRサーバー
FHIRサーバーとは、FHIR（Fast Healthcare Interoperability Resources）標準を実装するソフトウェアアプリケーションであり、医療システムが標準化された方法で医療データを保存、アクセス、交換、および管理することができるようにします。
Intersystems IRISは、以下のFHIRリソースを保存および取得できます。
Fast Healthcare Interoperability Resources（FHIR）は、HL7 Internationalによって作成された標準化されたフレームワークであり、柔軟かつ開発者に優しい最新の方法で医療データの交換を促進します。
これは InterSystems FAQ サイトの記事です。
ダイナミックオブジェクトの%ToJSONメソッドを利用することで簡単にJSONデータを送信することができます。
但し、標準的な方法では、出力するJSONのデータがIRIS文字列の最大長（約32万文字 正確には$SYSTEM.SYS.MaxLocalLength()が返す値）を超えると<MAXLENGTH>エラーとなります。
これを回避するためには、文字列として返すのではなく、%ToJSONメソッドの出力先としてStreamを指定し、その結果作成されたそのStreamデータを順次読み取って、出力先に書き出すようにする必要があります。
以下のように処理できます。
ClassMethod bigjson() As %Status [ ProcedureBlock = 0 ]
{
set x={}
for i=1:1:100 {
set cmd=" set x.a"_i_" = ^a " ;; ^aのサイズは1MB
xecute cmd
}
set tmpStream = ##class(%Stream.GlobalCharacter).%New()
do x.開発者の皆さん、こんにちは！
1つ前の記事では、VSCodeのObjectScriptエクステンションに追加されたRESTサービスのデバッグツールについてご紹介しましたが、この記事では、RESTクライアントなどからHTTP要求を実行し、処理中のIRIS内プロセスにアタッチしながらデバッグを行う方法についてご紹介します。
これは InterSystems FAQ サイトの記事です。
一般的に、500番台はサーバー側で発生したエラーを表していて、503番エラーはサーバーが何らかの理由で機能を停止していてクライアントの要求に回答できない場合に出現するエラーです。
外部サイトの説明：503エラー 【HTTP 503 Service Unavailable】
以下、InterSystems 製品の使用で発生する503エラーの考えられる原因について一覧します。
原因：ライセンスが割り当てられない場合に発生します（ライセンスが「同時接続ユーザ」での購入である場合、ユーザ数が制限を迎えたためライセンスが割り当てられずこのエラーが発生します）。
アプリケーションが「認証なし」アクセスを使用している場合、以下の原因により503エラーが発生します。
次回の Python コンテストでは、Python を使用して IRIS をデータベースとして使用する簡単な REST アプリケーションを作成する方法についての小さなデモを作成しようと思います。 以下のツールを使用します。
これは、ネイティブウェブアプリケーションとして IRIS にデプロイできる Django アプリケーションのテンプレートです。
git clone
cd iris-django-template
python3 -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt
docker-compose up
ベース URL は http://localhost:53795/django/ です。
/iris - IRISAPP ネームスペースに存在する上位 10 個のクラスを持つ JSON オブジェクトを返します。/interop - IRIS の相互運用性フレームワークをテストするための ping エンドポイント。/api/posts - Post オブジェクトの単純な CRUD エンドポイント。WSGI 導入記事をご覧ください: wsgi-introduction。
これはInterSystems FAQサイトの記事です。
ISCLOG を有効にすることにより、CSP（REST）アクセスに関連するログ情報を収集できます。これを使用してCSP(REST)でのトラブル時の調査を行うことが可能です。
◎このツールをトラブルシューティングに使用する場合は、基本的に、エラーを(意図的に)再現できる状況で使用します。
他のウェブアクセス等がない状態で、単体実行してエラーを発生させ、このログを取得して調査します。
手順は以下のとおりです。
① ログをクリアします。
//IRIS
Kill ^ISCLOG
//Caché
Kill ^%ISCLOG
② ロギングレベルを設定します。
Set ^%ISCLOG=3
③ CSPでエラーになる処理を行います。
これは InterSystems FAQ サイトの記事です。
以下の様なCurl コマンドで送信したファイルを受け取るRESTサービスを作成する方法を紹介します。
curl -X POST "http://localhost/api/upload/csv?a=123&b=999" -F file=@"C:/temp/a.csv"クライアントからPOSTされたファイルを受け取ってサーバーに保存するRESTサービスは以下の様に作成します。
(このサンプルでは、1000文字以下の小さいサイズおよび文字コードはutf-8のファイルを想定しています。）
Class User.MyREST Extends %CSP.REST
{
Parameter HandleCorsRequest = 1;
XData UrlMap
{
<Routes>
<Route Url="/csv" Method="POST" Call="readMimeData" />
</Routes>
}
ClassMethod readMimeData() As %Status
{
set upload=$g(%request.MimeData("csvfile", 1))
set fname=%request.MimeData("csvfile",1).
ウェブサーバーゲートウェイインターフェース（WSGI）は、ウェブサーバーがリクエストを Python プログラミング言語で記述されたウェブアプリケーションまたはフレームワークに転送するための単純な呼び出し規則です。 WSGI は PEP 3333 で詳しく説明された Python 規格です。
🤔 定義は良いとして、IRIS との関連性は何でしょうか？
IRIS 2024.2+ の新機能により、直接 IRIS で WSGI アプリケーションを実行できます。 この機能は、IRIS を他の Python フレームワークとライブラリに統合する優れた方法です。
これは、Python を使用して IRIS と対話できる Python ファーストエクスペリエンスのトレンドに沿ったもので、Python アプリケーションを IRIS 上で直接実行することもできるようになりました。
IRIS で WSGI アプリケーションをインスタンス化するには、IRIS 管理ポータルのセキュリティ -> アプリケーション -> ウェブアプリケーションのセクションで構成する必要があります。
単純な Flask の例:
/irisdev/app/community ディレクトリにある app.
開発者の皆さん、こんにちは。
Teams ワークフロー Webhook を用意すると、curl コマンドや REST クライアントを利用して Teams チャネルに任意メッセージを簡単に送信できるので、IRIS や IRIS の Interoperability を使って自動的に何か情報を入手＋必要なときだけ Teams チャネル通知ができたら面白いな、と思い試してみた内容をご紹介します。
以下、Teamsワークフローの作成例です。
Teams ワークフローの仕様に合わせたメッセージ用 JSON が用意できれば、こんなメッセージを出すことができます。
Teams チャネルにメッセージを通知するには「Teams ワークフローの Webhook」の用意が必要です。（この用意によってアクセスするために必要なURLが生成されます）詳しくは、「Microsoft Teamsのワークフローを使用して受信 Webhook を作成する」をご参照ください。
通知までの設定などについては、こちらのページを参考にさせていただきました：Teams チャネルへメッセージ送信する方法
以下、試した順でご紹介します。
IRIS サーバ側で JSON の操作を行う方法を解説します（3つのビデオに分かれています）。
ビデオ② ：ダイナミックエンティティで利用できるメソッドの練習
ビデオ③ ：SQL関数と %JSON.Adapter の使い方
なお、このビデオには、以下の関連ビデオがあります。ぜひご参照ください。
このビデオの目次は以下の通りです。
最初～ 復習ビデオ／関連ビデオについて など
2:05～ JSONとは？
3:26～ JSONオブジェクト：ダイナミックエンティティの作成
//%DynamicObjectを使用した例
set json=##class(%DynamicObject).%New()
set json.Name="テスト太郎"
set json.Address="東京都新宿区"
write json.生成AIを活用したアプリケーション開発は、Python、JavaScriptなどのメジャー言語による体験記事がよく見られます。一方、IRISのObjectScriptの開発に言及された記事は比較的少ないのが現状です。そこで、本記事では生成AIがObjectScriptの開発にどこまで活用できるのかを検証しました。
特にDevOpsのプロセスにおいて、生成AIは様々なシーンでの活用が期待できます。今回は開発工程に注目し、以下の観点から生成AIの有効性を調査しました。
本記事の検証は以下の環境で行いました。
開発環境
開発ツール IRISの開発にはStudioやVSCodeなどが利用可能ですが、今回は生成AIの活用に特化したエディタ「Cursor」を使用しました。
Cursorを選定した理由 Cursorは、生成AIによる支援機能に特化したコードエディタで、以下の特徴があります：
生成AIの支援：コードの自動生成や提案、バグの検出、修正提案を行います。また、外部のドキュメントや複数のソースを指定し、生成内容に反映させる簡易なRAG機能も搭載されています。
これは InterSystems FAQ サイトの記事です。
messages.logまたはcconsole.log内に記録されるCSPGatewayLatencyのメッセージは、サーバが、パフォーマンス測定のため定期的に「CSPゲートウェイにリクエストを送信して応答をもらう」ことを行っており、応答を受け取るまで一定時間以上かかったときに出る警告(応答時間の閾値）です。
その既定値は1000ミリ秒です。
WebGateway（CSPGateway）が稼働する Web サーバの負荷が高い場合に出力する場合がありますが、実際のCSPアプリケーションやREST APIの動作や応答速度に影響が見られなければ、特に問題はありません。
またこのメッセージの出力頻度を下げるためにこの閾値を変更する方法もあります。
変更方法は以下を参照ください
InterSystems IRIS® データ・プラットフォーム 2022.3 からライセンス消費メカニズムにRESTとSOAPを追加しました。この変更により、コア・ベースライセンス以外でRESTまたはSOAPを使用している場合、アップグレード後にライセンス消費量が多くなる可能性があります。この勧告がお使いのシステムに該当するかどうかは、以下にあるFAQ(英語)のリンクをご参照ください。.
ライセンス使用について、こちらの表にまとめています。
|
製品
|
REST と SOAP のリクエストがライセンスを消費するかどうか
|
|
InterSystems Caché® |
する
|
|
InterSystems Ensemble® |
しない
|
|
InterSystems IRIS, InterSystems IRIS® for Health, Health Connect 2022.3 より前 |
しない
|
|
InterSystems IRIS, InterSystems IRIS for Health, Health Connect 2022.3 以降 |
する
|
こんな状況を思い浮かべてください。「ウィジェットダイレクト」というウィジェットとウィジェットアクセサリーを販売する一流のネットショップで楽しく勤務しています。先日、上司から一部の顧客がウィジェット商品にあまり満足していないという残念な話を聞き、苦情を追跡するヘルプデスクアプリケーションが必要となりました。さらに面白いことに、上司はコードのフットプリントを最小限に抑えることを希望しており、InterSystems IRIS を使って 150 行未満のコードでアプリケーションを提供するという課題をあなたに与えました。これは実際に可能なのでしょうか？
免責事項: この記事は、非常に基本的なアプリケーションの構築を記すものであり、簡潔さを維持するために、セキュリティやエラー処理などの重要な部分は省略されています。このアプリケーションは参考としてのみ使用し、本番アプリケーションには使用しないようにしてください。この記事ではデータプラットフォームとして IRIS 2023.1 を使用していますが、それ以前のバージョンでは記載されているすべての機能が提供されているとは限りません。
クリーンなネームスペースを新規に定義することから始めましょう。CODE と DATA データベースを使用します。
これは InterSystems FAQ サイトの記事です。
InterSystems製品のInteroperability（相互運用性機能）を利用する際、REST経由で情報入力を行う場合の作成方法についてサンプルプロダクションを利用しながらご紹介します。
サンプルはこちら👉https://github.com/Intersystems-jp/FAQ-Interop-REST
コミュニティの皆さん、こんにちは！
私の IRIS Api Tester というアプリで使用する Postman コレクションのテストを作成する方法を説明します。
Newman とは？
Newman は、Postman コレクションを拡張可能な方法で自動的に実行できるコマンドラインツールです。 Newman でテストを作成することで、API エンドポイントの信頼性と正確性を確実にすることができます。 この記事では、Postman で Newman のテストを作成する方法と開始に役立つ実用的な例を紹介します。
Postman コレクションを作成したら:
.png)
テストスクリプトを書き始めることができます。
Postman のテストは、Postman スクリプトサンドボックスを使って JavaScript で記述します。 テストスクリプトを作成するには、リクエストを開いて「Test」タブに移動します。 ここで、API レスポンスを評価してその正確さを検証するカスタム JavaScript コードを作成できます。
例 1: レスポンスのステータスコードを確認する:
pm.test("Status code is 200", function () {
pm.response.to.have.status(200);
});
例 2: レスポンスの特定のフィールドの有無を検証する:
pm.コミュニティの皆さん、こんにちは！！
Open Exchange に最新の「IRIS Api Tester」アプリケーションをアップロードしました。
InterSystems IRIS と Newman を使用した Docker プロジェクトで、素早く簡単に Postman コレクションをテストできます。
リポジトリをクローンするだけで、初期状態で使用できるようになっています: https://github.com/daniel-aguilar-garcia/irisapitester
docker-compose ファイルを実行します。
.png)
この URL をブラウザで開きます。
http://localhost:52773/csp/user/index.html
.png)
テストを Postman コレクションに追加します。
.png)
この例では、テストをコレクションの Test セクションに追加することでコレクションのすべてのエントリにグローバルテストを追加していますが、個別のテストを項目ごとに追加することもできます。
ここでは、リクエストのステータスコードが 200 になることをテストしています。ステータスコードが 200 でない場合には、レポートにエラーとして表示されます。
これは InterSystems FAQ サイトの記事です。
こちらの記事 では、HTMLのフォームからRESTを使って画像ファイルをアップロードする方法をご紹介しました。
お客様からは、ダウンロードする方法もあわせてお問い合わせいただくことがあるため、この記事では両方の方法に加え、イメージファイル以外にも対応したサンプルをご紹介します。
サンプルでは、HTMLのフォームから IRIS REST API を呼び出してファイルの「アップロード／ダウンロード」を行っています。
【手順】
サンプルプログラムの使い方は次のとおりです。
IRIS側の処理は、IRISでREST APIを実装する方法を理解していれば、簡単です。
前回のログイン処理でユーザー認証をIRIS側でどのように実装されているか確認して見ましょう。
まずはディスパッチクラスの定義です。
Shop.Brokerというクラスの中で定義されています。
checkpasswordというメソッドが最後に定義されていて、最終的にShop.Rest.Customer:checkPasswordという（クラス）メソッドが呼ばれているのがわかると思います。
ここで定義しているパラメータは、とりあえずおまじない的に含めておくことをお勧めします。
（説明し出すと少し長くなるので）
Class Shop.Broker Extends %CSP.REST
{
Parameter CONVERTINPUTSTREAM = 1;
Parameter HandleCorsRequest = 1;
XData UrlMap
{
<Routes>
<Route Url="/product/:code" Method="GET" Call="Shop.Rest.Product:getRecord"/>
<Route Url="/products" Method="GET" Call="Shop.Rest.コミュニティの皆さん、こんにちは。
パート 1 では、すべてのパッケージ、使用されているライブラリ、および REST サービスについて説明しました。
次は、コンバーターサービスとバリデーターサービスについて詳しく説明したいと思います。
OpenAPI-Suite はデフォルトで、仕様バージョンが 3.0 未満である場合に HTTP リクエストを converter.swagger.io に送信し、別の HTTP リクエストを validator.swagger.io に送信して仕様ドキュメントの構造を単純化します。
オンラインユーティリティの使用は便利ではありますが、場合によっては独自のコンバーターとバリデーターのインスタンスを使用する方が便利な場合もあります。 たとえば、OpenAPI-Suite が ObjectScript 開発者向けに組織のサーバーに提供されている場合、外部サービスへのリクエストを回避する方が好ましいことがあります（プライバシーやリクエストレートの制限を回避するため）。
以下を実行してください。
docker run -d -p 8085:8080 --name swagger-converter swaggerapi/swagger-converter:latest
docker run -d -p 8086:8080 --name swagger-validator-v2 swaggerapi/swagger-validator-v2:latestコミュニティの皆さん、こんにちは。
私が作成した OpenAPI-Suite という最新のパッケージをご紹介します。これは、OpenAPI 仕様バージョン 3.0 から ObjectScript コードを生成するツールセットです。 簡単に言うと、これらのパッケージでは以下を行うことができます。
Windows環境にWebGatewayのみをインストールした場合に、「Service Unavailable / HTTP Error 503. The service is unavailable.」エラーとなりWebアプリケーションに接続できない場合があります。
こちらは、Visual C++ 再頒布可能パッケージ がインストールされていない環境に、Webゲートウェイをインストールした場合に見られる事象です。
Microsoft社のホームページより、Visual C++ 再頒布可能パッケージ（X64）をダウンロードしてインストールしてください。
インストール後IISを再起動し、以下のリンクよりWebゲートウェイ管理ページに接続できることをご確認ください。
Webゲートウェイ管理ページ：
http://localhost/csp/bin/Systems/Module.cxw
エラーが解消されない場合は、IISのアプリケーションプールが起動しているかをご確認ください。
.png)
【ご参考】
Microsoft Visual C++ Redistributable latest supported downloads
こちらの記事では、RESTやCSPなどの「Webアプリケーションのトラブルシューティング」のヒントをご紹介します。
何かしらのトラブルと思われる事象が発生した場合、確認したいのがログファイルになります。
各コンポーネント間のやり取りで、どこでどのようなトラブルが発生しているかを、それぞれログを取得して確認することができます。
① クライアント ⇔ Webサーバ間では、「Webサーバログ（IISやApacheのアクセスログなど）」、
② Webサーバ ⇔ Webゲートウェイ間では、「イベントログ」・「HTTPトレース」、
③ Webゲートウェイ ⇔ IRISサーバ間では、「ISCLOG」・「監査ログ」・「messages.log」などがあります。
こちらの記事では、IRISで取得できるログとして 
と 
で取得可能なログの取得方法をご紹介します。
1) Webゲートウェイ管理ページ（http://<IPアドレス>:<ポート>/csp/bin/Systems/Module.cxw）に接続します。
2) イベントログを削除します。
[イベントログを参照] > ログをクリア をクリック
3) イベントログレベルを設定します。