OutSystemsでは、Client Actionからサーバー側の処理を呼ぶと、（当然ながら）通信が発生する。サーバー側ロジックからクライアント側ロジックにExceptionが伝わっているので、通信の中でExceptionがどう表現されているかを確認してみた。

修正履歴

環境

Personal Environment(Version 11.17.0 (Build 36291))
Service Studio(Version 11.53.13)

通信に乗っている例外情報はほぼ同じ。ODCの場合、エラーコード（2024/05時点では定義のリストはないはず）がエラー種別ごとに定義されているようなので記述されている。また、ODC PortalでのTraceを特定できるtraceId項目もある。

Status Codeは250だった。200番台なので成功の扱い。

ForgeコンポーネントのV1.0.11。
MainFlow > Exception Screenの「②サーバーで発生した例外をClientで補足する」

Client Actionから呼び出したサーバー側ロジックで発生したExceptionは、HTTP通信のレスポンスとして、以下の形式となる（画像はChromeのデベロッパーツールでみた結果）。

HTTPレスポンスのJSON中のexceptionプロパティにExceptionの中身が入る。

exception
- message: Exceptionの「Exception Messageプロパティ」に渡したメッセージ
- name: （ドキュメントでは確認できないが見る限り）例外の種類。Exception Handlerで補足できるExceptionの種類に対応している。これがUserExceptionであれば、Exception HandlerのExceptionプロパティを「UserException」にすると補足できる
- specificType: 基本的に「モジュール名.Exception名」

テストパターン	nameプロパティ	specificTypeプロパティ
Server Action ¹	UserException	モジュール名.Exception名
Service Action	UserException	UserException
Extension	ServerException	OutSystems.NssExtension名.例外class名
Expose REST API	ServerException	System.Exception
Server ActionでOutSystems提供の例外をRaise	InvalidLoginException ²	""

Reactive Web Appの以下のようなClient Actionから、（必ず例外をRaiseする）各種サーバー側処理を呼び出し、どの種類の例外にHandleされるかと、通信内容を確認した。

呼び出すActionは以下のとおり。実行すると、定義したUser Exception（Sample Exception）を必ずRaiseする（Exception Message: "Exception2_1"）。

この場合、

SampleExceptionとしてHandleされる
通信レスポンスのexceptionプロパティの例
- message: "Exception2_1"
- name: "UserException"
- specificType: "HousesoftSampleReactive.SampleException"

呼び出す先のServer Actionが別のモジュールにあった場合に、通信内容に変化がないかを確認してみる。

UserExceptionとしてHandleされる
通信レスポンスのexceptionプロパティの例
- message: "Exception2_1_Producer"
- name: "UserException"
- specificType: "HousesoftSampleReactiveProducer.SampleExceptionInProducer"

今度は、同じモジュールのServer Actionから、独自に定義したExceptionでなくOutSystemsに元々備わっていたExceptionをRaiseしてみる。

Invalid LoginとしてHandleされる
通信レスポンスのexceptionプロパティの例
- message: "Exception2_1_ProvidedException"
- name: "InvalidLoginException"
- specificType: ""

外部モジュールにあるService Actionで例外が発生した場合。

User ExceptionとしてHandleされる
通信レスポンスのexceptionプロパティの例
- message: "Exception2_2"
- name: "UserException"
- specificType: "UserException"

Client ActionからExtensionに定義したServer Actionを呼び、その中でC#の例外classをthrowした場合。当然、OutSystemsで定義したExceptionとは別のものなので、どういう結果になるか。

All ExceptionとしてHandleされる
通信レスポンスのexceptionプロパティの例
- message: "Actionメソッドから直接例外をthrowする"
- name: "ServerException"
- specificType: "OutSystems.NssHousesoftSampleReactiveExtension.MyException"

絶対に例外を投げるExpose REST APIを作成し、そのAPIをConsumeし、さらにConsumeしたものをClient Actionから読んで結果を確認する。

All ExceptionとしてHandleされる
通信レスポンスのexceptionプロパティの例
- message: "500 Internal Server Error"
- name: "ServerException"
- specificType: "System.Exception"