自動化で Workato を使用する

Workato と自動化の統合は、Jira Service Management Cloud の Standard、Premium、または Enterprise プランのカスタマーのみ利用できます。プランのアップグレード方法をご確認ください。

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

In Jira Automation, flows are made up of a series of triggers, conditions, and actions. The Trigger Workato recipe action allows you to run an existing Workato recipe at a specific point in a flow.

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

Workato に接続する

考慮事項

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

  • Different Workato connections can be used, or a single connection re-used across multiple Workato actions in the same flow.

  • 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 flow 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 のコラボレーター ロールについて詳細をご確認ください。

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

  2. クライアント ロールを作成します。クライアント ロールを保存する前に、次のことを行います。

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

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

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

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

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

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

  3. API クライアントを作成します。API クライアントを保存する前に、次のことを行います。

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

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

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

  1. Workato に移動します。

  2. 先に進む前に、 Jira Automation の API レシピ コレクションを作成することをお勧めします。

  3. 新しい API クライアントを作成します。

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

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

  4. 新しい API キーを作成します。

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

Connect to Workato from an automation flow

You can create a connection with Workato by creating an automation flow that uses the Trigger Workato recipe action. This action triggers a Workato recipe that runs as part of your automation flow. You can re-use the same connection, or use different connections for any number of Workato actions in your flow.

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

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

  2. Select Create flow and add a trigger.

  3. Select Add step and find the Trigger Workato recipe action by searching for ‘Workato’ in the search box.

  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 レシピのトリガーアクションの詳細を入力します

考慮事項

  • Data from any recipe associated with a Workato connection created from your automation flow may be exposed to the user who triggers the flow. So when building your automation flow, you should be mindful of the data or information that may be exposed through smart values in subsequent flow actions.

  • 自動化アクションがエンドポイントを正常に呼び出せるように、レシピ エンドポイントのスキーマ検証がエンドポイント設定でオフになっていることを確認します (使用するエンドポイントメソッドのタイプに関係なく)。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 flow to time out. Read about automation service limits.

Once the connection is established, you’ll be able to use the Trigger Workato recipe action in your flow.

  1. Select a recipe: to use this action, you must select the Workato recipe you want to trigger from the flow. 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. ヘッダーとパス パラメーター – レシピで必要な場合は、キーと値のペアを入力として指定できます。複雑なネスト要件がある場合は、リクエスト スキーマを使用することをお勧めします。ヘッダー パラメーターを見つけるには、レシピのリクエスト構造を確認してください。パス パラメーターを見つけるには、レシピのリクエスト エンドポイントを確認してください。

    2. リクエスト スキーマ – レシピで想定されている場合は、JSON を使用してリクエスト スキーマ ペイロードを作成できます。リクエスト本文スキーマを見つけるには、レシピのリクエスト構造を確認します。

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

制限事項

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

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

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

スマート値

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

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

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

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