#Ensemble

これは InterSystems FAQ サイトの記事です。
 

WebゲートウェイのSystem Status（システムステータス）ページでは、現在のすべてのアクティブな接続のステータスを確認することができます。

最初のステータステーブル (システムステータス) は、IRIS への接続に関する情報を表示します。
2番目のステータステーブル (InterSystems IRIS サーバ) は、InterSystems IRIS サーバに関する情報を表示します。
3 番目のステータステーブルは、アプリケーションパスの情報を表示します。
4 番目のテーブルは、Web ゲートウェイの応答キャッシュに保持されるフォームを表示します。

いくつかのサンプル接続ステータスを例にご説明します。

【ケース１】

最小接続数 ５の設定で、現在3接続が処理中の場合。
使用中のプロセスは InUse のステータス、待ち受けで空いているプロセスは Free で表示されます。
※Server のステータスは、Webゲートウェイレジストリメソッドで使用のプロセスです。
　CSP.iniで以下の設定をしている場合は、このプロセスは作成されません。
　[SYSTEM]
　REGISTRY_METHODS=Disabled

【ケース２】

これは InterSystems FAQ サイトの記事です。
 

Webゲートウェイ管理ページで、サーバ毎の最大接続数を設定したり、最大接続に達した場合に待ち時間（キュー）や静的なビジーページを設定することが可能です。

実際にサーバに接続する最大接続数を設定すると、それに達した場合に待ち時間（キュー）で設定した秒数待って、それを過ぎても接続数に空きが出なかった場合に、静的なビジーページに移行するような設定が可能となります。

設定箇所は以下になります。
※Webゲートウェイ管理ページ：
例（URLは環境・バージョンによって変わります）：
http://<webserver>/<instancename>/csp/bin/Systems/Module.cxw
 

★全サーバに適用される設定（デフォルトパラメータ）

サーバ単位の個別の設定がない場合は、こちらの設定が適用されます。

構成 > デフォルトパラメータ：

最大接続：各サーバの合計接続数の最大数（既定：1024）。

キューイングされたリクエストのタイムアウト：最大接続まで接続がある場合に、空きが出るまで待つ時間のタイムアウト値（秒）

ビジーページ：上記タイムアウトに達した場合に表示するビジーページ（例：只今混みあっております）

★接続サーバ単位で適用される設定（サーバ接続）

これは InterSystems FAQ サイトの記事です。
アプリケーション保全のために、データベースのジャーナルは必ず有効にしておく必要がありますが、何らかの理由でジャーナルを無効にしなければならない場合があるかと思います。

ディスク容量の縮小や、データ更新時のシステム負荷の削減など理由は様々です。

ここで注意していただきたいのは、データベースのジャーナルを無効にした場合にどのような影響がでてくるのか、ということです。

こちらのトピックでは、「データベースのジャーナルを無効にした場合の影響について」ご説明します。

ジャーナルを無効にする方法は、以下の2種類があります。

1. システム全体で無効にする方法（こちらを行う場合は【慎重】に！）

Set$namespace="%SYS"Do^JOURNAL  > 2) Stop Journaling (^JRNSTOP)

2. プロセス単位で無効にする方法　※ご参考

do DISABLE^%SYS.NOJRN                   // ジャーナリングを停止do ENABLE^%SYS.NOJRN                    // ジャーナリングを開始

※ミラーリング対象のデータベースは、ジャーナルを無効にすることはできません。
ジャーナルを無効にした場合、以下のことができなくなります。

これは InterSystems FAQ サイトの記事です。
「定期的にプロセスを監視し、あるイベントが発生したときにのみ処理を実行したい」ような場合に使用できる、便利な機能をご紹介します。

もちろん、Forループを行う常駐プロセスを作成してその中で Hang XX しながらIf文にてイベントを検知したり、タスクスケジュールでルーチンを定期実行してその中でIf文にてイベントを検知して処理することも可能です。

今回ご紹介する、%SYSTEM.Event クラスを使用することで、よりシンプルに処理を作成することが可能となります。

