デバイス一覧のインポート/エクスポート
概要
enebularが管理するDevice Listの情報をファイル(Devicesファイルと呼ぶ)にExportする機能、および、DevicesファイルからenebularにImportする機能を提供します。 Import/Exportの対象はAWS IoTのConnectionで管理されたライセンスが付与されたDeviceの一覧です。
ユーザはExportしたDevicesファイルを修正し、そのファイルをenebularにImportすることでDevice Listを更新できます。
更新できるデータはTagsのみです。
Import/Exportの実施単位はConnection単位です。
デバイス台数が多い場合にはImport処理が長時間に及ぶことがあるため、Importの結果はメールを用いて通知します。
説明
前提
- Import/Export機能は有料ユーザのみ利用できます
- Import/Exportを実施できるのは、Projectのowner又はadminのみです
- Import機能は、ExportしたDevicesファイルを編集してExport元のConnectionのDevice Listを上書きするためにのみ利用します(新たなデバイスを追加したり、既存のデバイスを削除したり、別のConnectionにデバイスをコピーしたりする目的には利用できません)
Devicesファイルの形式
Import/Exportの対象であるDevicesファイルの形式について説明します。
- Devicesファイルの形式はTSV(Tab Separated Values)です
- Devicesファイルに出力する内容は以下です
| 項目(ヘッダー) | 説明 | Import時の変更可否 |
|---|---|---|
| id | enebularが付与したDeviceのID。 | 否 |
| identifier | AWS IoTでデバイスを特定する名前です。AWS IoTのThing名に相当します。 | 否 |
| tags | デバイスに付与したTagです。カンマ区切りで複数のTagを記述可能です。 | 可 |
| pelionDeviceName | 現在は利用しません（空文字を出力します）。 | 不可 |
- Devicesファイルの一行目はヘッダーを記載します(変更しないようにしてください)
- ファイル名は
<Connection名>_<ConnectionId>.tsvです - ファイルの文字コードはUTF-8、改行コードはCRLFです
以下にDevicesファイルの例を示します。
id identifier tags pelionDeviceName
e7df192d-9338-98fc-b051-06d01a0def27 agent-test-buster-01 foo,bar,foobar
1行目がヘッダー行であること、文字列と文字列の間はTabにて区切られていること、2行目のtagsの値はカンマ区切りで複数のTagを記載できることがわかるかと思います。
Export機能の使い方
Device ListをExportするときの操作手順を説明します。
- Export対象のConnectionが存在するProjectの画面を開きます
- 左側のメニューのDevicesをクリックします
- Export対象のConnectionをクリックします
- 表示されたDevices画面の右上部のSettingsをクリックします
- 表示されたサブメニューの中からExport Devicesをクリックします
- 確認ダイアログが表示されるため、OKボタンをクリックします
- Devicesファイルのダウンロードが開始します
Import機能の使い方
DevicesファイルをImportするときの操作手順を説明します。
- Import先のConnectionが存在するProjectの画面を開きます
- 左側のメニューのDevicesをクリックします
- Import先のConnectionをクリックします
- 表示されたDevices画面の右上部のSettingsをクリックします
- 表示されたサブメニューの中からImport Devicesをクリックします
- 表示されたダイアログでImport対象のDevicesファイルを指定します
- Importボタンを押下します
- しばらく待つとenebularに登録したemailアドレスへメールが送信されます
Import実行結果のメールには以下の内容を含みます。
- success count: 更新成功件数
- error count: 発生したエラー件数
- imported date: Importを実施した日時
- エラーがあった場合、以下のエラー情報を記載します
- line number: Devicesファイルにおけるエラーのあった行番号
- error message: エラーメッセージ(エラーの内容を表す)
※ エラーが発生してもImport処理を中断せず、エラーがない行のImportは継続して実施します ※ ヘッダー誤りやファイルが空など、Devicesファイルを正しく読み込めない場合にはメールではなく、画面上にすぐにエラーを表示します