2
0

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?

[OutSystems] O11 が中で生成したソースを取り出す話 〜LifeTime API で oml の向こう側を見る〜

2
Last updated at Posted at 2026-07-28

この記事は、2026-07-15(水) に開催された、「あつまれ OutSystems Developer! 開発者超会議 Summer 2026」のセッションで話した内容を、あらためて解説したものです。

セッションで使用したスライドは、Speaker Deck で公開しています。

はじめに

人によって節目を感じたタイミングはさまざまでしょうが、私は、2025 年の暮れごろ、つまり、AI エージェントで使える skill の仕様が公開されたあたりで、世の中の変化のスピードが一段と上がったように感じています。各社のモデルも次々とアップデートされ、現在(2026 年 7 月)では、既存のプログラムソースコード資産をまるごと AI で解析してマイグレーション・モダナイズする話は、まったく珍しくなくなりました。

一方で、私たちが長く使ってきた O11 のソースは、完全にクローズドな独自形式の oml です。これはテキストを入力とする AI にそのまま読み込ませることができません。そのため、これまで構築してきた O11 資産の多くが、昨今の AI の恩恵を受けにくい「開かずの箱」になってしまっている、と感じる O11 ユーザーも多いのではと思います。

この記事では、この問題意識を前提に、O11 が内部で oml から生成しているソースコードを外部に取り出す方法と、取り出したソースコードを AI 解析に使えるかどうかについて、以下の内容を共有します。

  1. O11 が生成したソースを取り出せる API がある
  2. API 抽出ソースには何が入っていて何がないか
  3. API 抽出ソースは AI 解析に使えるのか
  4. ソース抽出 API の使い方と注意点

O11 からソースを取り出す 3 つの方法

O11 のプラットフォームサーバーが oml から内部で生成しているソースコードを取り出す方法は、3 つあります。本稿の主題である LifeTime API 以外のものも、ここで少し見ておきます。

デタッチ

OutSystems 契約を解約するとき限定の依頼手続きで、対象アプリを指定して「デタッチ」をしてもらうことが可能です。デタッチが完了すると、アプリのソースコードファイルを取得できます。このソースコードからは、OutSystems 社のランタイムへの依存が完全に削除されており、公式ドキュメントの手順で DB データを移行して環境を整えれば、Visual Studio でコンパイル・ビルドして、O11 なしの環境でアプリを動かせます。
OutSystems 社が「OutSystems はベンダーロックインしない」と謳う根拠になっている機能ですが、O11 解約とセットなので、気軽に使える手段ではありません。

直接抽出

O11 はプラットフォームサーバー上で生成したソースコード一式を、ディスク上に置きっぱなしにしています。そのため、オンプレ運用の O11 でサーバーインフラを直接管理している場合、場所さえ分かれば、通常のファイルコピーで生成ソースコードを取得できます。クラウドライセンスでも、IIS の実行プロセスがソースの置かれたパスを見る権限を持っていれば、FileSystem や Powershell Commander などの Forge を使うことで、直接抽出するアプリを O11 自身で作ることができます。

こうして直接抽出したソースコードは O11 のランタイムに強く依存しているため、単独で別環境に持って行ってコンパイル・ビルドすることはできません。また、この直接抽出は O11 の使用許諾的にはおそらくかなりグレーで、OutSystems 社が想定している使い方ではありません。抽出コードを業務でがっつり利用する話になるのであれば、OutSystems 社と事前に協議しておいた方が無難だろうと思います。

SAST 用 LifeTime API

本記事で紹介するのは、この SAST(Static Application Security Testing - セキュリティ目的の静的解析)用の LifeTime API を使う方法です。CI/CD パイプラインを構築する際(これも LifeTime API を使って行なう)に、O11 が内部で oml から生成したソースコードを静的解析にかけるステップを組み込むための API で、2024 年の製品アップデートで公開されました。2026 年の今となっては、そんなに新しい機能ではないのですが、意外に周知されていない印象があります。

この API で抽出できるソースコードは静的解析にかけるためのものなので、サーバー上で実行されている生成コードと同等の内容です。直接抽出と同様、O11 ランタイムへの依存は残ったままで、単独でコンパイルできないことは、公式ドキュメントにも明記されています。また、公式ドキュメントには、この API では抽出できないファイルがある、とも記載されています。

では、実際にはどんなファイルが、SAST 用 API の抽出対象から除外されているのでしょうか。

API 抽出ソースには何が入っていて何がないか

