アプリ固有の用語
- CLOUDSHIP
- CLOUDSHIP API
- ポイント
- ポイント ID
- ポイントのデータ型
- ポイントのデータサーバ - DPort
- 時系列データベース - TSDB
- 瞬時値データ
- タイムスタンプ
- 期間データ
- ユーザ
- システム管理者
- チーム
- チームメンバ
- コンテンツ
- RealBoard API
CLOUDSHIP
時系列データのプラットフォームです。 株式会社 PROMPT-X の製品です。
IoT 機器のセンサデータやサーバログなど日々蓄積されるデータを格納し、データ分析や可視化に活用できる環境を提供します。
CLOUDSHIP API
時系列データにアクセスするための HTTP API です。
RealBoard は CLOUDSHIP API 経由で時系列データにアクセスします。
詳細は時系列データのクエリを参照してください。
ポイント
CLOUDSHIP における基本的な要素で時系列データを表します。 （例：観測した部屋の温度データ）
RealBoard には複数のポイントを登録できます。
ポイント ID
時系列データを一意に識別するための ID です。
（例：/tokyo/office/room02/temperature）
ポイントのデータ型
RealBoard ではポイントのデータ型を以下のように分類しています。
- 数値型
- 文字列型
- BLOB 型（Base64 エンコードされたバイナリデータ）
ポイントのデータサーバ - DPort
CLOUDSHIP API を提供する HTTP サーバです。 CLOUDSHIP を構成するソフトウェアの 1 つで DPort という名称で呼ばれます。 DPort は 1 台の時系列データベースと接続します。
RealBoard には複数の DPort を登録できます。ポイント毎に接続先の DPort を変更可能です。 RealBoard はバックエンドで DPort に接続し、CLOUDSHIP API を使って時系列データの読取と書込を行います。
時系列データベース - TSDB
ポイントの時系列データを記録するデータベースです。 CLOUDSHIP を構成するソフトウェアの 1 つで TSDB という名称で呼ばれます。
TSDB には時系列データに対するサービス期間の制限があります。 サービス期間内の時系列データは読み取り可能ですが、期間を過ぎると読み取りできなくなります。 ただし、時系列データを記録したファイル自体はサーバに残っています。
サービス期間は、現在から過去 X 日間で定義されます。
CLOUDSHIP インストール環境の設定により、サービス期間の長さは異なります。
瞬時値データ
時系列データ内の特定の時刻における瞬間的なデータです。
| ポイント ID | タイムスタンプ | 瞬時値 |
|---|---|---|
/tokyo/office/room02/temperature |
2023-09-01T12:00:00.000+09:00 |
26.5 |
タイムスタンプ
瞬時値データの発生時刻です。最小粒度は 1 ミリ秒間隔です。 表示する場合、秒の小数部をミリ秒桁まで記した W3C-DTF 形式を用います。
期間データ
時系列データ内の特定の開始時刻から終了時刻の間に含まれる瞬時値データの配列です。
| ポイント ID | タイムスタンプ | 瞬時値 |
|---|---|---|
/tokyo/office/room02/temperature |
2023-09-01T12:00:00.000+09:00 |
26.5 |
/tokyo/office/room02/temperature |
2023-09-01T12:05:00.000+09:00 |
26.4 |
/tokyo/office/room02/temperature |
2023-09-01T12:10:00.000+09:00 |
26.3 |
/tokyo/office/room02/temperature |
2023-09-01T12:15:00.000+09:00 |
26.3 |
/tokyo/office/room02/temperature |
2023-09-01T12:20:00.000+09:00 |
26.4 |
/tokyo/office/room02/temperature |
2023-09-01T12:25:00.000+09:00 |
26.5 |
/tokyo/office/room02/temperature |
2023-09-01T12:30:00.000+09:00 |
26.4 |
ユーザ
RealBoard にログインできるアカウントです。
- ユーザは「チーム」という単位でポイントを共有します。
- チーム内のダッシュボード上でポイントの時系列データを確認できます。
- ユーザは複数のチームに所属できます。
外部ログイン
外部の認証サーバ（OpenID Connect 準拠）のアカウントも RealBoard のユーザとして登録できます。
RealBoard インストール環境に認証サーバが発行するクライアント ID とシークレットキーの設定が必要です。
初回の外部ログインに成功すると RealBoard に自動登録されます。 ただし、ユーザはログインしただけではポイントにはアクセスできない状態です。 RealBoard のシステム管理機能で、ユーザをチームに所属させる必要があります。
システム管理者
RealBoard のシステム管理エリアにアクセスできるアカウントです。
- ユーザとポイントの登録が可能です。
- チームの新規作成、編集、削除が可能です。
- RealBoard API にアクセスするための API Key を発行できます。
チーム
RealBoard のシステム管理者は、ユーザとポイントをシステムに登録します。 ポイントに対するアクセス権限をユーザに与えるため、ポイントとユーザを同じ「チーム」に所属させる必要があります。
ユーザはチーム内でダッシュボードやチャートリスト等のコンテンツを共有します。
チーム
- システム管理者はユーザ、ポイント、チームを作成できます。
- システム管理者はユーザとポイントをチームに所属させることができます。
- ユーザとポイントは複数のチームに所属可能です。
チームメンバ
チームに所属するユーザのことです。 一般とチーム管理者の 2 種類があります。 それぞれダッシュボード等のコンテンツに対するアクセス権限が異なります。 チーム管理者はチーム内コンテンツの新規作成、編集、削除が可能です。
| 種類 | 閲覧権限 | 編集権限 |
|---|---|---|
| 一般（通常のメンバ） | あり | なし |
| チーム管理者 | あり | あり |
ユーザのチームメンバ種類の変更は、システム管理機能から行えます。
コンテンツ
コンテンツの種類は以下のとおりです。ポイントのデータを様々な UI で可視化します。
| 種類 | 内容 |
|---|---|
| ダッシュボード | 瞬時値データと画像・アイコン・図形を組み合わせて表示 期間データのチャート表示 瞬時値データの書込 |
| チャートリスト | 期間データのチャート表示 |
| ポイント一覧 | ポイント一覧のテーブル表示 最新値データと最古値データ表示 期間データのテーブル表示 瞬時値データの書込 |
| CSV エクスポート | 期間データの CSV ファイル出力 |
| 画像エクスポート | 期間データの画像・動画ファイル出力 （BLOB 型 JPEG / PNG 画像データ対応） |
| タグマップ | 瞬時値データに含まれる位置情報データをマップ表示 （文字列型 JSON 対応。例： { "location": "area_id" }） |
| グリッド | 期間データのテーブル表示 （文字列型 JSON 対応） |
RealBoard API
RealBoard のシステム管理等の操作を HTTP 経由の API から行えます。
以下のリソースに対する CRUD 機能があります。
CRUD は「作成」「読み取り」「更新」「削除」の意味です。
- ユーザ
- ポイント
- チーム
- チームメンバ
- チームポイント
- チャートリスト
API にアクセスするにはシステム管理者が発行した API Key が必要です。