ユーザーの居住地の気温が10℃以下になった地域に KARTE Message で自動メール配信する方法を解説！

<html><head></head><body><p>こんにちは、Customer Engineerのkobasukeです。<br>
今年上京したのですが、上京したての頃に毎日驚嘆していた東京の街並みと人の多さは今では見慣れてきて、「都会に染まってきているな」と感じる今日この頃です。</p>
<p>突然ですが、皆様はKARTE Datahubのジョブフローを利用していただいているでしょうか？利用してくださっている方、いつもありがとうございます！</p>
<p>さて、Datahubジョブフローを使用している中で、以下のようなニーズを持つ方もいるのではないでしょうか？</p>
<ul>
<li><strong>ジョブフローに登録できるジョブの上限数を超えて複数ジョブを逐次実行させたい</strong></li>
<li><strong>ジョブフローAの完了後にジョブフローB〜Eを並列実行させたい</strong></li>
</ul>
<p>現在のDatahubジョブフロー機能では、これらのニーズに残念ながらお応えできません。というのも現状のジョブフロー機能では以下のような制約があるためです。</p>
<ul>
<li><strong>ジョブフローに登録できるジョブ数には上限がある</strong></li>
<li><strong>複数のジョブフローで順番を指定して逐次実行させるといったことはできない</strong></li>
</ul>
<p>ですが、KARTE Craftとの連携によって、この制約を超えて皆様のニーズにお応えすることができます。<br>
そこで今回は、KARTE CraftとKARTE Datahubを連携させた <strong>「あるジョブフローが完了したら別のジョブフローを実行する」</strong> というソリューションを紹介していきます。</p>
<h1 id="目次">目次</h1>
<ul>
<li><strong>実装イメージ</strong></li>
<li><strong>作成手順</strong></li>
<li><strong>実際に動かしてみる</strong></li>
</ul>
<h1 id="実装イメージ">実装イメージ</h1>
<p>KARTE Craftを用いて、あるジョブフローが完了したら別のジョブフローを実行するシステムは下記のような構成で実装します。<br>
<img src="https://ik.imagekit.io/plaid/757b2f44-cf35-48e3-b8f7-923ba735d649/%E3%82%B7%E3%82%99%E3%83%A7%E3%83%95%E3%82%99%E3%83%95%E3%83%AD%E3%83%BC%E3%83%95%E3%83%AD%E3%83%BC%E3%83%81%E3%83%A3%E3%83%BC%E3%83%88.png" alt="ジョブフローフローチャート.png"><br>
システムの各登場人物を整理すると下記のようになります。</p>
<div class="TableScroll"><table>
<thead>
<tr>
<th>登場人物</th>
<th>詳細</th>
</tr>
</thead>
<tbody>
<tr>
<td>ユーザー</td>
<td>KARTE利用者</td>
</tr>
<tr>
<td>Trigger Jobflow</td>
<td>実行終了することで、Target Jobflowの実行条件となるジョブフロー</td>
</tr>
<tr>
<td>Target Jobflow</td>
<td>Trigger Jobflowの終了によって、実行されるジョブフロー</td>
</tr>
<tr>
<td>Hook v2</td>
<td>Functionを起動するトリガー</td>
</tr>
<tr>
<td>Craft Functions</td>
<td>KARTE Craftで作成する汎用プログラム</td>
</tr>
</tbody>
</table></div>
<p>システムの流れを説明すると下記のようになります。<br>
⓪ ユーザーがCraft Functionに実行させたいジョブフローを設定する<br>
① 最初のジョブフロー( Trigger Jobflow )が実行される<br>
② Trigger Jobflowの終了をHook v2で検知する<br>
③ Craft Functionsが起動される<br>
④ 次に実行するジョブフロー( Target Jobflow )の実行requestを行う<br>
⑤ Target Jobflowが実行される<br>
<strong>--Triger JobflowにTarget Jobflowを設定している場合--</strong><br>
②' Target Jobflowが終了<br>
③ Craft Functionが起動する<br>
以降繰り返す</p>
<h1 id="作成手順">作成手順</h1>
<p>手順は次の通りです。</p>
<ol>
<li>連続して実行したい2つ以上のジョブフローを用意する</li>
<li>API v2でアプリを作成する</li>
<li>Craft Functionsを作成する</li>
<li>API v2でHook v2を設定する</li>
</ol>
<p>順番に説明します。</p>
<h2 id="1. 連続して実行したい2つ以上のジョブフローを用意する">1. 連続して実行したい2つ以上のジョブフローを用意する</h2>
<p>まず、連続して実行したい2つ以上のジョブフローを用意します。まだジョブフローを作成していない場合は以下を参考に作成してください。</p>
<p>作成手順は次の通りです。</p>
<ol>
<li>[Datahub &gt; ジョブフロー &gt; 作成 &gt; ジョブを追加]を選択</li>
<li>任意のジョブを設定</li>
<li>ジョブフロー名を入力し、保存</li>
<li>残りのジョブフローも同じように作成</li>
</ol>
<h2 id="2. API v2でアプリを作成する">2. API v2でアプリを作成する</h2>
<p>次に、Craft FunctionsからKARTE Datahubを操作するアプリを作成します。</p>
<p>作成手順は次の通りです。<br>
<strong>＜アプリの設定＞</strong></p>
<ol>
<li>[ストア &gt; API v2 &gt; 作成] を選択</li>
<li>アプリの種類を<code>token</code>に設定</li>
<li>アプリのScopeを<code>datahub.jobflow.get</code>, <code>datahub.jobflow.exec</code>に設定</li>
<li>任意の名前をつけて保存<br>
<img src="https://ik.imagekit.io/plaid/56f3299c-4057-43e8-83dc-e16dac4449e6/%E3%82%B9%E3%82%AF%E3%83%AA%E3%83%BC%E3%83%B3%E3%82%B7%E3%83%A7%E3%83%83%E3%83%882023-11-2413.50.30.png" alt="スクリーンショット2023-11-2413.50.30.png"></li>
</ol>
<p><strong>＜アクセストークンの保存＞</strong></p>
<ol>
<li>アクセストークンが発行されるため「トークンをCraft Secretに保存する」を選択する</li>
<li>任意の名前をつけ、Craft Secretに保存する<br>
<img src="https://ik.imagekit.io/plaid/39c627c5-617c-4248-b1a2-72532a88115e/%E3%82%B9%E3%82%AF%E3%83%AA%E3%83%BC%E3%83%B3%E3%82%B7%E3%83%A7%E3%83%83%E3%83%882023-11-2413.39.24.png" alt="スクリーンショット2023-11-2413.39.24.png"></li>
</ol>
<h2 id="3.Craft Functionsを作成する">3.Craft Functionsを作成する</h2>
<p>次に、終了したジョブフローを判別し次のジョブフローを実行するCraft FunctionsのFunctionを作成します。サンプルとなるソースコードは、Craft FunctionsのテンプレートとしてGitHubで公開しています。<br>
<a href="https://github.com/plaidev/craft-codes/tree/main/craft-functions/execute-multiple-jobflow" target="_blank" rel="noreferrer">craft-codes/craft-functions/execute-multiple-jobflow at main · plaidev/craft-codes</a></p>
<p>作成手順は次の通りです。</p>
<ol>
<li>[Craft &gt; ファンクション &gt; 作成 &gt; テンプレートから作成] を選択</li>
<li><strong>あるジョブフローが完了したら別のジョブフローを実行する</strong> というテンプレートを検索し「取得」ボタンをクリック</li>
<li>「反映」ボタンをクリック</li>
<li>コード内で<code>TARGET_JOBFLOWS</code>を設定する</li>
<li>【変数】タブで変数を設定する</li>
<li>Functionを有効化して保存</li>
</ol>
<p><code>TARGET_JOBFLOWS</code>はジョブフローの実行方法に合わせて以下のように設定します。<br>
<strong>＜順次実行＞</strong><br>
ジョブフローA→B→C...の場合</p>
<pre><code class="hljs"><span class="hljs-keyword">const</span> TARGET_JOBFLOWS = [
    { trigger: <span class="hljs-string">'jobflowAのID'</span>, target: <span class="hljs-string">'jobflowBのID'</span> }, <span class="hljs-comment">// A -&gt; B</span>
    { trigger: <span class="hljs-string">'jobflowBのID'</span>, target: <span class="hljs-string">'jobflowCのID'</span> }, <span class="hljs-comment">// B -&gt; C</span>
    <span class="hljs-comment">/*
    ....
    */</span>
]
</code></pre>
<p><strong>＜並列実行＞</strong><br>
ジョブフローA→B,C,...の場合</p>
<pre><code class="hljs"><span class="hljs-keyword">const</span> TARGET_JOBFLOWS = [
    { trigger: <span class="hljs-string">'jobflowAのID'</span>, target: <span class="hljs-string">'jobflowBのID'</span> }, <span class="hljs-comment">// A -&gt; B</span>
    { trigger: <span class="hljs-string">'jobflowAのID'</span>, target: <span class="hljs-string">'jobflowCのID'</span> }, <span class="hljs-comment">// A -&gt; C</span>
    <span class="hljs-comment">/*
    ....
    */</span>
]
</code></pre>
<p>ジョブフローのIDの取得方法は以下です。</p>
<ol>
<li>[Datahub &gt; ジョブフロー]を選択</li>
<li>1.で準備したジョブフローを選択</li>
<li>画面左下の【詳細情報】のJobflow Idを取得<br>
<img src="https://ik.imagekit.io/plaid/d6861851-796c-4890-a9d5-b8eb00a18bc1/%E3%82%B9%E3%82%AF%E3%83%AA%E3%83%BC%E3%83%B3%E3%82%B7%E3%83%A7%E3%83%83%E3%83%882023-11-2414.46.27.png" alt="スクリーンショット2023-11-2414.46.27.png"></li>
</ol>
<p>変数は以下のように設定します。</p>
<div class="TableScroll"><table>
<thead>
<tr>
<th>変数名</th>
<th>詳細</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>KARTE_APP_TOKEN_SECRET</code></td>
<td>KARTE API v2アプリのtokenを登録したシークレット名</td>
</tr>
<tr>
<td><code>LOG_LEVEL</code></td>
<td><code>ERROR</code>/<code>WARN</code>/<code>INFO</code>/<code>DEBUG</code>から出力するログレベルを指定します</td>
</tr>
</tbody>
</table></div>
<p>サンプルコードの実装の特徴は次の通りです。</p>
<ol>
<li>triggerに設定したジョブフロー以外が終了した場合、ログにメッセージを出し、処理を強制終了させる</li>
<li>複数のジョブフローを並列実行した場合に、各々のジョブフローの実行レスポンスが返ってくる</li>
</ol>
<h2 id="4. API v2でHook v2を設定する">4. API v2でHook v2を設定する</h2>
<p>最後にCraft Functionsを起動させるトリガーとなるHook v2を設定します。</p>
<p>設定手順は以下です。</p>
<ol>
<li>2で作成したアプリにアクセス</li>
<li>[上部メニュー&gt;hook設定&gt;編集]を選択する</li>
<li>トリガー設定に<code>KARTE Datahub: ジョブフローの終了時</code>を追加</li>
<li>[チャネル設定&gt;Craft]を設定</li>
<li>保存<br>
<img src="https://ik.imagekit.io/plaid/1966a9d9-9f1d-4df8-bc73-2d3f84fa881b/%E3%82%B9%E3%82%AF%E3%83%AA%E3%83%BC%E3%83%B3%E3%82%B7%E3%83%A7%E3%83%83%E3%83%882023-11-2413.44.11.png" alt="スクリーンショット2023-11-2413.44.11.png"></li>
</ol>
<p>Hook v2の設定内容は以下です。</p>
<div class="TableScroll"><table>
<thead>
<tr>
<th>項目</th>
<th>詳細</th>
</tr>
</thead>
<tbody>
<tr>
<td>トリガー設定</td>
<td>KARTE Datahub: ジョブフローの終了時</td>
</tr>
<tr>
<td>hook status</td>
<td>有効にする</td>
</tr>
<tr>
<td>ファンクション名</td>
<td>3で作成したFunction名</td>
</tr>
</tbody>
</table></div>
<p>以上で、Craft FunctionsからKARTE Datahubのジョブフローを操作するための準備は完了です。</p>
<h1 id="実際に動かしてみる">実際に動かしてみる</h1>
<p>実際にKARTE Datehubで最初のTrigger Jobflowを実行して動作を確認してみましょう。</p>
<p>実際にKARTE DatahubからTrigger Jobflowとしたジョブフローを実行してみます。すると、Triggerに設定したジョブフローの実行が終了すると、Targetに設定したジョブフローが実行されていることがログで確認できます。以下はログの一例です。</p>
<p><strong>＜順次実行の場合（A→B→C）＞</strong><br>
<img src="https://ik.imagekit.io/plaid/bac9b838-d52c-474f-9e60-23e001e8e8b0/%E3%82%B9%E3%82%AF%E3%83%AA%E3%83%BC%E3%83%B3%E3%82%B7%E3%83%A7%E3%83%83%E3%83%882023-11-2415.14.08.png" alt="スクリーンショット2023-11-2415.14.08.png"><br>
<strong>＜並列実行の場合（A→B, C）＞</strong><br>
<img src="https://ik.imagekit.io/plaid/aea4a6be-b07e-4262-a048-f3dd120e0ada/%E3%82%B9%E3%82%AF%E3%83%AA%E3%83%BC%E3%83%B3%E3%82%B7%E3%83%A7%E3%83%83%E3%83%882023-11-2415.14.28.png" alt="スクリーンショット2023-11-2415.14.28.png"><br>
<strong>＜Trigger Jobflow以外が終了した場合＞</strong><br>
<img src="https://ik.imagekit.io/plaid/5122ab6a-d345-4edf-83b5-b4d41d095b58/%E3%82%B9%E3%82%AF%E3%83%AA%E3%83%BC%E3%83%B3%E3%82%B7%E3%83%A7%E3%83%83%E3%83%882023-11-2415.02.02.png" alt="スクリーンショット2023-11-2415.02.02.png"></p>
<h1 id="おわりに">おわりに</h1>
<p>今回は <strong>「あるジョブフローが完了したら別のジョブフローを実行する」</strong> というソリューションについて紹介しました。このソリューションを応用することで、複数のジョブフローの順次実行を並列に実行させたり、反対に複数の並列実行を順次実行させるなども実現することができます。<br>
皆さんもCraftを使用してDatahubジョブフローの機能拡張を行い、施策の幅を広げてみてください！</p>
<hr>
<p>プレイドでは、世の中にインパクトを与える新しいソリューションを一緒につくる仲間を募集しています！<br>
ぜひ気軽にお問い合わせください。</p>
<p>↓ パートナー企業になりたい</p>
<ul>
<li><a href="https://ecosystem.plaid.co.jp/" target="_blank" rel="noreferrer">CustomerData-Driven Solution を一緒に創りませんか？ | PLAID Ecosystem</a></li>
</ul>
<p>↓ PLAIDで働きたい</p>
<ul>
<li><a href="https://recruit.plaid.co.jp/requisitions/general-customer-engineer" target="_blank" rel="noreferrer">Customer Engineer | 募集ポジション | 株式会社プレイド</a></li>
<li><a href="https://recruit.plaid.co.jp/requisitions/product-engineer" target="_blank" rel="noreferrer">Product Engineer | 募集ポジション | 株式会社プレイド</a></li>
</ul>
</body></html>

KARTE Craftを使って「あるジョブフローが完了したら別のジョブフローを実行する」ソリューションを作成しました。