デバイスごとの設置場所、顧客、担当者、しきい値、運用状態をデバイス内の固定値にすると、設置後の変更や台数増加に合わせた管理が難しくなります。本構成では、IoT SIM とデバイスを対応づけて運用し、IoT SIM タグを現行値の保存先として使います。SORACOM Application Programming Interface (SORACOM API)、Comma-Separated Values (CSV)、外部台帳を組み合わせて、設定情報と管理情報をデバイス外で扱います。
ここでの外部化は、メタデータサービスだけを指しません。ユーザーコンソールや SORACOM API で管理するタグ、CSV による一覧、外部台帳との同期を含めて、どの情報をどこに置くかを決めるための設計です。デバイスからタグを読み書きする基本実装は、設計と実装 を参照してください。
このページが役立つケース
- デバイスごとの設置場所、顧客、担当者、しきい値、運用状態をデバイス内に固定せず管理したい。
- IoT SIM タグ、SORACOM API、CSV、外部台帳のどれを使うか判断したい。
- メタデータサービスを使う場合と、ユーザーコンソールや SORACOM API だけで管理する場合を分けたい。
- 多数の IoT SIM を、タグ検索、一覧表示、CSV ダウンロード、外部台帳で継続管理したい。
- デバイスから取得した電波状況や適用結果を、IoT SIM タグとしてユーザーコンソール上で確認したい。
タグは現行値の保存先として扱う
IoT SIM タグは、検索、一覧表示、SORACOM API 連携、デバイスからの参照に使う現行値の保存先です。変更履歴、承認状態、契約情報、長い説明文などを残す場合は外部台帳に保持し、タグには運用で必要な値だけを同期します。
全体の考え方
IoT SIM タグ、SORACOM API、CSV、外部台帳は、同じ役割ではありません。IoT SIM タグを中心にしながら、それぞれの役割を分けると運用しやすくなります。
| 要素 | 主な役割 | 向いている使いかた |
|---|---|---|
| IoT SIM タグ | IoT SIM に紐づく小さなキーと値を保持する | 設置場所、顧客、担当者、管理名、しきい値、運用状態など、検索や一覧表示に使う現行値を置く |
| ユーザーコンソール | 少数の IoT SIM を人が確認、更新する | 初期設定、個別変更、タグ検索、表示列への追加を行う |
| SORACOM API | 外部システムやスクリプトからタグを取得、更新する | 外部台帳をもとに繰り返し更新する、タグを一括取得する、運用状態を自動反映する |
| CSV | IoT SIM 一覧とタグをファイルとして扱う | 棚卸し、外部台帳への取り込み、更新前後の確認、バックアップに使う |
| 外部台帳 | 管理情報の元データや履歴を保持する | 顧客、設置場所、担当者、承認状態、変更履歴など、タグに収めない情報を管理する |
| メタデータサービス | デバイスから自身の IoT SIM 情報を参照または更新する | 起動時の設定取得、稼働中の設定取得、電波状況や適用結果のフィードバックに使う |
外部化する情報を分ける
IoT SIM タグには、運用上すぐに検索、一覧表示、分岐判断に使う値を置きます。一方、長い文章、履歴、承認状態、複数の関係を持つ情報は外部台帳に置きます。
| 情報 | IoT SIM タグに置く内容 | 外部台帳に置く内容 |
|---|---|---|
| 設置場所 | 拠点名、エリア名、設置場所コード | 住所、フロア、設置図、設置履歴 |
| 顧客 | 顧客コード、顧客名の短い表記 | 契約情報、担当窓口、請求や保守の詳細 |
| 担当者 | 担当部署、担当者コード | 担当者の連絡先、交代履歴、承認状態 |
| しきい値 | デバイスが参照する現在のしきい値やモード | しきい値の決定理由、変更履歴、適用対象の条件 |
| 運用状態 | active、maintenance、retired などの現在状態 | 状態変更の理由、作業記録、交換履歴 |
| 電波状況や取得時刻 | デバイスが最後に書き込んだ値 | 時系列の履歴、分析用データ |
タグを外部台帳の完全な代替にすると、タグ数、タグ値の長さ、履歴管理の面で扱いにくくなります。タグは、ユーザーコンソールや SORACOM API からすぐに参照する値に絞ります。
タグ設計で決めること
タグ設計では、タグ名、タグ値、主キー、更新元を先に決めます。
タグ名
タグ名は、運用中に安易に変えないものとして設計します。IoT SIM 名には name タグが使われます。SORACOM Air for セルラーが利用するタグ名は、IoT SIM に付加情報 (タグ) を設定する を参照してください。タグを外部台帳や SORACOM API と同期する場合は、表記ゆれを避けるため、タグ名の一覧を先に決めます。
たとえば、次のようなタグ名を使うと、ユーザーコンソール、CSV、外部台帳の項目を対応づけやすくなります。
| タグ名 | 用途 |
|---|---|
site | 拠点や設置場所 |
customer | 顧客または管理対象 |
owner | 担当部署または担当者 |
threshold | デバイスが参照するしきい値 |
status | 現在の運用状態 |
signal | デバイスが書き込む電波状況 |
signal_updated_at | 電波状況を取得した時刻 |
タグ値
タグ値は文字列として扱います。数値や日時を扱う場合も、デバイス側、外部台帳側、SORACOM API 側で同じ形式にします。
| 値の種類 | 例 | 決めておくこと |
|---|---|---|
| コード値 | site-a、customer-001 | 外部台帳のどの列と対応するか |
| 状態値 | active、maintenance、retired | 値の一覧と、状態変更できる条件 |
| しきい値 | 30、30.5 | 単位、桁数、デバイス側の解釈 |
| 日時 | 2026-06-09T10:00:00+09:00 | タイムゾーンと形式 |
| JavaScript Object Notation (JSON) 文字列 | {"interval":60} | デバイス側で処理できるサイズと形式 |
IoT SIM タグには個数と長さの制限があります。具体的な制限値は、IoT SIM に付加情報 (タグ) を設定する を参照してください。大きな JSON、長い説明文、時系列データをタグに保存する設計は避け、必要な値だけを置きます。
主キー
外部台帳と SORACOM を同期する場合は、どの識別子で紐づけるかを決めます。新規に SORACOM API で管理する場合は、SIM ID を主キーにし、Sim API を基本にします。International Mobile Subscriber Identity (IMSI) をキーにした既存処理がある場合や、利用サービスが IMSI / Subscriber を前提にしている場合は、Subscriber API を使うか確認します。詳しくは SORACOM API の Subscriber API と Sim API の違い を参照してください。
CSV を扱う場合も、外部台帳側で SIM ID、IMSI、Integrated Circuit Card Identifier (ICCID) など、どの識別子を列として保持するかを統一します。
更新経路を選ぶ
更新経路は、台数、更新頻度、更新元によって選びます。1 つの経路だけに固定せず、初期登録、日常運用、棚卸し、自動反映で分けると管理しやすくなります。
| 更新経路 | 向いている場面 | 注意点 |
|---|---|---|
| ユーザーコンソール | 少数の IoT SIM を個別に設定する | 大量更新には向かないため、表記ゆれや更新漏れが起きやすい |
| CSV ダウンロード | 現在の IoT SIM 一覧とタグを確認する | CSV は棚卸しやバックアップとして扱い、更新元を別に決める |
| SORACOM API | 外部台帳から継続的にタグを同期する | 権限、ページング、レート制限、再試行を設計する |
| SORACOM Command Line Interface (SORACOM CLI) | 手元の作業や運用スクリプトで更新する | 繰り返し実行する場合は認証情報の扱いと実行ログを決める |
| バッチ処理 | CSV をもとに複数の IoT SIM へ同じ種類の操作を行う | 操作ごとの CSV 仕様と、タグ削除やタグ名変更の扱いを確認する |
| メタデータサービス | デバイス自身がタグを読み書きする | SIM グループでの有効化、読み取り専用設定、書き込み対象のタグを決める |
外部台帳と同期する
外部台帳を使う場合は、外部台帳と IoT SIM タグのどちらを正とするかを決めます。多くの場合、顧客、設置場所、担当者、しきい値の元データは外部台帳に置き、IoT SIM タグには運用で使う現在値だけを同期します。
同期設計では、次の項目を決めます。
- 外部台帳の主キーと、SORACOM 側の SIM ID を対応づける。
- 外部台帳から IoT SIM タグへ同期する列を決める。
- IoT SIM タグから外部台帳へ戻す値を決める。
- 更新前に CSV で現在値を保存するかを決める。
- 同期失敗時の再試行、差分確認、復旧手順を決める。
外部台帳から一方通行でタグを更新するだけでなく、デバイスがメタデータサービスで書き込んだ電波状況や取得時刻を外部台帳へ取り込む構成も考えられます。この場合、タグは最新状態の表示、外部台帳は履歴や分析の保存先として分けます。
メタデータサービスとの使い分け
メタデータサービスは、デバイスから自身の IoT SIM に紐づく情報を参照または更新するための経路です。すべてのタグ管理にメタデータサービスが必要なわけではありません。
| 目的 | メタデータサービスの要否 | 理由 |
|---|---|---|
| 管理者がユーザーコンソールで設置場所や担当者を確認する | 不要 | ユーザーコンソール上のタグで確認できる |
| 外部台帳から SORACOM API でタグを更新する | 不要 | 管理側から SORACOM API を呼び出す構成で完結する |
| CSV でタグを棚卸しする | 不要 | SIM 管理画面の CSV ダウンロードで確認できる |
| デバイスが起動時にしきい値を読む | 必要 | デバイス自身がタグを取得する経路が必要になる |
| デバイスが電波状況や適用結果をタグへ書き込む | 必要 | デバイスから自身のタグへ値を書き込む経路が必要になる |
デバイスから値を書き込む場合は、どのタグをデバイスが更新してよいかを限定します。管理者や外部台帳が更新するタグと、デバイスが更新するタグを分けると、上書きや責任範囲の混乱を避けやすくなります。
既存記事との使い分け
- デバイスからタグを読み書きする基本構成と実装は、設計と実装 を参照してください。
- タグとユーザーデータの使い分け、設定情報の取得と反映タイミング、アクセス集中時の注意点は、活用と注意点 を参照してください。
運用前に確認すること
運用前に、次の項目を確認します。
- IoT SIM タグの個数、タグ名の長さ、タグ値の長さが制限内に収まっている。
nameタグや予約されたタグを、用途不明のまま変更または削除しない。- タグ名の表記ゆれを避けるため、外部台帳、CSV、SORACOM API で同じ名前を使う。
- 外部台帳と SORACOM の主キーを決め、SIM ID、IMSI、ICCID の使い分けを明確にする。
- SORACOM API を使う場合は、必要な権限、ページング、レート制限、再試行を設計する。
- CSV を使う場合は、更新前の一覧を保存し、どの時点の状態へ戻せるかを明確にする。
- バッチ処理を使う場合は、タグ削除やタグ名変更を同じ経路で扱えない場合の手順を確認する。
- メタデータサービスを使う場合は、SIM グループでの有効化、読み取り専用設定、デバイスが更新してよいタグを確認する。
- デバイスがタグを参照できない場合の初期値、再試行、運用者への通知を決める。
関連する SORACOM ドキュメント
- タグの設定: IoT SIM に付加情報 (タグ) を設定する
- IoT SIM の確認と検索: SIM 管理画面で IoT SIM の情報を確認 / 検索する
- メタデータサービス: デバイスで IoT SIM の情報を利用する (メタデータサービス)
- SORACOM API: SORACOM API 利用ガイド
- API のページング: 大量のデータを取得する (ページング)
- API のレート制限: レート制限 (rate limit)
- SORACOM CLI: SORACOM CLI 利用ガイド
- バッチ処理の CSV: CSV ファイルの要件
元記事・元資料
このページは、以下の記事・資料をもとにしています。
正確な内容や最新の情報を確認するときは、元の記事・資料もあわせて参照してください。
- SORACOM 公式ブログ: IoT SIM をもっと管理しやすく！タグ付けを Google スプレッドシートから操作できる「SORACOM Air Tag Manager」を作りました
- SORACOM 公式ブログ: SORACOM Arc でタグ機能を使ってみた
- SORACOM 公式ブログ: SORACOM API の Subscriber API と Sim API の違い
- SORACOM 公式ブログ: デバイスの電波状況を SORACOM ユーザーコンソールで確認できるようにする
- SORACOM 公式ブログ: SIM 一覧画面から CSV ダウンロードができるようになりました