backlog とワークフローの連携をカンタンに実現する方法

backlog と連携するための Questetra アドオンの作成

 

システム連携ネタでよくブログを書いている日下です。
※ちなみにこれまでのネタはこちら

 

backlog とワークフローシステムを併用されているケースをよく耳にします。

backlog とワークフローシステム、どちらもタスクを管理する仕組みと言えますが、backlog は処理の流れが定まらないものの管理が得意で、ワークフローシステムは処理の流れが定まったものの管理が得意、と特性が異なります。

また、併用されている場合、backlog とワークフローシステムの適用範囲が異なるケースが多いようです。具体的な例で言えば、自社内ではワークフローシステムで業務管理をしていて、社外の協力会社とのやりとりには backlog を利用されているケース等があります。

クラウド型ワークフローである Questetra のユーザでも、backlog と併用されているケースがあります(サーバーワークスさまシャノンさまアラタナさま)。また、Questetra の利用をご検討中のお客様からも backlog との連携についてご相談をいただくことがあります。

以前にサーバーワークスさまのブログ記事で、backlog と Questetra の連携方法をご紹介いただいたことがありますが、今回はそれをもっとカンタンに実現できるようにする、ということで backlog と連携するための Questetra アドオンを準備しました。そのアドオンについてご紹介します。


今回準備したアドオンは Questetra のワークフローの途中で backlog の課題を追加するものです。
課題の追加は、Questetra から backlog の API に対して http リクエストを投げることで実現できます。

以前のブログ記事で書いた通り、認証部分は OAuth ではなく API Key を使います。

backlog の課題追加の API 仕様の詳細はこちらのページの通りで、いくつかオプションのパラメータがあります。今回指定するパラメータは前述のサーバーワークスさまのブログ記事にあわせて、以下としました。

パラメータ名 必須 内容
projectId 必須 数値 課題を登録するプロジェクトのID
summary 必須 文字列 課題の件名
description 文字列 課題の詳細(課題の本文)
issueTypeId 必須 数値 課題の種別のID
priorityId 必須 数値 課題の優先度のID
assigneeId 数値 課題の担当者のID
dueDate 文字列 課題の期限(YYYY-MM-DD)
categoryId[] 数値 課題のカテゴリのID

ワークフローでの処理後に backlog の課題を起票するとなると、以下のようなフロー図となります。

またアドオンの設定画面は以下のような形となります。

アドオンの設定項目は以下の通り。

項目名 必須 形式
A: Space id 必須 文字入力
B: API key 必須 文字入力
C: プロジェクトIDが格納されている選択型データ項目 必須 選択型データを選択
D: 課題の件名が格納されている文字列型データ項目 必須 文字型データを選択
E: 課題の詳細が格納されている文字列型データ項目 必須 文字型(複数行)データを選択
F: 課題の種別のIDが格納されている選択型データ項目 必須 選択型データを選択
G: 課題の優先度のIDが格納されている選択型データ項目 必須 選択型データを選択
H: 担当者のIDが格納されている選択型データ項目 選択型データを選択
I: 締切日が格納されている日付型データ項目 日付型(年月日)データを選択
J: カテゴリのIDが格納されている選択型データ項目 選択型データを選択
X: ログが格納されている文字型データ項目 文字型(複数行)データを選択

※「E.課題の詳細」は、API 仕様としては必須ではありませんが、アドオンの設定としては必須としました。

 

サンプルフローのアーカイブをこちらからダウンロードできます(zip を展開すると qar ファイルが入っています)。
backlog_sample_download
※アーカイブのインポート方法はこちらのページをご覧ください

また今回のアドオンのダウンロードはこちらから。
backlog-issue-add-20171025-addonxml
 

使い方としては以下の通りで、プログラミングをしなくても、設定だけで連携が実現できます。

  1. Questetra でアドオンの登録をする。
    ※Questetra アドオンの設定方法について以下をご覧ください。
     M415 自動工程 業務プロセス定義で利用可能な自動工程を追加する
     ちなみに、backlog 以外にも様々なサービスと Questetra を連携するアドオンをこちらのページで準備しています。
     
  2. Questetra アプリ設定で、アドオンの設定項目にあわせて、データ項目を準備する。
    ※特にプロジェクトID・課題の種別・課題の優先度・担当者・カテゴリは backlog 側の ID にあわせて選択肢の準備が必要になります。
     
  3. Questetra アプリ設定で、フロー図にアドオンを入れて、アドオンのプロパティを設定する。
    ※backlog の API Key の取得等については、backlog のヘルプを参照ください。

 

余談ですが、backlog との連携ロジックを準備していてハマった点をメモしておきます。
backlog の API を呼び出す際の API Key の指定について、課題の追加等の POST で http リクエストを送るケースでも、API Key は URL の後ろにつけないといけない、という仕様でした。POST の場合は他のパラメータと同様に URL にはつけないものと思い込んでいたので、なかなか正しく処理されず、解決までに少し時間がかかりました。もし自分でロジックを書かれる場合にはご留意ください。

backlog と Questetra の連携がカンタンに実現できることがご理解いただけたかと思います。
Questetra は無料お試しアカウントもありますので、ぜひお試しください。

 

また別の記事で、逆向きでの連携(backlog → Questetra)のケースや、さらに同じヌーラボ社が提供されている typetalk との連携についても紹介したいと考えています。

 

もし、ご質問等がありましたら、お問い合わせフォームからご連絡ください。

 

Kusaka Tsuyoshi の紹介

営業をやってますが、もともとエンジニアなので、プログラミングもやります。
Kusaka Tsuyoshi の投稿をすべて表示

あわせて読みたい
50.Questetra Tips の前の記事 ロボット君がランダムに翻訳者を指名してくれる方法(3)
50.Questetra Tips の次の記事 入力データの変更履歴を自動取得する
Kusaka Tsuyoshi の他の記事 PDF 帳票自動生成でページ数を切り替える(ページングする)方法

アーカイブ

 RSS