通知を受け取る

UiPath Studio

UiPath Studio ガイド

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

UiPath Studio では、以下の種類のプロジェクトを作成できます。

  • プロセス - オートメーション プロセスを設計し、ロボットが実行できるようにパブリッシュします。
  • Library - Design workflows as reusable components and publish the project as a library that can be added as a dependency to multiple processes. For more information, see About Libraries.
  • Test Automation - Design a test automation project. For more information about test automation, see the Test Suite section.
  • Template - Design a process and publish it as a template that other processes which share common characteristics can then be based on. For more information, see Project Templates.

新しい空のプロジェクトを作成するには、[ホーム] (Studio の Backstage ビュー) > [スタート] に移動して、[新しいプロジェクト] で作成するプロジェクトの種類を選択します。[テンプレートから新規作成] で、利用可能な既定のテンプレートの 1 つを選択して作成を開始するか、[テンプレート] タブに移動して、さまざまなソースから提供される多数のテンプレートを参照することもできます。

563563

[新しいプロジェクト] ウィンドウで、プロジェクトごとに以下を設定します。

  • 新しいプロジェクトの名前 (最大 128 文字) とこのプロジェクトの目的を要約した説明 (最大 500 文字) を入力します。
  • プロジェクトを作成する場所を選択します。プロジェクトが作成される既定の場所は、%USERPROFILE%\Documents\UiPath です。
  • Select the compatibility and language.
    :information-source: Note: The compatibility and language cannot be changed after you create a project.

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

  • ファイル
    • 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. For test automation projects, a TestCase.xaml file is created by default instead of Main.xaml.
    • project.json オートメーション プロジェクトに関する情報が含まれています。
  • サブフォルダー
    • .entities - プロジェクト内で Data Service からインポートされるエンティティが使用されている場合に、そのエンティティに関するデータが含まれています。
    • .local - ローカルにキャッシュされるプロジェクト データが含まれています。
      :information-source: Note: The .local folder is hidden. You can enable viewing hidden items from the Windows File Explorer settings.
    • .objects - プロジェクト内でオブジェクト リポジトリに追加されたアイテムが使用されている場合に、そのアイテムに関するデータが含まれています。
    • .screenshots - プロジェクト内で UI Automation アクティビティで生成されるスクリーンショットが使用されている場合に、そのスクリーンショットが含まれています。
    • .settings - 実行時に使用される、アクティビティのプロジェクト設定が含まれています。
    • .templates - プロジェクトに追加されたファイル テンプレートが含まれています。
    • .tmh - プロジェクト内でテスト ケースが使用されている場合、そのテスト ケースに関するデータが含まれています。

📘

重要:

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

プロジェクトの対応 OS を設定する

Studio プロファイルで新しいプロジェクトを作成するときには、プロジェクトが実行される環境に基づいて対応 OS を選択します。

  • Windows - レガシ - 2021.10 より前のリリースで使用されていたフレームワークである .Net Framework 4.6.1 を使用します。これは既定のオプションです。
  • Windows - Windows でサポートされる .NET 6 (Studio 2021.10.6 以降のバージョンの場合) または .NET 5 (2021.10.6 より前のバージョンの Studio 2021.10 の場合) を使用します。
  • クロスプラットフォーム - クロスプラットフォームでサポートされる .NET 6 (Studio 2021.10.6 以降のバージョンの場合) または .NET 5 (2021.10.6 より前のバージョンの Studio 2021.10 の場合) を使用します。

🚧

重要

Windows プロセスとクロスプラットフォーム プロセスを実行するには、2021.10 以降の Orchestrator が必要です。

それぞれの対応 OS の違いについては、以下の表をご覧ください。

Windows - LegacyWindowsCross-platform
Process execution32-bit64-bit64-bit
Supported platforms for executionWindows (32-bit and 64-bit)Windows (64-bit)Windows and Linux (64-bit)
Processes are compiled when publishedNo. Published packages contain the project source files.Yes. Published packages contain compiled DLL files.Yes. Published packages contain compiled DLL files.

