あるジョブフローが完了したら別のジョブフローを実行する

<html><head></head><body>こんにちは、Customer EngineerのMasamichiです！ 
最近は本格的に寒くなり冬服に衣替えする頃ですが着痩せしないように背中と肩の筋トレを頑張っています。
さて、<a href="https://solution.plaid.co.jp/202310-craft-counter">Craft Counter</a>を使う上で「現在のカウント数を定期的に確認したい」と思ったことはありませんか？例えばクーポン在庫の払い出しをCraftで管理している場合、在庫がどのくらい消費されているか知らなければいつ在庫を補充すれば良いかわかりません。
実際に想定されるユースケースとして以下のようなものが挙げられます：
<ul>
<li>クーポン発行数をCraft Counterで管理していて、現在の発行数を知るために定期的にSlackに通知して欲しい 
（参考：<a href="https://solution.plaid.co.jp/202310-coupon-dispenser">クーポン在庫を順次払い出すAPIをKARTE Craftで実装してみた</a>）</li>
</ul>
今回は、KARTE Craftを使ってCraft Counterの値を定期的にSlackに通知する処理を実装します。
<hr>
<h1 id="全体像">全体像</h1>
<h2 id="処理の流れ">処理の流れ</h2>
実現する処理の流れは下図のようになります： 
<img src="https://ik.imagekit.io/plaid/5a585c12-9a7c-4696-9366-3b81127a4784/craft_counter_notification_flow.jpg" alt="all_process_flow"> 
Craft Counterに対して取得したいkeyをカンマ区切りの文字列で指定しておくと、Slackにそれらの現在の値が通知されます。
<h2 id="アウトプットイメージ">アウトプットイメージ</h2>
最終的なアウトプットイメージは、以下のように指定した複数keyに対応するvalueを一度で返します。例えばKARTEを用いてクーポンの発行を東京、大阪、名古屋でそれぞれ発行している場合、東京<code>coupon_count_tokyo</code>、大阪<code>coupon_count_osaka</code>、名古屋<code>coupon_count_nagoya</code>とすると下図のように通知されます。 
<img src="https://ik.imagekit.io/plaid/6d29d425-41bf-424f-94d7-e91198150b64/スクリーンショット2023-11-2715.09.29.png" alt="アウトプットイメージ">
<hr>
<h1 id="実装手順">実装手順</h1>
実装の手順は次の通りです。
<ol>
<li>Slackアプリを作成しワークスペースにインストールする</li>
<li>Craft Counterから欲しい値を取得しSlackに通知する</li>
<li>定期的に自動投稿するようにスケジューリングする</li>
</ol>
順番に説明します。
<h2 id="1. Slackアプリを作成しチャンネルに追加する">1. Slackアプリを作成しチャンネルに追加する</h2>
<h3 id="アプリの作成">アプリの作成</h3>
次の手順に沿ってアプリを作成して下さい：
<ul>
<li>[<a href="https://api.slack.com/apps" target="_blank" rel="noreferrer">Slack API &gt; Your Apps</a>]へいき<code>Create New App</code>をクリック</li>
<li>Create New Appの画面で<code>From scratch</code>を選択</li>
<li>App名と追加したいWorkspaceを指定</li>
</ul>
<h3 id="Scopeの設定">Scopeの設定</h3>
アプリを作成したら設定画面のOAuth &amp; PermissionへいきBotのスコープを設定します。 
<img src="https://ik.imagekit.io/plaid/f5b7a25f-4cf3-4f5e-be67-af7a47549395/%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-2717.34.48.png" alt="view_detail.png">
今回の処理ではBotに投稿させたいので<code>Bot Token Scopes</code>に<code>chat:write</code>の権限を選択して付与します。
<h3 id="チャンネルにアプリを追加する">チャンネルにアプリを追加する</h3>
完了したら次の手順に沿ってチャンネルに作成したアプリを追加して下さい：
<ul>
<li>OAuth Token for Your Workspaceの<code>Install to Workspace</code>をクリックしてSlackに接続</li>
<li>ワークスペースにいき<code>App</code>から作成したアプリを追加</li>
<li>[#Your Channel Name &gt; インテグレーション]から<code>アプリを追加する</code>をクリックして作成したアプリを追加</li>
</ul>
<img src="https://ik.imagekit.io/plaid/6c830b6f-70db-4350-80c6-6979bafb56e0/%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-2910.19.39.png" alt="スクリーンショット2023-11-2910.19.39.png">
これでSlackの設定は完了です
Slack APIを使用するにあたって以下の情報を必ず控えておいてください
<ul>
<li><code>Bot User OAuth Token</code>: Botが通知するのに必要な権限</li>
<li><code>Slack Channel ID</code>: SlackのチャンネルID(「チャンネル詳細を表示」を押して最下を確認)</li>
</ul>
<h2 id="2. Craft Counterの値をSlackに通知するCraft Functionsを作成する">2. Craft Counterの値をSlackに通知するCraft Functionsを作成する</h2>
<h3 id="Functionを作成する">Functionを作成する</h3>
それでは実際にCraft Couternの値をSlackに通知するCraft FunctionsのFunctionを作成します。サンプルとなるソースコードは、Githubで公開しています。 
<a href="">https://github.com/plaidev/craft-codes/tree/main/craft-functions/counter-notification-slack</a>
作成手順は次の通りです。
<ul>
<li>[Craft &gt; ファンクション &gt; 作成 &gt; テンプレートから作成]を選択</li>
<li><code>Craft Counterの中身を定期的にSlackに通知する</code>というテンプレートを検索し「取得」をクリック</li>
<li>「反映」をクリックしFunctionを有効化してから保存</li>
</ul>
ここでサンプルコードで行われている実装について解説します。
<h3 id="Craft Counterから値を取得する">Craft Counterから値を取得する</h3>
JavaScriptでのコード例：
<pre><code class="language-js: hljs">const COUNTER_KEYS = '&lt;% COUNTER_KEYS %&gt;';

const { counter } = MODULES;

const counterKeys = COUNTER_KEYS.split(',');

const counterValues = await counter.get({keys: counterKeys});
</code></pre>
<code>COUNTER_KEYS</code>はCraft変数の参照をしていてkeyをカンマ区切りの文字列で指定します。 
（keyの例：<code>"coupon_count_tokyo, coupon_count_osaka, coupon_count_nagoya"</code>） 
<code>counterValues</code>に指定したkeyに対応するvalueが配列で格納されます。
<h3 id="取得した値をSlackへ通知する">取得した値をSlackへ通知する</h3>
JavaScriptでのコード例：
<pre><code class="language-js hljs">import { WebClient } from '@slack/web-api';

const SLACK_CHANNEL_ID = '&lt;% SLACK_CHANNEL_ID %&gt;';
const SLACK_TOKEN_SECRET = '&lt;% SLACK_ TOKEN_SECRET %&gt;';

const { secret } = MODULES;
const secrets = await secret.get({keys: [SLACK_TOKEN_SECRET]});
const token = secrets[SLACK_TOKEN_SECRET];

const slackClient = new WebClient(token);

const message = counterKeys
 .map((key, i) =&gt; `現在の${key}のカウント数: ${counterValues[i]}`)
 .join('\n');

await slackClient.chat.postMessage({
 channel: SLACK_CHANNEL_ID,
 text: message
 });
</code></pre>
<ul>
<li><code>SLACK_CHANNEL_ID</code>：前述した<code>Slack Channel ID</code>を格納したCraft変数</li>
<li><code>SLACK_TOKEN_SECRET</code>：前述した<code>Slack Bot User OAuth Token</code>を登録したシークレットのCraft変数</li>
</ul>
取得した入力key: <code>counterKeys</code>と対応するvalue: <code>counterValues</code>が紐づくように、メッセージを以下のようなフォーマットで作成しSlackに通知します。
<pre><code class="hljs"> 現在のcounterKeys[0]のカウント数：counterValues[0]
 現在のcounterKeys[1]のカウント数：counterValues[1]
 現在のcounterKeys[2]のカウント数：counterValues[2]
 ⋮
</code></pre>
<h2 id="3. 定期的に自動投稿するようにスケジューリングする">3. 定期的に自動投稿するようにスケジューリングする</h2>
最後にBotが定期的に通知してくれるようにスケジューリングの設定をします。
スケジュールはCraft functionsの設定画面から<code>cron</code>形式を用いて分単位で設定できます。スケジュールを有効にすることを忘れないでください！ 
<img src="https://ik.imagekit.io/plaid/d89a864c-e64f-45f7-b720-313f7cf0fbf7/%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-2812.13.33.png" alt="スクリーンショット2023-11-2812.13.33.png"> 
（※スケジュール設定の詳細は<a href="https://developers.karte.io/docs/craft-scheduler" target="_blank" rel="noreferrer">Craft Scheduler</a>を確認して下さい。）
<h1 id="おわりに">おわりに</h1>
以上で実装は終了です、お疲れ様でした。
今回は「Craft Counterの中身を定期的にSlackに通知する」を紹介しました。これによりCraft Counterの最新の値を簡単に確認できるようになります。ぜひ皆さんも活用してみてください！
<hr>
プレイドでは、世の中にインパクトを与える新しいソリューションを一緒につくる仲間を募集しています！ 
ぜひ気軽にお問い合わせください。
↓ パートナー企業になりたい
<ul>
<li><a href="https://ecosystem.plaid.co.jp/" target="_blank" rel="noreferrer">CustomerData-Driven Solution を一緒に創りませんか？ | PLAID Ecosystem</a></li>
</ul>
↓ PLAIDで働きたい
<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を使って「Craft Counterからvalueを定期的に取得してSlackに自動投稿する」を実装しました。