Caché Server Pages (CSP) は、InterSystemsデータプラットフォームでインタラクティブなWebアプリケーションを構築するために使用するアーキテクチャとツールセットの両方のことです。
これは InterSystems FAQ サイトの記事です。
一般的に、500番台はサーバー側で発生したエラーを表していて、503番エラーはサーバーが何らかの理由で機能を停止していてクライアントの要求に回答できない場合に出現するエラーです。
外部サイトの説明：503エラー 【HTTP 503 Service Unavailable】
以下、InterSystems 製品の使用で発生する503エラーの考えられる原因について一覧します。
原因：ライセンスが割り当てられない場合に発生します（ライセンスが「同時接続ユーザ」での購入である場合、ユーザ数が制限を迎えたためライセンスが割り当てられずこのエラーが発生します）。
アプリケーションが「認証なし」アクセスを使用している場合、以下の原因により503エラーが発生します。
これは、InterSystems FAQサイトの記事です。
メソッドの実装に使用する言語を明示する場合は、下記のようにメソッドキーワードで「Language＝～～～」と指定します。
Method name(formal_spec) As returnclass [ Language = language ]
{ //implementation }指定できるLanguageの値は下記のとおりです。
上記の通り、ObjectScriptで記載する場合は、「Language＝objectscript」と指定します。
但し、CSP内の<SCRIPT>タグ内で指定する場合は、下記の通り、「LANGUAGE＝’cache’」と指定することにご注意ください。
<SCRIPT LANGUAGE='cache', ～～～>※CSPページは、IRISでは非推奨の機能です。
これは、ネイティブウェブアプリケーションとして 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 サイトの記事です。
※Caché/Ensembleの「CSPゲートウェイ」は、IRISでは「Webゲートウェイ」と名称が変更されています。
これに伴い、サービス名も、「%Service_CSP」 ⇒ 「%Service_WebGateway」となっています。
以下は、IRISベースの名称で記載しておりますので、適宜読み替えてご参照ください。
Webゲートウェイ・レジストリとその関連クラスを使用すると、Webゲートウェイのインストール環境の確認、および、設定値の変更が可能です。
関連するクラスは、以下になります。
%CSP.Mgr.GatewayRegistry
%CSP.Mgr.GatewayMgr
例えば、以下は、アクティブなWebゲートウェイのインストール環境(リストの1番目)の情報を書き出しています。
Set reqistry = $system.CSP.GetGatewayRegistry()
Set gateways = reqistry.GetGatewayMgrs()
Set gateway = gateways.GetAt(1)
Write gateway.IPAddress," : ",gateway.Port," : ",gateway.Version↓(結果)
これは、ネイティブウェブアプリケーションとして IRIS にデプロイできる FastAPI アプリケーションのテンプレートです。
git clone
cd iris-fastapi-template
python3 -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt
docker-compose up
ベース URL は http://localhost:53795/fastapi/ です。
/iris - IRISAPP ネームスペースに存在する上位 10 個のクラスを持つ JSON オブジェクトを返します。/interop - IRIS の相互運用性フレームワークをテストするための ping エンドポイント。/posts - Post オブジェクトの単純な CRUD エンドポイント。/comments - Comment オブジェクトの単純な CRUD エンドポイント。WSGI 導入記事をご覧ください: wsgiサポートの概要。
これはInterSystems FAQサイトの記事です。
ISCLOG を有効にすることにより、CSP（REST）アクセスに関連するログ情報を収集できます。これを使用して CSP(REST)でのトラブル時の調査を行うことが可能です。
◎このツールをトラブルシューティングに使用する場合は、基本的に、エラーを(意図的に)再現できる状況で使用します。
他のウェブアクセス等がない状態で、単体実行してエラーを発生させ、このログを取得して調査します。
手順は以下のとおりです。
① ログをクリアします。
//IRISKill^ISCLOG//CachéKill^%ISCLOG
② ロギングレベルを設定します。
Set^%ISCLOG=3
③ CSPでエラーになる処理を行います。
これは、ネイティブウェブアプリケーションとして IRIS にデプロイできる Flask アプリケーションのテンプレートです。
git clone
cd iris-flask-template
python3 -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt
docker-compose up
ベース URL は http://localhost:53795/flask/ です。
/iris - IRISAPP ネームスペースに存在する上位 10 個のクラスを持つ JSON オブジェクトを返します。/interop - IRIS の相互運用性フレームワークをテストするための ping エンドポイント。/posts - Post オブジェクトの単純な CRUD エンドポイント。/comments - Comment オブジェクトの単純な CRUD エンドポイント。WSGI 導入記事をご覧ください: wsgi-introduction。
これは InterSystems FAQ サイトの記事です。
messages.logまたはcconsole.log内に記録されるCSPGatewayLatencyのメッセージは、サーバが、パフォーマンス測定のため定期的に「CSPゲートウェイにリクエストを送信して応答をもらう」ことを行っており、応答を受け取るまで一定時間以上かかったときに出る警告(応答時間の閾値）です。
その既定値は1000ミリ秒です。
WebGateway（CSPGateway）が稼働する Web サーバの負荷が高い場合に出力する場合がありますが、実際のCSPアプリケーションやREST APIの動作や応答速度に影響が見られなければ、特に問題はありません。
またこのメッセージの出力頻度を下げるためにこの閾値を変更する方法もあります。
変更方法は以下を参照ください
これは InterSystems FAQ サイトの記事です。
404エラーが返される場合に、以下の対応でエラーが解消されることがわかっています。
(1) binの接続を許可
/cspの構成エディタ＞セクションで以下選択
system.webServer > security > requestFiltering
> hiddenSegmets 選択 ＞ (コレクション)の右欄(Count=xx)の右端 [...] クリック
> segment欄に binの行があったので、選択して削除
> 画面戻って、右上の [適用] クリック
または、IISの構成ファイルを直接編集することでも対応可能です。
C:\Windows\System32\inetsrv\config\applicationHost.config
そのファイルから以下のような記述部分を探し、<add segment="bin" />の行を削除し、保存します。
これは InterSystems FAQ サイトの記事です。
HTTPレスポンスヘッダ情報を取得したい場合、以下のような方法があります。
開発中などに、送られてきたヘッダの項目名、そのデータを確認したい場合に、是非ご活用ください。
set var=""for {
set var=$order(%request.CgiEnvs(var))
if var=""quitset val=$get(%request.CgiEnvs(var))
write var_": "_val,"<BR>"
}%Net.HttpRequest クラスの Head メソッドを使用します。
set http = ##class(%Net.HttpRequest).%New()
set http.Server = "localhost"set http.Port = 80do http.Head("/csp/user/menu.csp") // ヘッダ情報をリクエストするURLdo http.HttpResponse.OutputToDevice()
set http = ""InterSystems は、より新しく優れたオプションが利用可能になったときに従来のテクノロジーの開発を中止することがあります。
ただし、それら機能は最小サポートバージョン以後の製品であれば他の機能と同等にサポートします。
非推奨(Deprecated)とは、InterSystems が現在積極的に開発を行っておらず、より優れたオプションが存在する機能またはテクノロジーを意味します。
非推奨の機能やテクノロジーを使用されているお客様はそれらを使用しないように計画していただく必要がございます。
InterSystems は非推奨の製品機能をサポートするためのスタッフの専門知識を維持しております。
例: ICM, NLP, Studio, UIMA, Spark Connector, Atelier, Zen, Zenレポート, Cache Server Pages (CSP)
廃止された(Discontinued)とはその機能またはテクノロジーが既存アプリケーションであっても今後利用できなくなることを意味します。
InterSystems はそのような技術を使用し続けることがお客様のリスクであると考えます。
理由には以下が挙げられますが、これらに限定するものではありません。
最後にCSP機能の中でReactでうまく置き換えできなかった処理について紹介します。
該当する処理は、サーバー上の商品データに含まれるその商品の画像データ（GIF形式）を取得して、ブラウザにイメージとして描画させるものです。
CSPにはStreamServer.clsというサーバー側で動作する機能が用意されています。
この機能を使ってデータベース上に格納されているストリームデータをHTML IMGタグで処理できる形式に変換してくれます。
Reactで同様の機能を実現する方法が見つからなかったため（そもそもReactはサーバーサイドではなくクライアント上の技術なので）、データベース内に格納されているイメージを取得するのではなく、静的なイメージファイルをウェブサーバーが参照可能な場所に置くことで解決しました。
IRIS側の処理は、IRISでREST APIを実装する方法を理解していれば、簡単です。
前回のログイン処理でユーザー認証をIRIS側でどのように実装されているか確認して見ましょう。
まずはディスパッチクラスの定義です。
Shop.Brokerというクラスの中で定義されています。
checkpasswordというメソッドが最後に定義されていて、最終的にShop.Rest.Customer:checkPasswordという（クラス）メソッドが呼ばれているのがわかると思います。
ここで定義しているパラメータは、とりあえずおまじない的に含めておくことをお勧めします。
（説明し出すと少し長くなるので）
それでは、今回はより具体的にReact開発方法について解説します。
ショップデモのリポジトリの配下にreactというディレクトリがあります。
この下にReactのコードがあります。
ここのreact-setup.mdに記載されている通り、前準備としてreactのテンプレートを作ります。
npx create-react-app shopdemo --template typescript
あとはこのReactプロジェクトを動かすためのライブラリのインストールを行います。
詳細は、react-setup.mdに書いてあります。
まず３つのディレクトリがあって、これは絶対こうしなければならないというものでもないのですが、基本的なお作法として用意するのが一般的なようです。
ここでは、まずログインをするためのユーザー認証を行うコンポーネントの処理について説明します。
CSPを使って作成したアプリケーションをReactを使用して書き換える２回目の記事です。
前回の記事で紹介したショップデモの書き換えについてもう少し詳しく説明します。
まずReactについて、インターネット上に様々な情報が提供されていますので、それらを利用しながら学習するということも可能だとは思いますが、一方で学習時間を短縮するには、やはりReactについて説明した本を一通り読む方が速いのではないかと思います。
実際Reactに関する本はたくさんあるので、その中から自分に合いそうなものを選ぶのが良いかと思います。
ちなみに参考までに私が学習に使ったものは、以下です。
詳細は、本を読んでいただくとして、ここでは私の経験上のReact学習のポイントについて、いくつか列挙したいと思います。
CSPは非推奨機能となり、今後の新規アプリケーションの開発には使用しないことが推奨されています。
代わりに昨今のウェブアプリケーション開発に広く利用されているモダンなフレームワークの使用が推奨されています。
Webアプリケーション開発用のJava scriptフレームワークはたくさんあり、そのどれを選択するかは開発者の好みの問題です。
その中で比較的人気の高いReactを使って、CSPアプリケーションを書き換えた例について紹介します。
ちなみにCSPは機能的には２つの側面があり、今回非推奨となったのは、HTMLをサーバー側で生成するための拡張機能を使ったプログラミングに関連する部分です（.cspファイルを使用したHTMLとサーバーサイドプログラミング、Javascriptプログラミングによる開発）。
HTTP通信のインフラの部分（リクエストオブジェクトやセッション管理など）は引き続きIRISの根幹を支える機能として残ります。
実際、現在のIRISのREST関連機能は、このインフラ上で実装されています。
さて、CSPで記述されたアプリケーションをJavascriptフレームワークを使ったアプリケーションに簡単にコンバートできたらいいなと思われるでしょうが、残念ながらそんなうれしい方法はありません。
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のアプリケーションプールが起動しているかをご確認ください。
【ご参考】
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) イベントログを削除します。
[イベントログを参照] > ログをクリア をクリック
Question:
Windows環境にて、新規サーバにWebゲートウェイ(Web Gateway)をインストールしたところ「HTTP Error 503. The service is unavailable.」エラーで接続ができません。
対処法を教えてください。
Answer:
IRIS2022.1以降のバージョンでは、Visual Studio 2015 Visual C++ 再頒布可能パッケージ(64bit) のインストールが必須となりました。
IRISをインストールされているお客様は、IRISのインストール時に VC++ 2015 再頒布可能パッケージもインストールされるため気にする必要はありませんが、Webゲートウェイのみインストールされる場合は別途インストールする必要があります。
これは InterSystems FAQ サイトの記事です。
Web 経由でのイメージファイルのアップロード／ダウンロードを行うサンプルをご紹介します。
サンプルでは、以下の手順でファイルの「アップロード／ダウンロード」を行っています。
サンプルプログラムの使い方は次のとおりです。
最初のページでファイルを選択し go ボタンをクリックすると、次のページにアップロードされた画像が表示されます。
アップロードしたファイルをダウンロードしたい場合は、download ボタンをクリックしてください。
皆さん、こんにちは。
IRIS 履歴モニタープロジェクトが更新されました。ZPM とビルトインの REST API /api/monitor/metrics を使用します。
皆さん、こんにちは！
職場で持ち上がった単純なリクエストで始めた個人プロジェクトを紹介したいと思います。
使用している Caché ライセンス数を調べることはできますか？
コミュニティに掲載されている他の記事を読んでみたところ、David Loveluck が投稿したぴったりの記事が見つかりました。
APM - Using the Caché History Monitor（APM - Caché 履歴モニターを使用する）
https://community.intersystems.com/post/apm-using-cach%C3%A9-history-monitor
そこで、David の記事を参考に、Caché 履歴モニターを使って、リクエストされた情報を表示して見ました。
「どのテクノロジーを使用するのか」という疑問に対し
私は CSP に決定しました。単純で強力なテクノロジーであるため、私が担当するお客様は Caché が単なる MUMPS/ターミナルではないことに気づくでしょう。
ライセンス、データベース増加状況、CSP セッションの履歴を表示するページを作成した後、「システムダッシュボードとプロセス」ページのデザインを新装することにしました。
私の Caché インスタンスではすべてうまく機能します。
でも、IRIS はどうでしょうか？
これは、InterSystems FAQサイトの記事です。
CSPアプリケーションでは、リクエスト処理時間がサーバー応答タイムアウト値(CSPゲートウェイ管理ページで設定、既定値60 sec)を経過すると、CSPゲートウェイからクライアントブラウザにタイムアウトを通知し、処理を続けているデータプラットフォームサーバプロセスにエラーを発生させます。
エラーが発生している処理を確認して頂き、処理遅延の改善、例えばタイムアウトが発生しないように処理内容を見直して応答時間を短くすることや必要に応じてサーバ応答タイムアウト値を大きくすることで対処可能です。
InterSystems 製品のキットには Apache Web サーバが含まれています。
これにより、お客様が外部Webサーバをインストールせずに Caché/IRIS 管理ポータルを動作させる為の便利な方法を提供しています。
ただし、このWebサーバを実稼働インスタンスに使用しないでください。お客様は、システムに応じたニーズとセキュリティ/リスク要件に適合するWebサーバを別途インストールする必要があります。
最近のテストでは、現在含まれている Apache Web サーバにいくつかのセキュリティ問題があることがわかっていますが InterSystems が管理していないテクノロジである為、
InterSystems は、Apache または別のサードパーティから直接取得した Web サーババージョンをインストールし、付属の Apache Webサーバ を無効にすることをお勧めします。
InterSystems は、今後のリリースに Apache Web サーバの新しいバージョンを含める予定です。
現在のバージョンと同様に、そのバージョンも本番インスタンスには使用できません。
当社の製品の将来のリリースでは、InterSystems はWeb サーバを同梱またはインストールしません。
計画の詳細については、今後、更新情報を提供する予定です。
これは、InterSystems FAQサイトの記事です。
InterSystems 製品の管理ツールやWebページのセキュリティ強化のため、%付きのWebページ（例：管理ポータル上のユニットテストポータル、Webサービスクラスのテスト画面）に対するアクセスがより効率的に制御できるよう、新しいルールが追加されました。
これによりデフォルトで参照可能なページ以外については、明示的に参照許可を設定する必要があり、設定しない場合参照エラーとなります。 以下のドキュメントをご参照いただき、必要に応じて参照許可を設定するようにしてください。
%CSP ページへのアプリケーション・アクセスの制御について
Webサービスクラスのテスト画面の場合は、以下をご覧ください。
これは InterSystems FAQ サイトの記事です。
Web/CSPゲートウェイ管理ページは、通常クライアントマシンからアクセスできないように構成されています。
クライアントからその管理ページにアクセスすると、以下の様なメッセージが返ってきます。
システム管理 このシステムを使用する権限がありません。
Not authorized to use this facility.
You are not authorized to use this facility.
任意のクライアントからアクセスするためには以下の操作を行います。
Web/CSPゲートウェイ管理ページにアクセス可能なシステムからブラウザを起動し、管理ポータルにアクセスします。
管理ポータル>システム管理>構成>の所でCSPゲートウェイ管理をクリックします。
表示されるページの左ペインに表示されるデフォルトパラメータをクリックします。
システム管理マシンの所に*.*.*.*と入力し、設定を保存ボタンを押下げます。
しかしながら任意のクライアントから管理ページにアクセスできるようにするのはセキュリティの観点からはあまりお勧めできません。
アクセスできるクライアントはなるべく限定することをお勧めします。
クライアントアドレスの指定方法としては、以下のような指定形式があります。
この記事では、Caché Webアプリケーション（主にREST）のテストとデバッグを外部ツールを用いて行うことについて説明します。 パート2では、Cachéツールの使用について説明します。
サーバー側のコードを作成したのでクライアントからテストしたい、またはすでにWebアプリケーションが存在するが機能していない― そういったときに使用できるのがデバッグです。 この記事では、最も使いやすいツール（ブラウザ）から最も包括的なツール（パケットアナライザー）までを説明しますが、まずは、最も一般的なエラーとその解決方法について少し説明します。
これは InterSystems FAQ サイトの記事です。
2012.1以降管理ポータルの使用もライセンスを消費する様にシステムを変更しました。
これはインターシステムズが定める製品のライセンスポリシーとシステムの動作をできるだけ合わせる一連の措置の１つとして行われました。
この変更に伴いライセンス使用に関わる思わぬトラブルが発生する可能性がありますので注意が必要です。
特にライセンスの解放が管理ポータルページの操作法によって異なるため、その違いを十分認識して対処する必要があります。
管理ポータルのライセンスの解放はページの切断の仕方により以下の様に変わります。
a) ポータルを開き何らかの操作を行った後にログアウトを行うとライセンスは即時解放されます。
b) ポータルのページを開いた後、他に何も操作せずにログアウトを行うと一定の待ち時間の後にライセンスの解放が行われます。
この待ち時間はライセンスの意図的な規約違反を防ぐための措置であるため、設定等で変更できないようになっています。
c) ポータルを開き、ブラウザのXボタンやAlt+F4等のショートカットでページを強制的に閉じた場合は、デフォルトでは８時間後にライセンスの解放が行われます。
ライセンスの解放の時間は以下の操作で変更することができます。
RESTフレームワークの有用な機能の1つに、ディスパッチクラスがリクエストのプレフィックスを識別して別のディスパッチクラスに転送するという機能があります。 URLマップをモジュール化するこの手法により、コードの可読性が向上し、インターフェースの個別のバージョンが管理しやすくなります。また、特定のユーザーのみがアクセスできるように、API呼び出しを保護する手段も得ることができます。
CachéインスタンスにRESTサービスをセットアップするには、専用のSCPアプリケーションを定義して、それに関連付けられた、受信リクエストを処理するディスパッチクラスを作成する必要があります。 ディスパッチクラスは、%CSP.RESTを拡張し、URLマップを含むXDataブロックを含めます。 こうすることで、システムに、特定のリクエストを受信したときにどのメソッドを呼び出すのかを指示します。
以下に、例を示します。
これは InterSystems FAQ サイトの記事です。
ソースプログラムのコンパイル後に生成される *.obj のみをエクスポート／インポートすることでソースの隠蔽化を実現できます。
コマンド実行例は、EX1Sample.mac と EX2Sample.mac のコンパイルで生成される EX1Sample.obj と EX2Sample.obj をエクスポート対象に指定し、第2引数のファイルにエクスポートしています。
別ネームスペースに移動したあと、エクスポートした XML ファイルを利用してインポートを実行しています。