Product UpdatesStatus PageWorkato Academy
English
日本語
Get a trial

Workato CLIのユースケース例 ​

このページは機械翻訳により提供されています。翻訳内容と英語版に相違がある場合は、英語版が優先されます。

次のユースケース例では、個人開発者、チームおよび組織、自動化、エンタープライズ連携のワークフローにWorkatoプラットフォームCLIを使用する方法について説明します。

個人開発者向けユースケース例 ​

プラットフォームCLIは、ローカルレシピDevelopmentや複数Environment管理など、個人開発者向けのユースケースに使用できます。

ローカルレシピDevelopment ​

デプロイメント前に連携レシピをローカルで編集および検証し、プロダクションの問題を回避します。

メリット ​

  • 構文エラーの早期検出
  • 連携レシピのバージョン管理
  • Development、ステージング、プロダクション用の異なるプロファイルを使用したレシピのテスト
  • Developmentサイクルの高速化

コマンド ​

bash
workato recipes validate --path ./recipes/RECIPE-NAME.json
workato push --restart-recipes

例 ​

bash
% workato recipe validate --path ./customer_onboarding/google_calendar_recipe.recipe.json
✅ Recipe validation passed (0.1s)
📄 File: google_calendar_recipe.recipe.json
% workato push --restart-recipes
✅ Package created: customer_onboarding.zip (0.1s)
✅ Package uploaded successfully (0.9s)
  📊 Import ID: 203018
  📈 Status: in_progress
🎉 Import completed successfully
📋 Recipe Import Results:
  ✅ 4 recipe(s): No restart needed
  ⚠️ 1 recipe(s): Updated but stopped
  📊 Summary: 4/5 recipes imported successfully

複数Environment管理 ​

Development、ステージング、プロダクションのEnvironmentを個別の設定で管理します。

利点 ​

  • 分離されたテストEnvironment
  • より安全な昇格ワークフロー
  • Environment固有の設定
  • ロールバック機能

ワークフロー ​

bash
# Development
workato profiles use dev
workato push

# Staging
workato profiles use staging
workato pull
workato push --restart-recipes

# Production
workato profiles use production
workato pull

例 ​

bash
# Development
% workato profiles use dev
✅ Set 'dev' as profile for current workspace
   Workspace: /Users/user-directory/workato
   Project config also updated: customer_onboarding
% workato push
✅ Package created: customer_onboarding.zip (0.1s)
✅ Package uploaded successfully (0.9s)
  📊 Import ID: 203022
  📈 Status: in_progress
🎉 Import completed successfully
📋 Recipe Import Results:
  ✅ 5 recipe(s): No restart needed

# Staging
% workato profiles use staging
✅ Set 'staging' as profile for current workspace
   Workspace: /Users/user-directory/workato
   Project config also updated: customer_onboarding
% workato pull
Pulling latest changes for project: customer_onboarding
✅ Export manifest created: 39763 (0.9s)
✅ Export package triggered: 203024 (0.5s)
✅ Package ready for download (2.4s)
✅ Package downloaded (0.4s)
✅ Project assets extracted (0.1s)
✅ Project is already up to date
% workato push --restart-recipes
✅ Package created: customer_onboarding.zip (0.1s)
✅ Package uploaded successfully (0.8s)
  📊 Import ID: 203025
  📈 Status: in_progress
🎉 Import completed successfully
📋 Recipe Import Results:
  ✅ 5 recipe(s): No restart needed

# Production
% workato profiles use production
✅ Set 'production' as profile for current workspace
   Workspace: /Users/user-directory/workato
   Project config also updated: customer_onboarding
% workato pull
Pulling latest changes for project: customer_onboarding
✅ Export manifest created: 39765 (0.8s)
✅ Export package triggered: 203028 (0.4s)
✅ Package ready for download (2.5s)
✅ Package downloaded (0.7s)
✅ Project assets extracted (0.1s)
✅ Project is already up to date

チームおよび組織向けユースケース例 ​

プラットフォームCLIは、コラボレーション、CI/CDパイプライン連携、レシピライフサイクルマネジメントなど、チームおよび組織向けのユースケースに使用できます。

チームコラボレーション ​

標準化されたワークフローを使用して、Developmentチーム間でレシピとコネクションを共有します。

利点 ​

  • 一貫性のあるプロジェクト構造
  • 共有コネクション設定
  • 連携のコードレビュープロセス
  • ナレッジ共有

ワークフロー ​

bash
# Developer A
workato push --include-tags

# Developer B
workato pull

例 ​

bash
# Developer A
% workato push --include-tags
✅ Package created: customer_onboarding.zip (0.1s)
✅ Package uploaded successfully (0.9s)
  📊 Import ID: 203030
  📈 Status: in_progress
🎉 Import completed successfully
📋 Recipe Import Results:
  ✅ 5 recipe(s): No restart needed

