Workato:新たに追加されたRecipe functions by Workatoコネクターについて


はじめに

Workatoで、新たに「Recipe functions by Workato」コネクター(以下、「Recipe functionsコネクター」)が追加されました。

もしかしたら、レシピ作成時に「Build recipe function」がStarting pointに追加されていたこと(Callable recipeから変わっていたこと)に気付いた方もいるかもしれません。

Recipe functionsコネクターは、これまであった(今もある)Callable Recipeコネクターと似ていますが、レシピから呼び出されるモジュールとしての利用に特化したコネクターとなっています。

Recipe functionsについて、簡単に以下で説明します。

Callable RecipeとRecipe functionsの違い

Callable Recipeは、レシピから呼び出されるモジュールとしての役割と、API Platformにおけるエンドポイントの役割の両方に対応します。このため、例えばRequest typeやReply typeといった、API Platform固有の(モジュール用途において不要な)設定項目が存在します。また、Callable Recipeでは必ずNameを定義する必要があります。

これに対して、Recipe functionsはモジュール用途としての利用に必要な設定項目(Parameters schema, Result schema)のみが用意されています。つまり、設定項目を必要最低限とし、モジュール用途に特化したコネクターとなっています。

また、Recipe functionsはNameの指定は不要なため、呼び出し元のレシピではレシピ名を指定して利用します。

簡単な利用方法(レシピ作成方法)

呼び出し先(モジュール)レシピの作成

呼び出し先となるレシピの作成方法は、Callable Recipeと殆ど変わりません。大きな違いはNameの指定の有無で、Recipe functionsはNameの指定が不要です(設定項目がありません)

呼び出し先レシピの作成

呼び出し先となるレシピの作成方法も、Callable Recipeとほとんど変わりません。大きな違いは、Recipe functionでRecipe functionsをトリガーとするレシピ名を指定する(Callable Recipeではレシピ内で定義したNameの値を指定する)点になります。

Callable RecipeとRecipe functionsの使い分け

今後作成するレシピにおいては、特別な理由が無ければ、Recipe functionsを使用するのが適当でしょう。

もちろん、Callable Recipeでこれまで同様にレシピのモジュールを作成することは可能です。例えば、呼び出し先の名称とレシピの名称は別々に管理したい場合は、Callable Recipeが有効です。また、API Platformとレシピのモジュール両方で活用したい場合も、Callable Recipeが有効です。用途に応じてCallable RecipeとRecipe functionsを使い分けていただければ宜しいかと思います。

Callable RecipeからRecipe functionsへの移行は必要か

これまでCallable Recipeで作成したレシピや呼び出し元のレシピは、Callable Recipeのまま利用可能です。
(Recipe functionsへ移行する必要もなく、Callable Recipeのままでこれまで通り利用可能です)

Callable RecipeとRecipe functionsを相互に変換する方法はあるか

Callable RecipeからRecipe functions、あるいはRecipe functionsからCallable Recipeへ変換する方法はありません。