検証には、住所録 Excel インポートで作成したエンティティを Scaffolding して作った、一覧・詳細 2 画面構成の簡単な住所録アプリを使いました。このアプリを Service Studio からパブリッシュし、SAST 用 API で抽出したソースと、プラットフォームサーバーから直接抽出したソースを比較してみました。

その結果、API 抽出は直接抽出の完全な部分集合になっていて、共通しているファイルの内容はすべて一致していました(API 抽出 266 ファイル / 直接抽出 346 ファイル)。

API 抽出には含まれていなかったのは、次のようなファイルです。

  • Service Studio の Resources 内ファイル
  • Service Studio の Images 内ファイル
  • カスタムハンドラー(403 や 500 などの IIS エラーハンドラー)と関連リソース
  • Web.config
  • 各種 SQL

コードロジックの静的解析には使わないものが外されている、と言えそうです。逆に言えば、アプリの実行ロジックを理解するのに必要な情報は、API 抽出ソースにもおおむね含まれていると考えられます。

具体的に、直接抽出にはあって API 抽出にはなかった情報を 3 点挙げます。

  • エンティティの各属性(列)の桁長は、API 抽出のソースには情報がなく、直接抽出にしかないテーブル定義 SQL にのみ含まれていました。列の桁長管理は DB 任せの形になっているようです。
  • Excel インポートで作ったモジュールには初期データ投入用の Bootstrap タイマーが When Published(公開時実行)で自動構築されますが、このスケジュール情報も、API 抽出には含まれない SQL ファイル内の INSERT 文に記載されていました。
  • 初期データの元になる Excel リソースファイルの実体も、API 抽出には含まれていませんでした。

以上は今回の検証範囲での内容ですが、公式ドキュメントによれば、他にも、エクステンションコードはまったく取れず、構成やシークレットといった情報も取れないとされています。

API 抽出ソースは AI 解析に使えるのか?

上で見た住所録アプリの API 抽出ソースを、事前情報なしで AI に読み込ませ、アプリの仕様を起こさせてみました。

API 抽出ソースを元に作成させたアプリ仕様
# アプリ仕様書: Contacts Manager

> 本仕様書は、OutSystems O11 (Platform Server, Traditional/Reactive Web) がビルド・デプロイ時に生成した
> サーバーサイド C# コードおよびクライアントサイド JavaScript (MVC) の展開物**のみ**から復元したものである。
> Service Studio のオリジナル定義 (.oml) は参照していない。読み取れなかった項目は「不明」と明記する。
>
> - 復元元ディレクトリ: `/tmp/sast_blind_cmd333/src`
> - 主たる根拠ファイル: `moduleDefinitions.json`, `scripts/ContactsManager.appDefinition.js`,
>   `scripts/ContactsManager.model.js`, `Entities.ENContactEntityRecord.cs`, `Actions.*.cs`,
>   `ScreenServices.*.cs`, `scripts/ContactsManager.MainFlow.*.mvc.js`, `TimerBootstrapContacts.cs`,
>   `ExtendedActions.cs`, `referencesProxy/*.cs`

---

## 1. アプリ概要

| 項目 | 値 | 根拠 |
|------|----|------|
| アプリケーション名 | **Contacts Manager** | `appDefinition.js` `applicationName:"Contacts Manager"` |
| アプリケーションキー | `0903334e-1835-4dfd-b9ed-0fa1686b3ed5` | 同上 `applicationKey` |
| モジュール名 (eSpace) | **ContactsManager** | `moduleDefinitions.json` / `appDefinition.js` `homeModuleName` |
| モジュールキー | `5461e7fe-20a4-4e7b-b97e-cab49435f96e` | `moduleDefinitions.json` |
| モジュール種別 | Web (Reactive Web / OutSystems UI ベース) | `appDefinition.js` `isWeb:true`、クライアントは React ベースの `OutSystemsReactView.js` を使用 |
| ホーム画面 | `MainFlow.Contacts` | `moduleDefinitions.json` `homeScreenName` |
| デフォルト画面遷移 | Fade | `appDefinition.js` `defaultTransition:"Fade"` |
| 認証プロバイダ | **Users** モジュール | `appDefinition.js` `userProviderName:"Users"` |
| ビルド環境 | Production (environmentKey `b12a14c7-...`) | `appDefinition.js` `environmentName:"Production"` |
| ウォーターマーク表示 | なし | `appDefinition.js` `showWatermark:false` |
| デバッグ | 有効 (`debugEnabled:true`) | `appDefinition.js`。生成コードに Debugger.HandleBreakpoint が全面挿入されている |

