エクスポート

このセクションでは、プラットフォーム上の全データまたは選択したデータに対して定期的にエクスポートを構成する方法と、データポイントテーブル ウィジェットなどのウィジェットに統合されたエクスポート機能の違いについて説明します。エクスポート機能を使用すると、選択したデータポイントから現時点のデータをエクスポートできます。

エクスポートの管理

エクスポート機能を使用すると、特定のデータを CSV または Excel ファイルにエクスポートできます。

必要条件

ロールとアクセス権限：

  • エクスポートを表示する：「インベントリ」権限タイプの読み取り権限
  • エクスポートを編集する：「インベントリ」権限タイプの管理者権限
  • 新しいエクスポートを追加する：「インベントリ」権限タイプの作成権限または管理者権限
  • エクスポートをスケジュールする：「エクスポートのスケジュール」権限タイプの管理者権限
  • エクスポートを複製する：「インベントリ」権限タイプの管理者権限
  • エクスポートを削除する：「インベントリ」権限タイプの管理者権限

この機能を使用すると、テナント全体のデータをリクエストできます。さらに、特定のデバイス、期間、フィールドなどのフィルタリングすることができます。エクスポートデータには、指定したすべてのフィルターと有効なフィールドに関する情報が含まれます。

すべてのエクスポートを表示する

すべてのエクスポートを表示するには、ナビゲータの 構成 メニューで エクスポート をクリックします。

エクスポート ページには、すべてのエクスポートの名前、ファイルタイプ、期間がリスト表示されます。

Exports

エクスポートを追加する

  1. トップメニューバーで エクスポートを追加 をクリックします。

  2. エクスポートの名前を入力し、レポート出力のファイルタイプ（CSV または Excel(.xlsx)）を選択します。

フィルター

フィルターセクションでは、特定のオブジェクトまたは期間のデータをリクエストするためのフィルターを選択できます。

特定のオブジェクトをフィルタリングするには、検索フィールドに名前またはプロパティ値を入力し、検索アイコン をクリックします。一致するすべてのデバイスまたはグループが、値 フィールドの下に表示されます。オブジェクトをクリックして選択します（緑色で強調表示）。

備考
グループを選択すると、直接の子デバイスのデータが含まれます。ただし、エクスポートにはサブグループ（間接の子）のデバイスのデータは含まれません。

期間 フィルターは、特定の期間のデータをフィルタリングできます。ドロップダウンフィールドから期間を選択します。すべての期間はプラットフォームのシステム時間（UTC）を想定しています。

  • 過去24時間：
    • 開始： エクスポート時間の 24 時間前
    • 終了： エクスポート時間
    • 例： 2020年12月31日 12:34:56 から 2021年1月1日 12:34:56 まで（2021年1月1日 12:34:56 にエクスポートした場合）
  • 過去7日間：
    • 開始： エクスポート時間の 7 日前
    • 終了： エクスポート時間
    • 例： 2020年12月25日 12:34:56 から 2021年1月1日 12:34:56 まで（2021年1月1日 12:34:56 にエクスポートした場合）
  • 過去30日間：
    • 開始： エクスポート時間の 30 日前
    • 終了： エクスポート時間
    • 例： 2020年12月2日 12:34:56 から 2021年1月1日 12:34:56 まで（2021年1月1日 12:34:56 にエクスポートした場合）
  • 先週：
    • 開始： エクスポート日に対して、先週の午前 0 時
    • 終了： エクスポート時間
    • 例： 2020年12月25日 00:00:00 から 2021年1月1日 12:34:56 まで（2021年1月1日 12:34:56 にエクスポートした場合）
  • 先月：
    • 開始：エクスポート時間と同じ日、ただし先月の午前 0 時
    • 終了： エクスポート時間
    • 例： 2020年12月1日 00:00:00 から 2021年1月1日12:34:56 まで（2021年1月1日 12:34:56 にエクスポートした場合）
  • 昨年:
    • 開始： エクスポート日と同じ日、ただし昨年の午前 0 時
    • 終了： エクスポート時間
    • 例： 2020年1月1日 00:00:00 から 2021年1月1日 12:34:56 まで（2021年1月1日 12:34:56 にエクスポートした場合）
  • カスタム：
    • 開始： ユーザーが指定した日時
    • 終了： ユーザーが指定した日時

