- リリース ノート
- 基本情報
- 管理者向け
- RPA ワークフロー プロジェクト
- アプリ プロジェクト
- エージェンティック プロセス
- Agents
- ソリューション
- API ワークフロー - プレビュー
- ユーザー インターフェイス
- API ワークフローを管理する
- API ワークフローを利用する
Studio Web ガイド
- Automation Cloud™ の組織で Studio Web を開きます。
- [API ワークフロー >新規作成] を選択します。新しいソリューションが開き、 API ワークフロー デザイナー キャンバスが表示されます。
API ワークフローはそれ自体が API として機能するため、期待される入力パラメーターを定義するための入力スキーマが必要になる場合があります。入力スキーマは、ワークフローをトリガーするときに外部サービスが提供する必要があるデータ構造を指定します。
入力スキーマを設定するには、JSON をアップロードするか、入力パラメーターを手動で定義します。
出力スキーマは、API ワークフローによって返されるデータの構造を定義し、ワークフローを呼び出すすべてのサービスが出力形式を事前に理解できるようにします。出力スキーマには、スキーマ自体の中で明示的に定義されたデータ (ID やユーザーが指定した値など) のほか、ワークフロー ステップから動的に生成された出力 (API 応答や計算値など) が含まれる場合があります。
出力スキーマは、JSON をアップロードするか、出力パラメーターを手動で定義して設定できます。
式エディターを使用すると、API ワークフロー内のデータにアクセスし、評価し、データを操作できます。条件ロジックの作成、アクティビティ フィールドの設定、または JavaScript アクティビティの記述に使用します。
式エディターのレイアウト
[式エディター] のレイアウトには、次のパネルが含まれます。| パネル | 説明 |
|---|---|
| 入力 |
メイン パネルは入力パネルで、ここで JavaScript 式または JQ 式を記述します。 このパネルには、式の構文のエラーを特定して強調表示する構文チェッカーが組み込まれています。 |
| Autopilot 式ジェネレーター |
入力パネルの下部にある Autopilot 式ジェネレーターを使用すると、JavaScript を記述する代わりに自然言語を使用してワークフロー式を作成できます。 Autopilot はワークフローのコンテキストを理解し、目的の結果を記述するだけでオブジェクトやワークフローのステップを参照できるようにします。 |
| アクティビティのテスト入力 |
コード パネルの右側にある [アクティビティ テストの入力 ] パネルでは、以前のワークフロー実行から生成されたテスト データを確認できます。 式の構築と検証に使用できるサンプル データを提供します。また、[ 式の出力 ] パネルと直接対話して、式で目的の結果が生成されるようにします。 |
| 式の出力 |
[ 式の出力 ] パネルには、 アクティビティのテストの入力 データからのデータに基づいた式の結果が表示されます。これにより、式が期待される結果を生成することを検証できます。 式にエラーがある場合、[ 式の出力] セクションでは問題のある式が強調表示され、対応するエラー メッセージが表示されます。 結果は、入力パネルで式を変更するたびに自動的に更新されます。 |
JavaScript を使用してデータにアクセスする
ワークフロー データには次の 2 つのアクセス ポイントがあります。$workflow—ワークフロー レベルの設定を指します。$context— アクティビティ レベルの設定を指します。$input- 以前に実行されたアクティビティの設定を参照します。
| アクセスポイント | 説明 | 列の合計 |
$workflow.input | 要求スキーマと、テスト コンフィギュレーションで定義されたすべての値を格納します。 | 式エディター内でテストの設定データにアクセスするには、次の構文を入力し、{property_name} を参照する特定のプロパティに置き換えます。 |
$context | Stores the input and output data for each workflow step. To reference these properties in your expressions, first run and Debug the workflow . This generates step-level inputs and outputs visible in the Test Input screen. | 特定のステップの出力応答データにアクセスするには、[ 式エディター] で次の構文パターンを使用し、 {step_name} と {property_name} をそれぞれステップ名とプロパティ名に置き換えます。 |
$input | 前のステップから現在のステップに直接渡されたデータを格納します。$inputを使用すると、$context全体を移動せずに前の手順のプロパティを参照できます。
| 前の手順のプロパティにアクセスするには、次の構文を使用し、 {property_name}を参照するプロパティに置き換えます。 |
API ワークフローとの連携を成功させるには、ワークフローを早い段階から頻繁にテストします。定期的なテストを行うことで、エラーをすばやく特定して解決できます。IntelliSense、オートコンプリート、Autopilot、アクティビティ テストの入力画面などの機能は、テスト データによって異なります。[テスト] ボタンを使用してワークフローを定期的に実行し、このデータを生成します。
テストによって以下が保証されます。
- ワークフロー ステップ間のデータ マッピングが正しく、予期しない動作が防止されている。
- API 要求が適切に設定され、応答の信頼性が確保されます。
- ワークフローは意図したとおりに実行されるため、運用環境で予期しないエラーが発生するリスクが軽減されます。
実行結果に関する情報を理解する
[実行結果] パネルには、ワークフローの実行に関する詳細情報が表示されます。
アクティビティの入力データと出力データ
このデータは、選択したアクティビティごとに利用でき、以下を提供します。- 入力データ—ステップが前のアクティビティから受け取る情報。
- 出力データ—現在のステップで生成され、次のアクティビティに渡される情報。
API 要求情報
ワークフローが API と対話する場合は、次の要求の詳細を確認します。- 要求 URL—動的 URL パラメーターが正しく解決されることを確認します。
- ヘッダー—認証ヘッダーと content-type ヘッダーが適切に設定されていることを確認します。
- クエリパラメータ—フィルターとパラメーターの形式が正しいことを確認します。
- 本文の内容—JSON 構造が API 要件に一致していることを検証します。
成功した API 要求
API 要求が成功したら、各手順を展開して確認します。- リクエストの詳細—URL、ヘッダー、クエリ パラメーター、本文の内容。
- 回答の詳細—ステータス コード、ヘッダー、応答コンテンツ。
- 出力データ—後続のワークフロー ステップで使用するための API 呼び出しによって生成された情報。
デバッグ
ワークフローのエラーを効率的に特定してデバッグするには、次のガイドラインに従ってください。- エラー インジケーター
- ステップでエラーが発生すると、エラー アイコンが表示されます。
- ステップを選択すると、詳細なエラー メッセージと出力が表示されます。
- 一般的なデバッグ手順
- API 要求の検証 — URL、ヘッダー、パラメーター、本文の内容などの要求の詳細が API ドキュメントと一致していることを確認します。
- エラー メッセージを確認する - 認証エラー、誤ったペイロード、またはスクリプトの誤りに関する手がかりがないか、エラー メッセージを調べます。
デバッグ構成の追加
$workflow.input オブジェクトを介してエミュレートされたデータにアクセスできます。
デバッグ構成を追加するには、次の手順を実行します。
- API ワークフロー デザイナー キャンバスの上部で [デバッグ] ドロップダウンを開き、[ デバッグ構成] を選択します。
- 開いたウィンドウで、テスト入力データを JSON 形式で指定します。
- テストの設定を保存します。
-
保存すると、[式エディター] で参照
$workflow.input.{propertyname}を使用してテスト設定にアクセスできます。さらに、デバッグ設定は [式エディター] の [アクティビティ テスト] 入力 パネルにも表示されます。
API ワークフローをデバッグする
- API ワークフローを開きます。ワークフローが完全に設定され、実行できる状態になっていることを確認します。
- ワークフローが入力データ (外部システムからのものなど) に依存する場合は、テスト前に デバッグ構成 を定義します。これにより、すべてのステップで必要なデータが確実に受信されます。
- ワークフローをデバッグします。[ デバッグ] ボタンはページの上部にあります。このファイルを選択すると、ワークフローが実行され、リアルタイムの結果を確認できます。
- デバッグが開始されると、画面の右側に [実行結果 ] パネルが表示されます。ここで、各ステップの実行ステータスに成功、失敗、保留中として明確にマークされています。
個人用ワークスペース フィードにパブリッシュした場合、ワークフローは Orchestrator の [マイ ワークスペース] > [オートメーション] > [プロセス] の下に表示されます。API ワークフローは、 API の種類で識別できます。
テナント フィードにパブリッシュした場合は、Orchestrator の [ テナント] > [ソリューション] にワークフローが表示されます。API ワークフローは、 API の種類で識別できます。
個人用ワークスペース フィードから API ワークフローをデプロイする
個人用ワークスペースにパブリッシュすると、API ワークフローがプロセスとして Orchestrator > [マイ ワークスペース] > [API ワークフロー名] > [オートメーション] > [プロセス] のサブフォルダーに準備されます。テナント フィードから API ワークフローをデプロイする
Orchestrator テナントにパブリッシュすると、API ワークフロー パッケージが Orchestrator >テナント > ソリューションにアップロードされます。
プロセスとしてデプロイするには、以下の手順を実行します。
- Orchestrator の > テナント >ソリューション] に移動します。
- テナント フィードにパブリッシュした API ワークフロー パッケージの 3 点リーダー メニューを選択し、[ パッケージをデプロイ] を選択します。
- ソリューション バージョンのデプロイ ウィザードで、次の詳細を設定します。
- デプロイ名 - プロセスについて記載、表示、監視しているすべてのページに表示する名前を追加します。何も指定しない場合は、パッケージの名前が使用されます。
- コピー先フォルダー - ソリューションのルートの親フォルダーとして使用するフォルダーを指定します。ソリューションは選択したフォルダーにはデプロイされませんが、新しい子フォルダーが作成されます。
- テナント下の新しいルート フォルダーとしてインストール - このチェックボックスをオンにすると、ソリューションが現在のテナント下の新しいルート フォルダーとしてインストールされます。
- ソリューションのルート フォルダー名 — ルート フォルダー名を変更します。
- [ レビュー] を選択します。これで、ソリューションを下書きとして保存したり、検証して操作を続行したりできます。
- [ デプロイ] を選択します。これで、ワークフローは、手順 3 > [オートメーション] > [プロセス] で指定したフォルダーにプロセスとして格納されます。API ワークフローは API タイプで識別できます。
- [ デプロイをアクティブ化 ] を選択して、API ワークフローのデプロイを完了します。
- 明確な 入力 スキーマと 出力 スキーマを定義し、他の UiPath 製品がワークフローを理解して操作できるようにします。
- API ワークフローの迅速な実行速度を利用して、設計時に入出力ペイロードをテストします。
- Autopilot を使用して、コンテキストに対応した式と JavaScript コードを生成します。
- [式エディター] の出力パネルで式を検証し、実行前に構文やロジックの問題をキャッチします。
- [実行結果] パネルで入力データと出力データを操作するには、値を展開、折りたたむ、またはクリップボードにコピーします。
- [成功] または [失敗] のいずれかの [応答] アクティビティを設定して、ワークフローを早期に終了します。
- ループ内の アクティビティ、 つまり [繰り返し (コレクション の各要素)] と [ 繰り返し (後判定)] で、 $context の代わりに $input を使用して前のオブジェクトの出力にアクセスします。
- コネクタが必要な機能が提供されない場合に API を直接呼び出すには、[ HTTP ] アクティビティを使用します。ネイティブの [HTTP ] アクティビティまたはコネクタ固有の [HTTP 要求 ] アクティビティのいずれかを選択します。
- [HTTP アクティビティのヘッダー] プロパティに認証トークンを指定します。
{ Authorization: "<my_token>", "Content-Type": "application/json" }{ Authorization: "<my_token>", "Content-Type": "application/json" }基本認証の場合は、以下を使用します。
{ Authorization: "Basic " + btoa("<username>:<pass>")}{ Authorization: "Basic " + btoa("<username>:<pass>")}
