【IRIS/Cache】起動時処理を実行する(%ZSTART)

今回は、特定イベントの開始時に実行される%ZSTARTルーチン(以下%ZSTART)について解説します。

※この記事は下記の方向けになります。

インスタンス起動時に何かしらの処理を行いたい方
ターミナル等々の開始時に、何かしらの処理を行いたい方

はじめに
%ZSTARTとは
作成してみよう！
1. ベース作成
2. 処理の追記
確認してみよう！
おわりに

はじめに

「システム起動時何らかの処理を自動で実行させたいけれど、具体的にどのように設定すればいいのかわからない」といったお悩みはありますか？

%ZSTARTは、プログラムを開始する際に自動的に実行されるコードを定義できます。
開発者にとって非常に便利な仕組みですね。

本記事では、％ZSTARTの基本的な仕組みと設定方法、さらに具体例を交えながらその活用法について詳しく解説します。

それではさっそく、％ZSTARTについて詳しくみていきましょう。

%ZSTARTとは

%SYSネームスペースに「%ZSTART」ルーチンと、下記サブルーチンを定義する事で、各処理の開始時にサブルーチンが呼びされます。

サブルーチン	説明
SYSTEM	システムの開始時に実行する
LOGIN	%Service_Console、Service_Telnetサービスを使用してログインした際に実行する
JOB	JOBが開始された際に実行する
CALLIN	外部プログラムがCALLINを開始した際に実行する

これらサブルーチンは、複雑な処理や長時間の処理を行うものではありません。
　→起動に時間がかかるか、JOBの処理能力が低下するとの事

※でもローカル(開発・検証)環境なら気にしないでいいと思います。
　自分が我慢すればよいだけですから（笑

作成してみよう！

では早速%ZSTARTルーチンを作成しましょう。
スタジオ(or VsCode)より、%SYSネームスペースで新規ルーチンを選択し、「%ZSTAET.mac」の名称で保存します。

ベース作成

ルーチンを作成したら、下記をベースとして張り付けてください。

%ZSTART
	q
	;-
	;
SYSTEM ;
	q
	;-
	;
LOGIN ;
	q
	;-
	;
JOB ;
	q
	;-
	;
CALLIN ;
	q
	;-
	;

ベースを張り付けたら、次は「SYSTEM」「LOGIN」「JOB」「CALLIN」の各ラベルに必用な処理を記載していきます。

処理の追記

次に各サブルーチンに対し、簡単な処理を記述していきたいと思います。

サブルーチン毎にネームスペース「USER」へ切り替え、グローバルを作成する処理を追加しました。

%ZSTART
	q
	;-
	;
SYSTEM ;
	try{
		s ns = "User"
		i (##class(%SYS.Namespace).Exists(ns)){
			d LOGGING(ns, "SYSTEM")
		}
	}catch e {
	}
	q
	;-
	;
LOGIN ;
	try{
		s ns = "User"
		i (##class(%SYS.Namespace).Exists(ns)){
			d LOGGING(ns, "LOGIN")
		}
	}catch e {
	}
	q
	;-
	;
JOB ;
	try{
		s ns = "User"
		i (##class(%SYS.Namespace).Exists(ns)){
			d LOGGING(ns, "JOB")
		}
	}catch e {
	}
	q
	;-
	;
CALLIN ;
	try{
		s ns = "User"
		i (##class(%SYS.Namespace).Exists(ns)){
			d LOGGING(ns, "CALLIN")
		}
	}catch e {
	}
	q
	;-
	;
LOGGING(ns, key)	;
	new $namespace
	s $namespace = ns
	s ^test(key,$zdt($h, 3, 1)) = ""
	q
	;-
	;

ネームスペースの切り替えに関しては、下記記事を参照してください。