通知を受け取る

UiPath Orchestrator

UiPath Orchestrator ガイド

入力パラメーターと出力パラメーター

DCM や BPMなど、使用中のツールとシームレスに統合する方法として、Studio 内で既に使用されている入力および出力引数を公開しました。これは、作成したプロセスは、Orchestrator API またはインターフェイスを介して、入力パラメーターを受け取るとともに、上記のすべての出力が返されることを意味します。最後に付け加えると、これはプロセス間連携への足がかりとなるものです。この拡張性により、貴社のエコシステムに UiPath をよりスムーズに統合できるようになります。

📘

重要

Only the In, Out, and In/Out arguments of the .xaml marked as Main in Studio are exposed to other apps.
The arguments are saved in the project.json of a project.

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

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

パラメーター値の設定

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

Studio

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

📘

重要

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

Orchestrator

  • プロセス レベル - [プロセスを表示] ウィンドウの [パラメーター] タブで入力できます (こちらの説明を参照)。
  • ジョブ レベル - [ジョブを開始] ウィンドウの [パラメーター] タブで入力できます (こちらの説明を参照)。
  • スケジュール レベル - [スケジュールを追加] ウィンドウの [パラメーター] タブで入力できます (こちらの説明を参照)。

📘

注:

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

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

  • String - the value has to be provided without quotation marks, such as string;
  • Int32 - provide the value as you would any integer, 11;
  • ブール型 - true または false を選択する 2 つのラジオ ボタンが表示されます。
  • Double - provide the value as a floating point value, such as 3.5;
  • DateTime - provide the value as a valid JSON, such as "2012-04-23T18:25:43.511Z";
  • Array - provide values as valid JSON, such as [1, 1, 2, 3, 5, 8] または ["firstString", "secondString"] です。

📘

重要

いずれの種類の入力引数も使用できますが、Orchestrator が検証するのはプリミティブのみです。

Orchestrator API

📘

注:

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

パラメーター値の表示

入力パラメーターの値は次のようにマークされます。

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

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

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

[パッケージのバージョン] ウィンドウでは、入力および出力パラメーターをパッケージ レベルで表示することもできます。詳細については、「パッケージの管理」をご覧ください。

📘

重要

Workflows that were created and published to Orchestrator prior to v2018.3 must be re-uploaded with a v2018.3 (or later) Robot so that the In and Out arguments of the Main.xaml file can be displayed.

アクセス許可

Orchestrator の入力パラメーターおよび出力パラメーターに関連して、次の権限が必要です。

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

2 年前に更新



入力パラメーターと出力パラメーター


改善の提案は、API リファレンスのページでは制限されています

改善を提案できるのは Markdown の本文コンテンツのみであり、API 仕様に行うことはできません。