Skip to main content

データの使用方法

概念​

データモジュールは、企業がデータ資産を効率的に管理、利用、共有するのを支援することを目的としています。柔軟なデータインターフェース、メタデータ管理、データソース設定、およびデータインポート機能を通じて、ユーザーはデータフローのプロセスを完全に制御および最適化できます。製品は直感的な操作インターフェースを提供し、ユーザーがデータのクエリ、プレビュー、および操作を簡単に行えるようにし、データのサブスクリプションおよびプッシュ機能をサポートして、データのリアルタイム性と正確性を確保します。

全体構造

データ資産​

データモジュールのエントリーポイントとして、データ資産モジュールは、企業ユーザーがシステム内のさまざまなデータ資産の数と詳細情報を直感的に把握できる概要ビューを提供し、ユーザーが現在のデータの全体像とその分布状況を完全に理解するのを支援します。

データ資産の検索​

検索機能（虫眼鏡）を使用して、キーワード、データ資産のカテゴリなどの情報を使用してデータ資産を迅速に特定できます。

資産データとメタデータの表示​

各データ資産のカードには、データプレビューおよびメタデータ表示のクイックリンクが提供されています。

カードの中央領域をクリックすると、データプレビュー画面に入り、対応するデータテーブルの一部のデータを表示できます。下にスクロールすると、さらに多くのデータが読み込まれます。

ChatXモジュールが有効になっている場合、右側にAgent対話インターフェースが表示され、ユーザーは自然言語を使用して現在のデータをクエリし、システムに洞察を提供させることができます。

カードの右上隅にある[メタデータ表示]をクリックすると、メタデータ表示画面に入ります。ここでは、メタデータのテーブル名、コメント、備考などが表示され、テーブル内のすべてのフィールドのフィールド名、コメント、タイプ情報も含まれます。

[表示]ボタンをクリックしてフィールドの詳細ページに入ります。

データインターフェース​

簡便なデータインターフェースの作成、変更、およびテスト機能を提供し、ユーザーはデータインターフェースを効率的に開発および維持でき、インターフェースログのクエリをサポートして、インターフェースの安定性と追跡可能性を確保します。

操作説明

  • 検索、インターフェース名、データエンティティ名でフィルタリング
  • 新規作成、ポップアップウィンドウをクリックして新しいデータインターフェースを定義
  • インターフェースログ、データインターフェースログ表示ページに入る
  • 認可、指定されたクライアントにインターフェースのアクセス権を付与し、クライアントがバインドされていない場合、インターフェースはアクセスできません
  • 行操作
    • 詳細、インターフェースの詳細情報を表示
    • 編集、既に作成されたインターフェースを変更
    • ログ、このインターフェースに関連するログのみを表示
    • 有効/無効、無効にされたインターフェースは呼び出せなくなりますが、インターフェース自体は削除されず、いつでも有効にできます
    • 削除、インターフェースを削除

インターフェースの詳細

データインターフェースの作成​

インターフェース作成を通じて、新しいデータインターフェースをシステムに追加できます。ユーザーは異なるデータエンティティ、異なる条件、異なるフィールドのクエリに使用するために異なるデータインターフェースを追加できます。 現在、単一のデータエンティティのクエリインターフェース定義のみをサポートしています。複数のエンティティの関連クエリが必要な場合は、上流プラットフォームでビューを組み合わせてから、データインターフェースを通じて条件を追加してクエリしてください。

フィールド説明

  • カテゴリ、インターフェースのカテゴリ、データインターフェースが多い場合、グループの識別として使用できます
  • インターフェース名、インターフェースの一意の識別子
  • インターフェースアドレス、インターフェース公開後のアクセスアドレス、他のインターフェースと同じアドレスを使用することはできません
  • データソース、インターフェースのデータソース、データドメインをシステムに維持してから選択する必要があります
  • データエンティティ、インターフェースのデータがどのデータエンティティからクエリされるか
  • 入力パラメータ、インターフェースに対して1つ以上の入力パラメータを定義してデータをフィルタリングできます。等しい、含む、大きいなどの一般的な演算子を提供し、入力パラメータはインターフェース呼び出し元によって渡されます
  • 固定パラメータ、呼び出し元が渡す必要のない固定パラメータ/条件、例えば、常に中国地域の省をクエリする場合、中国地域を固定パラメータとして設定できます
  • ページングを行うかどうか、いいえ、条件に一致するすべてのレコードを常に返します。はい、呼び出し元の入力パラメータpageSizeで各ページの数を指定し、pageIndexでページ番号を指定します。総レコード数と総ページ数は、対応する戻りパラメータtotalCount、totalPageに返されます
  • ソート条件、ソートフィールドと方向（昇順または降順）を指定してクエリ結果をソートします
  • 戻りパラメータ、インターフェースを通じて返すフィールドを制御します。チェックされていないフィールドはクエリ結果のメッセージに表示されません（機密情報の送信を制御するために使用できます）

データインターフェースの認可​

すべてのデータインターフェースは、認可を受けた後に外部システムから呼び出すことができます。クライアントは外部システムの識別子を表し、通常、1つのクライアントは1つの外部システムに対応します。 認可の前に、SERVICEME管理者にクライアントをシステムに追加してもらう必要があります。ここで対応するクライアントを選択して認可を行います。

インターフェーステスト（プレビュー）の実行​

既に作成されたデータインターフェースに対してテストを実行し、詳細な入力および出力メッセージを通じてインターフェースが期待通りに動作するかどうかを確認します。

注：インターフェースをテストする前に、クライアント認可を完了し、計算済みのAuthorizationをHeaderに入力する必要があります。そうしないと、リクエストは拒否されます。Authorizationアルゴリズムについては[技術ガイド/DATA 開発連携]を参照してください。

