データソース

breaking changes

Currently, the Reveal SDK is in the process of decoupling the data sources from the Reveal SDK core package. In order to ensure the project's continued functionality, you might be required to install additional packages into your project. Please see the Supported Data Sources topic for more information.

Reveal SDK は、分析ツール、コンテンツマネージャー、クラウドサービス、CRM、データベース、スプレッドシート、公開データソースなど、30 を超えるデータソースをサポートしており、毎月さらに多くのデータソースが出荷されています。データソースは、ダッシュボードのどこからデータが取得されるかを定義します。各データソースには、接続文字列、ユーザー ID、パスワードなど、データに接続してデータを取得するためにコードで設定した固有のプロパティがあります。

Reveal SDK には、データソースに関して 2 つの概念があります。

データソース - これはデータの主要なソースです。たとえば、SQL Server をデータソースにすることができます。
データソース項目 - これは、データソースから利用できる特定の項目です。例えば、SQL Server の特定のテーブル。

データソース (データストア) とデータソース項目 (データ項目) は、Reveal View の [データソースの選択] ダイアログで別々に分類されます。

Reveal SDK でデータソースを作成するには、2 つの方法があります。

クライアント側
サーバー側

Installing Data Sources

Before creating data sources for use in the Reveal SDK, you must install the correct package for each data source you wish to use in your Reveal SDK application.

Step 1 - Install the package for the data source you would like to use. To learn which data sources are supported and which packages you must install, refer to the Supported Data Sources section.

Step 2 - After you have installed the data source package, register the data source with the Reveal SDK.

ASP.NET
Java
Node.js

using Reveal.Sdk;
using Reveal.Sdk.Data;

builder.Services.AddControllers().AddReveal( builder =>
{
    //all data sources use the RegisterXXX naming convention
    builder.DataSources.RegisterMicrosoftSqlServer();
});

Coming Soon...

Coming Soon...

クライアントでのデータソースの作成

クライアントでデータソースまたはデータソース項目を追加するには、RevealView.onDataSourcesRequested イベントにイベントハンドラーを追加します。イベントハンドラーでは、ダッシュボードで使用されるさまざまなタイプのデータソースまたはデータソース項目のインスタンスを作成するコードを記述します。次に、これらのインスタンスを callback に渡して、[データソースの選択] ダイアログで使用できるようにします。

var revealView = new $.ig.RevealView("#revealView");
revealView.onDataSourcesRequested = (callback) => {

    //provide all data sources and data source items in callback
    callback(new $.ig.RevealDataSources([], [], false));
};

データソースは、コールバックの最初のパラメーターに配列として提供されます。
データソース項目は、コールバックの 2 番目のパラメーターに配列として提供されます。
3 番目のパラメーターは、ダッシュボードに保存されているデータソースが [データソースの選択] ダイアログに表示されるかどうかを決定します。false の場合、onDataSourcesRequested イベントで作成されたデータソースのみが表示されます。

クライアントでデータソースを作成するときは、データソースまたはデータソース項目のすべての接続情報を提供することが重要です。例えば、MS SQL Server のデータソースを作成する場合は、host や database などの接続情報を提供する必要があります。データソース項目の場合は、table を提供する必要があります。

revealView.onDataSourcesRequested = (callback) => {

    var sqlServerDS = new $.ig.RVSqlServerDataSource();
    sqlServerDS.host = "your-db-host";
    sqlServerDS.database = "your-db-name";
    sqlServerDS.title = "My SQL Server";

    var sqlServerDSI = new $.ig.RVSqlServerDataSourceItem(sqlServerDS);
    sqlServerDSI.title = "My SQL Server Item";
    sqlServerDSI.table = "TableName";    

    callback(new $.ig.RevealDataSources([sqlServerDS], [sqlServerDSI], false));
};

データソースまたはデータソース項目で使用できるプロパティについては、データソースの対応するヘルプトピックまたは API ドキュメントを参照してください。

危険

クライアントで JavaScript を使用してデータソースとデータソース項目を作成すると、サーバー名、ホスト名、IP アドレス、ポート番号、エンドポイントなどのすべての接続情報がブラウザーに公開されます。これにより、ユーザーはこれらの値を表示できるだけでなく、変更することもできます。公開する情報に注意し、クライアント側のアプローチを使用してデータソースを作成することに関連する潜在的なセキュリティリスクを考慮することが重要です。

