サービス連携仕様
⚙️

サービス連携仕様

サービス連携:接続設定

「サービス連携」から各社サービスとデータ連携の設定をします。

  1. srushの管理画面へログインします。
  2. データシート > サービス連携 > 連携したいサービス名を検索 > 押下
image

差分同期で一意キーにファイル内の列名が出てこない、全データ同期が赤×で失敗する

ファイルの内容によってファイル内のデータが正常に取得できず、一意キー選択時に列名が表示されない場合、あるいは全データ同期が赤×で失敗する場合があります。

それでも改善されない、もしくは文字コードが「shiftjis」の場合は接続設定の「スキーマ」を指定する必要があります。

以下の形ですべての列名を並べ、「スキーマ」の入力欄に設定してください。

{"列名1": "string", "列名2": "string"}

サービス連携:オブジェクト一覧の設定

  1. 名前
  2. 任意のお好きなものを入力してください。

  3. フォーマット
  4. 連携対象のファイルの形式を選択してください。

    ここでは CSV Format を選択した場合を例に説明します。

  5. ヘッダーの定義
  6. CSVのヘッダー(カラム名)の定義方法を選択します。 From CSV を選択してください。

    ※ From CSVはCSV中のヘッダーからヘッダーを定義する方法です

    任意の設定項目

任意の設定項目

  1. パス パターン(必須)
  2. どのファイルを選択するかを指定するためのパターンを入力してください。

    例)
💡

通常、以下項目はデフォルトから変更する必要はございません。 デフォルトの設定でうまく連携出来ない場合にご設定ください。

  1. スキーマレス
  2. ストリーム(オブジェクト)のスキーマに対してレコードの検証や構造化を行わないかどうかを選択します。

  3. スキーマ
  4. ファイルから抽出されたレコードを検証するために使用されるスキーマ(カラム定義)を入力します。設定した場合、受信ファイルから自動検出されるオブジェクトのスキーマを上書きします。

  5. 検証ポリシー
  6. レコードがストリームスキーマに準拠していない場合、同期の動作を指示する検証ポリシーの名前を選択します。

  7. 履歴がいっぱいの場合に同期するまでの日数
  8. 履歴がいっぱいの場合に同期するまでの日数をご入力してください。

    ファイル・ストアの状態履歴がいっぱいになると、シンクは指定された日数の範囲で最後に更新されたファイルのみを読み込みます。

サービス連携:オブジェクト選択

image
  1. どのオブジェクトをSrushに連携するかを選択します。
  2. ※データ量に応じて取得時間も増えますので、必要なオブジェクトのみに絞り込んでいただくのがおすすめです。

  3. データ同期方式
    1. データ同期方式を選択してください。

      通常はデータ転送量の少ない 差分同期 を 推奨します。 差分同期 で問題がある場合は 全データ同期 をご選択ください。

    2. 全データ同期
    3. 差分同期
      1. 更新キー
      2. _ab_source_file_last_modified のみ選択可能です。

      3. 一意キー
      4. ユニークな列名(IDなど)を選択してください。

全データ同期

更新の際に、毎回すべてのデータを取得して同期します。

※連携元に日次や週次でファイルが増えていくような場合は、年月が経過するにつれてデータ量が膨大になり更新が終わらなくなってしまうなどの問題が発生するため差分同期をお願いします。

差分同期

更新の際に、差分のデータを判別して同期します。

差分の判別には「更新キー」「一意キー」が必要です。

更新キー

時系列の判別に使われる情報です。

「_ab_source_file_last_modified」のみ選択可能です。

「_ab_source_file_last_modified」とは、連携元のファイルの更新日です。

更新キーをみて、どのデータが新しいのかを判別します。

一意キー

データの特定に使われる情報です。

連携元のファイルにある列の中から1つ選択可能です。

たとえばIDなど、ユニークに割り当てられる列を選択してください。

一意キーをみて、同期済のデータなのか、新しいデータなのかを判別します。

更新条件

差分同期では、以下のように同期が行われます。

  • 一意キーが異なる場合、新しいデータとして同期
  • 一意キーが同一で更新キーが異なる場合
    • 更新キーが新しければ新しい方のデータで上書き
    • 更新キーが古ければそのまま(Srush上のデータは上書きされない)

<TOPへ戻る