エクスポートするオブジェクト と 期間 のチェックボックスを選択して、それぞれのフィルターを有効にします。

備考
定義されたフィルターに一致するドキュメントの最大数は 100 万です。定義されたフィルターのドキュメント数がこの制限を超える場合、最初の 100 万のドキュメントのみがエクスポートされます。さらに、この制限により結果が切り詰められると、インジケーターを含む追加の行がファイルの最後に追加されます。インジケーター行には、「限界を超えました」と「結果が切り捨てられました」というステートメントが 1 列おきに交互に含まれています。

フィールド

オブジェクトおよび期間のフィルターに加え、特定のフィールドでデータをフィルタリングできます。

  • アラーム
  • イベント
  • マネージドオブジェクト
  • メジャーメント

トグルを使用して、フィールドの有効 / 無効を切り替えます。

備考
期間が選択できるフィルターは、アラーム、イベント、メジャーメントにのみ適用され、マネージドオブジェクトには適用されません。マネージドオブジェクトを選択すると、指定した期間に関係なくエクスポートに表示されます。

フィールドを有効になると、事前定義されたプロパティ、または空のプロパティを追加できます。

備考
選択したフィールドのどれにも値が定義されていないドキュメントは、生成されるエクスポートファイルから削除されます。これは、上記で定義したフィルターの結果がすでに計算された後にのみ実行されます。一般的に、結果として得られるファイルが 100 万行の最大制限数には滅多に達しないからです。
プロパティを追加する

追加 をクリックして、空のプロパティを追加します。ラベルまたはパスを入力するには、列 または パス をクリックしてフィールドを編集します。例えば、アラーム フィールドを有効にすると、列に「重大度」、パスに「severity」と入力してアラーム重大度のデータを受信できます。

事前定義された属性を追加 をクリックして、定義済みのプロパティを追加します。リストから目的のプロパティを選択し、選択 をクリックします。上部の検索フィールドを利用して、特定のプロパティを検索することもできます。

「プロパティを選択」リストからのフィールドではなく、カスタムプロパティとして定義されたフィールドが少なくとも 1 つある場合、エクスポートにカスタム値を表示するために、少なくとも 1 つのプロパティを設定する必要があります。

例：エクスポートに、期間、デバイス名、タイプ、c8y_SpeedMeasurement.speed.value の 4 つのフィールドが定義されています。最初の 3 つは定義済みプロパティで、最後の 1 つはカスタムプロパティです。エクスポートするメジャーメントにカスタムプロパティ c8y_SpeedMeasurement.speed.value がない場合、エクスポートファイルには表示されません。

フィールドが valid.key.with.dot の場合、パス内で [‘fragment.key.with.dot’] として参照します。
例：[‘fragment.key.with.dot’].series.value

「メジャーメント」が有効な場合は、データポイントから追加 を選択することもできます。データポイントの追加方法の詳細については、データポイントを追加するを参照してください。

データポイントから追加された JsonPath 式は、フラグメントとシリーズの命名の柔軟性を高めるために括弧 [ ] 表記で保存されます（空白などは対応します）。

データポイントから追加されたメジャーメント

エクスポートをスケジュールする

CSV または Excel(.xlsx) ファイルへのエクスポートを任意の時間に設定するには、それぞれのエクスポートを開き、下部の スケジュールを追加 をクリックします。

次のダイアログボックスでは、以下の情報を入力して、スケジュールした日時にメールでエクスポートを受信します。

Schedule export

1 － 頻度

ドロップダウンリストからエクスポートを送信する間隔（時間、日、週、月、年）を選択します。選択した頻度に応じて、追加のタイミング情報を指定します。例えば、「月」を選択した場合、その月の日、時間を指定します。