【こんな時に便利】
・テーブルやグローバルに、あるデータが全て格納されたら処理を行いたい
・あるエラーを検知したときにのみ、^SystemCheck情報を取得したい
・処理が必要なものがデータベースに入ったら順番に処理を行いたい（pythonだとQueueモジュールのような感じ）

【使用方法】

準備（任意のプロセス）

do $SYSTEM.Event.Create("test")
これで、testというイベントがシステムワイドで作成されます。
 

パターンA＝単純な常駐プロセス

これは InterSystems FAQ サイトの記事です。
IRISのプロセスを終了したい場合、管理ポータルから行う方法と、ターミナルからユーティリティやコマンドを使用して行う方法があります。

こちらのトピックでは、以下の3つの方法で停止する方法をご紹介します。

【プロセスの停止方法】
１．管理ポータルから停止する方法２．ユーティリティーで停止する方法（RESJOB、JOBEXAM）３．プログラムで停止する方法

【注意】
IRIS外から（Windowsならタスクマネージャーなど）、プロセスの終了は絶対に行わないでください。
IRIS外からプロセス終了してしまうと、IRIS内部ではプロセスの削除を検知できなかったりすることで、IRISの動作が不安定になったり、システム全体がハングする危険性がありますので、ご注意ください。

外部から停止の例外が一つだけあります。
$ZF コマンドによって起動された子プロセスが、何らかの問題で応答を返さなかった場合、$ZF コマンドを実行した親プロセスはそのまま残り続けます。
そのような親プロセスを終了したい場合、通常の上記１～３の方法では停止できません。
その際は、先に外部から子プロセスを停止する必要があります。子プロセスを特定するためには、以下の方法があります。

これは InterSystems FAQ サイトの記事です。

これらすべての操作は $ZCONVERT()関数を利用して操作できます。

詳しくは、ObjectScript CookBook に記載の説明をご参照ください。

• 全部大文字／小文字にしたい
• 指定の文字コードに文字列を変換したい
• HTMLの小なり記号 < や大なり記号 > をエスケープしたい
• URLやクエリパラメータに含まれる文字をエスケープ文字にしたい

これは InterSystems FAQ サイトの記事です。

一般的に、500番台はサーバー側で発生したエラーを表していて、503番エラーはサーバーが何らかの理由で機能を停止していてクライアントの要求に回答できない場合に出現するエラーです。

外部サイトの説明：503エラー 【HTTP 503 Service Unavailable】

以下、InterSystems 製品の使用で発生する503エラーの考えられる原因について一覧します。

REST/CSPページにアクセスできない

原因：ライセンスが割り当てられない場合に発生します（ライセンスが「同時接続ユーザ」での購入である場合、ユーザ数が制限を迎えたためライセンスが割り当てられずこのエラーが発生します）。

アプリケーションが「認証なし」アクセスを使用している場合、以下の原因により503エラーが発生します。

これは InterSystems FAQ サイトの記事です。
各InterSystems製品のサポートOS情報は、製品ドキュメントの「サポートプラットフォーム」情報で確認できます。

製品ドキュメントは、弊社ホームページ > サポート > ドキュメント よりご確認いただけます。

確認したい製品バージョンのドキュメント（例えば、InterSystems IRIS Version 2025.1）を開いていただき、「サポート対象プラットフォーム」リンクからご確認いただけます。

 　　　 ↓↓↓ 

※Cache & Ensemble の場合は（例えば、Cache & Ensemble Version 2018.1）、ドキュメント上部の Supported Platforms リンク 

これは InterSystems FAQ サイトの記事です。

ObjectScript で日付の比較を行う場合、一旦 $HOROLOG 形式（内部数値）に変換することで算出しやすくなりますが、SQL 関数を利用して算出することもできます。

ObjectScript から SQL 関数を実行するには、%SYSTEM.SQL.Functions クラスを使用します。

※ 2021.1以前のバージョンでは、%SYSTEM.SQL クラスを使用します。

%SYSTEM パッケージは、システム・オブジェクトと呼ばれ ObjectScript では $SYSTEM 特殊変数を利用して以下の構文で実行します。

  $SYSTEM.サブパッケージ名.クラス名.メソッド名() または $SYSTEM.クラス名.メソッド名()

