自動化で Workato を使用する

The Workato integration with Automation is only available to Jira Service Management Cloud customers on Premium or Enterprise plans. Find out how to upgrade your plan.

Atlassian supports an integration with Workato, allowing you to create a connection between your automation rules and Workato account. Read about connections in Automation.

Jira 自動化ルールは一連のトリガー、条件、アクションで構成されています。[Workato レシピをトリガー] アクションを使用すると、ルール内の特定の時点で既存の Workato レシピを実行できます。

Workato レシピをトリガー」アクションを初めて使用する前に、Workato との接続を作成する必要があります。

Workato に接続する

考慮事項

  • Jira 自動化で Workato を使用するには、次の手順を実行します。

    • you need the Workato API Platform enabled. Read more about the Workato API Platform.

    • Workato から開発者 API トークンとプラットフォーム API/認証トークンを生成し、それらを使用して Jira 自動化から Workato 接続を作成する必要があります。

  • 異なる Workato 接続を使用することも、同じルール内の複数の Workato アクション間で単一の接続を再利用することもできます。

  • Workato アクションが追加され、新しい接続が作成されたら、レシピの変更は接続を作成した管理者のみが行うことができます。ただし、ルール編集権限を持つ管理者なら誰でもペイロード構成を変更できます。接続で利用できるレシピを確認して、共有される可能性があるデータを把握しておいてください。

開発者 API トークンを生成する

To generate a developer API token, you need to be a Workato admin. Read more about Workato collaborator roles.

  1. Workato アカウントにログインします。

  2. Create a client role. Before you save your client role:

    1. [プロジェクト] を選択します。

    2. [Project assets (プロジェクト資産)] で [レシピ] を展開します。

    3. List | GET /api/recipes の横にあるボックスにチェックを入れます。

    4. ツールを選択します。

    5. [API プラットフォーム] で [コレクションとエンドポイント] を展開します。

    6. コレクション内のエンドポイントを一覧表示する | GET /api/api_endpoints の横にあるボックスにチェックを入れます。

  3. Create an API client. Before you save your API client:

    • [Client role (クライアント ロール)] で、事前に作成したクライアント ロールを選択します。

  4. API クライアントの作成後に表示される API トークンを安全な場所に保管します。

Platform API または認証トークンの生成

  1. Workato に移動します。

  2. Before proceeding, we recommend that you create an API recipe collection for Jira Automation.

  3. Create a new API client.

    1. Jira 自動化のコレクションを作成した場合は、そのコレクションを含める API コレクションに追加します。

    2. [ 認証方法] で、[ 認証トークン] を選択します。

  4. Create a new API key.

  5. 表示される認証トークンをコピーして、安全な場所に保存します。

自動化ルールから Workato に接続する

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.

Workato と Jira Automation 間の接続を作成するには、Jira 管理者である必要があります。

  1. サービス プロジェクトから、[ プロジェクト設定]、[ 自動化] の順に選択します。

  2. [ルールを作成] を選択し、トリガーを追加します。

  3. [コンポーネントを追加] を選択し、検索ボックスで「Workato」を検索して [Trigger Workato recipe (Workato レシピをトリガー)] アクションを見つけます。

  4. Workato への接続を求められたら、[ 接続] を選択します。

  5. Workato に API クライアントを登録したときに受け取った詳細情報をフォームに記入します。

    1. 接続名を入力します。

    2. Workato の [Developer API token (開発者 API トークン)] を入力します。開発者 API トークンを生成する手順は前述のとおりです。

    3. Enter your Base URL. Read more about defining a base URL.

    4. Workato のプラットフォーム API または認証トークンを入力します。認証トークンを生成する手順は前述のとおりです。

  6. [Connect] を選択します。

Workato レシピのトリガーアクションの詳細を入力します

考慮事項

  • 自動化ルールから作成された Workato 接続に関連付けられたレシピのデータは、ルールをトリガーしたユーザーに公開される可能性があります。そのため、自動化ルールを構築する際は、その後のルールアクションでスマート値を通じて公開される可能性のあるデータや情報に注意する必要があります。

  • Ensure the schema validation for your recipe endpoint is toggled off in your endpoint settings (regardless of the type of endpoint method used), so that the automation action can call the endpoint successfully. Read about configuring API recipe endpoints.

  • We recommend using POST as the HTTP verb method for passing request data and recipe inputs (avoid using GET where possible when you need to pass request data). Read about HTTP methods.

  • 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 レシピをトリガー」アクションを使用できるようになります。

  1. 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.

  2. ヘッダー、リクエストスキーマ、およびパスパラメーターに関する情報を入力します。これはオプションですが、選択したレシピがレシピの入力方法として受け入れる場合に使用できます。これらの入力が動作するには、レシピスキーマに正しく従う必要があります。

    1. 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.

    2. Request schema – you can craft a request schema payload using JSON if your recipe expects it. To find the request bodies schema, check the recipe’s request structure.

  3. 完了したら、[ 次へ ] を選択します

制限事項

  • パス パラメーターはスキーマを持つことができますが、サポートされているのは単純なテキストまたは数値のみです。

  • クエリ パラメーターはサポートされていません。GET リクエストのリクエスト スキーマは、リクエスト ペイロードとして送信されます。

  • コンテンツタイプ JSON を返すエンドポイントのみがサポートされています。

スマート値

You can use these smart values to access Workato request response data in subsequent rule actions.

{{workatoResponse.statusCode}} – 応答コードを返します。
{{workatoResponse.headers}} – ドット表記を使用してアクセスできる応答ヘッダーを返します。
{{workatoResponse.body}} – ドット表記を使用してアクセスできる応答の本文を返します (JSON オブジェクトの場合)。
{{workatoResponse.body.nested_field_name}} – ドット表記を使用してアクセスできる、応答の本文のネストされた値を返します (JSON オブジェクトの場合)。

さらにヘルプが必要ですか?

アトラシアン コミュニティをご利用ください。