**目的 (コードから推定)**: 連絡先 (氏名・カナ・郵便番号・住所・電話・FAX・メール) を一覧・検索・登録・編集する、
シンプルな連絡先管理 CRUD アプリ。属性名 (`NameKana`) および UI ラベル「Name Kana」から、**日本向けの連絡先台帳**を
意図していると読み取れる。初期データは組込 Excel (`Contacts.xlsx`) から Timer で投入される。

---

## 2. データモデル (エンティティ)

### 2.1 Contact エンティティ (アプリ固有・DB テーブル)

- 物理テーブル名: **`OSUSR_gq6_Contact`** (根拠: `Entities.ENContactEntityRecord.cs` L32/L40)
- Entity 論理名: `Contact`

| 属性 | データ型 | 必須 (UI検証) | 備考 | 根拠 |
|------|----------|:---:|------|------|
| Id | Long Integer | (自動採番/PK) | 主キー。`GenericRecord` 上で LongInteger、既定値=LongInteger.defaultValue | `model.js` ContactRec, entity attr map |
| Name | Text | ○ | 氏名 | 同上 (TypeKind.Text) |
| NameKana | Text | ○ | 氏名カナ | 同上 |
| PostalCode | Text | ○ | 郵便番号 | 同上 |
| Address | Text | ○ | 住所 | 同上 |
| Phone | Phone Number | ○ | 電話番号 (TypeKind.PhoneNumber) | 同上 |
| Fax | Phone Number | × (任意) | FAX 番号。`model.js` で mandatory フラグ false、`ContactCreateOrUpdate` の必須検証からも除外 | `model.js` L186 (Fax の mandatory=false)、`Actions.ActionContactCreateOrUpdate.cs` 検証式に Fax 無し |
| Email | Email | ○ | メールアドレス (TypeKind.Email) | 同上 |

- **Id が主キー・自動採番**であることは、`ContactCreateOrUpdate` が新規時に採番された `Id` を返す挙動と、
  一覧/詳細クエリが `[ENCONTACT].[ID]` を PK として扱う点から確定的。ただし DB 制約 (NOT NULL / 桁長) の
  厳密な定義値はソースからは**不明** (生成コードにテキスト属性の Length 定数が現れないため)。
- 必須の「○」は **UI/サーバーアクション上のバリデーション**を指す (`ContactCreateOrUpdate` が
  Name/NameKana/PostalCode/Address/Phone/Email の非空を検査)。DB レベルの Mandatory 定義そのものはソースから断定不可。

### 2.2 参照している静的エンティティ (OutSystemsUI モジュール由来)

アプリ固有ではなく **OutSystemsUI** モジュール (キー `8be17f2a-...`) の静的エンティティを参照。
UI レイアウト用の列挙値であり、業務データではない。

- **GutterSize** (静的): none / extraSmall / small / base / medium / large / extraLarge / xXLarge
- **BreakColumns** (静的): none / first / middle / last / all

(根拠: `model.js` L354-440 の staticEntities 定義)

---

## 3. 構造体 (Structure)

| 構造体 | メンバ | 用途 | 根拠 |
|--------|--------|------|------|
| **Excel_Contacts** (STExcel_Contacts) | Name, NameKana, PostalCode, Address, Phone, Fax, Email (全 Text) | Bootstrap 時に Excel を読み込むための行構造。Contact エンティティと同構成 | `Structures.STExcel_ContactsStructure.cs`, `model.js` Excel_ContactsRec |
| **ErrorMessage** (STErrorMessage) | Code (Text), Message (Text) | エラーメッセージ表現用 | `Structures.STErrorMessageStructure.cs` |

`model.js` には UI 用の匿名 Record として `BreakColumns` / `GutterSize` / `ErrorMessage` の
ラッパも存在するが、これらは OutSystemsUI のリスト表示補助であり業務構造ではない。

---

## 4. 画面構成 (Screens / Flows)

`moduleDefinitions.json` に定義された画面は 4 つ。フローは大きく **Common** (共通/認証) と
**MainFlow** (業務) に分かれる。加えて共通 Block・Layout が存在する。

### 4.1 画面一覧

| 画面 | フロー | URL | アクセス制御 | 根拠 |
|------|--------|-----|--------------|------|
| **Contacts** (ホーム) | MainFlow | `/Contacts` | Registered ロール必須 | `moduleDefinitions.json`, Controller L84 `CheckRegisteredRole` |
| **ContactDetail** | MainFlow | `/ContactDetail` | Registered ロール必須 | 同上 Controller L83 |
| **Login** | Common | `/Login` | 匿名可 (ログイン画面) | `moduleDefinitions.json` |
| **InvalidPermissions** | Common | `/InvalidPermissions` | 権限不足時のリダイレクト先 | `moduleDefinitions.json` |

