Workato（ワーカート）のMattermost（マターモスト）コネクタを作成しました

2020年09月09日
Workato（ワーカート）のMattermost（マターモスト）コネクタを作成しました

Author

近藤哲也 Tetsuya Kondo

こんにちは、リックソフトの近藤です。
今回のブログでは弊社が作成したWorkato用のMattermostコネクタをご紹介します。

MattermostはSlackライクなオンプレミス型のチャットツールで、セキュリティや運用ポリシーを自社に適合できるのが特徴です。
WorkatoはDXや業務自動化を支えるクラウド型のエンタープライズ自動化プラットフォームで、ビジネスユーザーがノーコーディングで各種アプリを連携する自動化ロジックを作成できます。

今回作成したWorkatoのMattermostコネクタを利用することで、より簡単にMattermostと各種アプリとの連携を実現することができます。
このMattermostコネクタはWorkatoのコミュニティライブラリに公開しています。Workatoの利用ユーザであれば自由にご利用いただけます。

Mattermostコネクタ作成の背景

Mattermostをコラボレーションの中心として利用していく際、各種アプリと連携したくなるシーンが出てきます。

各種アプリと連携を行う際、連携する経路の数だけアプリ間の接続を確立する必要がありますが、連携したい対象アプリが多岐に渡ったり、複数のアプリを連携して業務プロセスを組み立てる場合は仕組みが複雑になりがちです。
アプリ連携時の接続に利用する認証情報が各アプリに分散してしまい、セキュアに運用することが難しいといったこともあります。

Workatoをインテグレーションハブとして利用することで、すべてのアプリはWorkatoに一度接続すれば、他のアプリすべてと連携が取れるようになります。
接続に利用する認証情報もWorkatoに集約されるため、セキュアに管理運用ができるようになります。

Workatoはコネクタが用意されていないアプリでも、汎用コネクタを利用することで連携が可能ですが、アプリ専用コネクタがあるとより簡単に連携レシピを作成できます。
特にMattemostのようなコラボレーションツールの場合は各種連携で利用する頻度が高く専用コネクタがあると便利、ということで今回Mattermostコネクタを作成しました。

クラウド/オンプレミス間のインテグレーション

Workatoはクラウドのプラットフォーム、Mattermostはオンプレのチャットツールなので両者の相性は良くないのでは？とお考えの方もいらっしゃるかもしれません。

Workatoはクラウドアプリとの連携が注目されますが、オンプレアプリとの連携も得意です。
Mattermostとの連携に限らず、例えばオンプレのJira Software、基幹システム、データベース、ファイル等とクラウドアプリをセキュアに連携することが可能です。

なお、Workatoでオンプレアプリと連携する際には、オンプレエージェント（OPA）と呼ばれるオプション機能を利用します。
このOPA機能はWorkatoとオンプレアプリとの通信を仲介することで、Workatoとオンプレアプリが直接通信できない環境下でも連携を可能にします。

前置きが長くなりましたが、次からはそういった経緯で作られたMattermostコネクタの紹介をしていきたいと思います。

Mattermostコネクタの紹介

Mattermostコネクタのインストール

Mattermostコネクタは、Workatoのコミュニティライブラリ > カスタムコネクターから「Mattermost」で検索してインストールすることが出来ます。

Mattermostコネクタをインストールすると、Mattermostのアプリコネクションを作成できるようになります。
アプリコネクションを作成する際には以下のMattermostインスタンス情報および認証情報を入力して接続を確立します。

サイトURL
ユーザー名（パーソナルユーザートークンの場合は省略）
パスワードまたはパーソナルユーザートークン
オンプレミスエージェント（OPA）の利用有無

Mattermostコネクタの機能

ブログ執筆時点で利用できるMattermostコネクタの機能は以下のとおりです。

利用できるアクション	内容
Get user by email	ユーザー情報をメールアドレスから取得	メールアドレスからMattermostのユーザー情報を取得します。例えば、他のアプリからユーザーのメールアドレスが渡された場合に、Mattermost側のユーザーを特定してメンション付きのメッセージを送る際に利用します。
Post message	特定のチャンネルにメッセージを送信する	指定されたチーム、チャンネルにメッセージを送信します。 Mattermostではプレーンなメッセージの他に、マークダウン形式のリッチなメッセージを送信することもできます。
(追加予定) Custom Action	カスタムアクション	上記以外のアクションを実行する際に利用できるカスタムアクションです。利用する際は、MattermostのREST-APIリファレンスを確認しながら利用します。 ※ 利用頻度の高いアクションについては今後アクションに追加する予定です。

利用できるアクション

内容

Get user by email

ユーザー情報をメールアドレスから取得

メールアドレスからMattermostのユーザー情報を取得します。
例えば、他のアプリからユーザーのメールアドレスが渡された場合に、Mattermost側のユーザーを特定してメンション付きのメッセージを送る際に利用します。

Post message

特定のチャンネルにメッセージを送信する

指定されたチーム、チャンネルにメッセージを送信します。
Mattermostではプレーンなメッセージの他に、マークダウン形式のリッチなメッセージを送信することもできます。

(追加予定) Custom Action

カスタムアクション

上記以外のアクションを実行する際に利用できるカスタムアクションです。
利用する際は、MattermostのREST-APIリファレンスを確認しながら利用します。

※ 利用頻度の高いアクションについては今後アクションに追加する予定です。

ユーザー情報をメールアドレスから取得

メールアドレスからMattermostのユーザー情報を取得するアクションです。
Mattermost上のユーザー名、表示名、ニックネームなどを取得することが出来ます。

特定のチャンネルにメッセージを送信する

指定したチーム、チャンネルにチャットメッセージを送信するアクションです。

チーム
チャンネル
メッセージの内容

を指定してメッセージを送信することが出来ます。チームやチャンネルは実際のMattemostインスタンスに存在するチームやチャンネルがコンボボックスに表示されます。

下記のサンプルでは Get user by email アクションで取得したユーザ名を利用して "@Username"のようなメンション付きのマークダウン形式のメッセージを作成しています。

このアクションを利用してレシピを実行すると、実際に以下のようにMattermostに指定したチーム、チャンネルにメッセージを送信されます。

参考. HTTP汎用コネクタ利用時の実装

WorkatoのHTTP汎用コネクタを利用してメッセージを送信する場合は以下のような利用イメージになります。
汎用コネクタを利用する場合は、MattermostのAPI仕様を把握した上でチームやチャンネルのIDを引き渡す必要がありますが、Mattermostコネクタを利用した場合は特にAPI仕様を知らなくても利用できるようになっていることが分かるかと思います。

まとめ

今回のブログでは弊社で作成したWorkatoのMattemorstコネクタを紹介しました。Mattermostはオンプレミスにご利用いただくことが多いかと思いますが、Workatoはクラウド/オンプレ間のアプリ連携を実現することが可能です。
WorkatoのMattemorstコネクタを利用してクラウド/オンプレアプリを統合し、Mattermostを中心にビジネスのコラボレーションを加速していきましょう。

Workatoではコミュニティライブラリから追加のコネクタをインストールすることができます。また、コミュニティライブラリに公開されていないアプリについては自分でカスタムコネクタを作成することが出来ます。もし、対象のアプリがコミュニティライブラリに公開されておらず、自分でカスタムコネクタを作るのも難しい場合は弊社でお手伝いすることも出来ますので、ぜひお問い合わせください。