モジュールについて¶
このアプリでは、データの検証や保管先、ユーザー認証といったお客様の環境に強く依存する要件は、'モジュール' と呼ばれる単位でアプリ本体から分離されており、このモジュールを自由に開発してアプリに組み込むことで、様々な環境に合わせて柔軟にカスタマイズできるよう設計されています。
モジュールの種類と役割¶
モジュールは次の3種類あります。このうち2種類のモジュールは原則お客様による開発が必要となります。
用語 | お客様で開発 | 役割 |
---|---|---|
キャプチャーモジュール | - (不可) | 画像と被写体上のシンボルをスキャンします。詳細はこのページの キャプチャーモジュール セクションを参照してください。 |
ユーザー認証モジュール | ● (任意) | 作業するユーザーを識別します。省略可。詳細は モジュールの開発 ページを参照してください。 |
データ保管モジュール | ● (必須) | キャプチャーで収集したシンボルから主/副ラベルを特定したり、画像やシンボルなどのデータを保管したりします。このモジュールはお客様による開発が必須となります。詳細は モジュールの開発 ページを参照してください。 |
次の図は、アプリと各モジュールがいつ・どのようなやり取りをしているかを示す概略図です。
sequenceDiagram
participant AUTH as ユーザー認証モジュール
participant CAM as キャプチャーモジュール
participant APP as アプリ本体
participant DB as データ保管モジュール
activate APP
APP ->>+ AUTH: ユーザー認証要求
AUTH ->>- APP: ユーザー情報
loop 情報が揃うまで繰り返し
APP ->>+ CAM: キャプチャ要求
CAM ->>- APP: 画像とシンボル
APP ->> + DB: 主/副ラベル検出要求
DB ->> APP: 主/副ラベル
end
APP->>DB: データ登録・保管要求
deactivate APP
キャプチャーモジュール¶
キャプチャーモジュールは画像と被写体上のシンボルをスキャンして収集します。このモジュールはお客様による開発はサポートされておらず、現時点では以下のモジュールを使用できます。