### 4.2 Contacts 画面 (連絡先一覧・ホーム)

- **役割**: 連絡先の一覧表示・検索・並べ替え・ページング。新規追加への導線。
- **画面変数** (ローカル): `SearchKeyword` (Text), `StartIndex` (Int), `MaxRecords` (Int), `TableSort` (Text)
  (根拠: `Contacts.mvc.js` L21-30, ScreenModel L26-30)
- **データソース (Aggregate) `GetContacts`**:
  - `SELECT ... FROM {Contact}`
  - 検索: `SearchKeyword` 非空時 `WHERE [ENCONTACT].[NAME] LIKE N'%' + @keyword + N'%'` (**Name 列のみ**部分一致検索)
  - 並べ替え: `TableSort` により動的 ORDER BY (テーブルヘッダのソート機能)
  - ページング: `StartIndex` / `MaxRecords` + 件数カウントクエリ (`SELECT COUNT(1) ...`)
  - (根拠: `ScreenServices.ContactsManager_MainFlow_Contacts_ScreenModel.cs` L96-146)
- **UI 構成** (`Contacts.mvc.js`):
  - タイトル "Contacts"、見出し "Contact List"
  - 検索ボックス (OutSystemsUI **Search** ウィジェット)
  - 一覧テーブル。表示列は **Name / Name Kana / Postal Code / Address の 4 列**
    (Phone/Fax/Email はテーブルには表示されない — 詳細画面のみ)。列ヘッダに **Sort** 機能あり
  - "Add Contact" ボタン (plus アイコン) → **ContactDetail** へ遷移 (新規)
  - 各行クリック → **ContactDetail** へ遷移 (該当 Id)
  - 空表示: **BlankSlate** (Empty ウィジェット)
  - **Pagination** ウィジェット
- **アクセス制御**: 未ログイン (Registered ロール無し) の場合、Controller が権限チェックに失敗し
  InvalidPermissions/Login へ誘導される (L84 `CheckRegisteredRole`)。

### 4.3 ContactDetail 画面 (連絡先 詳細・登録/編集フォーム)

- **役割**: 1 件の連絡先の新規登録・編集。
- **入力パラメータ**: `ContactId` (Long Integer)。0/空なら新規、値ありなら既存編集
  (根拠: `ContactDetail.mvc.js` L21, ScreenModel L26)
- **データソース (Aggregate) `GetContactById`**:
  `SELECT ... FROM {Contact} WHERE [ENCONTACT].[ID] = @qploId AND [ENCONTACT].[ID] IS NOT NULL`
  (根拠: ScreenModel L83-87)
- **UI 構成** (`ContactDetail.mvc.js`):
  - 見出しは条件表示: **"New Contact"** (新規) / **"Edit Contact"** (編集) (L179/L188)
  - フォーム (form card) に 7 フィールド: **Name / Name Kana / Postal Code / Address / Phone / Fax / Email**
  - ボタン: **"Back"** (→ Contacts 一覧へ戻る) / **"Save"**
  - Save 押下 → サーバーアクション **ContactCreateOrUpdate** を呼び出し (L643-656)
- **削除機能**: 画面・スクリプト上に連絡先削除の UI/アクションは**存在しない**
  (`DeleteContact` 等のユーザーアクションは無く、grep ヒットは生成された Entity 標準 Delete メソッドのみ)。
  → **本アプリが UI で提供する操作は Create / Read / Update の 3 種**。Delete は公開されていない。

### 4.4 Login 画面 (Common)

- ユーザー名/パスワードによるログイン。Save 相当の操作で **DoLogin** アクションを実行。
- クライアント: `ContactsManager.Common.Login.mvc.js`。
- 統合ログイン (SSO/Unified Login) にも対応 (下記 §5, §6 参照)。

### 4.5 InvalidPermissions 画面 (Common)

- 権限不足時に表示される定型画面。`ContactsManager.Common.InvalidPermissions.mvc.js`。

### 4.6 共通 Block / Layout

`ScreenServices.*` および `scripts/*.mvc.js` から確認できる共通部品:

