セットアップ

このドキュメントでは、Foundryアプリケーションでの分析のために、時系列オブジェクトタイプとプロパティを作成および設定する方法を説明します。

はじめに

分析に使用できる時系列オブジェクトタイプとプロパティを設定する前に、Foundryに時系列を含む1つ以上のデータセットが必要です。複数のデータセットがある場合、シリーズのすべての値は同じデータセット内に含まれている必要があります。一般的な開始点の例については、セットアップチェックポイントを参照してください。

まず、タイムスタンプの行が含まれているデータセットプレビューに移動し、データを分析アクションメニューから時系列の設定を選択します。

これにより、時系列のセットアップアシスタントが起動されます。以下のドキュメントでは、アシスタントが次のプロセスを進める中で、必要に応じたデータ変換に関する詳細な説明が提供されます。

時系列オブジェクトタイプの作成または選択

既存のオブジェクトタイプに時系列プロパティを追加するには、セットアップアシスタント内の既存のオブジェクトタイプを選択パスをたどります。次の手順に進むには、時系列プロパティの設定セクションを参照してください。

新しいオブジェクトタイプを作成する必要がある場合は、時系列オブジェクトタイプの元データセットが必要です。この目的のスキーマに一致するデータセットがまだない場合は、Pipeline Builderで作成する必要があります。

新しいオブジェクトタイプをPipeline Builderのオントロジー出力として作成することもできますが、時系列オブジェクトタイプの元データセットをPipeline Builderで作成し、セットアップアシスタントに従って新しいオブジェクトタイプを作成することをお勧めします。Pipeline Builderでデータセットを準備するには、以下の手順に従ってください。

時系列オブジェクトタイプの元データセットを準備する

1. まず、新しいオブジェクトタイプの1つのオブジェクトを表す各行があるデータセットを作成します。このデータセットには、オブジェクトを一意に識別できるプライマリキー行と、オブジェクトの非時系列プロパティごとの行が必要です。
2. 次に、このオブジェクトタイプの元データセットが時系列をサポートするように、時系列プロパティごとにシリーズIDを追加します。おそらく、Pipeline Builderでデータの形状に応じて、以下の変換のいずれかを追加することになります。

時系列データが複数のデータセットに分かれていて、新しいシリーズIDの列を手動で作成したい場合

オブジェクトに関する情報が含まれているデータセットから始めます（下の画像では、マシン情報）：

1. Pipeline Builderで文字列の連結変換を追加します。

   1. アンダースコア（_）などの一般的な区切り文字を選択します。
   2. 式を設定します：
      1. Valueタイプの入力を入力し、この値をシリーズ名に設定します（例：temperature）。
      2. Columnタイプの入力を入力し、これをプライマリ/オブジェクトキーに設定します。

2. この新しい列を、この特定のシリーズのシリーズIDとして簡単に識別できるように命名します（例：temperatureまたはtemperature_series_id）。

   

単一のデータセットがある場合や、多数のシリーズがある場合

新しいシリーズID列を手動で作成するのを避けるために、シリーズ名が列名としてあるデータセットを結合によって作成します。この単一のデータセットができたら、以下の手順に従ってください。

1. Unpivot変換を追加します。

   1. 出力される非ピボット列名をseries_nameに設定します。
   2. 非ピボットされた値の出力列名をseries_valueに設定します。
   3. 非ピボットする列フィールドで、シリーズ名のすべての列を選択します。

   

2. Pivot変換を追加します。

   1. Columnにseries_nameを選択します。
   2. Distinct値を設定します。
      1. 各シリーズ名の行を追加（または一括追加）します。行の左と右の入力に同じ名前を入力します。一括追加の場合、各シリーズ名を別々の行に追加します。
   3. Rowsフィールドに、オブジェクトキー列を追加します。
   4. 集計を設定します。
      1. 集計タイプをMinに設定します。
      2. Expressionを文字列の連結に設定します。
      3. アンダースコア（_）などの一般的な区切り文字を選択します。
      4. 式を設定します： i. 最初の入力としてseries_nameを入力します。 ii. オブジェクトキーを2番目の入力として入力します。
      5. この新しい出力をseries_idとして名前を付けます。

   

3. シリーズID列をオブジェクトタイプの元データセットに戻して結合します。

