転送先 - kintone
  • 07 May 2024
  • PDF

転送先 - kintone

  • PDF

記事の要約

概要

サイボウズのkintoneへデータを転送する設定のヘルプページです。

制約

  • kintone APIの制約があります。
  • 転送設定ごとに、kintone側でアプリを作成する必要があります。
    • TROCCO側から自動でアプリを作成することはできません。
  • 転送モードがupsertの場合、アップデートキーに空のレコードを含まれていると、そのレコードは新規追加されます。
    • 転送先に空のキーを持つレコードが存在するとしても、その行は更新されません。

補足事項

転送設定STEP2のカラム定義について

転送設定STEP2「カラム定義」のカラム名には、kintoneアプリのフィールドコードを入力してください。

設定項目

STEP1 基本設定

項目名必須内容
kintone接続情報Yesあらかじめ登録してあるkintoneの接続情報から、今回の転送設定に必要な権限を持つものを選択します。
アプリIDYesデータの転送先となる、kintoneのアプリIDを入力します。
アプリIDは、アプリ画面のURLから確認できます。
data-destination-kintone_001.png
APIで取得する場合はkintone API公式ドキュメント - アプリの ID を取得するを参照ください。
ゲストスペースIDNoゲストスペースを利用している場合は、ゲストスペースIDを入力してください。
転送モードYes転送モードを指定します。
  • insert:転送先にレコードを転送します。
  • update:アップデートキーが一致するレコードを更新します。
  • upsert:アップデートキーが一致するレコードがあれば更新し、そうでなければ新しくレコードを転送します。
  • アップデートキーYes転送モードにてupdateまたはupsertを選択した場合に入力します。
    ユニークな値を持つフィールドのカラム名を入力してください。
    なお、アップデートキーは、STEP2カラム定義の任意のカラム名と一致している必要があります。

    STEP1 詳細設定

    詳細設定をクリックすると、設定項目が表示されます。

    項目名デフォルト値内容
    テーブル転送キー-アプリ内のテーブル(旧:サブテーブル)にレコードを転送する場合に入力します。
    詳しくは、アプリ内のテーブル(旧:サブテーブル)を更新したい場合を参照ください。
    一度のリクエストで更新するレコード数100一度に更新するレコード数を入力します。
    NULLを含む場合の更新処理NULLで更新するkintone上のレコード更新時に、転送データに含まれるNULL値をどのように扱うかを設定できます。以下から選択してください。
    • NULLで更新する
      • 転送データに含まれるNULL値は、更新対象のkintone上のデータに反映されます
    • 更新をスキップする
      • 転送データに含まれるNULL値は、更新対象のkintone上のデータに反映されず、元の値が維持されます
    なお、kintone上に新たに追記されるレコードには本項目の設定は適用されず、転送データのNULL値はNULL値のまま追加されます。

    STEP2 出力オプション

    カラムに関して詳細な設定を行うことができます。

    項目内容
    カラム名転送設定STEP2カラム定義の任意のカラム名を入力します。
    フィールドコード転送先のkintoneアプリのフィールドコードを入力します。
    データ型フィールドのデータ型を明示的に指定したい場合に選択します。
    選択できる型の一覧
  • SINGLE_LINE_TEXT
  • MULTI_LINE_TEXT
  • RICH_TEXT
  • NUMBER
  • CHECK_BOX
  • RADIO_BUTTON
  • MULTI_SELECT
  • DROP_DOWN
  • DATE
  • TIME
  • DATETIME
  • LINK
  • SUBTABLE
  • タイムゾーンDATE型またはTIME型で転送したい場合に、展開時に利用するタイムゾーンを入力できます。
    テーブルの行をソートするカラムSUBTABLE型で転送したい場合、テーブル(旧:サブテーブル)に値を昇順ソートした状態で登録できます。
    詳しくは、アプリ内のテーブル(旧:サブテーブル)を更新したい場合を参照ください。

    アプリ内のテーブル(旧:サブテーブル)を更新したい場合

    アプリ内のテーブル(本記載以降、サブテーブルと表記)にレコードを転送することもできます。
    なお、以下ではフィールドを階層構造別に区別して説明します。

    • アプリ直下のフィールド
    • サブテーブル内のフィールド

    一度の転送で、アプリ直下のフィールドへの転送、およびサブテーブル内のフィールドの更新を一括で行うことができます。

    サブテーブルへの転送に関する制約
    • 転送モードでupdateupsertを選択していても、サブテーブルへのデータ転送は常に洗い替えとなります。
      すなわち、既存のサブテーブルのレコードは、転送のたびに新しく転送されたデータに置き換わります。
    • アプリ直下のフィールドに、ユニークな値で構成されたフィールドが少なくとも1つ存在している必要があります。

    2次元テーブルを利用したサブテーブルの更新

    用意する転送データ

    サブテーブル内のフィールドのレコードが最小粒度となる形で、アプリ直下のフィールドの値が平坦化されて結合されたテーブルを用意します。
    具体例を用いて説明します。

    • アプリ直下:案件ID会社名というフィールドが存在する
    • サブテーブル:活動履歴というサブテーブルに、活動日活動内容というフィールドが存在する

    このようなケースにおいて、以下のような4列のテーブルを用意します。
    なお、転送データには、サブテーブルそのものに関する要素(上記例での活動履歴)を含める必要はありません。

    data-destination-kintone_002.png

    転送設定STEP1詳細設定のテーブル転送キー

    ユニークな値で構成されたアプリ直下のフィールドに該当するカラム名を入力します。
    ここで指定されたカラムの値に基づいて、サブテーブルのレコードがグルーピングされます。
    なお、本箇所で入力した値は、次手順で設定するカラム定義の任意のカラム名と一致している必要があります。

    data-destination-kintone_003.png

    転送設定STEP2のカラム定義

    カラム名をそれぞれ以下の通り入力します。

    • アプリ直下のフィールド:該当フィールドのフィールドコード
    • サブテーブル内のフィールド:「サブテーブルのフィールドコード.サブテーブル内のフィールドのフィールドコード
      • .を含めて入力する必要があります。

    data-destination-kintone_004.png

    転送設定STEP2出力オプションのカラム設定

    カラム設定を追加することで、フィールドごとにデータ型を明示的に指定できます。
    カラム名には、転送設定STEP2のカラム定義で指定したカラム名を入力ください。
    なお、サブテーブル内のフィールドの場合、.を含めて入力する必要があります。

    また、サブテーブルに対し、何らかのフィールドの値を基準に昇順ソートしてデータを転送することもできます。
    ソートして転送したい場合は、以下の通りカラム設定を追加してください。

    • カラム名:転送設定STEP2のカラム定義で指定したサブテーブル内のフィールドより、カラム名の「サブテーブルのフィールドコード」の部分(.の前部分)を入力ください。
    • フィールドコード:該当サブテーブルのフィールドコードを入力ください。
    • データ型:SUBTABLEを選択してください。
    • テーブルの行をソートするカラム:任意のサブテーブル内のフィールドのフィールドコードを入力ください。
      • 本箇所では「サブテーブルのフィールドコード.」(.の前部分)の部分を入力する必要はありません。

    data-destination-kintone_005.png

    上記設定に基づいて転送ジョブを実行すると、以下の通りにデータが転送されます。

    data-destination-kintone_006.png

    案件IDが1の中身を確認すると、サブテーブルも更新されていることがわかります。

    data-destination-kintone_007.png


    この記事は役に立ちましたか?