通知を受け取る

UiPath Studio

UiPath Studio ガイド

オートメーション プロジェクトについて

UiPath Studio allows you to create two types of standalone automation projects: process or library. Processes can incorporate all types of workflows, sequence, flowchart, state machine and global exception handler, while the global exception handler isn't available for libraries. Moreover, libraries can be added as dependencies to automation processes.

Studio で新しいプロセスを開始すると、選択した場所にカスタム名でフォルダーが作成されます。プロジェクトは、手動で保存場所を変更しないかぎり、既定では %USERPROFILE%\Documents\UiPath ディレクトリに保存されます。

プロジェクト フォルダーには、既定で以下のファイルとサブフォルダーが含まれます。

  • ファイル
    • Main.xaml - Created by default to hold your main workflow. In addition, all the other automation XAML files you add to the project are stored in the project folder. Optionally, you can set a different file as main. All the files must be linked through the Invoke Workflow File activity to the file set as main or to a file marked as an entry point to the project. In the case of test projects created in Studio Pro, a TestCase.xaml file is created by default instead of Main.xaml.
    • project.json オートメーション プロジェクトに関する情報が含まれています。
  • サブフォルダー
    • .entities - プロジェクト内で Data Service からインポートされるエンティティが使用されている場合に、そのエンティティに関するデータが含まれています。
    • .local - ローカルにキャッシュされるプロジェクト データが含まれています。
    • .objects - プロジェクト内でオブジェクト リポジトリに追加されたアイテムが使用されている場合に、そのアイテムに関するデータが含まれています。
    • .screenshots - プロジェクト内で UI Automation 系アクティビティで生成されるスクリーンショットが使用されている場合に、そのスクリーンショットが含まれています。
    • .settings - 実行時に使用される、アクティビティのプロジェクト設定が含まれています。
    • .tmh - プロジェクト内でテスト ケースが使用されている場合、そのテスト ケースに関するデータが含まれています。

📘

重要:

新しいバーションの Studio で作成したプロジェクトは古いバージョンの Studio では実行できない場合があります。詳しくは、「相互運用性」を参照してください。

プロジェクト言語を設定する

Studio および StudioX のプロファイルで作成されたプロジェクトでは、式に VB.NET 言語を使用します。

Studio Pro のプロファイルでは、新しいプロジェクトを作成するときに VB か C# を選択できます。既定で選択される言語は VB ですが、[ホーム] (Studio の Backstage ビュー) > [設定] > [デザイン] から、C# を新しいプロジェクトの既定の言語に設定することもできます。C# プロジェクトは Studio Pro のプロファイルからしか開くことができないので、注意してください。

同じプロジェクト内で VB と C# の両方の式を使用することはできません。C# ワークフローでの VB の式の使用もサポートされていません (逆も同様)。他のプロジェクトからのアクティビティのコピー アンド ペースト、ワークフローの呼び出しまたはインポートを行うときは、必ずプロジェクトと同じ言語を使用してください。

C# ライブラリを依存関係として VB プロジェクトにインストールできます (逆も同様)。ただし、ライブラリがインストールされているプロジェクトから、言語固有の式を使用してライブラリ プロジェクトの引数に定義されている既定値にアクセスすることはできません。

C# の制限事項

  • 現在の C# の実装は C# バージョン 5 を使用する C# コンパイラに基づいています。したがって、合体代入、null 条件演算子、null 合体演算子、文字列補間などの新機能の利用が制限されます。
  • インクリメント付きの式を含むプロジェクトは無効です。
  • nameof() 演算子を含む式は無効としてマークされ、C# の現在の実装では許可されません。
  • オプションの引数を使用したメソッド呼び出しを含む式には、オプションの引数の値を含める必要があります。
  • C# プロジェクトのデザイン時と実行時のパフォーマンスは VB.NET プロジェクトに比べて低いため、実行時のパフォーマンスを重要視する場合は C# ではなく VB.NET の使用をお勧めします。

プロジェクト バージョンの設定

セマンティック バージョン管理