備考
スケジュール間隔は協定世界時（UTC）で指定する必要があります。

2 － E メールを送信

メール情報を入力します。

送信先 フィールドに、受信者のメールアドレスを入力します。このフィールドは必須です。任意で、コピー（CC）またはブラインドコピー（BCC）を送信するためのメールアドレスを指定できます。複数の受信者を入力するには、区切り文字としてカンマを使用します。

必要に応じて、返信用の送信者のメールアドレスを追加します。

メールの件名を指定します。このフィールドはあらかじめ入力されていますが、変更することができます。

実際に、メールに記載されるメッセージ本文を入力します。利用可能なプレースホルダーは {host}、{binaryId} です。デフォルト値は「エクスポートされたデータを含むファイルは、{host}/inventory/binaries/{binaryId} からダウンロードできます。」です。
メールにクリック可能なリンクを作成するには、リンクに「https://」を追加する必要があります。
例：エクスポートされたデータを含むファイルは、https://{tenant-domain}/inventory/binaries/{binaryId} からダウンロードできます。

備考
対応するメールは、Content-Type ヘッダーとして「text / html」で送信されることに注意してください。

作成をクリックして、新しいエクスポートスケジュールを作成します。

エクスポートスケジュールは、エクスポートの詳細に追加されます。

スケジュールされたエクスポートの移行

バージョン 10.6.2 では、スケジュールされたエクスポートを可能にする新しいレポート エージェントが実装されました。スマートルールに基づくエクスポート スケジュール機能は廃止されました。

レポートを開くと、スマートルールに基づいてスケジュール設定されたすべてのエクスポートが新しいレポート エージェントに自動的に移行され、ユーザーにそのプロセスを通知するメッセージが表示されます。

重要
レポートに含まれるエクスポート スケジュールを移行するには、各レポートを手動で開く必要があります。
備考
新しいエクスポートスケジュール機能を使用し、移行を正常に実行するには、report-agent マイクロサービスをサブスクライブする必要があります。新しいテナントは自動的にサブスクライブされます。既存のテナントは、サブスクライブされていることを確認してください。

データをエクスポートする

CSV または Excel (.xlsx) ファイルにデータをエクスポートするには、リストの各行の前にあるチェックボックスを選択して、トップメニューバーの左側にある エクスポートをクリックします。

各エクスポートファイルへのリンクが記載されたメールが届きます。

標準の時間プロパティ（アラームの time または creationTime など）は、ISO-8601 で定義されている日付と時間の形式に従って、Excel (.xlsx) ファイル と CSV ファイルにエクスポートされます。

エクスポート ドキュメントの制限に達し、その制限により結果が切り捨てられると、ドキュメントの最後にインジケーター付きの追加行が追加されます。

インジケーターを使用した CSV エクスポートのサンプル：

時間,デバイス名,作成日時,デバイス名,ID,ソース,テキスト,時間,タイプ
2021-11-25T10:37:06.485Z,Position #1,2021-11-25T10:37:06.485Z,Position #1,1266,1195,Location updated,2021-11-25T10:37:06.485Z,c8y_LocationUpdate
2021-11-25T10:37:01.484Z,Position #1,2021-11-25T10:37:01.484Z,Position #1,1265,1195,Location updated,2021-11-25T10:37:01.484Z,c8y_LocationUpdate
[…]
limit exceeded!,result truncated!,limit exceeded!,result truncated!,limit exceeded!,result truncated!,limit exceeded!,result truncated!,limit exceeded!

エクスポートを編集する

それぞれの行をクリックするか、行の右端にあるメニューアイコン をクリックし、編集 をクリックします。

フィールドの詳細については、エクスポートを追加する を参照してください。

エクスポートを複製する

  1. 行の右端にあるメニューアイコン をクリックし、複製 をクリックします。
  2. 少なくとも名前は変更します。
  3. 保存して閉じるをクリックしてエクスポートを保存し、エクスポートリストに戻ります。

エクスポートを削除する

行の右端にあるメニューアイコン をクリックし、削除 をクリックします。

