自動化で Workato を使用する
自動化による Workato 統合は、Jira Service Management Cloud Premium プランまたは Enterprise プランのカスタマーのみ利用できます。プランのアップグレード方法をご確認ください。
アトラシアンは Workato との統合をサポートしているため、自動化ルールと Workato アカウント間の接続を作成できます。自動化での接続についてご確認ください。
Jira 自動化ルールは一連のトリガー、条件、アクションで構成されています。[Workato レシピをトリガー] アクションを使用すると、ルール内の特定の時点で既存の Workato レシピを実行できます。
Before you can use the Trigger Workato recipe action for the first time, you’ll need to create a connection with Workato.
Connect to Workato
考慮事項
Jira 自動化で Workato を使用するには、次の手順を実行します。
you need the Workato API Platform enabled. Read more about the Workato API Platform.
Workato から開発者 API トークンとプラットフォーム API/認証トークンを生成し、それらを使用して Jira 自動化から Workato 接続を作成する必要があります。
異なる Workato 接続を使用することも、同じルール内の複数の Workato アクション間で単一の接続を再利用することもできます。
Once the Workato action is added and a new connection is made, recipe changes can only be made by the admin who created the connection. However, any admin with rule editing permissions can change the payload configuration. Review the recipes available with the connection to ensure you’re aware of what data may be shared.
開発者 API トークンを生成する
開発者 API トークンを生成するには、Workato 管理者である必要があります。Workato のコラボレーター ロールの詳細をご覧ください。
Workato アカウントにログインします。
Create a client role. Before you save your client role:
[プロジェクト] を選択します。
Under Project assets, expand Recipes.
List | GET /api/recipes の横にあるボックスにチェックを入れます。
ツールを選択します。
[API プラットフォーム] で [コレクションとエンドポイント] を展開します。
コレクション内のエンドポイントを一覧表示する | GET /api/api_endpoints の横にあるボックスにチェックを入れます。
API クライアントを作成します。API クライアントを保存する前に、次のことを行います。
[Client role (クライアント ロール)] で、事前に作成したクライアント ロールを選択します。
API クライアントの作成後に表示される API トークンを安全な場所に保管します。
Platform API または認証トークンの生成
Go to Workato.
Before proceeding, we recommend that you create an API recipe collection for Jira Automation.
If you created a collection for Jira Automation, add it under API collections to include.
Under Authentication method, select Auth token.
Copy the auth token that displays and save it somewhere safe.
Connect to Workato from an automation rule
You can create a connection with Workato by creating an automation rule that uses the Trigger Workato recipe action. This action triggers a Workato recipe that runs as part of your automation rule. You can re-use the same connection, or use different connections for any number of Workato actions in your rule.
You must be a Jira admin to create a connection between Workato and Jira Automation.
From your service project, select Project settings, then Automation.
Select Create rule and add a trigger.
Select Add component and find the Trigger Workato recipe action by searching for ‘Workato’ in the search box.
Workato への接続を求められたら、[ 接続] を選択します。
Complete the form with the details you received when you registered the API client in Workato.
Enter a Connection name.
Workato の [Developer API token (開発者 API トークン)] を入力します。開発者 API トークンを生成する手順は前述のとおりです。
Enter your Base URL. Read more about defining a base URL.
Enter a Platform API or auth token from Workato. Instructions for generating an auth token are above.
[Connect] を選択します。
Enter details for the Trigger Workato recipe action
考慮事項
自動化ルールから作成された Workato 接続に関連付けられたレシピのデータは、ルールをトリガーしたユーザーに公開される可能性があります。そのため、自動化ルールを構築する際は、その後のルールアクションでスマート値を通じて公開される可能性のあるデータや情報に注意する必要があります。
自動化アクションがエンドポイントを正常に呼び出せるように、レシピ エンドポイントのスキーマ検証がエンドポイント設定でオフになっていることを確認します (使用するエンドポイントメソッドのタイプに関係なく)。API レシピ エンドポイントの構成の詳細をご確認ください。
リクエスト データやレシピ入力を渡す際の HTTP 動詞メソッドとしては POST を使用することをお勧めします (リクエスト データを渡す必要がある場合は、なるべく GET を使用しないでください)。HTTP メソッドについては、こちらをご確認ください。
Automation has an HTTP request timeout of 30 seconds for outgoing webhooks. Complex Workato recipes that run for longer than 30 seconds may cause the rule to time out. Read about automation service limits.
接続が確立されると、ルール内で「Workato レシピをトリガー」アクションを使用できるようになります。
Select a recipe: to use this action, you must select the Workato recipe you want to trigger from the rule. Only recipes with a new API endpoint as the recipe trigger will be listed. If no recipes are available, create some in Workato or use a different connection. Read about API recipes.
ヘッダー、リクエストスキーマ、およびパスパラメーターに関する情報を入力します。これはオプションですが、選択したレシピがレシピの入力方法として受け入れる場合に使用できます。これらの入力が動作するには、レシピスキーマに正しく従う必要があります。
Headers and path parameters – you can enter key value pairs as an input if your recipe expects it. We suggest using the request schema if you have complex nesting requirements. To find the header parameters, check the recipe’s request structure. To find the path parameters, check the recipe’s request endpoint.
リクエスト スキーマ – レシピで想定されている場合は、JSON を使用してリクエスト スキーマ ペイロードを作成できます。リクエスト本文スキーマを見つけるには、 レシピのリクエスト構造を確認します。
Select Next when you’re done.
制限事項
パス パラメーターはスキーマを持つことができますが、サポートされているのは単純なテキストまたは数値のみです。
クエリ パラメーターはサポートされていません。GET リクエストのリクエスト スキーマは、リクエスト ペイロードとして送信されます。
Only endpoints returning Content-type JSON are supported.
スマート値
これらのスマート値を使用して、後続のルール アクションで Workato リクエスト応答データにアクセスできます。
{{workatoResponse.statusCode}}
– Returns the response code.{{workatoResponse.headers}}
– Returns the response headers that can be accessed using dot notation.{{workatoResponse.body}}
– Returns the response body that can be accessed using dot notation (if a JSON object).{{workatoResponse.body.nested_field_name}}
– Returns nested values in the response body that can be accessed using dot notation (if a JSON object).
この内容はお役に立ちましたか?