サーバーでのデータソースの作成

サーバーでのデータソースまたはデータソース項目の作成は、クライアントでの作成と似ています。主な違いは、クライアントで接続情報が提供されないことです。IRVDataSourceProvider を実装することにより、すべての接続情報がサーバー上で提供されます。

イベントハンドラーを RevealView.onDataSourcesRequested イベントに追加することから始め、データソースとデータソース項目を作成します。この例では、MS SQL Server を使用しています。データソースの識別に使用できる id と、[データソースの選択] ダイアログに表示される title のみを設定していることに注意してください。

var revealView = new $.ig.RevealView("#revealView");
revealView.onDataSourcesRequested = (callback) => {
    
    var sqlServerDS = new $.ig.RVSqlServerDataSource();
    sqlServerDS.id = "MySqlServerDataSource";
    sqlServerDS.title = "My Sql Server";

    var sqlServerDSI = new $.ig.RVSqlServerDataSourceItem(sqlServerDS);
    sqlServerDSI.id = "MySqlServerDataSourceItem";
    sqlServerDSI.title = "My Sql Server Item";

    callback(new $.ig.RevealDataSources([sqlDataSource], [sqlServerDSI], false));
};

次に、サーバーアプリケーションで、データソースプロバイダーを作成する必要があります。データソースプロバイダーは、Reveal SDK に接続方法を指示するデータソースおよびデータソース項目のさまざまなプロパティを変更するために使用されます。

データソースプロバイダーは、次の 2 つの手順で作成できます。

手順 1 - データソースプロバイダーを作成します。この例では、クライアントで定義された MS SQL Server データベースに接続するための接続情報を提供しています。これを実現するために、使用しているデータソース/項目のタイプを決定し、オブジェクトで使用可能なプロパティを設定します。

ASP.NET
Java
Node.js

public class DataSourceProvider : IRVDataSourceProvider
{
    public Task<RVDataSourceItem> ChangeDataSourceItemAsync(IRVUserContext userContext, string dashboardId, RVDataSourceItem dataSourceItem)
    {
        if (dataSourceItem is RVSqlServerDataSourceItem sqlServerDsi)
        {
            //required: update underlying data source
            ChangeDataSourceAsync(userContext, sqlServerDsi.DataSource);

            //only change the table if we have selected our data source item
            if (sqlServerDsi.Id == "MySqlServerDatasourceItem")
            {
                //set the table/view
                sqlServerDsi.Table = "Orders";
            }
        }
        return Task.FromResult(dataSourceItem);
    }

    public Task<RVDashboardDataSource> ChangeDataSourceAsync(IRVUserContext userContext, RVDashboardDataSource dataSource)
    {
        if (dataSource is RVSqlServerDataSource sqlDatasource)
        {
            sqlDatasource.Host = "10.0.0.20";
            sqlDatasource.Database = "Northwind";
            sqlDatasource.Schema = "dbo";
        }
        return Task.FromResult(dataSource);
    }
}

public class DataSourceProvider implements IRVDataSourceProvider {

    public RVDataSourceItem changeDataSourceItem(IRVUserContext userContext, String dashboardsID, RVDataSourceItem dataSourceItem) {

        if (dataSourceItem instanceof RVSqlServerDataSourceItem sqlServerDsi) {            
            //required: update underlying data source
            changeDataSource(userContext, dataSourceItem.getDataSource());

            //only change the table if we have selected our custom data source item
            if (dataSourceItem.getId() == "MySqlServerDatasourceItem") {
                sqlServerDsi.setTable("Orders");
            }            
        }
        return dataSourceItem;
    }

    public RVDashboardDataSource changeDataSource(IRVUserContext userContext, RVDashboardDataSource dataSource) {
        if (dataSource instanceof RVSqlServerDataSource sqlDatasource) {
            sqlDatasource.setHost("10.0.0.20");
            sqlDatasource.setDatabase("Northwind");
            sqlDatasource.setSchema("dbo");
        }
        return dataSource;
    }
}

const dataSourceItemProvider = async (userContext: IRVUserContext | null, dataSourceItem: RVDataSourceItem) => {
    if (dataSourceItem instanceof RVSqlServerDataSourceItem) {

        //required: update underlying data source
        dataSourceProvider(userContext, dataSourceItem.dataSource);

        //only change the table if we have selected our data source item
        if (dataSourceItem.id === "MySqlServerDatasourceItem") {
            dataSourceItem.table = "Orders";
        }       
    }
    return dataSourceItem;
}