以下、SQL 関数 DATEDIFF を使用して日付の比較を行う例です。

USER>write$system.SQL.Functions.DATEDIFF("dd","2025-01-20","2025-03-20")
59

分での比較

USER>write$system.SQL.Functions.DATEDIFF("mi","2025-01-20","2025-03-20")
84960

秒での比較

これは InterSystems FAQ サイトの記事です。

管理ポータルのシステム管理やシステムエクスプローラーなど最上位のメニューについては、事前定義ロールをユーザに付与することでアクセスを制限することができます。

最下位のメニュー、例えば [システム管理] > [構成] > [システム構成] > [ネームスペース] などは、事前定義ロールの %Manager を付与されたユーザであれば、全てのユーザが利用できてしまいます。

このページに対して、「%Manager ロールを持っているが、あるユーザは使用でき あるユーザは使用できない」のようにユーザ毎のアクセス制限を追加したい場合は、カスタムリソースを作成し再下位メニューに対して作成したカスタムリソースを付与することで制限を追加することができます。

手順は以下の通りです。

1. カスタムリソースを任意名で作成する。この時パブリック許可は設定しない。
2. 管理ポータルの任意の再下位メニューに 1 で作成したカスタムリソースを設定する。
3. 新規でロールを作成し、1で作成したカスタムリソースに対する USE 許可を設定する。
4. メニューを利用できるユーザを 3 で作成したロールのメンバーに設定する。

具体的な設定の流れは以下の通りです。

1. カスタムリソースを任意名で作成する。この時パブリック許可は設定しない。

これは InterSystems FAQ サイトの記事です。

InterSystems 製品インストール時に用意されている事前定義ロールを利用して、ログインユーザ毎に管理ポータルメニュー（システム管理／システムエクスプローラー／システムオペレーション　など）のアクセスを制限することができます。

管理ポータルメニューに対するアクセス制限を行うためには、管理ポータルへの「認証なし（UnknownUser）」アクセス（※1）を使用しない環境が必要です。

管理ポータル上部の「ログアウト」をクリックしてログイン画面が表示されない場合は、関連記事「管理ポータル／スタジオ／ターミナルにパスワード認証を設定するにはどうしたらいいですか？」をご覧いただき必要な設定を行ってください。

以下、インストールデフォルトで管理ポータルへのフルアクセスが許可されている事前定義ユーザ（※2）： SuperUser や _SYSTEM アカウントを使用して管理ポータルにログインした状態の設定例でご説明します。

これらユーザのパスワードはインストール時に設定しています（インストール時の「初期セキュリティ」を「最小」でインストールした環境では、パスワードは大文字の SYS が設定されています）。

これは InterSystems FAQ サイトの記事です。
こちらの記事では、非ミラー環境にミラー環境でオンラインバックアップしたバックアップファイルをリストアする方法をご紹介します。

手順は大きく分けて2つになります。

１．バックアップファイルからリストアを行う

２．データベースファイルのミラー属性を削除する

１．バックアップファイルからリストアを行う

以下は、^DBREST ユーティリティによる対話形式のリストア方法になります。

これは InterSystems FAQ サイトの記事です。

InterSystems 製品では、ユーザが持つロールによって「InterSystems 製品内で何ができるのか」が決まります。

では、ロールには何が含まれているのでしょうか。

ロールには、複数の特権を含めることができます。特権とは、リソース（保護対象）に対する許可の設定を指しています。

本記事では、IRIS の開発者である山田さん(Yamada) を例に、以下の内容をご説明します。

1) ロールから付与される特権（＝リソースに対する許可）について具体例を利用した確認方法

2) ロールを利用したセキュリティ設定について

《ご参考》

ビデオでの解説もあります。ラーニングパスの「InterSystems IRIS 管理の基本」の「4. セキュリティの構成と管理」をご参照ください。

ラーニングパスには、管理者ではないけれど管理概要も知っておきたい方向けの「開発者向け InterSystems IRIS の管理概要」もあります。ぜひご参照ください。