| 部品 | 種別 | 役割 | 根拠 |
|------|------|------|------|
| Layouts.LayoutTopMenu | Layout | トップメニュー型レイアウト (業務画面用) | `ScreenServices.ContactsManager_Layouts_LayoutTopMenu_Controller.cs` |
| Layouts.LayoutBlank | Layout | 空レイアウト (Login 等用) | `ScreenServices.ContactsManager_Layouts_LayoutBlank_Controller.cs` |
| Common.Menu | Block | メニュー | `..._Common_Menu_Controller.cs` |
| Common.MenuIcon | Block | メニューアイコン | `..._Common_MenuIcon_Controller.cs` |
| Common.ApplicationTitle | Block | アプリタイトル表示 | `..._Common_ApplicationTitle_Controller.cs` |
| Common.UserInfo | Block | ログインユーザー情報表示 + ログアウト | `..._Common_UserInfo_*.cs` |

**UserInfo Block** の詳細:
- データアクション **GetUserNameFromServer** → `User_GetName` を呼び、ログインユーザー名を取得・表示
  (根拠: `ScreenServices.ContactsManager_Common_UserInfo_ScreenModel.cs`, `..._DataActionGetUserNameFromServer_Model.cs`)
- クライアントアクション: ログアウト時に **DoLogout** を実行し、返却された RedirectURL へ遷移
  (根拠: `..._Common_UserInfo_Controller.cs` L172)
- 統合ログイン URL 取得 (`User_GetUnifiedLoginUrl`) も公開エンドポイントとして存在 (L189-193)

---

## 5. Server / Client アクション

### 5.1 業務ロジック (User Action / Server Action)

| アクション | 種別 | 入力 | 出力 | 内容 | 根拠 |
|-----------|------|------|------|------|------|
| **ContactCreateOrUpdate** | Server Action | Source (Contact レコード) | Id (Long) | 必須項目 (Name/NameKana/PostalCode/Address/Phone/Email が全て非空) を検証し、成立時に Entity の CreateOrUpdate を実行 (`ExtendedActions.CreateOrUpdateContact`) して採番 Id を返す。検証失敗時は EntityException `"Mandatory fields are required"` を送出 | `Actions.ActionContactCreateOrUpdate.cs` |
| **BootstrapContacts** | User Action (Timer から実行) | なし | なし | Contact テーブルが空の場合のみ、組込 Excel `bin2\hidden_resources\ContactsManager\Contacts.xlsx` を読み込み、各行を Contact として作成 (`ExtendedActions.CreateContact`)。既にデータがあれば何もしない | `Actions.ActionBootstrapContacts.cs` |
| **OnSessionStart** | System Event Handler | heContext | なし | 中身は空 (処理なし) | `Actions.ActionOnSessionStart.cs` |
| **OnBeginWebRequest** | System Event Handler | heContext | なし | 中身は空 (処理なし) | `Actions.ActionOnBeginWebRequest.cs` |

### 5.2 認証系アクション (Users モジュール参照アクションのラッパ)

これらはすべて外部モジュール **Users** の対応アクションを呼び出す薄いラッパ (根拠: `referencesProxy/eSpace_Users_proxy.cs`, `Actions.ActionUser_*.cs`)。

| アクション | 委譲先 (Users) | 役割 |
|-----------|----------------|------|
| **DoLogin** | User_Login | ユーザー名/パスワード/RememberLogin でログイン |
| **DoLogout** | User_GetUnifiedLogoutUrl → 無ければ User_Logout + User_GetUnifiedLoginUrl | ログアウト。統合ログアウト URL があればそちらへ、無ければ通常ログアウト後に統合ログイン URL を返す |
| User_Login | Users.User_Login | 資格情報によるログイン |
| User_Logout | Users.User_Logout | ログアウト (セッション変数クリア) |
| User_GetName | Users.User_GetName | ログインユーザー名取得 |
| User_GetUnifiedLoginUrl | Users.User_GetUnifiedLoginUrl | 統合 (SSO) ログイン URL 取得。Windows 統合認証パターンを含む |
| User_GetUnifiedLogoutUrl | Users.User_GetUnifiedLogoutUrl | 統合 (SSO) ログアウト URL 取得 |

### 5.3 ロール判定 (ExtendedActions)

| アクション | 判定ロジック | 根拠 |
|-----------|--------------|------|
| **CheckAnonymousRole** | 常に true (誰でも Anonymous) | `ExtendedActions.cs` L374 |
| **CheckRegisteredRole** | `heContext.Session.UserId != 0` (=ログイン済みなら true) | `ExtendedActions.cs` L384-388 |

---

## 6. ロール / 認証

