入力および出力引数について

Orchestrator を介してオートメーション プロセスとの間でデータを渡すための入力引数と出力引数の概要。

We have exposed the In and Out arguments, you are already used to in Studio, as a way to seamlessly integrate the tools you use, such as various DCMs or BPMs. This means that any process you create can now receive input arguments through the Orchestrator API or interface, as well as return output to all of the aforementioned.

Last but not least, this is a stepping stone in linking processes together. This extensibility helps you better integrate UiPath® in your company’s ecosystem.

注:

他のアプリに公開されるのは、Studio でメインとしてマークされている .xaml の入力、出力、入力/出力の引数のみです。 引数はプロジェクトの project.json に保存されます。

At design time, in Studio, the way you configure your project to accept In or Out arguments, with or without default values, enables you to use them in other third-party apps or Orchestrator. You can only make use of input and output arguments in Orchestrator and other third-party apps if you had added the corresponding arguments in your Studio project beforehand.

If no arguments have been added in Studio, the following message is displayed: "Input arguments are not defined for this version.".

プロジェクトの入力、出力、入力/出力の引数は、Orchestrator にパブリッシュされることで、入力引数と出力引数になります。入力/出力引数については、Orchestrator で 2 つの引数 (入力引数と出力引数) が同じ名前で作成され、表示されます。

引数値を指定する

値の設定は入力引数に対してのみ可能で、次のように、Studio、Orchestrator、Orchestrator API のいずれかを使用します。

Studio

引数を作成する際の既定値です。簡単な例については、 こちらをご覧ください。Studio で引数に指定した既定値は、Orchestrator ではプロセス レベルまたはジョブ レベルの両方で上書きできます。

注:

Studio で入力引数に設定されている既定値は、レベルを問わず、Orchestrator では表示されません。

Orchestrator

• プロセス レベル - [プロセスを表示] ウィンドウの [引数] タブで入力できます (こちらの説明を参照)。
• ジョブ レベル - [ジョブを開始] ウィンドウの [引数] タブで入力できます (こちらの説明を参照)。
• トリガー レベル - [トリガーを追加] ウィンドウの [引数] タブで入力できます (こちらの説明を参照)。
  注:

  Orchestrator のプロセス レベルで入力引数として入力した値は、新しいパッケージのバージョンが引数の定義に関係していない限り、パッケージの更新時にも維持されます。 入力/出力引数のストレージ制限は 1 MB です。

Orchestrator で入力引数を設定する場合、JSON 形式で設定する必要があります。次の例のようにします。

• 文字列 - 値は引用符で囲む必要があります。例: string
• Int32 型 - 値を整数で指定します。例: 11
• ブール型 - true または false を選択する 2 つのラジオ ボタンが表示されます。
• ダブル型 - 浮動小数値として値を設定します。例: 3.5
• 日時型 - 有効な JSON として値を設定します。例: "2012-04-23T18:25:43.511Z"
• 配列型 - 有効な JSON として値を設定します。例: [1, 1, 2, 3, 5, 8] または ["firstString", "secondString"]
  注:

  いずれの種類の入力引数も使用できますが、Orchestrator が検証するのはプリミティブのみです。 列挙型 (enum) を JSON に変換すると、列挙メンバーは名前ではなく整数値で表されます。つまり、列挙の JSON 表現は、元の列挙に含まれる各メンバーの数値になります。

Orchestrator API

• パッケージ レベル - /odata/Processes/UiPath.Server.Configuration.OData.SetArguments(key='key') エンドポイント。
• プロセス レベル - /odata/Releases(Id) エンドポイントへの PATCH 要求として入力します。
• ジョブ レベル - /odata/Jobs/UiPath.Server.Configuration.OData.StartJobs エンドポイントへの POST 要求として入力します。
• スケジュール レベル - /odata/ProcessSchedules エンドポイントへの POST 要求として入力します。
  注:

  API 呼び出しでは、入力引数の JSON 表現は、引数名、エスケープされた文字、スペース、ブラケット (かっこ)、引数の値を含め、全体で 10,000 文字以下となっています。

引数値を表示する

入力引数の値は次のようにマークされます。

• 値がありません - プロセス、ジョブ、スケジュール、パッケージ (Studio) のいずれのレベルでも、引数に値が設定されていません。
• パッケージから継承しました - 値が Studio で既定として設定されている場合です。このメッセージは、特定のパッケージの [引数] ウィンドウ、および [プロセスを表示] ウィンドウ、[ジョブを開始] ウィンドウ、[スケジュールを追加] ウィンドウに表示されます。
• プロセスから継承しました - 値がプロセス レベルで ([プロセスを表示] ウィンドウで) 設定された場合。このメッセージは、[ジョブを開始] および [スケジュールを追加] ウィンドウに表示されます。[プロセスを表示] ウィンドウには、値そのものが表示されます。

図 1. 引数値

入力引数または出力引数の値が存在する場合、それらは [ジョブの詳細] ウィンドウに表示されます。次の場合には、入力値が上記のウィンドウに表示されます。

• 入力値がプロセス レベルで追加された場合
• 入力値がジョブ レベルで追加された場合

また、[ パッケージ バージョン ] ウィンドウで、パッケージ レベルで入力引数と出力引数を表示することもできます。詳しくは、「 パッケージを管理する」をご覧ください。

注:

作成したワークフローを v2018.3 より前のバージョンの Orchestrator にパブリッシュした場合、Main.xaml ファイルの入力および出力引数を表示するには、v2018.3 以降の Robot への再アップロードが必要になります。

引数の権限

Orchestrator の入力引数および出力引数に関連して、次の権限が必要です。

• パッケージ レベル - パッケージに関する [表示] 権限
• プロセス レベル - プロセスに関する [表示] および [編集] 権限
• ジョブ レベル - ジョブに関する [作成] 権限
• トリガー レベル - スケジュールに関する [作成] および/または [編集] 権限

大きな入力引数 (>10,000 文字) の処理

ジョブ入力引数のサイズが 10,000 文字を超えると、ジョブを開始した呼び出し元がペイロードを添付ファイルベースの入力に変換します。

この場合、入力引数はジョブの要求本文に直接含まれるのではなく、添付ファイルとして Orchestrator に保存され、ダウンロード可能なペイロードとしてロボットに渡されます。

Robot のバージョンの相互運用性

この機能は、v2025.10 以降の Robot でサポートされています。

重要:

添付ファイルベースの入力引数を使用するジョブを、この形式をサポートしていない以前のバージョンを実行しているロボットで実行すると失敗します。

大きな入力を処理する方法

この動作が発生した場合は、以下を行うことができます。

• Robot を互換性のあるバージョン (2025.10 以降) にアップグレードします。
• 入力引数のサイズを小さくして、インラインで送信できるようにします。
• 大きなデータを外部 (ストレージ バケットや外部ストレージなど) に保存し、参照 (ファイル名、ID、URL など) のみを渡して、ペイロードをオフロードします (推奨)。

例

1. 大きなペイロード (JSON ファイルなど) をストレージ バケットにアップロードします。
2. ファイルへの参照を入力引数として渡します。

{
  "inputFileName": "large-payload.json"
}

3. ワークフローで、適切なアクティビティ (例: [ストレージ ファイルをダウンロード]) を使用してファイルを取得および処理します。