1) ロールから付与される特権（＝リソースに対する許可）について具体例を利用した確認方法

これは InterSystems FAQ サイトの記事です。
ロックテーブルを参照する方法として、主に以下の3つの方法が挙げられます。

1. 管理ポータルで参照する方法
　⇒ 管理ポータル：システムオペレーション > ロック > ロックを表示（または管理）

2. ^LOCKTAB ユーティリティ を使用する方法
　⇒ %SYS> do ^LOCKTAB

3. プログラムで参照する方法
　⇒ プログラム内でロック情報を取得する方法

こちらの記事では、ロックテーブルで参照できる情報について、以下の３つのケースに分けて、かかるロックとその意味をご説明します。

１．トランザクションで更新クエリ実行時、他のプロセスで更新・参照した状態
２．デッドロックとなった状態
３．テーブルロックがかかった状態

目視で一番わかり易いのは、１の 管理ポータルで参照する方法 になるので、こちらで説明したいと思います。

最初に、
１．トランザクションで更新クエリ実行時、他のプロセスで更新・参照をすると、どのようなロックがかかるのか見ていきます。

a. プロセスA（PID=10044）にてトランザクションで、Sample.Personテーブルの ID=1 を更新します。    ⇒ Exclusive_e->Delock ロック

これは InterSystems FAQ サイトの記事です。

InterSystems製品では、複数のプロセスが同時に同じデータにアクセスする場合、排他制御を行うためにロックを使用できます。
ロックは、データの更新を正しく行い整合性を保つための仕組みで、あるデータに対する更新処理を制御するために使用します。
ロックを操作するには、LOCK（Ｌ）というコマンドが使用できます。

こちらの記事では、InterSystems製品で使用できるロックの種類、LOCKコマンドの使い方をご紹介します。

★ロックの種類

プラス記号 (+) をつけると、増分ロックになります。１つのプロセスで複数の増分ロックを追加できます。
プラス記号 (+) をつけないと、単純ロックになります。こちらは、１つのプロセスで１つのロックのみ所有できます。単純ロックコマンド実行時に既存のロックがあった場合、そのプロセスが保持している既存のロックをすべて削除し、新しいロックを追加します。

IRISから他DDLのデータを参照したり取り込んだりする場合、各DDLのデータ型はそれと同等の InterSystems IRIS データ型にマッピングされます。

マッピングの定義は、管理ポータル、および、下記ドキュメントページでご確認いただけます。

管理ポータル：[システム管理] > [構成] > [SQLとオブジェクトの設定] > [システムDDLマッピング]

ドキュメント：InterSystems IRIS へのデータ型のマッピングの表示

これは、InterSystems FAQサイトの記事です。

メソッドの実装に使用する言語を明示する場合は、下記のようにメソッドキーワードで「Language＝～～～」と指定します。