- **認証基盤**: OutSystems 標準の **Users** モジュール (`userProviderName:"Users"`)。
- **ロール**:
  - **Anonymous** — 未ログインを含む全員。
  - **Registered** — ログイン済みユーザー (UserId≠0)。**業務画面 (Contacts / ContactDetail) は Registered 必須**。
- **ログイン方式**:
  - フォームログイン (ユーザー名 + パスワード + Remember Me) — Login 画面 → DoLogin。
  - **統合ログイン/SSO** — Unified Login/Logout URL を用いた外部 IdP 連携に対応。
    bin に **`ITfoxtec.Identity.Saml2.dll`** および OutSystems の SAML/認証拡張
    (`OutSystems.NssSAMLAuthentication.dll`, `OutSystems.NssAuthentication.dll`) が含まれ、
    Users モジュール経由で **SAML2 ベースの SSO** が利用可能な構成。
    (ただし SAML の具体的な IdP 設定値はこのアプリのソースには含まれず、Users モジュール側の管理事項ゆえ**不明**)
- **権限不足時**: InvalidPermissions 画面へ誘導。

---

## 7. バックグラウンド処理 (Timer)

| Timer | スケジュール | 処理 | 根拠 |
|-------|--------------|------|------|
| **BootstrapContacts** | (スケジュール値は DB 管理のため実値はソースから**不明**) | `Actions.ActionBootstrapContacts` を実行。Contact が空なら組込 Excel から初期データ投入 | `TimerBootstrapContacts.cs` (TimerName="BootstrapContacts", TimerKey `tnzN4yxGa0imWanoTKglxw`) |

- Timer は標準の実行制御 (多重実行防止・リトライ・CyclicJobLog 記録) を伴う生成コードで実装されている。
- `ExtendedActions.WakeBootstrapContacts` により手動起床 (即時実行トリガ) も可能。

---

## 8. 外部連携・参照モジュール / ライブラリ

### 8.1 参照 OutSystems モジュール (アプリが依存)

| モジュール | 用途 | 根拠 |
|-----------|------|------|
| **Users** | 認証・ユーザー管理 (ログイン/ログアウト/ユーザー名/SSO URL) | `referencesProxy/eSpace_Users_proxy.cs`, `bin/Users.dll` |
| **OutSystemsUI** | UI フレームワーク (レイアウト・Search・Pagination・BlankSlate・GutterSize/BreakColumns 静的エンティティ 等) | `referencesProxy/eSpace_OutSystemsUI_proxy.cs`, `moduleDefinitions.json` |
| **RichWidgets** | 補助ウィジェット群 | `bin/RichWidgets.dll`, `scripts/RichWidgets.referencesHealth.js` |

### 8.2 プラットフォーム/サードパーティ ライブラリ (bin 内・主なもの)

- **GemBox.Spreadsheet.dll** / `OutSystems.Spreadsheet.dll` — Excel 読み込み (Bootstrap の Excel→RecordList 変換に使用)
- **ITfoxtec.Identity.Saml2.dll**, `System.IdentityModel.Tokens.Jwt.dll`, `Microsoft.IdentityModel.*` — SAML2 / JWT (SSO 認証基盤)
- **Newtonsoft.Json.dll**, `System.Text.Json.dll` — JSON 処理
- **HtmlSanitizer.dll**, `AngleSharp*.dll` — HTML サニタイズ
- **NLog.dll**, `OutSystems.Logging.*` — ロギング
- **RabbitMQ.Client.dll**, `OutSystems.Plugin.RabbitMQ.dll` — メッセージング (プラットフォーム標準)
- その他 OutSystems ランタイム/DB アクセス/セッション管理系の標準アセンブリ

> 注: 8.2 の多くは OutSystems Platform Server が全アプリに同梱する標準依存であり、
> 本アプリが**業務目的で明示的に呼び出している**のは Excel 読込 (Bootstrap) と Users 経由の認証のみ。

### 8.3 外部 API / DB 連携

- 独自の REST/SOAP 消費 (Consume REST/SOAP) や、Contact 以外の外部 DB 連携を示すコードは**確認できなかった**。
  データ永続化はプラットフォーム DB 上の `OSUSR_gq6_Contact` テーブルのみ。
- 画面と C# 間の通信は OutSystems 標準の内部 REST エンドポイント (`ScreenServices.REST*`) で行われる
  (これはフレームワークの仕組みであり、外部公開 API ではない)。

---

## 9. 多言語 / メッセージ