時系列オブジェクトタイプの元データセットが準備できたら、セットアップアシスタントで新しいオブジェクトタイプを作成するパスをたどります。このパスは、オントロジーマネージャーオブジェクト作成セットアップアシスタントにリダイレクトされ、新しいデータセットを基となるデータソースとして選択します。アシスタントダイアログが完了すると、時系列プロパティの設定が可能になります。

タイムシリーズプロパティ（TSP）

タイムシリーズプロパティ（TSP）は、Foundryアプリケーションでタイムシリーズデータを使用できるようにするプロパティです。タイムシリーズの使用方法の詳細を確認してください。

タイムシリーズプロパティを表示すると、関連するタイムシリーズ値のプロットとして値が表示されます。たとえば、以下の例は、「temperature_id」タイムシリーズプロパティを、Quiverで基となるタイムシリーズデータを使用して可視化しています。

タイムシリーズプロパティの設定

以下の手順については、プラットフォーム内のタイムシリーズセットアップアシスタントを使用してガイド付きのウォークスルーを行います。セットアップアシスタントを起動するには、https://<domain>/workspace/ontology/home/overview/time-series-setupに直接移動するか、タイムスタンプ列を含むデータセットプレビューに移動し、Analyze dataアクションメニューからSet up time seriesを選択します。

タイムシリーズオブジェクトタイプの設定に関する詳細なガイダンスは、前のセクションを参照してください。

タイムシリーズプロパティは、オントロジーマネージャアプリケーションのCapabilitiesタブで設定されます。セットアップアシスタントに従っている場合、新しいオブジェクトタイプを作成するか既存のものを選択した後、自動的にCapabilitiesタブに移動します。オブジェクトタイプにすでにタイムシリーズプロパティが設定されている場合、それらがテーブルビューに表示され、タイムシリーズプロパティを追加または削除することもできます。

オブジェクトタイプに既存のタイムシリーズプロパティがない場合、追加する手順が説明されます。

タイムシリーズプロパティを追加するには、Add propertyを選択します。これにより、次の手順をガイドするダイアログが起動されます。

1. オブジェクトタイプの決定： このオブジェクトタイプがセンサーオブジェクトタイプであるかどうかを決定します。

2. プロパティの選択： シリーズIDを含む string プロパティを選択し、Nextを選択します。

3. タイムシリーズ同期の選択：既存のタイムシリーズ同期がある場合は選択し、ない場合は新しい同期を作成する手順に従います。

タイムシリーズの書式設定

タイムシリーズの書式設定では、タイムシリーズの内部補間と単位を設定できます。Quiverのようなアプリケーションでは、指定された補間と単位の値が適用されます。

単位と補間の書式設定は、このオブジェクトタイプの他の string プロパティを指定して、より細かい制御が可能です（たとえば、タイムシリーズプロパティに含まれる各タイムシリーズの単位と補間が異なる場合）。細かい制御が必要でない場合は、補間と単位の両方に標準値が用意されています。

センサーオブジェクトタイプの内部補間と単位は、センサーオブジェクト構成セクションで設定されます。

デフォルトのタイムシリーズプロパティ

オブジェクトタイプは、デフォルトのタイムシリーズプロパティとして1つのタイムシリーズプロパティを持つことができます。オブジェクトタイプの最初のタイムシリーズプロパティを設定するとき、そのプロパティがデフォルトのタイムシリーズプロパティとして設定されます。

一部のアプリケーションでは、デフォルトのタイムシリーズプロパティがユーザーの追加的な操作なしに表示されます。例えば、Quiverでは、オブジェクトプロパティのタイムシリーズカードは、特に指定がない限り、デフォルトのタイムシリーズプロパティを指します。

センサーオブジェクトタイプの単一のタイムシリーズプロパティは、デフォルトのタイムシリーズプロパティでなければなりません。センサーオブジェクトタイプの設定 の詳細をご覧ください。

タイムシリーズの同期

タイムシリーズの同期は、任意の数のタイムシリーズ（seriesIdsでキー化された）に関連する時間-値のペアを保持し、そのシリーズと関連する時間-値のペアのそれぞれに対して効率的なインデックスを可能にします。タイムシリーズの同期は、データセットまたはストリームによってバックアップされ、タイムシリーズプロパティの基となるデータソースです。

Foundryが特定のオブジェクトのタイムシリーズプロパティを解決するとき、プロパティの値に含まれるseriesIdは、そのプロパティのデータソース内で検索され、その関連するタイムシリーズデータが返されます。

タイムシリーズの同期には以下の行が必要です：