Method name(formal_spec) As returnclass [ Language = language ]
{    //implementation }

 指定できるLanguageの値は下記のとおりです。

• objectscript (既定) — ObjectScript
• python — 組み込み Python
• tsql — Transact-SQL
• ispl — Informix ストアド・プロシージャ言語

ドキュメント：Language (メソッド・キーワード)

上記の通り、ObjectScriptで記載する場合は、「Language＝objectscript」と指定します。
但し、CSP内の<SCRIPT>タグ内で指定する場合は、下記の通り、「LANGUAGE＝’cache’」と指定することにご注意ください。

<SCRIPT LANGUAGE='cache',　～～～>

ドキュメント：<SCRIPT>  

※CSPページは、IRISでは非推奨の機能です。

これは、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

      ↓(結果)

これはInterSystems FAQサイトの記事です。
 

サーバのIPアドレスやマシン名は、%SYSTEM.INetInfoクラスのメソッドで取得することが出来ます。

set hostname=$System.INetInfo.LocalHostName()　//マシン（ホスト）名set ip=$system.INetInfo.HostNameToAddr($system.INetInfo.LocalHostName())　　//IPアドレス 

これはInterSystems FAQサイトの記事です。
 

指定した文字列式のうち指定したフィールド幅(半角での文字数)に収まる文字数を取得する関数：$ZPOSITIONと、部分文字列を返す関数：$EXTRACTを組み合わせることによって、全角/半角混在文字列から、指定された幅の文字列を取得することが出来ます。
※$Extractは文字単位で処理を行いますので、全角/半角を区別した取り扱いはできません。

構文：

$ZPOSITION(<文字列式>, <フィールド幅>, <全角文字に使用するピッチ値(デフォルトは2)>)

$EXTRACT(<文字列>, <開始位置>, <終了位置>)

例：

//指定した文字列(str)のうち、全角=2/半角=1 の幅として、フィールド幅10(半角10文字分)に含まれる文字数を取得
USER>set str="あい1234うえお"
USER>write$ZPOSITION(str,10,2)
7//指定した文字列(str)のうち、全角=2/半角=1 の幅として、フィールド幅10(半角10文字分)に含まれる文字列を取得
USER>write$extract(str,1,$zposition(str,10,2))
あい1234う

$ZPOSITION、$EXTRACTの詳細については、下記各ドキュメントページをご確認ください。

これは、InterSystems FAQ サイトの記事です。
 

InterSystems製品では、％Installerユーティリティによりインストール・マニフェストを定義することができます。これを利用することにより、複雑な構成設定を自動化することが可能になります。
これは特に、複数の同様なアプリケーションデプロイを行うときに大変有効です。

インストール・マニフェストの詳細については、下記のドキュメントページをご参照ください。
インストール・マニフェストの作成および使用

また、下記の トピックでも、詳しく記載されています。
%InstallerでInterSystems Cachéにアプリケーションをデプロイする
※記事ではCachéについて記述していますが、内容はIRISでも同様です。

これは、InterSystems FAQ サイトの記事です。
 

HTTPプロキシサーバまたは負荷分散装置（ロードバランサ）を経由してウェブサーバに接続するクライアントの送信元IPアドレスを特定する際は、HTTPヘッダ：X-Forwarded-For (XFF) を取得しますが、IRISでは以下で取得できます。

set ip = %request.GetCgiEnv("HTTP_X_FORWARDED_FOR")

これは、InterSystems FAQ サイトの記事です。
 

InterSystems製品は、二要素認証をサポートしています。
下記ドキュメントページに詳細について記載がありますので、ご参照ください。
２要素認証

以下、例として、スマートフォン用認証アプリを用いて、IRIS上のCSPアプリケーションの2要素認証を行うための設定方法を解説します。

これは、InterSystems FAQ サイトの記事です。
 

小数点桁数を指定しない単純な整数への切り上げ・切り捨ては、それぞれ、以下の関数で実行できます。

(SQL関数)

切り上げ：CEILING
切り捨て：FLOOR

(ObjectScript関数)

切り上げ： $system.SQL.Functions.CEILING()
切り捨て： $system.SQL.Functions.FLOOR()

※バージョン2021.1以前は以下のメソッドを使用します。

　切り上げ： $system.SQL.CEILING()
　切り捨て： $system.SQL.FLOOR()

小数桁数を指定して切り上げ・切り捨てを行いたい場合は、2つの関数を組み合わせ、以下のようなメソッドを作成して対応します。

これは、InterSystems FAQ サイトの記事です。
  

管理ポータルの [システムオペレーション] > [ジャーナル]のページで実行できる、 整合性チェックの実行や、サマリーの表示は、%SYS.Journal.File クラスのメソッドやクエリでも実行することができます。

クラスリファレンス：%SYS.Journal.File

以下、実行例です。
※全て、％SYSネームスペースで実行します。

(1) 整合性チェック

(2）サマリー

これは、InterSystems FAQ サイトの記事です。
 

システムログ(messages.log/cconsole.log)に出力される、

というログは、機能トラッカというタスクが出力しているメッセージです。
このタスクは、弊社がユーザ使用状況の統計を取得する為のデータ送信タスクになります。
エラーは弊社と通信が行われてない為に発生しています。

機能トラッカの詳細については下記ドキュメントをご確認ください。
機能トラッカによる使用量統計の収集

このタスク自体は、アプリケーションやシステムの動作自体に関連はありませんので、メッセージが出ていても影響はありませんが、タスクを無効にすることもできます。
機能トラッカのタスクを無効にする手順は以下の通りです。

1. 管理ポータルで、[システム操作]→[タスクマネージャ]→[タスクスケジュール] を選択
2. 機能トラッカの行を見つけて、[機能トラッカ] を選択
3. タスク詳細のページが表示されたら、[一時停止]
4. [タスク実行が一時停止された場合にタスクを再スケジュールしますか?] という質問に適切に回答
 → いいえ
5. [このアクションをすぐに実行する] を選択、タスクを停止

これは、InterSystems FAQサイトの記事です。
 

SQLでクエリ実行時、ORDER BYで並べ替えをする場合、各RDBMSによって、照合順が異なることがあります。

たとえば、NULLと空文字の混じった文字列のカラムを並べ替える場合、

IRIS SQLでは、既定の照合順は下記のようになりますが、 

Oracleでは、下記のような照合順になります。

複数のDB由来のデータを取り扱う際には、このような照合順の違いを合わせたい場合があります。

IRISの場合、既定の文字列照合はSQLUPPERですが、照合タイプを変更することによって、照合順を変えることが出来ます。
ドキュメント：照合

上記のIRIS SQLとOracleの違いを合わせるためには、照合タイプを「SQLSTRING」に設定し、インデックスを作成します。

Property TestColumn As%String(COLLATION = "SQLSTRING"); 
Index IdxTest On TestColumn;

以前公開している こちら の記事では、「OAuth 2.0 を利用して IRIS から Gmail を送信する」方法をご紹介しています。

本記事では、 %Net.POP3 クラスを使用してメールを受信するサンプルをご紹介します。

【事前準備（Gmailの場合）】

外部アプリからGmailを受信するには OAuth 2.0が必要となるため、こちらの手順 に従ってAccessToken を取得しておきます。
また、「2.【準備】IRIS で、SSLクライアントの設定をする : 手順(4)」の手順に従って、GMAILSSL（任意の名前）の構成を作成しておきます。

【サンプルの内容】

以下のサンプルでは、

１．Gmailの受信サーバ（servername = pop.gmail.com）に、ユーザ名（user = xxx@gmail.com）、パスワード（pass = パスワード）、AccessTokenを使用して接続し、

Set status=server.Connect(servername,user,pass,accesstoken)

２．メールボックスの情報を取得し、

Do..ShowMailbox(server)

３．Fetch() メソッドを使用して、添付ファイルを含むメールの内容の取得し、
　 （添付は server.AttachDir で指定したディレクトリに保存）

これは、InterSystems FAQサイトの記事です。
 

クライアントーサーバ接続を担当するスーパーサーバで、SSLバージョン3とTLSバージョン1での通信が可能です。
このオプションを利用することで、通信上のデータを暗号化できます。

その他、Kerberosを使うことで通信上の暗号化も可能です。

これはInterSystems FAQサイトの記事です。

大量の更新を行うプログラムで、処理途中に何らかの問題が発生してもデータを初期化して再度実行することができる状況では、プロセスレベルでジャーナリングを無効／有効に変更することが可能です。

※但し、トランザクションのロールバックにはジャーナルが必要ですので、ロールバックを正しく動作させたい場合にはこの方法は使用しないでください。

以下のコマンドを使用します。更新処理の開始と終了(またエラー処理での終了)の際に以下のコマンドを追加します。

//ジャーナリング無効化(停止)do DISABLE^%SYS.NOJRN
 
 //ジャーナリング有効化do ENABLE^%SYS.NOJRN

【注意】
こちらの機能は、ミラーリング対象のデータベースには使用できません。
DISABLE^%NOJRN を使用してジャーナリングを無効にしても、ミラーリングされたデータベースに影響はありません。

詳細は、以下のドキュメントをご参照ください。
ドキュメント：DISABLE^%NOJRN を使用したプロセス・レベルでのジャーナリングの管理