The design experience is the same for all compatibilities, but only the activities packages that support the selected compatibility can be installed from the package manager.

各プロジェクトの対応 OS は、Studio のステータス バーの右隅と、[プロジェクト] パネル内の [依存関係] ノードに表示されます。対応 OS は、[ホーム] (Studio の Backstage ビュー) > [開始] タブの [最近使用したプロジェクトを開く] のリストに含まれる各プロジェクトのエントリにも表示されます。

クロスプラットフォーム プロジェクトを設計する

クロスプラットフォーム プロジェクトでは、Windows および Unix 系オペレーティング システムで実行可能な API ベースのオートメーションを作成できます。

📘

注:

2021.10 のリリースでは、クロスプラットフォーム プロジェクトは Windows および Linux での実行のみがサポートされています。

クロスプラットフォームのサポートを使用して無人プロジェクトを作成するには、以下の手順を実行します。

  1. Studio で新しいプロジェクトを作成し、[対応 OS] で [クロスプラットフォーム] オプションを選択します。このオプションは、すべての種類のプロジェクトで利用できます。
  2. オートメーションを設計します。すべてのアクティビティ パッケージがクロスプラットフォーム プロジェクトに対応しているわけではないため、パッケージ マネージャーで選択できるパッケージには制限があることに注意してください。クロスプラットフォーム プロジェクトの既定の依存関係は、UiPath.System.ActivitiesUiPath.WebApi.Activities です。
  3. オートメーションをテストします。オートメーションのテストは、Windows ロボットと Linux ロボットの両方で動作するリモート デバッグを使用して、そのオートメーションを実行するマシンで行うことをお勧めします。
  4. オートメーションをテストしたら、プロジェクトを Orchestrator にパブリッシュします。無人ジョブを実行する手順は、Windows と Linux で同じです。

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