1. seriesId: シリーズの識別子（string）。
2. timestamp: 関連する値が発生した時間（timestampまたはlong）。
   • long型の時間行の場合、単位を指定する必要があります。利用可能な単位には、秒、ミリ秒、マイクロ秒、ナノ秒があります。
3. value: 特定のタイムスタンプでのシリーズの値（double、integer、floatまたはstring）。
4. Ingestion time: （オプション）：ストリーミングデータポイントが取り込まれた時間（timestamp）。

タイムシリーズ同期の作成

タイムシリーズ同期の作成には、Pipeline Builderの使用をお勧めします。データの追加、変換の作成、同期ターゲットの設定についてのガイダンスは、ドキュメンテーションセクションをご覧ください。あるいは、手動で設定することもできます。

1. セットアップアシスタントに沿って進めている場合は、Go to Builderを選択します。

あるいは、Pipeline Builderアプリケーションに移動し、新しいパイプラインを作成します。

2. タイムシリーズデータをインポートし、タイムシリーズ同期の形状に合うように必要な変換を適用します。

3. データが正しい形状に変換されたら、タイムシリーズ同期ターゲットを作成します。

4. 次に、行マッピングを設定します。

5. パイプラインをデプロイしてタイムシリーズ同期を作成し、ビルドします。これにより、元データセットとタイムシリーズの同期が作成されます。

6. オントロジーマネージャーアプリケーションに戻り、このタイムシリーズ同期をタイムシリーズプロパティのデータソースとして追加します。

追加のタイムシリーズプロパティを追加したい場合は、これらの手順を繰り返します。もし、あなたの同期がすべてのシリーズIDを含んでいるなら、新しいタイムシリーズプロパティのために新しいものを作成する代わりに、同じ同期を選択することができます。

タイムシリーズカタログアプリケーション

タイムシリーズカタログアプリケーションは、タイムシリーズ同期設定の高度な設定に使用されます。アプリケーションは、タイムシリーズ同期リソースを開いたり、手動でhttps://<domain>/workspace/time-series-catalog-appに移動することでアクセスできます。

高度なタイムシリーズ設定には以下の機能が含まれます：

1. 入力データセットまたはストリームからのマーキングの継承を停止します。タイムシリーズの権限のドキュメンテーションで詳細をご覧ください。
2. SparkまたはFlinkの計算プロファイルを設定します。
   • デフォルトの計算プロファイルの使用をお勧めします。プロファイルが追加されていない場合、デフォルトの計算プロファイルが使用されます。
3. 入力データセットの更新に基づいてタイムシリーズ同期を自動的にビルドするスケジュールを設定します。イベントトリガーとスケジュールのドキュメンテーションで詳細をご覧ください。
4. 現在のタイムシリーズ同期内に存在するseriesIdsを、指定されたタイムシリーズ同期内のもので上書きします。これは、レガシータイムシリーズ設定のための高度な機能です。

以下の例は、データセットにバックアップされたタイムシリーズ同期を示しています：

タイムシリーズデータの分析

オントロジーマネージャーで保存を選択して変更を保存してください。新しいオブジェクトタイプを作成し、これが初めての保存作業である場合は、TSPを分析できるようになる前に初期インデックスが完了するまで待つ必要があります。オントロジーマネージャーのオブジェクトタイプのデータソースタブに移動して、インデックスのステータスを確認します。

新しく設定したタイムシリーズデータをどのように分析できるかについて詳しく学ぶには、タイムシリーズの使用をご覧ください。

センサーオブジェクトタイプのセットアップ

最初に、新しい時系列オブジェクトタイプを作成するための手順に従ってください。時系列オブジェクトタイプの元データセットは次のようなスキーマを持つべきです：

オントロジーマネージャのCapabilitiesページで、Time seriesセクション内のGet startedを選択します。

Time series setupダイアログの最初のステップで、Sensor object typeをオンにします。

その後、ダイアログの残りのステップに従って、TSPの設定を完了します。

プロパティを追加すると、Time series propertiesテーブルの下に展開されたSensor object type configurationセクションが表示され、以下の設定オプションがあります：

• Sensor link (required)
  • このセンサーオブジェクトタイプが時系列データを記録するルートオブジェクトタイプにリンクする少なくとも1つのリンクタイプを選択する必要があります。
  • また、このリンクタイプのセンサー名を含むプロパティを選択する必要があります。
