自動化で Workato を使用する
自動化による Workato 統合は、Jira Service Management Cloud Premium プランまたは Enterprise プランのカスタマーのみ利用できます。プランのアップグレード方法をご確認ください。
アトラシアンは Workato との統合をサポートしているため、自動化ルールと Workato アカウント間の接続を作成できます。自動化での接続についてご確認ください。
Jira 自動化ルールは一連のトリガー、条件、アクションで構成されています。[Workato レシピをトリガー] アクションを使用すると、ルール内の特定の時点で既存の Workato レシピを実行できます。
「Workato レシピをトリガー」アクションを初めて使用する前に、Workato との接続を作成する必要があります。
Workato に接続する
考慮事項
Jira 自動化で Workato を使用するには、次の手順を実行します。
Workato API プラットフォームを有効にする必要があります。Workato API プラットフォームに関する詳細をご確認ください。
Workato から開発者 API トークンとプラットフォーム API/認証トークンを生成し、それらを使用して Jira 自動化から Workato 接続を作成する必要があります。
異なる Workato 接続を使用することも、同じルール内の複数の Workato アクション間で単一の接続を再利用することもできます。
Workato アクションが追加され、新しい接続が作成されたら、レシピの変更は接続を作成した管理者のみが行うことができます。ただし、ルール編集権限を持つ管理者なら誰でもペイロード構成を変更できます。接続で利用できるレシピを確認して、共有される可能性があるデータを把握しておいてください。
開発者 API トークンを生成する
開発者 API トークンを生成するには、Workato 管理者である必要があります。Workato のコラボレーター ロールの詳細をご覧ください。
Workato アカウントにログインします。
クライアント ロールを作成します。クライアント ロールを保存する前に、次のことを行います。
[プロジェクト] を選択します。
[Project assets (プロジェクト資産)] で [レシピ] を展開します。
List | GET /api/recipes の横にあるボックスにチェックを入れます。
ツールを選択します。
[API プラットフォーム] で [コレクションとエンドポイント] を展開します。
コレクション内のエンドポイントを一覧表示する | GET /api/api_endpoints の横にあるボックスにチェックを入れます。
API クライアントを作成します。API クライアントを保存する前に、次のことを行います。
[Client role (クライアント ロール)] で、事前に作成したクライアント ロールを選択します。
API クライアントの作成後に表示される API トークンを安全な場所に保管します。
Platform API または認証トークンの生成
Workato に移動します。
先に進む前に、 Jira Automation の API レシピ コレクションを作成することをお勧めします。
Jira 自動化のコレクションを作成した場合は、そのコレクションを含める API コレクションに追加します。
[ 認証方法] で、[ 認証トークン] を選択します。
表示される認証トークンをコピーして、安全な場所に保存します。
自動化ルールから Workato に接続する
Workato への接続は、Workato レシピをトリガーするアクションを使う自動化ルールを作成することで行えますこのアクションにより、自動化ルールの一部として実行される Workato レシピがトリガーされます。同じ接続を再利用することも、ルール内の Workato アクションに別の接続をいくつでも使用することもできます。
Workato と Jira Automation 間の接続を作成するには、Jira 管理者である必要があります。
サービス プロジェクトから、[ プロジェクト設定]、[ 自動化] の順に選択します。
[ルールを作成] を選択し、トリガーを追加します。
[コンポーネントを追加] を選択し、検索ボックスで「Workato」を検索して [Trigger Workato recipe (Workato レシピをトリガー)] アクションを見つけます。
Workato への接続を求められたら、[ 接続] を選択します。
Workato に API クライアントを登録したときに受け取った詳細情報をフォームに記入します。
接続名を入力します。
Workato の [Developer API token (開発者 API トークン)] を入力します。開発者 API トークンを生成する手順は前述のとおりです。
ベース URL を入力します。ベース URL の定義について詳しくご確認ください。
Workato のプラットフォーム API または認証トークンを入力します。認証トークンを生成する手順は前述のとおりです。
[Connect] を選択します。
Workato レシピのトリガーアクションの詳細を入力します
考慮事項
自動化ルールから作成された Workato 接続に関連付けられたレシピのデータは、ルールをトリガーしたユーザーに公開される可能性があります。そのため、自動化ルールを構築する際は、その後のルールアクションでスマート値を通じて公開される可能性のあるデータや情報に注意する必要があります。
自動化アクションがエンドポイントを正常に呼び出せるように、レシピ エンドポイントのスキーマ検証がエンドポイント設定でオフになっていることを確認します (使用するエンドポイントメソッドのタイプに関係なく)。API レシピ エンドポイントの構成の詳細をご確認ください。
リクエスト データやレシピ入力を渡す際の HTTP 動詞メソッドとしては POST を使用することをお勧めします (リクエスト データを渡す必要がある場合は、なるべく GET を使用しないでください)。HTTP メソッドについては、こちらをご確認ください。
自動化では、発信 Webhook の HTTP リクエスト タイムアウトが 30 秒に設定されています。複雑な Workato レシピが 30 秒以上続くと、ルールがタイムアウトする可能性があります。自動化サービスの制限をご確認ください。
接続が確立されると、ルール内で「Workato レシピをトリガー」アクションを使用できるようになります。
レシピを選択: このアクションを使用するには、トリガーする Workato レシピをルールから選択する必要があります。レシピ トリガーとして新しい API エンドポイントがあるレシピのみがリストされます。利用できるレシピがない場合は、Workato でレシピを作成するか、別の接続を使用してください。API レシピについてご確認ください。
ヘッダー、リクエストスキーマ、およびパスパラメーターに関する情報を入力します。これはオプションですが、選択したレシピがレシピの入力方法として受け入れる場合に使用できます。これらの入力が動作するには、レシピスキーマに正しく従う必要があります。
ヘッダーとパス パラメーター – レシピで必要な場合は、キーと値のペアを入力として指定できます。複雑なネスト要件がある場合は、リクエスト スキーマを使用することをお勧めします。ヘッダー パラメーターを見つけるには、レシピのリクエスト構造を確認してください。パス パラメーターを見つけるには、レシピのリクエスト エンドポイントを確認してください。
リクエスト スキーマ – レシピで想定されている場合は、JSON を使用してリクエスト スキーマ ペイロードを作成できます。リクエスト本文スキーマを見つけるには、 レシピのリクエスト構造を確認します。
完了したら、[ 次へ ] を選択します。
制限事項
パス パラメーターはスキーマを持つことができますが、サポートされているのは単純なテキストまたは数値のみです。
クエリ パラメーターはサポートされていません。GET リクエストのリクエスト スキーマは、リクエスト ペイロードとして送信されます。
コンテンツタイプ JSON を返すエンドポイントのみがサポートされています。
スマート値
これらのスマート値を使用して、後続のルール アクションで Workato リクエスト応答データにアクセスできます。
{{workatoResponse.statusCode}} – 応答コードを返します。{{workatoResponse.headers}} – ドット表記を使用してアクセスできる応答ヘッダーを返します。{{workatoResponse.body}} – ドット表記を使用してアクセスできる応答の本文を返します (JSON オブジェクトの場合)。{{workatoResponse.body.nested_field_name}} – ドット表記を使用してアクセスできる、応答の本文のネストされた値を返します (JSON オブジェクトの場合)。
この内容はお役に立ちましたか?