MSG_RECEIVE
このアクティビティは、IBM MQ Seriesなどのサポートされるメッセージ・ブローカー・システムからメッセージを受信します。このアクティビティとこのアクティビティを使用する際の前提条件については、「メッセージング構成」を参照してください。
MSGCONFIGパラメータでメッセージング構成の名前を指定します。この構成で、メッセージング・システムのアドレスと証明情報、メッセージの受信元の待ち行列などを指定する必要があります。
メッセージの内容はファイル内へ受信します。受信するファイルの場所と名前は、構成とパラメータ値によって決定されます。
さらに、第2のファイル内へ、コンマ区切り形式でメッセージ・プロパティを受信できます。CSVファイルの場所と名前は、構成とパラメータ値によって決定されます。
パラメータ値を指定した場合は、常に構成内の値が上書きされます。
受信するメッセージが存在しない場合、またはWAITTIMEパラメータで指定された時間(指定された場合のみ)の間待った後、このアクティビティは正常に終了しますが、メッセージ属性を含むOUTPUTパラメータは埋められません。メッセージが受信されたかどうかを確認するには、OUTPUTパラメータのMSGRCVCOUNTの値を利用してください。
INPUTパラメータ:
MSGCONFIG: 必須
このパラメータで、メッセージング構成の名前を指定します。この構成は、LANSA Composerクライアント・ソフトウェアのメッセージング構成のオプションで作成して保守できます。メッセージング構成では、必ず、アドレス、待ち行列の名前およびメッセージ・ブローカー・システムで使用するセキュリティ証明書を指定する必要があります。このパラメータを指定しない場合、これが見つからない場合または非アクティブな場合は、アクティビティがエラーを返し、処理が破棄されます。
WAITTIME: 任意
アクティビティが実行された際に取得可能なメッセージがない場合に、待ち行列に適切なメッセージが届くまでどのくらい待つかの時間を(ミリ秒単位で)指定します。
省略値は-1です。つまり、アクティビティが実行された際に取得可能なメッセージがない場合、待ち行列にメッセージが届くまで待ちません。
特別な値の0(ゼロ)を指定すると、アクティビティはメッセージが届くまでいつまでも待ちます。ただしこの値でメッセージが待ち行列に送られない場合、アクティビティおよびその中に含まれる処理シーケンスがいつまでも止まった状態になってしまうことを理解しておく必要があります。メッセージの到着以外の方法でこのような処理シーケンスの実行を中止するには、ジョブを中止させるか、ジョブが実行されているサブシステムまたはシステムを終了するしかありません。
ENCODING: 任意
ENCODINGは、受信するメッセージがUnicodeテキスト・メッセージの場合に使用します。省略値はUTF-8です。
MSGFOLDER: 任意
MSGFOLDERで、受信したメッセージの内容を含むファイルが格納されるフォルダーを指定します。指定した場合は、メッセージング構成の[受信フォルダ]の値がこのパラメータで上書きされます。
このパラメータを指定せずに、完全修飾名でMSGFILENAME.を指定することもできます。
フォルダーもMSGFILENAMEも指定しない場合は、\x_lansaにファイルが作成されます。
MSGFILENAME: 任意
受信したメッセージの内容が含まれるファイルの名前を指定します。MSGFOLDERまたは構成の[受信フォルダ]とともに使用します。指定した場合は、メッセージング構成の[受信ファイル名]の値がこのパラメータで上書きされます。
ファイル名を指定しない場合は、以下の形式でファイル名が自動生成されます。
<system setting prefix><number>
<system setting prefix>は[システム設定]の[POP3保存サブディレクトリ名接頭辞]に設定された値です。<number>は連番です。
PTYFILENAME: 任意
受信したメッセージ・プロパティが含まれるファイルの名前を指定します。このパラメータの値を指定しない場合に、メッセージ・プロパティを受信すると、ファイルにMSGFILENAMEと同じ名前が付き、拡張子CSVが追加されます。
メッセージング構成([メッセージプロパティ]タブ)で指定した場合は、このファイルが[メッセージプロパティ]の受信ファイルのパスに作成されます。指定しない場合は、MSGFOLDERに作成されます。MSGFOLDERを指定しない場合は、\x_lansaに作成されます。
SELECTOR: 任意
MQSeries システムに渡すメッセージ・セレクターを指定します。このパラメータは、IBM i サーバー上のMQSeriesメッセージ・キューにのみ有効です。このアクティビティでどのメッセージを受け取るかの選択をメッセージ・セレクターが行います。指定された場合、指定の条件に一致するメッセージのみをこのアクティビティで受け取ることができます。それ以外の場合は、メッセージのフィルターは行われません。
OUTPUTパラメータ:
MESSAGEID:
メッセージ・ブローカー・システムが返す受信メッセージのメッセージID
MSGRCVCOUNT:
受信メッセージのカウント。正しくメッセージを受信した場合はこの値が1になり、それ以外の場合はゼロ(0)になります。
MSGFILENAMEOUT:
受信したメッセージの内容が書き込まれたファイルのフル・パスとファイル名
PTYFILENAMEOUT:
受信したメッセージ・プロパティが書き込まれたファイルのフル・パスとファイル名