• Primary sensor link (required if present)
  • これは、Foundryインスタンスで古いバージョンのQuiverにアクセスできる場合にのみ表示されます。
  • これが表示される場合、上記のSensor linkセクションの設定済みエントリの1つに一致するリンクタイプとセンサー名を選択する必要があります。
• Is categorical? (required if the TSP is backed by multiple syncs of different types)
  • TSPが数値とカテゴリカルの両方のタイプの複数の同期によって裏付けられている場合、センサーオブジェクトがカテゴリカルな時系列データを持つかどうかを示すために使用されるブールプロパティを選択する必要があります。
• Units (optional, recommended)
  • 各センサーオブジェクトの時系列データの単位を含むプロパティをオプションで選択します。
• Internal interpolation (optional)
  • 各センサーオブジェクトの時系列データに使用すべき内部補間のタイプを含むプロパティをオプションで選択します。
  • 有効な値は以下の通りです：
    • LINEAR: 2点間を線形に補間します。数値の時系列にのみ適用可能です。
    • NEAREST: 最近傍の点の値を取ります。
    • PREVIOUS: 前の点の値を取ります。
    • NEXT: 次の点の値を取ります。
    • NONE: 補間を行わない。

Measuresからの移行

もしMeasuresセットアップの既存ユーザーであれば、センサーオブジェクトタイプのセットアップへの移行はほぼ自動化されています。

まず、Measuresセットアップを持つオブジェクトタイプのOntology ManagerのCapabilitiesページに移動します。

このオブジェクトタイプがTSPを持っていない場合は、Get startedの指示に従い、1つ追加します。

TSPが設定されていると、センサーオブジェクトタイプの設定セクションが展開され、既存のMeasures設定が自動的に移行されます。

セットアップチェックポイント

以下の決定木を使用して、時系列セットアッププロセスを開始する点または進行中のプロセスを再開する点を特定します。

• 生の時系列データはすでにFoundryにありますか？
  • No: Data Connectionを使用してデータをFoundryに同期します。
• 生の時系列データにはタイムスタンプの列があり、そのタイプはタイムスタンプのみですか？
  • No: Datasetアプリでスキーマを編集します。
• 生のデータは以下の例のように見えますか？

  • オブジェクトキー、タイムスタンプ列、そしてその時間点の値を含む複数の列を含む単一のデータセット。

    

  • オブジェクトに関する情報を含むデータセットと、キー、タイムスタンプ列、そして単一のシリーズの値を含む複数のデータセット。

    

  • No: データをこれらの例の1つに似たスキーマに変換することを検討するかもしれません。そうでない場合でも、有効な時系列オブジェクトタイプの元データセットと時系列同期を生成するために自分でデータを変換する方法を知っている必要があります。

• セットアップアシスタントをどのように起動しますか？

  • 時系列データセット（つまり、タイムスタンプ列を含むデータセット）を表示し、Analyze dataアクションメニューの下からSet up time seriesを選択します（Get startedを参照）。これにより、ウォークスルーダイアログとセットアップアシスタントが表示されます。

    

  • または、直接https://<domain>/workspace/ontology/home/overview/time-series-setupに移動して、セットアップアシスタントを直接起動します。

• オブジェクトタイプはすでに存在しますか？
  • Yes: セットアップアシスタントを起動し、Choose existing objectを選択します。
  • No: セットアップアシスタントを起動し、Create new object typeを選択します。
• オブジェクトタイプの元データセットはありますか？
  • Yes: Create new object typeダイアログでそれを選択します。
  • No: Pipeline Builderに移動し、共通の形状から時系列オブジェクトタイプの元データセットの形状にデータを変換します（時系列オブジェクトタイプを作成または選択するを参照）。
• オブジェクトタイプに時系列プロパティ（TSP）を追加しましたか？
  • Yes: 時系列オブジェクトタイプを使用する準備が整いました。Foundryのアプリケーションで時系列を使用するさまざまな方法については、Foundryでの時系列の使用を参照してください。
  • No: 次のステップについては、時系列プロパティの設定を参照してください。
• 時系列同期がありますか？
  • Yes: 時系列プロパティの設定を終了し、ダイアログの2番目のステップで同期を選択します。
  • No: 時系列プロパティの設定の下で時系列同期を作成するための指示に従います。
    • 時系列同期のシリーズIDがオブジェクトタイプの元データセットのシリーズIDと一致することを確認します
• 設定した時系列プロパティをどのように使用しますか？
  • Foundryで時系列を分析する方法を探るために、Foundryでの時系列の使用を参照してください。