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

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

注:

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

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

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

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

パラメーター値の設定

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

Studio

As default values, when creating the arguments. A short example can be found here. A default value provided for an argument in Studio can be overwritten in Orchestrator, both at process or job level.

注:

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

Orchestrator

• At process level - in the Parameters tab of the View Process window, as explained here.

• At job level - in the Parameters tab of the Start Job window, as explained here.

• At trigger level - in the Parameters tab of the Add trigger window, as explained here.

  注:

  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 が検証するのはプリミティブのみです。

Orchestrator API

• At package level - to the /odata/Processes/UiPath.Server.Configuration.OData.SetArguments(key='key') endpoint;

• At process level - as a PATCH request to the /odata/Releases(Id) endpoint;

• At job level - as a POST request to the /odata/Jobs/UiPath.Server.Configuration.OData.StartJobs endpoint;

• At schedule level - as a POST request to the /odata/ProcessSchedules endpoint.

  注:

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

パラメーター値の表示

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

• 値がありません - プロセス、ジョブ、スケジュール、パッケージ (Studio) のいずれのレベルでも、値が設定されていません。

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

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

  

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

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

You can also view input and output parameters at package level, in the Package Versions window. For more information, see the Managing Packages.

注:

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

権限

The following permissions are required in relation to input and output parameters in Orchestrator:

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