Studio プロファイルで新しいプロジェクトを作成するときには、式に使用する言語 (VB または C#) を選択できます。既定で選択される言語は VB ですが、[ホーム] (Studio の Backstage ビュー) > [設定] > [デザイン] で、C# を新しいプロジェクトの既定の言語に設定することもできます。StudioX プロファイルで作成されたプロジェクトは、式に VB.NET 言語を使用します。

同じプロジェクト内で 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 桁のバージョン管理スキームを使用するプロジェクトを考慮に入れたものです。

プロジェクトを管理する

393393

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

14441444

ファイル エクスプローラーから [プロジェクト] パネルに直接ファイルをコピーして貼り付けられます。同じ操作を、.xaml ワークフローなどの 1 つまたは複数のファイルに対し、ドラッグ アンド ドロップによって実行することも可能です。ショートカットの Ctrl + CCtrl + V、またはコンテキスト メニューのオプション [コピー][貼り付け] を使用して、ファイルまたはフォルダーをコピーしてパネル内に複製することもできます。

OptionDescription
Expand Allexpand_allexpand_allExpands all nodes in the automation project.
Collapse Allcollapse_allcollapse_allCollapses all nodes in the automation project.
RefreshrefreshrefreshRefreshes the project.
Show All Filesshow_filesshow_filesShows all files belonging to the automation project, including the project.json.
File Explorerfile_explorerfile_explorerOpens the project's location on the machine.
Project Settingsproject_settingsproject_settingsOpens the Project Settings window for processes or libraries.

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

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

OptionDescription
Open Project FolderOpens the local folder containing the project.
Project SettingsOpens the Project Settings window for adjusting project preferences.
AddOpens a list of items that can be added to the project: folder, sequence, flowchart, state machine, global handler, workflow, or, in test automation projects, test case.
Import WorkflowsImports .xaml files to the project and adds Imported in the file name if it coincides with the name of the main file.
Import FilesOpens the File Explorer window for importing various files into your project.
Add to Source ControlAdds the current project to source control using Git Init, Copy to Git, Add to TFS, or Add to SVN options. Please note that this option is only visible when right-clicking the project node.
When a project is added to source control, additional options are available in the context menu. See the options for GIT and the options for SVN and TFS.
OpenOpens the selected files using the default program.
Open File LocationOpens the local folder containing the file.
RenameEnables you to rename the selected file or folder, and opens the Rename Item window. The item is renamed in all occurrences.
CopyCopies the selected files or folders to the clipboard. You can then paste them in the project panel or in the Windows file explorer.
PastePastes files or folders that were copied to the clipboard.
DeleteDeletes the selected item only from your local machine.
Select for CompareSelects the current file for comparison.
Compare with SelectedCompares the current file with the previously selected file using Compare Files.
Find ReferencesFinds all references to the file in the project. The results are displayed in the Find References panel.
Debug FileDebugs the selected .xaml file.
Set as MainSets the selected .xaml file as Main in the project definition, meaning that the project execution starts with that file. There can only be one Main project file. The name of the file set as main appears in bold in the Project panel.
PropertiesOpen the library’s Properties window for adding a tooltip and Help Link.
Set as Global HandlerSets the .xaml file as the Global Exception Handler for the project. This is applicable to one workflow per project/process.
Remove HandlerRemoves the Global Exception Handler tag from the .xaml file.
Enable Entry PointMarks the selected workflow file as an entry point for the process, making it possible to select it as the workflow to run first when using the Invoke Process and Run Parallel Process activities in other processes, or when starting a job from Orchestrator.
Notes:
When a file is marked as an entry point, an arrow is displayed on the icon next to the file name icon_enable_entry_pointicon_enable_entry_point.
Enabling a file that is ignored from publishing as an entry point sets the file as publishable.
This option is not available for test case files.
This option is not available in library projects.
Disable Entry PointNo longer marks the selected workflow file as an entry point for the process. This option is not available for the workflow file that is set as Main.
Extract as TemplateSaves the selected workflow or test case as a template on which you can then base other files in the project. Using a file template allows you to save time when you need to create multiple files with the same structure. When you add a new workflow or test case, you have the option to base it on any template of the same type that exists in the Templates project folder.
Ignore from Publish / Set as PublishableMarks one or more selected files as excluded from publishing or publishable.
Notes:
When a file is ignored from publishing, the icon next to the file name turns gray icon_ignore_publishicon_ignore_publish.
Ignoring a file marked as an entry point from publishing disables the entry point.
These options are not available for workflow files in library projects.
In projects where XAML files are compiled when published, workflow and test case files that are excluded from publishing are not compiled.
Make Private / Make PublicMarks one or more selected files in a library project as private or public, A private workflow file is included in the published package, but no reusable component is created and made available in the Activities panel in projects where the library is installed as a dependency.
Notes:
When a file is marked as private, the icon next to the file name turns gray icon_ignore_publishicon_ignore_publish.
These options are not available for test case files.
Create Test CaseCreates a test case that invokes the selected workflow file.
Convert to Test Case / Convert to WorkflowConverts the selected workflows to test cases or the selected test cases to workflows.
Import Test CasesImports test cases into the project as draft test cases.
Add Test DataOpens the Import Data Variation Source window that enables you to add test data to the project. This option is only available for test cases.
Link to Test ManagerOpens the Link to Test Manager window that enables you to link the selected test cases to Test Manager.
Run Test Cases / Debug Test CasesRuns or debugs multiple selected test cases.

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

Git リポジトリに追加されたプロジェクトでは、[プロジェクト] パネルの各ファイルの横にファイルのステータスを示すアイコンが表示されます。
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.

234234
OptionDescription
CommitCommits current changes to the local GIT repository.
PushPushes the current version onto the remote repository.
Pull (rebase)Pulls remote files and rebases the current branch.
Manage BranchesOpens the GIT window with options for managing currently added branches.
Show ChangesOpens the File Diff window for comparing changes between the local version and the remote version of the file.
Show HistoryOpens the Show History window for comparing two versions of the same file.
UndoOpens the Undo Pending Changes window if the file was not committed or pushed to the remote repository.
Copy Repository URLCopies the repository URL of the project to the clipboard.

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

SVN または TFS リポジトリに追加されたプロジェクトは、 [プロジェクト] パネル内の各ファイルの横にアイコンが表示され、ファイルのステータスを示されます。
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.

233233
OptionDescription
Open Opens the selected .xaml file in the Designer panel, in read-only mode if it was not checked out for edit from the TFS/SVN repository.
Rename Enables you to rename the selected file or folder, and opens the Rename Item window. When checking in the renamed .xaml file, the previously modified version must also be checked in.
Delete Deletes the selected item only from your local machine. The latest checked in version of the file is still available in the TFS/SVN repository.
Check Out For EditMarks the selected file or folder as locked for editing. Checking out a file locks it on the server so that no one else can edit it.
Finish EditingChecks in the project.json file in the respository, together with changes and a commit message.
Add Uploads the selected item to the TFS/SVN server. This option is not available, if the item was previously uploaded to the server.
Get Latest Version Downloads the latest version of the selected item from the TFS/SVN repository.
Show changes...Opens the File Diff to compare changes between the versioned file and the one mapped locally.
Check In Displays the Check In Changes window and enables you to upload the selected item to the server as the newest version. The .xaml file must be saved before uploading it. After it’s checked in, the file becomes read-only in Studio.
Undo Displays the Undo Pending Changes window and enables you to Revert the changes done to the project, either revert modified files to previous or unversioned states, or retrieve files which were deleted from the local machine.

Changes cannot be reverted after the file was checked in.
RunRuns the selected workflow, even if it's not checked out or added to the repository.
Set as MainSets the selected .xaml file as Main in the project. The first created .xaml is set as Main by default.
Copy Repository URLCopies the repository URL of the project to the clipboard.

プロジェクト設定の調整

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

875875

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

The following table describes the project settings for process, test automation, and template projects. For information about the settings available for libraries, see About Libraries.

FieldDescription
NameChange the name of the project. Such names may contain whitespace characters. When naming projects, keep in mind that whitespace characters are removed at publish time. This field accepts up to 128 characters.
DescriptionChange the project description. This field accepts up to 500 characters.
Automation Hub URLURL of an Automation Hub idea linked to the project. For more information, see Linking a Project to an Idea in Automation Hub.
Package IconOptionally, define a custom icon for the project. You can browse to and select a file, or enter a path or public URL to an ico, jpeg, jpg, or png file up to 1MB in size.

After the project is published, the icon is displayed as follows:
For processes, in the Assistant next to the process name, making it easier to identify it in the list of processes.
For templates, next to the template in Home (Studio Backstage View) > Templates.
For libraries, next to the package in the Manage Packages window in Studio.
:information-source: The icon is not visible in Manage Packages if a local file is used for a library published to Orchestrator or a feed that does not support embedded icons, In this case, specify the icon using a URL.
Disable PauseEnable or prevent users from pausing execution from the UiPath Assistant. Set to Yes if pausing the process during execution would result in crashing it. For example, if an activity in your workflow uses the Timeout property, pausing the execution might cause the timeout to expire, thus breaking the execution.
Attended AutomationSet to Yes to indicate that the project should only be executed in an attended context. Use this setting for projects that include UI Automation activities or other activities that require user interaction.
Starts in BackgroundSet to Yes to turn the project into a Background Process and allow it to run in the background concurrently with other processes, as long as it does not use UI interaction.
Supports PersistenceSet to Yes to turn the project into an Orchestration Process.
PiP Ready Set to Yes to indicate that the project was tested using Picture in Picture. If set to No, when the process is run in PiP from the Assistant, a dialog informs the user it was not tested using this feature and prompts for confirmation before proceeding.
Starts in PiP Set to Yes to indicate that the process should be run by default using the Picture in Picture feature.
Modern Design Experience Set to Yes to enable a modern experience of working with UI Automation, including new and improved activities, recorders, and wizards, as well as the Object Repository.
This setting also enables / disables a modern design experience for Excel if the Excel Design Experience option is set to UseGlobalSetting in the Excel activities project settings.

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

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

📘

注:

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

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

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

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

6 か月前に更新


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


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

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