- 言語リソース (`languageResources.js`) は OutSystems 標準のバリデーションメッセージ
  (This field is required. / Enter a valid email. 等) と、アプリ更新エラー系メッセージのみ。
  **UI テキストは英語**で定義されている ("Contact List", "Add Contact", "New Contact", "Edit Contact",
  "Save", "Back", "Search", "Name", "Name Kana", "Postal Code", "Address", "Phone", "Fax", "Email")。
- 属性 `NameKana` およびラベル「Name Kana」の存在から**日本語圏の連絡先**を扱う想定だが、
  画面ラベル自体は英語。多言語 (ロケール切替) 定義はソースからは**確認できず** (不明)。

---

## 10. 復元できなかった/確証のない項目 (正直な明示)

- Contact 各 Text 属性の **DB 桁長 (Length)** と DB レベルの NOT NULL 制約値: 生成コードに現れず**不明**。
  (UI/アクションレベルの必須検証のみ確認可能)
- Contact エンティティの **インデックス定義**: ソースからは**不明** (検索が Name の LIKE のみである点は確認できる)。
- BootstrapContacts Timer の **実スケジュール値** (実行間隔): DB 側管理のため**不明**。
- **Contacts.xlsx の中身** (初期投入される具体的な連絡先データ): バイナリリソース参照のみ確認、内容は**不明**。
- SAML/SSO の **IdP 設定・証明書・メタデータ**: Users モジュール側の設定事項でありこのアプリのソースには含まれず**不明**。
- 各画面の **細かなスタイル/CSS カスタマイズ**: `css/ContactsManager.ContactsManager.extra.css` に存在するが
  本仕様書では詳細スタイルは対象外とした。
- Fax 以外の項目の「必須」は UI/サーバーアクション検証に基づく。**モデル上の Mandatory 属性値**そのものは
  クライアント model.js のフラグ (Fax のみ false、他 true) から推定しており、DB 定義との一致は未確証。

---

## 付録: 画面遷移まとめ

```
[Login] --(DoLogin: Users.User_Login)--> [Contacts] (ホーム, Registered必須)
   |                                          |
   | (統合ログイン/SSO URL)                    |--(Add Contact)------> [ContactDetail] (New)
                                              |--(行クリック)---------> [ContactDetail] (Edit, ContactId)
                                              |
[ContactDetail] --(Save: ContactCreateOrUpdate)--> 検証OK→保存→[Contacts]へ戻る / 検証NG→EntityException
   |--(Back)-----------------------------------> [Contacts]

[UserInfo Block] --(Logout: DoLogout)--> RedirectURL (統合ログアウト or 通常ログアウト+統合ログインURL)

権限不足時 --> [InvalidPermissions]

[Timer: BootstrapContacts] --(Contact空なら)--> Contacts.xlsx を読み込み初期データ投入
```

かなりの情報がきちんと拾えていることが見て取れます。

もちろん、この一例だけで、どんな規模・どんな構成の O11 アプリでもじゅうぶんな仕様復元ができるとまでは言えません。ですが、少なくとも今回のような小規模な Reactive Web アプリについては、API 抽出したソースコードから、アプリの構造と主要な処理を理解できるだけの仕様を起こせた、と言えます。

以上から、取れない情報があることを承知しておけば、API 抽出ソースは AI 解析の材料として十分使える、ということが分かりました。

開発と本番の差

SAST 用 LifeTime API の呼び出しにおいては、抽出元の環境を指定します。つまり、開発環境を指定すれば、開発環境のプラットフォームサーバー内で生成されたソースが、本番環境を指定すれば本番環境内で生成されたソースが、それぞれ抽出できます。そこで、開発環境から抽出したソースと、本番環境から抽出したソースにどんな差があるかも軽く確認してみました。

ファイル数は dev 266 / prod 266 で同数でした。差分があったのは 17 ファイルで、加えて各環境に固有のファイルが 2 ファイルずつありました。差分の内訳は、コンパイル時刻などのビルドメタ情報や、日付書式、環境名、接続先、その環境にだけ設定された拡張に関する情報など、環境固有の設定や状態に関するものでした。アプリの構造や処理内容を表す部分には、差は 1 件もありませんでした。

デバッグ情報まわりの実装差異があるのではと予想していたのですが、そうではありませんでした。今回の実験結果だけから「どんな内容のアプリでも環境間に差異はない」と断言できるわけではありませんが、少なくとも今回確認した範囲ではこうだった、という情報として共有しておきます。

SAST 用 LifeTime API の使い方