データポイントに基づく機能とのエクスポート統合

エクスポート機能自体は独立した機能ですが、データポイントを選択できる他の機能と組み合わせることができます。このようにエクスポート機能を使用するには、データポイントテーブル ウィジェットなど、対応する機能にエクスポート機能を統合する必要があります。

必要条件

ロールとアクセス権限：

  • ウィジェットでエクスポートを生成する： 「計測値」権限タイプの読み取り権限が必要です。

ウィジェットでエクスポートを作成する

次の例は、エクスポート機能が データポイントテーブル ウィジェットに、どのように統合されているかを示しています。

  1. データポイントテーブルの右上にあるエクスポートアイコン をクリックします。

  2. エクスポートの生成 ダイアログボックスが表示され、次のカテゴリでエクスポートをさらに構成できます。

    • 期間： エクスポートの期間を選択します。デフォルトでは、ウィジェットの設定で構成された期間が使用されます。
    • データ範囲：
      • エクスポートモード：
        • コンパクト（デフォルトで選択）： すべてのデータが 1 つのファイルにエクスポートされ、ブラウザから直接ダウンロードされます。
        • フル： 処理されるレコード数に応じて、データは 1 つの zip ファイル（データポイントごとの 1 つのファイルを含む）で提供されるか、メールで送信されるか、全くエクスポートできないかのいずれかになります。 エクスポートモードの詳細については、エクスポートモード を参照してください。
      • 集計： コンパクトモードを選択した場合にのみ使用できます。デフォルト値は、ウィジェットの設定と同じです。次の 4 つのオプションがあります。
        • なし
        • 分単位
        • 時間単位
        • 日単位
    • ファイルタイプ： データをエクスポートするファイル形式を選択します。デフォルトでは Microsoft Excel が選択されており、CSV も選択できます。両方のタイプを同時に選択することもできます。

  3. ダウンロード ボタンをクリックします。ダウンロード結果は、選択したエクスポートモードによって異なります。

エクスポートモード

ウィジェットに統合されたエクスポート機能では、複数のエクスポートモードを利用できます。

  • コンパクト：
    • データポイントごとに最大 5,000 件、またはデータ保持期間まで処理されます
    • すべてのデータを含む 1 つの結合ファイルを作成します
    • 最小値と最大値を提供します
    • プレビューは利用できません
    • オプションのデータ集計をサポートします
  • 完全：
    • データポイントごとに最大 1,000,000 件、またはデータ保持期間まで処理されます
    • 50,000 件を超えるレコードをエクスポートする場合、データはメールで送信されます
    • 選択したデータポイントごとに、個別のデータファイルを含む圧縮 zip ファイルを作成します
    • プレビューは利用できます
    • データ集計はサポートされていません

100 万件を超えるデータポイントのエクスポート

100万件（処理上限）を超えるレコードを含むデータポイントに対して、完全 エクスポートモードを選択した場合、ダウンロードオプションは無効になります。エクスポートを続行するには、期間を狭めてレコード数を減らす必要があります。レコード数が減るまでは警告メッセージが表示されます。

完全モードでエクスポートする複数のデータポイントを選択し、1 つ以上のデータポイントが 100 万件のレコード制限（データポイントあたり）を超える場合、期間を狭めてレコード数を減らしてください。制限内にあるデータポイントには影響しません。

この場合、影響を受けるデータポイントの数と、その理由を説明する詳細な情報メッセージが表示されます。このメッセージは動的に表示され、次の情報が含まれる場合があります。

  • ダウンロード可能なアイテム数：直接エクスポートして、ブラウザから 1 つのファイルでダウンロードできるデータポイント
  • メール配信可能なアイテム数：さらに処理が必要なデータポイント。これらのファイルは準備ができ次第、個別のメールで送信されますが、処理に時間がかかる場合があります。
  • 取得できないアイテム数：処理上限である 1,000,000 件を超えるデータポイント。このデータをエクスポートするには、日付範囲を絞り込んでください。上限を超えると、これらのファイルはダウンロードも、メール送信もできなくなります。