セマンティック バージョン管理スキームは、Major.Minor.Patch[-Suffix] という形式です。ここで、

  • Major は、メジャーバージョンです。
  • Minor は、マイナーバージョンです。
  • Patch は、パッチバージョンです。
  • -Suffix (任意) は、パッチバージョンに続いて、ハイフンの後にドットで区切られた識別子が付加されます。これは、プレリリースバージョンを表します。

識別子は、ASCII 英文字とハイフンのみで指定してください。空欄にすることはできません。数値識別子は、0を先頭につけることはできません。また、ビルドのメタデータは、パッチバージョンまたはプレリリースバージョンの後にハイフンが続き、その後にプラス記号が付加された構成になることがあります (例: 1.0.0-alpha+1)。

新しいプロセスやライブラリの作成する場合、既定のスキームはセマンティックです。この設定は、[パブリッシュ] ウィンドウでバージョン番号に数字を追加すれば、変更できます。このプロジェクトのセマンティック バージョンは、project.json ファイルからも変更できます。バージョン番号 major.minor に、パッチ番号 0 が自動的に追加されます。

レガシーバージョン管理

プロジェクトにより生成されるレガシーのバージョン番号の形式は、「M.m.bbbb.rrrrr」です。それぞれの意味は次のとおりです。

  • M はメジャーバージョンです。
  • m はマイナーバージョンです。
  • bbbb はビルドバージョンです。
  • rrrrr はリビジョンバージョンです。

メジャーバージョンとマイナーバージョンは project.json ファイルでも編集できますが、ビルドバージョンとリビジョンバージョンはアルゴリズムに従って生成されます。ビルドの値は、2000年1月1日からの経過日数です。リビジョンの値は、現時点からリリース時までに経過した秒数です。この結果を2で割って、リビジョン番号が65535を超えないようにします。

[パブリッシュ] ウィンドウに候補として表示されるバージョン番号は、このプロジェクトの以前のバージョン管理スキームに基づいて生成されています。タイムスタンプは、4 桁のバージョン管理スキームを使用するプロジェクトを考慮に入れたものです。

Managing Projects

[プロジェクト] パネルでは、現在のプロジェクトの内容の確認、フォルダーの追加、ファイルの場所を開く、依存関係の管理、プロジェクト設定の調整などの操作が行えます。

ファイル エクスプローラーから [プロジェクト] パネルに直接ファイルをコピー アンド ペーストできます。.xaml ワークフローを含む 1 つまたは複数のファイルに対して、同じ操作をドラッグ アンド ドロップによって実行することも可能です。ショートカットの Ctrl + C および Ctrl + V を使用しても、ファイルをコピーして、ツリーの任意の場所に複製できます。

オプション

説明

すべて展開expand_allexpand_all

オートメーション プロジェクト内のすべてのノードを展開します。

すべて折りたたみcollapse_allcollapse_all

オートメーション プロジェクト内のすべてのノードを折りたたみます。

更新refreshrefresh

プロジェクトを再読み込みします。

すべてのファイルを表示show_filesshow_files

オートメーション プロジェクトに属するすべてのファイルを表示します (project.json を含みます)。

ファイル エクスプローラーfile_explorerfile_explorer

マシン上のプロジェクトの場所を開きます。

プロジェクト設定project_settingsproject_settings

プロセスまたはライブラリについて [プロジェクト設定] ウィンドウを開きます。

プロジェクトのコンテキスト メニュー

[プロジェクト] パネルの任意の場所を右クリックすると、コンテキスト メニューが開きます。このコンテキスト メニューには、以下の表に示すオプションが表示されます。利用可能なオプションは、パネル内のどこを右クリックするかと、プロジェクトの種類、およびプロジェクトがソース管理に追加されるかどうかによって異なります。

オプション

説明

プロジェクト フォルダーを開く

プロジェクトを含むローカル フォルダーを開きます。

プロジェクト設定

プロジェクト設定を調整するために [プロジェクト設定] ウィンドウを開きます。

追加

プロジェクトに追加できる次の項目のリストを表示します。フォルダー、シーケンスフローチャートステート マシンまたはグローバル ハンドラー

ワークフローをインポート