# Developer B
% workato pull
Pulling latest changes for project: customer_onboarding
✅ Export manifest created: 39766 (0.5s)
✅ Export package triggered: 203031 (0.6s)
✅ Package ready for download (2.4s)
✅ Package downloaded (0.4s)
✅ Project assets extracted (0.1s)
✅ Project is already up to date

CI/CDパイプライン連携 ​

ビルドおよびリリースパイプラインの一部として、レシピのデプロイメントを自動化します。

利点 ​

  • 一貫性のあるデプロイメントプロセス
  • 自動化された検証ゲート
  • Environment昇格ワークフロー
  • 手動エラーの削減

実装 ​

bash
# In CI pipeline
workato recipes validate --path ./recipes/*.json
workato push --restart-recipes --include-tags

例 ​

bash
% workato recipes validate --path ./customer_onboarding/google_calendar_recipe.recipe.json
✅ Recipe validation passed (2.0s)
  📄 File: google_calendar_recipe.recipe.json
% workato push --restart-recipes --include-tags
✅ Package created: customer_onboarding.zip (0.1s)
✅ Package uploaded successfully (1.0s)
  📊 Import ID: 203034
  📈 Status: in_progress
🎉 Import completed successfully
📋 Recipe Import Results:
  ✅ 5 recipe(s): No restart needed

レシピライフサイクルマネジメント ​

チーム全体でレシピの作成、テスト、デプロイ、監視の方法を標準化します。

オペレーション ​

  • デプロイメント前のレシピ検証
  • メンテナンスのためのレシピの開始/停止
  • レシピ実行の監視
  • プログラムによるコネクションの更新

コマンド ​

bash
workato recipes validate --path ./recipe.json
workato recipes start --id 12345
workato recipes stop --id 67890
workato connections create-oauth --parent-id 123

自動化 ​

プラットフォームCLIは、自動コネクション管理、エラー解決および監視に使用できます。

自動コネクション管理 ​

OAuthフローと認証情報管理をプログラムで処理できます。

利点 ​

  • 手動OAuthセットアップの排除
  • コネクションの一括作成
  • 認証情報の安全な処理
  • Environment固有の設定

コマンド ​

bash
workato connections create-oauth --parent-id 123
workato connections get-oauth-url --id 456

エラー解決および監視 ​

一般的な連携の問題を自動的に診断して解決できます。

利点 ​

  • プロアクティブな問題検出
  • 自動トラブルシューティング
  • パフォーマンス監視
  • ダウンタイムの削減

監視 ​

bash
workato recipes list --running
workato recipes list --stop-cause trigger_errors_limit

例 ​

bash
% workato recipes list --running
📋 Recipes (1 found) - (0.8s)
  🔍 Filters: folder 75510, running recipes only

  ▶️ Google Calendar Recipe
    🆔 ID: 366663
    📊 Status: Running
    📱 Trigger App: clock
    🔧 Action Apps: google_calendar
    ⚙️  Config Apps: clock, google_calendar (Account: 71959)
    📁 Folder ID: 75510
    📊 Jobs: 24 succeeded, 0 failed
    🕐 Last Run: 2025-10-28T12:49:55.834000-07:00
    📅 Created: 2025-03-25T11:58:33.598000-07:00
    👤 Author: Amy Peak
    📝 Description: When there is a trigger on a specified schedule, do action
% workato recipes list --stop-cause trigger_errors_limit
📋 Recipes (0 found) - (0.4s)
  🔍 Filters: folder 75510, stopped due to: trigger_errors_limit
  ℹ️  No recipes found
% workato recipes list --stop-cause trigger_errors_limit
📋 Recipes (0 found) - (0.4s)
  🔍 Filters: folder 75510, stopped due to: trigger_errors_limit
  ℹ️  No recipes found

エンタープライズ連携シナリオ ​

プラットフォームCLIは、API管理、データ操作、プロジェクト整理など、エンタープライズ連携シナリオに使用できます。

API管理 ​

複数のEnvironmentにわたるAPIコレクションの管理とデプロイメントを一元化します。

利点 ​

  • 一貫性のあるAPI定義
  • API仕様のバージョン管理
  • 自動APIデプロイメント
  • Environment固有の設定

実装 ​

bash
workato api-collections create --format yaml --content ./api-spec.yaml --name "API-COLLECTION-NAME"

データ操作 ​

大規模なデータ同期および変換ワークフローを管理します。

利点 ​

  • バッチ処理機能
  • データ検証およびクレンジング
  • エラー処理および再試行ロジック
  • 監査証跡および監視

プロジェクト整理 ​

大規模チーム全体でスケーラビリティと保守性を確保できるようにプロジェクトを構成できます。

利点 ​

  • 一貫性のあるフォルダ構造
  • 共有命名規則
  • アクセス制御管理
  • 依存関係の追跡

組織 ​

  • ビジネス機能別にレシピをグループ化
  • 説明的なコネクション名の使用
  • 一貫性のあるタグ付けの実装
  • 定期的なクリーンアップとメンテナンス

Last updated: