Orchestrator ユーザーガイド

デリバリー:

Automation Cloud Automation Cloud Public Sector Automation Suite Standalone

最終更新日時 2024年10月17日

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

UiPath では、Studio 内で使用されている入力および出力引数を公開し、DCM や BPM などのユーザーが使用しているツールとシームレスに連携できるようにしています。つまり、ユーザーが作成したプロセスは、Orchestrator API やインターフェイスを介して入力引数を受け取り、同様に出力を返すことができます。これを元に、プロセス同士を連携させことができます。この拡張性により、ユーザーのエコシステムに UiPath をよりスムーズに統合できます。

注:

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

引数はプロジェクトの project.json に保存されます。

Studio での設計時に、既定値の有無を問わず、入力および出力の引数を受け入れるように設定することにより、これらの引数をサードパーティアプリや Orchestrator で使用できるようになります。Studio プロジェクトに該当する引数をあらかじめ追加することにより、Orchestrator やサードパーティアプリで入力引数と出力引数を利用できます。これらの引数が Studio で追加されていない場合は、次のメッセージが表示されます。「このバージョンは入力引数が未定義です。」

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

引数値を指定する

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

Studio

引数を作成する際の既定値として入力できます。Studio で引数に対して設定した既定値は、プロセスレベルでもジョブレベルでも、Orchestrator で上書きすることができます。

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

Orchestrator

プロセスレベル - [プロセスを表示] ウィンドウの [引数] タブで入力できます。
ジョブレベル - [ジョブを開始] ウィンドウの [引数] タブで入力できます。
トリガーレベル - [トリガーを追加] ウィンドウの [引数] タブで入力できます。

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

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