プロジェクトに .xaml ファイルをインポートします。メインファイルと名前が一致した場合、ファイル名に「Imported」を追加します。

ファイルをインポート

ファイル エクスプローラーを開いて、プロジェクトに各種ファイルをインポートします。

ソース管理に追加

[Git Init][Git にコピー][TFS に追加][SVN に追加] オプションを使用して、ソース管理に現在のプロジェクトを追加します。このオプションは、プロジェクト ノードを右クリックしたときにのみ表示されます。
プロジェクトがソース管理に追加されると、追加のオプションがコンテキスト メニューで利用可能になります。「Git のコンテキスト メニュー オプション」および「SVN と TFS のコンテキスト メニュー オプション」を参照してください。

開く

既定のプログラムを使用して、選択したファイルを開きます。

ファイルの場所を開く

ファイルを含むローカル フォルダーを開きます。

名前の変更

選択したファイルまたはフォルダーの名前を変更できます。[Rename Item] ウィンドウを開きます。すべての箇所で項目の名前は変更されます。

削除

選択した項目をローカル マシンからのみ削除します。

比較対象として選択

比較対象として使用中のファイルを選択します。

選択済みと比較

[ファイルを比較] を使用して、現在使用中のファイルと以前選択したファイルを比較します。

参照を検索

プロジェクト内でファイルへのすべての参照を検索します。結果は、[参照を検索] パネルに表示されます。

ファイルをデバッグ

選択した .xaml ファイルをデバッグします。

メインに設定

選択した .xaml ファイルをプロジェクト定義の Main として設定します。つまり、プロジェクトの実行はそのファイルから開始されます。Main プロジェクト ファイルは 1 つしか設定できません。Main として設定されたファイルの名前は、[プロジェクト] パネルに太字で表示されます。

プロパティ

ツールチップとヘルプ リンクを追加するために [プロパティ] ウィンドウを開きます。

グローバル ハンドラーとして設定

.xaml ファイルをプロジェクトのグローバル例外ハンドラーとして設定します。これは、1 つのプロジェクト/プロセスにつき 1 つのワークフローに適用可能です。

ハンドラーを削除

.xaml ファイル内に存在するグローバル例外ハンドラーのタグを削除します。

エントリ ポイントを有効化

選択したワークフロー ファイルをプロセスのエントリ ポイントとしてマークします。これにより、他のプロセスで [プロセスを呼び出し] アクティビティおよび [プロセスを並列実行] アクティビティを使用するとき、または Orchestrator からジョブを開始するときに最初に実行するワークフローとして、そのワークフロー ファイルを選択できるようになります。
注:
あるファイルがエントリ ポイントとしてマークされると、そのファイルの名前の横にあるアイコンに矢印が表示されます icon_enable_entry_pointicon_enable_entry_point
パブリッシュから除外されるファイルをエントリ ポイントとして有効にすると、そのファイルがパブリッシュ可能に設定されます。
このオプションは、テスト ケース ファイルでは利用できません。
このオプションは、ライブラリ プロジェクトでは利用できません。

エントリ ポイントを無効化

選択したワークフロー ファイルがプロセスのエントリ ポイントとしてマークされなくなります。このオプションは、メインに設定されているワークフロー ファイルでは利用できません。

パブリッシュから除外

選択した 1 つ以上のファイルをパブリッシュから除外するようにマークします。
注:
あるファイルがパブリッシュから除外されると、そのファイルの名前の横にあるアイコンが灰色に変わります icon_ignore_publishicon_ignore_publish
エントリ ポイントとしてマークされているファイルをパブリッシュから除外すると、エントリ ポイントが無効になります。
ライブラリ プロジェクトでは、パブリッシュから除外されるファイルはパッケージに含まれます。ただし、再利用可能なコンポーネントは作成されず、ライブラリが依存関係としてインストールされているプロジェクト内の [アクティビティ] パネルで利用することもできません。

「パブリッシュ可能」として設定

パブリッシュから除外されているファイルを 1 つ以上選択し、パブリッシュ可能としてマークします。

Git のコンテキスト メニュー オプション