const dataSourceProvider = async (userContext: IRVUserContext | null, dataSource: RVDashboardDataSource) => {
    if (dataSource instanceof RVSqlServerDataSource) {
        dataSource.host = "10.0.0.20";
        dataSource.database = "Northwind";
        dataSource.schema = "dbo";
    }
    return dataSource;
}

手順 2 - データソースプロバイダーを Reveal SDK に登録します。

ASP.NET
Java
Node.js

builder.Services.AddControllers().AddReveal( builder =>
{
    builder.AddDataSourceProvider<DataSourceProvider>();
});

RevealEngineInitializer.initialize(new InitializeParameterBuilder().
    setDataSourceProvider(new DataSourceProvider()).
    build());

const revealOptions: RevealOptions = {
    dataSourceProvider: dataSourceProvider,
    dataSourceItemProvider: dataSourceItemProvider,
}
app.use('/', reveal(revealOptions));

Important

ChangeDataSourceAsync メソッドでデータソースに加えられた変更は、ChangeDataSourceItemAsync メソッドには引き継がれません。どちらの方法でも、データソースプロパティを更新する必要があります。上記の例に示すように、ChangeDataSourceItemAsync メソッド内で ChangeDataSourceAsync メソッドを呼び出し、データソース項目の基になるデータソースをパラメーターとして渡すことをお勧めします。

サポートされるデータソース

Enhancments Coming

Currently, the Reveal SDK is in the process of decoupling the data sources from the Reveal SDK core package. Not only will this reduce the size of your application, it will also make releasing new data sources and updating existing data sources easier. We appreciate your patience as we work towards this next evolution of the Reveal SDK.

Use the table below to see which data sources are supported and which packages you must install for your target framework.

Data Source	ASP.NET	JAVA	Node.js
Amazon Athena		Included in SDK	Included in SDK
Amazon Redshift		Included in SDK	Included in SDK
Amazon S3		Included in SDK	Included in SDK
Box		Included in SDK	Included in SDK
CSV (Comma Separated Values)	Included in SDK	Included in SDK	Included in SDK
Dropbox		Included in SDK	Included in SDK
Google Analytics 4		Included in SDK	Included in SDK
Google BigQuery		Included in SDK	Included in SDK
Google Drive		Included in SDK	Included in SDK
Google Sheets		Included in SDK	Included in SDK
Hubspot		Included in SDK	Included in SDK
In-Memory Data	Included in SDK	Included in SDK	Included in SDK
JSON	Included in SDK	Included in SDK	Included in SDK
Marketo		Included in SDK	Included in SDK
Microsoft Analysis Services		Included in SDK	Included in SDK
Microsoft Azure Analysis Services		Included in SDK	Included in SDK
Microsoft Azure SQL Database		Included in SDK	Included in SDK
Microsoft Azure Synapse Analytics		Included in SDK	Included in SDK
Microsoft Dynamics CRM		Included in SDK	Included in SDK
Microsoft Excel	Included in SDK	Included in SDK	Included in SDK
Microsoft OneDrive		Included in SDK	Included in SDK
Microsoft Reporting Services (SSRS)		Included in SDK	Included in SDK
Microsoft SharePoint		Included in SDK	Included in SDK
Microsoft SQL Server		Included in SDK	Included in SDK
MySQL		Included in SDK	Included in SDK
OData Feed	Included in SDK	Included in SDK	Included in SDK
Oracle		Included in SDK	Included in SDK
PostgreSQL		Included in SDK	Included in SDK
Quickbooks		Included in SDK	Included in SDK
REST	Included in SDK	Included in SDK	Included in SDK
Snowflake		Included in SDK	Included in SDK
Sybase		Included in SDK	Included in SDK
TSV (Tab Separated Values)	Included in SDK	Included in SDK	Included in SDK

Included in SDK - there is not a separate package to install for this data source. The data source ships with the Reveal SDK.

データ ソース

Installing Data Sources​

クライアントでのデータ ソースの作成​

サーバーでのデータ ソースの作成​

サポートされるデータ ソース​

データソース

Installing Data Sources

クライアントでのデータソースの作成

サーバーでのデータソースの作成

サポートされるデータソース