Page History

BellaDati Connector SDKはJavaで書かれたAPIです。主な目標は、顧客が自分のデータコネクタを実装し、BellaDatiとそれを統合するための機能を提供することです。それを動作させるための3の前提条件があります。

• あなたはBellaDatiのオンプレミスのインストールへの完全なアクセス権を持っている必要があります（そうでなければ管理者またはクラウドプロバイダにお問い合わせください）
• BellaDatiによって使用される他のクラスに干渉しないJavaのパッケージ構造とクラス名を定義されます。（以下のセクションで説明する）
• 必要なすべてのパーツを含むJARファイルパッケージを準備しました。これは、次のドキュメントに記載されているとおりに正しくビルドされています。

コネクタSDKの設定

Connector SDKが2つの部分で構成されます

• SDKのインタフェース宣言を含むAPI(Javadoc onlineとJavadoc download)　
• SDKを含むテストをより良く理解するための例を実装

SDKを使用するには、API jarファイルをダウンロードしてください。SDKのソースはGitHubの上で利用可能です。

IDE設定

独自のコネクタを実装するには、Java IDEが必要です（Eclipseなど）。BellaDati Connector SDKのIDEを設定するための特別な設定は必要ありません。

プロジェクトの設定

カスタムコネクタは、パッケージ名が続き「com.belladati.sdk.connector」プレフィックス（単純なクラスパスのスキャンによる）とパッケージにする必要がある。Javaパッケージ構造の接尾辞として会社のWebアドレスを使用するのは良い考えです。例：

com.belladati.sdk.connector.my.awesome.company

Javaプロジェクトに少なくとも1つの依存関係が必要です  　-　 SDKのインタフェース宣言を含む最新のConnector SDK API。依存関係を手動で設定したり、ビルドツール（Maven、Gradleなど）を設定してあなたのために行うことができます。

Maven使用

pom.xmlファイルに次の依存関係を追加します。

  <dependencies>
      ...
      <dependency>
          <groupId>com.belladati</groupId>
          <artifactId>sdk-connector-api</artifactId>
          <version>0.0.6</version>
          <scope>provided</scope>
      </dependency>
      ...
  </dependencies>

Gradle使用

build.gradleファイルに次の依存関係を追加します。

dependencies {
	...
	provided 'com.belladati:sdk-connector-api:0.0.6'
    ...
}

SDK内にクラスの概要

このセクションでは、JDKにバンドルされているクラスおよびインタフェースの高い概要が含まれています。詳細については、JavadocオンラインとGitHubでのソースコードをご参照してください。

DataProviderApi

特定の構成に基づいてインポートデータを提供します（プレビューデータとデータ定義を含む）。これはあなたのコネクタへのメインエントリポイントです。あなたのカスタムコネクタに、この抽象クラスを拡張し、また公共の静的メソッドのgetNameを実装する必要があります。（詳細は以下を参照）

RowApi

一つのソース行は、文字列値の配列として表現しました。あなたのカスタムコネクタで、このインタフェースを実装する必要があります。

RowsApi

行ソースのIterable とCloseable の定義。あなたのカスタムコネクタにこのインタフェースを実装する必要がある。

PropertyValueApi

プロパティの値を表すクラスがDataProviderApi 構成で使用されます。このプロパティが必要な場合は、値、デフォルト値、およびフラグが含まれます。。String, IntegerとBoolean値の型がサポートされています。あなたのカスタムコネクタのパラメータを管理するためにこのクラスを使用できます。

ProgressBarApi

プログレスバーはインポート時に、ユーザインターフェース上に表示されます。インポートアクションの進捗状況を更新するために、カスタムコネクターにこのリファレンスを使用できます。

ConnectorUtils

コネクタSDK用ユーティリティ。あなたの実装を簡素化するために、このクラスのヘルパーメソッドを使用できます。

実装

カスタムコネクタはRowApi、RowsApiとDataProviderApiなど3抽象型の具象サブクラスを含んでいる必要があります。もう1つの静的メソッド "getName"があります。これは、DataProviderApiの具体的なサブクラスで実装する必要があります。

/**
 * Returns name of this data provider that should be displayed on the user interface.
 * @return Data provider name
 */
public static String getName() {
	return "Name of my your custom connector";
}

ビルディング

カスタムコネクタは、すべての必要な依存関係を持つJAR（JavaArchive）としてパッケージ化する必要があります。使用方法、バージョンとすべての依存関係のスコープをBellaDatiチームに議論してください。準備ができたら、このプロジェクトをビルドするために優先ツールを呼び出します。

Maven使用

mvn clean install

Gradle使用

gradle clean install

「ターゲット」ディレクトリは、プロジェクトのjarファイルや他のビルド成果物が含まれています。

検査

カスタムコネクタプロジェクトには、動作を確認するためのテストが含まれている必要があります。 あなたはあなたのコードを担当しています。 テストには否定的なシナリオも含める必要があります。

展開

あなたの<belladati_installation_folder>/ belladati/ WEB-INF/ libにあるlibディレクトリを検索します。インストール先フォルダは、アプリケーションサーバのインストールパスを応じて、使用するアプリケーションサーバーの種類に従って異なる場合があります。 BellaDatiにカスタムコネクタを展開するにはbelladati/ WEB-INF/ libフォルダにファイル構築されたJARファイル（依存関係を含む）をコピーして、アプリケーションサーバーを再起動することを忘れないでください。

使用法

データ・ソースへの接続の「カスタム・コネクター」オプションをクリックすると、あなたのカスタムコネクタを使用できます。あなたのクラスパスで使用可能なすべてのカスタムコネクタとダイアログウィンドウが表示されます。

コネクタのいずれかを選択し、「続行」ボタンをクリックした後、選択したコネクタのパラメータをカスタマイズすることができます。

有効なパラメータを入力し、「続行」ボタンをクリックした後、あなたは一般的なインポート設定ページで、インポートのワークフローを続行できます。

行ソースのIterable とCloseable の定義。あなたのカスタムコネクタにこのインタフェースを実装する必要がある。