In projects added to GIT repositories, an icon is displayed next to each file in the Project panel to indicate the file status:
git branchgit branch The file is synced with the repository.
git editedgit edited The file has been modified.
source control addedsource control added The file has been added.

Right-click a file or project node in the Project panel to open the GIT-specific context menu for Managing Projects with GIT.

オプション

説明

確定

現在の変更をローカル Git リポジトリにコミットします。

プッシュ

現在のバージョンをリモートリポジトリにプッシュします。

プル (リベース)

リモート ファイルをプルして、現在のブランチをリベースします。

ブランチを管理

[Git] ウィンドウを開きます。このウィンドウには、現在追加されているブランチのオプションが表示されます。

変更を表示

ファイル差分検出ウィンドウを開きます。ファイルのローカル バージョンとリモート バージョンの変更を比較できます。

履歴を表示

[履歴を表示] ウィンドウを開きます。こ同じファイルの 2 つのバージョンを比較できます。

元に戻す

[保留中の変更を元に戻す] ウィンドウを開きます。ただし、ファイルがリモート リポジトリに確定またはプッシュされていない場合にのみ表示されます。

SVN と TFS のコンテキスト メニュー オプション

In projects added to SVN or TFS repositories, an icon is displayed next to each file in the Project panel to indicate the file status:
svn lockedsvn locked The file is not checked out for editing.
svn checked outsvn checked out The file has been checked out for editing.
svn editedsvn edited The file has been edited.
source control addedsource control added The file has been added.

Right-click a file or project node in the Project panel to open the context menu with options specific to managing projects with TFS or SVN.

オプション

説明

開く

選択した .xaml ファイルが TFS/SVN リポジトリから編集のためにチェックアウトされたものではない場合、[デザイナー] パネルでこのファイルを読み取り専用で開きます。

名前の変更

選択したファイルまたはフォルダーの名前を変更できます。[名前の変更] ウィンドウを開きます。名前を変更した .xaml ファイルをチェックインする際には、以前変更したバージョンもチェックインする必要があります。

削除

選択した項目をローカル マシンからのみ削除します。ファイルの前回チェックインしたバージョンがまだ TFS/SVN リポジトリで利用可能です。

編集用にチェックアウト

選択したファイルまたはフォルダーを、編集用にロック済みと表示します。ファイルをチェックアウトすると、他のユーザーが編集できないように、サーバー上でファイルがロックされます。

編集を終了

リポジトリの project.json ファイルが、変更とコミットメッセージとともにチェックアウトされます。

追加

選択した項目を TFS/SVN サーバーにアップロードします。同じ項目が既にサーバーにアップロードされている場合、このオプションは使用できません。

最新バージョンを取得

選択した項目の最新バージョンを TFS/SVN リポジトリからダウンロードします。

Show changes... (変更を表示...)

ファイル差分検出ウィンドウを開き、バージョン管理されているファイルとローカルにマッピングされているファイルの変更点を比較します。

チェックイン

[変更をチェックイン] ウィンドウを表示します。選択した項目を最新バージョンとしてサーバーにアップロードできます。.xaml ファイルはアップロードする前に保存する必要があります。チェックイン後、ファイルは Studio で読み取り専用になります。

元に戻す

[保留中の変更を元に戻す] ウィンドウを表示します。プロジェクトに加えた変更を元に戻すことができます。変更されたファイルを前のステートまたはバージョン管理されていないステートに戻すか、ローカル マシンから削除されたファイルを取得します。

ファイルをチェックインすると、変更は元に戻せなくなります。

実行

選択したワークフローがチェックアウトされていない、またはリポジトリに追加されていない場合でも、実行します。

メインに設定

選択した .xaml ファイルをプロジェクトのメインとして設定します。既定では、最初に作成された .xaml がメインとして設定されています。

プロジェクト設定の調整

作業中のオートメーション プロジェクトごとに、一連の設定を個別に作成できます。これらの設定は [プロジェクト設定] ウィンドウで行えます。[プロジェクト設定] ウィンドウを開くには、[プロジェクト] パネルの settings_iconsettings_icon をクリックします。

[設定] ウィンドウのフィールドの説明

