- 基本情報
- セットアップと構成
- オートメーション プロジェクト
- 依存関係
- ワークフローの種類
- ファイルの比較
- オートメーションのベスト プラクティス
- ソース管理との連携
- デバッグ
- 診断ツール
- ワークフロー アナライザー
- 変数
- 引数
- インポートされた名前空間
- コード化されたオートメーション
- トリガーベースの有人オートメーション
- 制御フロー
- オブジェクト リポジトリ
- ログ
- ScreenScrapeJavaSupport ツール
- Studio でのテスト
- 拡張機能
- トラブルシューティング
Studio ガイド
Studio におけるプロジェクトの依存関係とは、既定またはカスタムのアクティビティを含む特定のプロジェクトにリンクされているパッケージを指します。依存関係は、コンテキストに基づき、各プロジェクトの定義 (使用するアクティビティ、変数、入力/出力引数など) を考慮に入れます。このため、プロジェクトの定義に 1 つ以上の参照が存在する場合にのみ、依存関係が設定されます。
Studio では、プロジェクトの既定の依存関係は、プロジェクトの種類、対応 OS、またはプロジェクトの作成に使用したテンプレートによって異なります。
StudioX の場合は、すべてのプロジェクトに次の既定パッケージが付属しています。UiPath.System.Activities、UiPath.ComplexScenarios.Activities、UiPath.Excel.Activities、UiPath.Mail.Activities、UiPath.Presentations.Activities、UiPath.UIAutomation.Activities、UiPath.Word.Activities。
これ以外のものを追加する場合は、[パッケージを管理] をクリックして、それらをインストールします。インストールした依存関係は、現在のプロジェクトでのみ使用できます。プロジェクトごとの依存関係のリストは project.json ファイルで確認できます。
[プロジェクト] パネルには、オートメーション プロジェクトにインストールされているアクティビティ パッケージと、その下位依存関係、ランタイム ルール、要求済み/解決済みのバージョンが表示されます。また、プロジェクトの対応OS は [依存関係] ノードに表示されます。
依存関係の上にホバーすると、要求済み/解決済みのバージョンが表示されます。[管理]、[修復]、[依存関係を削除] などのコンテキストによる操作は、依存関係にのみ使用可能であり、サブパッケージには使用できません。
ツリー内の依存関係のステータスは、次のように色分けされます。
- 赤 - 依存関係が見つかりませんでした。
- オレンジ - サブパッケージが見つかりませんでした。
- 灰色 - 依存関係は未解決です。
- 薄い青 - 解決されたバージョンのほうが要求されたバージョンよりも高くなっています。
- 濃い青 - 要求されたバージョンと解決されたバージョンは完全に一致しています。
依存関係を追加・更新する
プロジェクトに依存関係を追加するには、[ パッケージを管理 ] ウィンドウからインストールします。利用可能なパッケージは、 プロジェクトの対応 OS によって異なります。
Whenever new versions are available for the current project dependencies, the Manage Packages button from the ribbon gets an update icon
.
-
To manage dependencies in a project, simply right-click on the Dependencies category in the Project panel, and then click on Manage. This opens the Manage Packages window, with the Project Dependencies category. The
icon shows which packages are currently installed. -
Default dependencies are displayed, together with the versions that are currently linked to the project. To update a package, simply click on the update icon
, next to the available version number. The
icon is shown next to the package, meaning that dependencies are ready to be installed. -
[保存] をクリックしてはじめてプロジェクトに依存関係がインストールされます。同時に、プロジェクトに属する
project.jsonファイル内の依存関係のバージョンが更新されます。
依存関係を削除する
- プロジェクトの依存関係を削除するには、[プロジェクト] パネルの依存関係を右クリックして、[依存関係の削除] をクリックします。依存関係が [プロジェクト] パネルと
project.jsonファイルから削除されます。 [パッケージを管理] > [プロジェクト依存関係] に移動し、削除する依存関係を選択して [アンインストール] をクリックすることもできます。 - プロジェクト内の未使用の依存関係をすべて削除するには、Studio のリボンで [未使用を削除] > [依存関係] を選択するか、キーボード ショートカット Ctrl + Shift + R を使用します。現在のプロジェクト内の参照のないすべてのインストール済みパッケージが、[プロジェクト] パネルと
project.jsonファイルから削除されます。
依存関係を修復する
Studio で開いたワークフローに、現在の Studio フィードで使用できないバージョンのパッケージへの参照が含まれている場合、該当する依存関係が [プロジェクト] パネルで破損しているものとしてマークされます。詳細は、[出力] パネルで確認できます。
Studio では、すべての依存関係の修復が一括または個別で行えます。破損した依存関係を修復するには、[プロジェクト] パネルの [依存関係] ノードを右クリックし、[依存関係を修復] をクリックします。
個別に修復するには、破損した依存関係を右クリックして、[依存関係を修復] をクリックします。または、[管理] を選択して、[パッケージを管理] を開き、パッケージを更新することもできます。
NuGet resolves broken dependencies by applying the Lowest Applicable Version
runtime rule, meaning that it searches for the first applicable package version, higher than the one previously set.
対象のバージョンが見つからない場合、修復機能では次に使用可能な上位バージョンが自動的に使用されます。なお、この動作はフィードの設定によって異なります。
デザイナーパネルでは、存在しないアクティビティや無効なアクティビティがマークされます。また、ワークフローとその解決されない依存関係に関する追加情報がエラーバナーに表示されます。
依存関係のルールを設定する
アクティビティ パッケージは複数のバージョンで使用可能です。このため、[パッケージを管理] を使用してこれらのバージョンをインストールまたは更新する際には、これらの各バージョンについて依存関係のランタイム ルールを設定できます。
[ランタイム ルール] では、ランタイムでインストールするパッケージ バージョンを指定します。2 つのオプションを使用できます。
The Strict runtime rule is the default state for dependencies added upon process creation, and for activities packages installed from the Manage Packages window. It means that only the specified version of the package is used at runtime to execute the parent process. The Strict rule is marked in the Project panel, under Dependencies by the
sign next to the package version.
The Lowest Applicable Version runtime rule means that if the target package isn’t found, the next higher version is searched in order to resolve dependencies. The Lowest Applicable Version rule is marked in the Project panel, under Dependencies by the
sign next to the package version.
Studio からオートメーション プロジェクトを実行する場合、Robot は、各プロジェクトにあらかじめ設定されたランタイム ルールに従って、プロジェクトの実行に必要な、指定または指定したパッケージ バージョンをダウンロードします。実行時に使用された依存関係に ストリクト のランタイム ルールが設定されており、正確なパッケージ バージョンが見つからなかった場合、エラーがスローされます。プロジェクトの依存関係にランタイム ルールを設定する方法について詳しくは 、「依存関係を管理する 」をご覧ください。
依存関係の競合を解決する
アクティビティ パッケージのインストールでは、該当するパッケージに以前設定した依存関係のランタイム ルールを考慮に入れます。それでも、プロジェクトの自動化でバージョン間の競合が発生する可能性があります。オートメーション プロジェクトとそれを含むライブラリに同じアクティビティ パッケージが含まれているとしても、バージョンやランタイム ルールが異なる場合があります。デザインタイムで、NuGet は、階層の中で該当するプロジェクトに最も近いトップレベルの依存関係を選択することにより、競合を解決します。
競合の解決は次のように行われます。
プロジェクトにバージョン 1.0 のアクティビティ パッケージが含まれています。このプロジェクトはライブラリを参照しています。ライブラリは同じパッケージの、より高いバージョンを使用します。トップレベルの依存関係である v1.0 が使用されます。ダウングレードが検出されたことを示す警告が表示されます。
The resolution of this scenario is applicable regardless of the runtime rule (Strict
or Lowest Applicable Version
) previously set for the activities packages.
-
[はい] を選択すると、プロジェクトで参照しているアクティビティ パッケージが、ライブラリで使用されているバージョンにアップグレードされます。
-
[いいえ] を選択した場合、Package Manager が開き、[パッケージを管理] ウィンドウが表示されます。
The project contains an activities package with the version 2.0. The library uses the same pack, but with a lower version and the Strict
runtime rule. The top level dependency used in this case is v2.0 and a warning is given when the package is installed in the project.
The project contains an activities package with the version 2.0. The library uses the same pack, but with a lower version and the Lowest Applicable Version
runtime rule. The top level dependency used in this case is v2.0 and a warning is given when the package is installed in the project.
The project references a library with an activities package version 1.0 and Strict
runtime rule. The project references another library, but with an activities package version 2.0. The top level dependency in this case is the pack with v2.0, since it has the highest version. A warning is given when the activities package is installed.
In this conflict the project references two libraries, which in turn have Strict
dependencies referenced among them. This scenario isn't supported. For detailed information, check the Dependency Resolution page.
依存関係の循環は、パッケージが自身を参照する場合に発生する競合です。プロジェクト名を「UiPath」とした場合は、Studio は依存関係の競合を検出します。これは、「UiPath」パッケージが既に存在し、UiPath.UIAutomation.Activities に対して依存関係を有するためです。プロジェクトの名前を付ける際には、依存関係として追加しようとする既存パッケージと同じ名前は避けることをお勧めします。
同じ依存関係の循環は、「UiPath」など、依存関係として追加しようとする既存パッケージの名前と同じ名前のフォルダーから .xaml ファイルを開き、そのフォルダーに project.json が存在しない場合にも発生します。関連する project.json ファイルが存在しない .xaml ファイルを開くと、Studio が関連ファイルを作成し、親フォルダーの名前に "name" タグが付加されます。
以前のバージョンで作成したプロジェクトを開く
v2016.2 の Studio で作成されたプロジェクトは、v2020.4 以降のバージョンで直接開くことができません。これらのプロジェクトは、まず v2018.4 の Studio で開いてから、v2020.4 以降のバージョンで開いてください。
v2018.3 より前 (v2016.2 を除く) のバージョンで依存関係あり/なしで作成したプロジェクトを開くと、Studio は欠落している依存関係の取得または既定の依存関係の追加を試みるために、自動移行を実行するかどうかを尋ねます。
Upon confirmation, Studio attempts to retrieve missing dependencies and sets the Strict
runtime rule for the packages that it finds. When using the Repair Dependency option in the Project panel, Studio attempts to install the next best package version. If the package version is not found, alerts are shown in the Output panel and you should check the configured feeds in the Manage Packages window.
Processes containing dependencies and that were built with Studio versions prior to v2018.3 continue to execute with Robot v2018.3. The runtime rule for such projects is set to Lowest Applicable Version
.
Projects created with versions prior to v2018.3 that were never published don't have dependencies listed in the project.json file. When opening such projects, an alert in the Output panel notifies you of missing dependencies. UiPath packages delivered locally with Studio are added as dependencies with the Strict
runtime rule. The latest version of such packages is automatically set.
そのようなプロジェクトに、Studio でローカルに提供されたもの以外のパッケージが含まれる場合、以下をお勧めします。
- 作成された Studio バージョンを使用してプロジェクトをパブリッシュし、
project.jsonファイルに依存関係を追加して移行プロセスを支援します。 - 必要なフィードを設定した後に、[ パッケージを管理 ] ウィンドウから不足しているパッケージを手動でインストールする
- プロジェクト依存関係一括更新ツールを使用して、不足している依存関係を多数のプロジェクトに追加する。
注:アクティビティ パッケージ
無効なアクティビティを含むワークフローは、保存できません。必要な依存関係をインストールし、そのプロジェクトを保存してください。
UiPath.V7.Activities、UiPath.Platform.Activities、UiPath.Framework.Activitiesは廃止されました。UiPath.Platform.ActivitiesおよびUiPath.Framework.Activitiesのパッケージを持つプロジェクトを開くと、Studio v2018.3 またはそれ以降のバージョンは自動移行を実行し、古いバージョンのアクティビティを新しいバージョンのものに置き換えることを試みます。
UiPath.V7.Activities パッケージの一部であるアクティビティを含むワークフローは、移行できません。
移行が自動的に実行されない一部のケースについては、回避策を用いることができます。
- Notepad++ で、
project.jsonファイルを開きます。 "schemaVersion": "3.2"パラメーターを削除します。"studioVersion"を"toolVersion"に置き換えます。"toolVersion"値を"18.3.xxx"から以前のバージョンに変更します。たとえば、値を"18.3.0.958"から"18.2.958"に変更します。ファイルを保存します。- 移行を実行するために Studio v2018.3 またはそれ以上のバージョンで
.xamlファイルを開きます。廃止されたアクティビティ パッケージは新しいもので置き換えられます。これは、[プロジェクト] パネルの [依存関係] セクションで確認できます。注:Studio v2018.4.1 以降、Microsoft.Activities v.1.0.1 と Microsoft.Activities.Extensions v2.0.6.9 に場合によっては、パッケージ
UiPath.Platform.ActivitiesおよびUiPath.Framework.Activitiesを含む.xamlファイルは 移行が自動的に行われず、回避策も適用できないことがあります。このような場合には、プロジェクトを Studio v2018.2 またはそれ以前のバージョンで開き、前述のパッケージに属するアクティビティをUiPath.Core.Activitiesパッケージに含まれるアクティビティに置き換えることを推奨します。UiPath.V7.Activitiesパッケージからのアクティビティを含むワークフローについても、同じことができます。UiPathStudio.msiインストーラーにはパッケージ化されなくなりました。
これらのパッケージを依存関係として含むプロジェクトを移行するときに修復が必要な場合は、公式フィードまたはローカル フィードから 2 つのパッケージをインストールします。v2018.4.1 より前のバージョンで作成されたこのようなプロジェクトを実行する前に、Robot がアクセスできるフィードで前述のパッケージが利用可能であることを確認してください。
v2018.4.1 より前のバージョンからアップグレードする場合、2 つのアクティビティ パッケージはローカル フィードに残ります。