インターフェースログの表示​

システムの最近のすべてのデータインターフェースクエリログを表示できます。システムは呼び出し元のIPアドレス、返されたメッセージなどの情報を記録します。

データサブスクリプション​

データインターフェースとは逆に、データサブスクリプションはSERVICEMEプラットフォームが外部システムにデータをプッシュするものです。ユーザーはここでデータサブスクリプションの条件と頻度を設定でき、システムはトリガー時間に条件に一致するデータが存在するかどうかを確認し、存在する場合は対応するデータを指定されたインターフェースにプッシュします。

操作説明

  • クエリ、サブスクリプション名などの条件でデータサブスクリプションをクエリ
  • 新規作成、データ定義のパラメータを入力して作成
  • 即時トリガー、クリックすると条件に一致するデータが存在するかどうかを即座に確認し、存在する場合は即座にプッシュ
  • 削除、データサブスクリプションを削除し、トリガーとデータプッシュを行わない
  • プッシュログ、データサブスクリプションをまたいですべてのプッシュログをクエリ
  • 行操作
    • 有効/無効、サブスクリプションを無効にするとトリガーとデータプッシュを行わない
    • プッシュログの表示、現在のサブスクリプションに関連するログのみを表示

データサブスクリプションの作成と編集​

フィールド説明

  • データ設定
    • 名称、データサブスクリプションの一意の識別子
    • データソース、データサブスクリプションのデータソース
    • データエンティティ、データサブスクリプションがクエリするデータエンティティ（テーブルまたはビュー）
    • フィルタールール、条件に一致するデータが存在するかどうかを判定するために使用され、複数の条件を組み合わせることができます
    • データフィールド、データサブスクリプションが最終的にプッシュするデータフィールド。ここでエイリアスとデフォルト値を設定できます
  • サブスクリプション設定
    • プッシュ方法、プッシュのプロトコル。現在、HTTPメッセージ方式をサポートしています
    • 頻度、プッシュ頻度。CRONS（5桁）式をサポート
    • バッチ数、条件に一致するデータがバッチ数を超える場合、いくつかのバッチに分けてプッシュし、1回のプッシュのデータ量を制御します
    • API、データ受信側のAPIアドレス。ここにはドメイン名とインターフェースパスを含む完全なアドレスを入力する必要があります。例：https://www.baidu.com/api/sendData
    • HTTP Method、POSTとPUTの2つをサポート
    • Headers、受信側が送信する必要があるHTTP Header。認証に必要な固定api_keyを送信するために使用できます
    • Body、受信側が受信するメッセージ形式。調整しない場合、すべてのデータはJSONオブジェクトのdataプロパティに配列形式で配置されます

特殊ルール

  • 日付タイプのフィールドについては、値の入力ボックスに日付変数を使用して、特定の時間範囲内のデータをクエリできます。

日付変数の例

$utcnow-1m$ 最近1分間
$utcnow-1h$ 最近1時間
$utcnow-1d$ 最近1日間
$utcnow-1w$ 最近1週間
$utcnow-1M$ 最近1か月
$utcnow-1y$ 最近1年間

組み合わせ
$utcnow-1h20m$ 最近1時間20分

プッシュログのクエリ​

システムの最近のすべてのプッシュログをクエリでき、ユーザーがデータサブスクリプションの実行状況を把握できます。データ受信側がデータを受信していないとフィードバックした場合、プッシュログを組み合わせて調査できます。

データソース​

さまざまなタイプのデータソースの接続と管理をサポートし、ユーザーはデータソース接続を簡単に新規作成および設定でき、データ入力の信頼性と柔軟性を確保します。

操作説明

  • クエリ、番号/名称/タイプなどの情報でデータソースをクエリ
  • 新規作成、クリックしてデータソース作成フォームを表示
  • メタデータ同期、このデータソース内のすべてのメタデータを即座に同期
  • 削除、データソースを削除し、使用できなくなり、関連するメタデータの同期も行われなくなります
  • 行操作
    • リンクをクリック、データソース情報を表示。セキュリティ上の理由から、データベース接続は変更のみ可能で、表示はできません

データソースの作成​

まず、データソースタイプを選択する必要があります。現在、プラットフォームはExcel、Azure SQL、Azure Databricksの3種類のデータソースをサポートしています。

Azure SQLを例にとると、作成プロセスは次のとおりです：

まず、データソースの基本情報と接続文字列を入力します。

フィールド説明

  • 番号、データソースの一意の識別子
  • 名称、データソースの表示名
  • タグ、データソースのカテゴリに使用できます
  • 接続文字列、対応するデータソースの接続文字列を入力し、接続テストボタンを使用して検証します

接続文字列のテストが成功したら、次のステップに進んでメタデータを選択します。

操作説明

  • すべて同期、このデータソースのすべてのメタデータを同期し、将来新規作成されるメタデータも含みます
  • 選択同期、選択したメタデータのみを同期

保存をクリックして、データソースの作成を完了します。

メタデータ​

製品に組み込まれたメタデータ管理機能は、データドメインの作成、編集、および管理をサポートし、企業が明確なデータ体系構造を構築するのを支援します。

操作説明

  • クエリ、エンティティ名/表示名/データソースなどのフィールドでメタデータをフィルタリング
  • メタデータ同期、このメタデータエンティティおよびフィールドを即座に同期
  • データドメイン設定、メタデータを対応するデータドメインに指定
  • データドメイン管理、データドメインのメンテナンス
  • 行操作
    • エンティティ名のハイパーリンク、クリックしてメタデータの詳細ページに入る

メタ​