フィールド

説明

名前

プロジェクト名を変更します。名前には空白文字を含めることができます。プロジェクトに名前を付ける際、空白文字はパブリッシュ時に削除される点にご注意ください。このフィールドには最大 128 文字まで入力できます。

説明

プロジェクトの説明を変更します。このフィールドには最大 500 文字まで入力できます。

パッケージのアイコン

必要に応じて、プロジェクトのカスタム アイコンを定義します。ファイルを参照して選択するか、最大 1MB の icojpegjpg、または png ファイルへのパスまたはパブリック URL を入力します。

プロジェクトがパブリッシュされると、アイコンは次のように表示されます。
プロセスの場合、プロセス リストで特定しやすいように、Assistant でプロセス名の横に表示されます。
テンプレートの場合、[ホーム] (Studio の Backstage ビュー) > [テンプレート] でテンプレートの横に表示されます。
ライブラリの場合、Studio の [パッケージを管理] ウィンドウでパッケージの横に表示されます。
:information-source: Orchestrator にパブリッシュされるライブラリまたは埋め込みアイコンがサポートされていないフィードに対してローカル ファイルが使用されていると、[パッケージを管理] にアイコンが表示されません。この場合は、URL を使用してアイコンを指定します。

一時停止を無効化

ユーザーがロボット トレイでプロセスを一時停止するのを有効または無効にします。実行中にプロセスを一時停止するとクラッシュが発生する場合には、[はい] に設定します。たとえば、ワークフローのアクティビティが Timeout プロパティを使用している場合、実行を一時停止すると、タイムアウトの期限が切れ、実行が中止されてしまいます。

バックグラウンドで開始

プロジェクトをバックグラウンド プロセスに変換するには [はい] に設定します。ユーザーの操作を必要としない限り、他のプロセスと同時にバックグラウンドで実行できます。

永続性をサポート

プロジェクトをオーケストレーション プロセスに変換する場合に [はい] に設定します。

PiP 対応確認済

ピクチャ イン ピクチャを使用してプロジェクトがテストされたことを示すには、[はい] に設定します。[いいえ] に設定した場合、プロセスを Assistant から PiP で実行するときに、この機能を使用してテストされていないことを知らせるダイアログが表示され、次に進む前に確認を求められます。

PiP で開始

ピクチャ イン ピクチャ機能を使用してプロセスを既定で実行する必要があることを示す場合は、[はい] に設定します。

モダン デザイン エクスペリエンス

[はい] に設定すると、UI Automation の操作のモダン エクスペリエンス (向上した新しいアクティビティ、レコーダー、ウィザード、オブジェクト リポジトリなど) が有効になります。

[OK] をクリックすると、[プロジェクト] パネルと project.json ファイルに変更が表示されます。

プロジェクト レベルでアクティビティのプロパティを調整する方法については、「アクティビティ プロジェクトの設定」ページを参照してください。

📘

注:

Windows Workflow Foundation の制限により、大量のアクティビティを 1 つのシーケンスから別のシーケンスにコピーする場合は必ず、下にスクロールして、あらかじめ [Designer] パネルを開いておくことをお勧めします。

未使用のプロジェクト リソースを削除する

不要なリソースがあると、プロジェクトが分かりにくくなり、パフォーマンスに影響を与える可能性があります。この問題を回避するために、Studio のリボンで [未使用を削除] をクリックし、削除する項目を選択して、未使用のリソースをプロジェクトから削除します。

  • ワークフロー - プロジェクトで参照されていないワークフロー ファイルを削除します。
  • 変数 - 現在開いているファイルで使用されていない変数を削除します。
  • 引数 - 現在開いているファイルで使用されていない引数を削除します。
  • 依存関係 - アクティビティがプロジェクトで使用されていない、インストール済みのアクティビティ パッケージを削除します。
  • インポート - 現在開いているファイルで使用されていない、インポートされた名前空間を削除します。
  • スクリーンショット - プロジェクト内のアクティビティで使用されていない、参考スクリーンショットを削除します。

約 1 か月前に更新


オートメーション プロジェクトについて


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

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