最後に、SAST 用 LifeTime API の使い方について、軽く触れておきます。基本的には、公式ドキュメントに従って 6 つの API を順番に呼ぶだけです。

まず、公式ドキュメントにあるバージョン要求(Platform Server 11.28.0 以降 / LifeTime 11.22.0 以降)を満たしているか確認し、適切な権限を持つ Service Account を LifeTime で作成して、トークンを払い出しておきます。以降のすべての API 呼び出しには、このトークンを格納した Authorization HTTP ヘッダが必要です。

手順は次の 6 ステップです。

# ステップ メソッド
1 環境キー取得 GET
2 対象アプリ/モジュールのキー取得 GET
3 パッケージ(ZIP)作成リクエスト POST
4 ステータス確認(Done になるまで繰り返し) GET
5 ダウンロード URL 取得 GET
6 ZIP ダウンロード GET

#2 で取得するキーがアプリキー/モジュールキーのいずれであるかで、抽出をアプリ単位で行なうか、モジュール単位で行なうかが決まります。CI/CD のリリースパイプラインで使う場合、アプリ単位での取得が標準的な使い方ですが、公式ドキュメントによると #6 で取得できる ZIP のサイズに 150 MB の制限があります。今回使った一覧・詳細 2 画面だけの小さなモジュールでも、ZIP サイズは 20 MB 近くありました。
このことから、取得対象が大きくなりそうな場合は、アプリではなく、モジュール単位で取得する方が無難だと思います。

なお、#6 で使うダウンロード URL 自体も LifeTime API として実装されているため、ブラウザを #5 で取得した URL にリダイレクトしても、Service Account の認証ヘッダがないため、失敗してしまいます。

ZIP ダウンロード API の注意点

前述したように、ダウンロード URL への GET リクエストにも Service Account のトークンが必須です。ですが、だからと言って、O11 の Consume REST でこの取得処理を組むのは、ちょっと考えものです。

バイナリを返す REST を Consume REST で扱う場合、サーバーアクションロジックの上で、いったん取得したバイナリ全量をアクションの出力パラメーターに詰め直す必要があります。そうすると、そのタイミングで ZIP バイナリ全量が、プラットフォームサーバーのメモリ上に載ることになります(下図の赤矢印の箇所)。今回使った小規模な 2 画面アプリですら ZIP は 20 MB 近いサイズだったので、モジュール規模によっては、プラットフォームサーバーに対してかなりのメモリ負荷になってしまいます。

Consume REST で ZIP ダウンロードを組んだ場合のサーバーアクションフロー(バイナリ全量がメモリ上に載る)

O11 で取得用のアプリを作るという観点であれば、#5 で得られるダウンロード URL と Service Account の認証トークンの両方をクライアント側に渡し、認証ヘッダ付きの GET リクエストをブラウザ JavaScript から直接 LifeTime サーバーに投げる、という方法も、技術的には 考えられます(下図)。

クライアントアクションからブラウザ JS で認証ヘッダ付き GET を投げるフロー

ただし、 この方法は非推奨です 。

LifeTime 管理画面で発行する Service Account 認証トークンは、有効期間のあいだ使いまわす仕様なので、本来 CI/CD パイプラインなどのシステム側に閉じて使わなければなりません。ユーザーのブラウザに直接露出させるのはご法度です。

リスクを承知の上でこの方法を採用する場合は、専用に払い出した Service Account を使って使用後すぐに無効化する、Internal Network でアクセス元を制限する、User Provider を Service Center にした上で、IT ユーザーのロール管理ロジックも独自に組み込んでロール制御する、何らかの難読化を組み合わせるなど、考えられる限りの防御策を講じて、リスクの緩和を試みる必要があります。ですが、どう緩和しても、非推奨であることは変わりません。

余談ですが、ODC の SAST 用 API では、ダウンロード URL 自体が有効期限付きの認証不要 URL として発行されるようになっています。O11 でもそうなってほしいところです。

まとめ

2024 年から使えるようになっている SAST 用の LifeTime API を、テキスト入力 AI で O11 資産を活用するのに使えないか、という観点で、あれこれ見てきました。

  • O11 がプラットフォームサーバー内部で oml から生成したソースの抽出に使える LifeTime API がある
  • API で抽出したソースには含まれない情報もある
  • API 抽出ソースは、AI 解析でアプリ仕様を確認するのには使えそう!
  • ソースダウンロード API を Consume REST で使うときには注意が必要

これらの情報が、皆さまの O11 と AI の活用、そして楽しい開発に、少しでもお役に立てたら幸いです。

2
0
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
2
0

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?